ti-enxame.com

Como alterar o valor padrão de um atributo Struct?

De acordo com a documentação os atributos não configurados do Struct são configurados para nil:

parâmetros não configurados padrão como nulo.

É possível especificar o valor padrão para atributos específicos?

Por exemplo, para o seguinte Struct

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

Eu gostaria que o atributo happy tivesse como padrão true em vez de nil. Como posso fazer isso? Se eu fizer o seguinte

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

Eu recebo

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

Isso também pode ser conseguido criando o Struct como uma subclasse e substituindo initialize pelos valores padrão, como no exemplo a seguir:

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

Por um lado, esse método leva a um pouco de clichê; por outro, faz o que procura Nice e de forma sucinta.

Um efeito colateral (que pode ser um benefício ou um aborrecimento, dependendo de suas preferências/caso de uso) é que você perde o comportamento padrão Struct de todos os atributos padrão de nil - a menos que você explicitamente configurá-los para ser assim. De fato, o exemplo acima tornaria name um parâmetro obrigatório, a menos que você o declare como name=nil

22
rintaun

Seguindo o exemplo de @ rintaun, você também pode fazer isso com argumentos de palavra-chave em 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>

ATUALIZAÇÃO

O código agora precisa ser escrito da seguinte maneira para funcionar.

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

O @Linuxios deu uma resposta que substitui a pesquisa de membro. Isso tem alguns problemas: você não pode definir explicitamente um membro para zero e há uma sobrecarga extra em cada referência de membro. Parece-me que você realmente deseja fornecer os padrões ao inicializar um novo objeto struct com valores parciais de membros fornecidos a ::new ou ::[].

Aqui está um módulo para estender o Struct com um método de fábrica adicional que permite descrever a estrutura desejada com um hash, onde as chaves são os nomes dos membros e os valores que os padrões devem preencher quando não fornecidos na inicialização:

# 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
4
dbenhur

Eu também encontrei isso:

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

Eu acho que a substituição do método #initialize É a melhor maneira, com a chamada para #super(*required_args).

Isso tem uma vantagem adicional de poder usar argumentos no estilo hash. Por favor, veja o seguinte exemplo completo e de compilação:

Argumentos no estilo hash, valores padrão e Ruby Struct

# 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
2
Konstantin Gredeskoul

Você pode fazer isso com um singleton:

Person = Struct.new("Person", :name, :happy) do
  @@defaults = {:happy => true}
  @@vars = [:name, :happy]
  def [](i)
    return super if(super)
    return @@defaults[i] if(@@defaults[i])
    return nil
  end
  @@vars.each do |v|
    define_method(v) {return self[v]}
  end
end
1
Linuxios

Basta adicionar outra variação:

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