如何更改 Struct 属性的默认值？

Question

根据the documentation未设置的Struct属性设置为nil：

未设置的参数默认为零。

是否可以为特定属性指定默认值？

例如，对于下面的 Struct

Struct.new("Person", :name, :happy)

我希望属性 happy 默认为 true 而不是 nil。我怎样才能做到这一点？如果我这样做

Struct.new("Person", :name, :happy = true)

我明白了

-:1: syntax error, unexpected '=', expecting ')'
Struct.new("Person", :name, :happy = true)
                                    ^
-:1: warning: possibly useless use of true in void context

Answer 1

这也可以通过将 Struct 创建为子类并覆盖 initialize 具有默认值，如下例所示：

class Person < Struct.new(:name, :happy)
    def initialize(name, happy=true); super end
end

一方面，这种方法确实会导致一些样板；另一方面，它可以简洁明了地满足您的需求。

一个副作用（根据您的偏好/用例可能是好处或烦恼）是您失去了默认为 nil 的所有属性的默认 Struct 行为 - 除非您明确设置它们是这样。实际上，上面的示例将使name 成为必需参数，除非您将其声明为name=nil

Answer 2

按照@rintaun 的示例，您也可以在 Ruby 2+ 中使用关键字参数来做到这一点

A = Struct.new(:a, :b, :c) do
  def initialize(a:, b: 2, c: 3); super end
end

A.new
# ArgumentError: missing keyword: a

A.new a: 1
# => #<struct A a=1, b=2, c=3> 

A.new a: 1, c: 6
# => #<struct A a=1, b=2, c=6>

更新

现在需要编写如下代码才能工作。

A = Struct.new(:a, :b, :c) do
  def initialize(a:, b: 2, c: 3)
    super(a, b, c)
  end
end

Answer 3

我还发现了这个：

Person = Struct.new "Person", :name, :happy do
  def initialize(*)
    super
    self.location ||= true
  end
end

Answer 4

@Linuxios 给出了覆盖成员查找的答案。这有几个问题：您不能将成员显式设置为 nil，并且每个成员引用都有额外的开销。在我看来，您真的只想在使用提供给::new 或::[] 的部分成员值初始化新结构对象时提供默认值。

这是一个扩展 Struct 的模块，它带有一个额外的工厂方法，可让您使用散列描述所需的结构，其中键是成员名称，而值是在初始化时未提供时填充的默认值：

# Extend stdlib Struct with a factory method Struct::with_defaults
# to allow StructClasses to be defined so omitted members of new structs
# are initialized to a default instead of nil
module StructWithDefaults

  # makes a new StructClass specified by spec hash.
  # keys are member names, values are defaults when not supplied to new
  #
  # examples:
  # MyStruct = Struct.with_defaults( a: 1, b: 2, c: 'xyz' )
  # MyStruct.new       #=> #<struct MyStruct a=1, b=2, c="xyz"
  # MyStruct.new(99)   #=> #<struct MyStruct a=99, b=2, c="xyz">
  # MyStruct[-10, 3.5] #=> #<struct MyStruct a=-10, b=3.5, c="xyz">
  def with_defaults(*spec)
    new_args = []
    new_args << spec.shift if spec.size > 1
    spec = spec.first
    raise ArgumentError, "expected Hash, got #{spec.class}" unless spec.is_a? Hash
    new_args.concat spec.keys

    new(*new_args) do

      class << self
        attr_reader :defaults
      end

      def initialize(*args)
        super
        self.class.defaults.drop(args.size).each {|k,v| self[k] = v }
      end

    end.tap {|s| s.instance_variable_set(:@defaults, spec.dup.freeze) }

  end

end

Struct.extend StructWithDefaults

Answer 5

只需添加另一个变体：

class Result < Struct.new(:success, :errors)
  def initialize(*)
    super
    self.errors ||= []
  end
end

Answer 6

我认为覆盖#initialize 方法是最好的方法，调用#super(*required_args)。

这还有一个额外的优势，那就是能够使用散列样式的参数。请看下面的完整编译示例：

哈希样式参数、默认值和 Ruby 结构

# This example demonstrates how to create Ruby Structs that use
# newer hash-style parameters, as well as the default values for
# some of the parameters, without loosing the benefits of struct's
# implementation of #eql? #hash, #to_s, #inspect, and other
# useful instance methods.
#
# Run this file as follows
#
# > gem install rspec
# > rspec struct_optional_arguments.rb --format documentation
#
class StructWithOptionals < Struct.new(
    :encrypted_data,
    :cipher_name,
    :iv,
    :salt,
    :version
    )

    VERSION = '1.0.1'

    def initialize(
        encrypted_data:,
        cipher_name:,
        iv: nil,
        salt: 'salty',
        version: VERSION
        )
        super(encrypted_data, cipher_name, iv, salt, version)
    end
end

require 'rspec'
RSpec.describe StructWithOptionals do
    let(:struct) { StructWithOptionals.new(encrypted_data: 'data', cipher_name: 'AES-256-CBC', iv: 'intravenous') }

    it 'should be initialized with default values' do
        expect(struct.version).to be(StructWithOptionals::VERSION)
    end

    context 'all fields must be not null' do
        %i(encrypted_data cipher_name salt iv version).each do |field|
            subject { struct.send(field) }
            it field do
                expect(subject).to_not be_nil
            end
        end
    end
end