dry-initializer/CHANGELOG.md

3.1.1 2022-01-19

Changed

• Improved error messages were rolled back, they created an implicit dependency on dry-types (@flash-gordon)

Compare v3.1.0...v3.1.1

3.1.0 2022-01-16

Changed

• Improved error messages on type mismatch (@swerling)
• [BREAKING] Minimal supported Ruby version is 2.7 (@flash-gordon)

Compare v3.0.4...v3.1.0

3.0.4 2020-09-29

Fixed

• Arity check for lambdas used for coercion (@flash-gordon)

Compare v3.0.3...v3.0.4

3.0.3 2020-01-08

Fixed

• Constrained member arrays work correctly now (see #33) (@bjeanes + @solnic)

Compare v3.0.2...v3.0.3

3.0.2 2019-11-07

Fixed

• Warnings about keyword arguments (flash-gordon)

Compare v3.0.1...v3.0.2

3.0.1 2019-04-15

Fixed

• Usage of underscored names of option-s and param-s (nepalez)

  You can use any sequence of underscores except for in nested types. In nested types single underscores can be used to split alphanumeric parts only.

  class Test
    extend Dry::Initializer
  
    # Proper usage
    option :foo_bar do
      option :__foo__, proc(&:to_s)
    end
  end
  
    # Improper usage
    option :__foo__ do
      # ...
    end
  
    option :foo__bar do
      # ...
    end
  end
  

  This restriction is necessary because we constantize option/param names when defining nested structs.

Compare v3.0.0...v3.0.1

3.0.0 2019-04-14

Added

• Support of wrapped types/coercers (nepalez)

  class Test
    # Wrap type to the array
    param :foo, [proc(&:to_s)]
  end
  
  # And the value will be wrapped as well
  test = Test.new(42)
  test.foo # => ["42"]
  

• It works with several layers of nesting (nepalez)

  class Test
    # Wrap type to the array
    param :foo, [[proc(&:to_s)]]
  end
  
  # And the value will be wrapped as well
  test = Test.new(42)
  test.foo # => [["42"]]
  

• Support of nested types/coercers (nepalez)

  class Test
    param :foo do
      option :bar do
        option :baz, proc(&:to_s)
      end
    end
  end
  
  test = Test.new(bar: { "baz" => 42 })
  test.foo.bar.baz # => "42"
  

• Wrapped/nested combinations are supported as well (nepalez)

  class Test
    param :foo, [] do
      option :bar, proc(&:to_s)
    end
  end
  
  test = Test.new(bar: 42)
  test.foo.first.bar # => "42"
  

• [2.7.0] Unreleazed

Fixed

• Roll back master to the state of [2.5.0].

  Somehow distinction between @default_null and @null variables in the Dry::Initializer::Builders broken the rom library.

  The version [2.6.0] has been yanked on rubygems, so the master was rolled back to the previous state until the reason for the incompatibility become clear (bjeanes, nepalez)

• [2.6.0] [2018-09-09] (YANKED)

Compare v2.5.0...v3.0.0

2.5.0 2018-08-17

Fixed

• nil coercion (belousovAV)

  When default value is nil instead of Dry::Initializer::UNDEFINED, the coercion should be applied to any value, including nil, because we cannot distinct "undefined" nil from the "assigned" nil value.

Compare v2.4.0...v2.5.0

2.4.0 2018-02-01

Added

• Dispatchers for adding syntax sugar to param and options (nepalez)

  # Converts `integer: true` to `type: proc(&:to_i)`
  dispatcher = ->(op) { op[:integer] ? op.merge(type: proc(&:to_i)) : op }
  # Register a dispatcher
  Dry::Initializer::Dispatchers << dispatcher
  # Use syntax sugar
  class User
    param :id, integer: true # same as param :id, proc(&:to_i)
  end
  

Compare v2.3.0...v2.4.0

2.3.0 2017-09-19

Added

• Type coercer can take second argument for the initialized instance (nepalez) This allows to wrap assigned value to the object that refers back to the initializer instance. More verbose example:

  class Location < String
    attr_reader :parameter # refers back to its parameter
  
    def initialize(name, parameter)
      super(name)
      @parameter = parameter
    end
  end
  
  class Parameter
    extend Dry::Initializer
    param :name
    param :location, ->(value, param) { Location.new(value, param) }
  end
  
  offset = Parameter.new "offset", location: "query"
  offset.name     # => "offset"
  offset.location # => "query"
  offset.location.parameter == offset # true
  

Compare v2.2.0...v2.3.0

2.2.0 2017-09-13

Added

• Option :desc for option/param to add a description (nepalez)

• Methods Definition#inch and Config#inch to inspect definitions (nepalez)

  class User
    extend Dry::Initializer
    option :name,  proc(&:to_s), optional: true, desc: "User name"
    option :email, optional: true, desc: "user email"
  end
  
  User.dry_initializer.inch
  # @!method initialize(*, **options)
  # Initializes an instance of User
  # @option [Object] :name (optional) User name
  # @option [Object] :email (optional) User email
  # @return [User]
  

Compare v2.1.0...v2.2.0

2.1.0 2017-09-11

Added

• Method #options to param/option definition (nepalez)

  class User
    extend Dry::Initializer
    option :name,  proc(&:to_s), optional: true
    option :email, optional: true
  end
  
  User.dry_initializer.options.map do |option|
    [option.source, option.options]
  end
  # => [
  #      [:name,  { type: proc(&:to_s), as: :name, optional: true }],
  #      [:email, { as: :email, optional: true }]
  #    ]
  

  This method can be helpful for replicating params/options in another class without inheritance.

Compare v2.0.0...v2.1.0

2.0.0 2017-08-28

and to @gzigzigzeo for persuading me to do this refactoring.

Added

• Class method .dry_initializer -- a container for .params and .options .definitions along with the .null setting (either nil or UNDEFINED) used for unassigned values (nepalez)

• .dry_initializer.attributes method takes an instance of the same class and returns the hash of assigned options. This provide the same functionality as previously used instance variable @__options__ (nepalez)

  object.class.dry_initializer.attributes(object)
  

  When you use "Dry::Initializer.define -> { ... }" syntax, the class method .dry_initializer is not defined. To access attributes you should use private instance method #__dry_initializer_config__ instead:

  object.send(:__dry_initializer_config__).attributes(object)
  

  Both methods .dry_initializer and #__dry_initializer_config__ refer to the same object.

• .dry_initializer.public_attributes. This method works differently: it looks through (possibly reloaded) readers instead of variables (gzigzigzeo, nepalez)

  object.class.dry_initializer.public_attributes(object)
  

  You can use the same trick as above mutatis mutandis.

Fixed

• Definition order dependency bug (nepalez)

  I've found out that if you provided a subclass and then changed params or options of its superclass, these changes woudn't be reflected in subclasses until you change any of it params/options as well.

  Now this bug is fixed: every time you call param or option at any class, the gem scans through all its descendants to the very bottom of the tree, and reloads their defintitions.

  Being done in load time, the rebuilt makes no effect on runtime performance.

• Possible misbehavior when you define param and option with the same name (nepalez)

  Doing this will provide option :name only, not both:

  param  :name
  option :name
  

• Attempt to redefine param/option of superclass with option/param in its subclass will cause an exception because it would break Liskov substitute principle with unexpected behaviour (nepalez)

  No, you can do neither these definitions, nor vice versa:

  class Foo
    extend Dry::Intitializer
    param :name
  end
  
  class Bar < Foo
    option :name
  end
  

• When you reloading previously defined param of superclass, the gem will check all its descendands for whether all required positional params goes before optional ones (nepalez)

  class Foo
    param :name
    # Foo: def initializer(name)
  end
  
  class Bar
    param :email
    # Bar: def initializer(name, email)
  end
  
  class Foo
    # This raises SyntaxError because in Bar this would cause wrong definition
    # Foo: def initializer(name = nil)
    # Bar: def initializer(name = nil, email)
    param :name, optional: true
  end
  

Changed

• Under the hood I've separated param/option settings declaration (a container with param/option settings) from code builders for initializer and readers (nepalez)

  You can check both the code for the __initializer__:

  class Foo
    extend Dry::Initializer
    # ...
  end
  
  Foo.dry_initializer.code
  

  and readers:

  Foo.dry_initializer.params.map(&:code)
  Foo.dry_initializer.options.map(&:code)
  
  # or
  
  Foo.dry_initializer.definitions.values.map(&:code)
  

  You can also check settings for every param and option using methods dry_initializer.params, dry_initializer.options (lists), or dry_initializer.definitions (hash).

  You can check null value via .dry_initializer.null which is different for Dry::Initializer and Dry::Initializer[undefined: false] modules.

• Optimized the code for __initializer__-s (the method where all magics occurs) (nepalez)

  Benchmarks remained about the same:

  rake benchmark
  

  Benchmark for instantiation with plain params
          value_struct:  4317196.9 i/s
            plain Ruby:  4129803.9 i/s - 1.05x  slower
       dry-initializer:  1710702.1 i/s - 2.52x  slower
               concord:  1372630.4 i/s - 3.15x  slower
                values:   601651.8 i/s - 7.18x  slower
           attr_extras:   535599.5 i/s - 8.06x  slower
  

  Benchmark for instantiation with plain options
            plain Ruby: 1769174.1 i/s
       dry-initializer:  636634.1 i/s - 2.78x  slower
                kwattr:  423296.5 i/s - 4.18x  slower
                 anima:  399415.0 i/s - 4.43x  slower
  

  Benchmark for instantiation with coercion
            plain Ruby:  1565501.0 i/s
       fast_attributes:   569952.9 i/s -  2.75x  slower
       dry-initializer:   461122.1 i/s -  3.39x  slower
                virtus:   138074.8 i/s - 11.34x  slower
  

  Benchmark for instantiation with default values
            plain Ruby:  3402455.4 i/s
                kwattr:   586206.5 i/s -  5.80x  slower
       dry-initializer:   528482.2 i/s -  6.44x  slower
           active_attr:   298697.7 i/s - 11.39x  slower
  

  Benchmark for instantiation with type constraints and default values
            plain Ruby: 2881696.1 i/s
       dry-initializer:  470815.1 i/s -  6.12x  slower
                virtus:  180272.6 i/s - 15.99x  slower
  

Compare v1.4.1...v2.0.0

1.4.1 2017-04-05

Fixed

• Warning about redefined #initialize in case the method reloaded in a klass that extends the module (nepalez, sergey-chechaev)

Changed

• Rename Dry::Initializer::DSL -> Dry::Initializer::ClassDSL (nepalez)
• Add Dry::Initializer::InstanceDSL (nepalez)

Compare v1.4.0...v1.4.1

1.4.0 2017-03-08

Changed

• The @__options__ hash now collects all assigned attributes, collected via #option (as before), and #param (nepalez)

Compare v1.3.0...v1.4.0

1.3.0 2017-03-05

Added

• No-undefined configuration of the initializer (nepalez, flash-gordon)

  You can either extend or include module Dry::Initializer with additional option [undefined: false]. This time nil will be assigned instead of Dry::Initializer::UNDEFINED. Readers becomes faster because there is no need to chech whether a variable was defined or not. At the same time the initializer doesn't distinct cases when a variable was set to nil explicitly, and when it wasn's set at all:

  class Foo # old behavior extend Dry::Initializer param :qux, optional: true end

  class Bar # new behavior extend Dry::Initializer[undefined: false] param :qux, optional: true end

  Foo.new.instance_variable_get(:@qux) # => Dry::Initializer::UNDEFINED Bar.new.instance_variable_get(:@qux) # => nil

Changed

• Fixed method definitions for performance at the load time (nepalez, flash-gordon)

Compare v1.2.0...v1.3.0

1.2.0 2017-03-05

Fixed

• The @__options__ variable collects renamed options after default values and coercions were applied (nepalez)

Compare v1.1.3...v1.2.0

1.1.3 2017-03-01

Added

• Support for lambdas as default values (nepalez, gzigzigzeo)

Compare v1.1.2...v1.1.3

1.1.2 2017-02-06

Changed

• Remove previously defined methods before redefining them (flash-gordon)

Compare v1.1.1...v1.1.2

1.1.1 2017-02-04

Fixed

• @__options__ collects defined options only (nepalez)

Compare v1.1.0...v1.1.1

1.1.0 2017-01-28

Added

• enhancement via Dry::Initializer::Attribute.dispatchers registry (nepalez)

  # Register dispatcher for `:string` option
  Dry::Initializer::Attribute.dispatchers << ->(string: nil, **op) do
    string ? op.merge(type: proc(&:to_s)) : op
  end
  
  # Now you can use the `:string` key for `param` and `option`
  class User
    extend Dry::Initializer
    param :name, string: true
  end
  
  User.new(:Andy).name # => "Andy"
  

Changed

• optimize assignments for performance (nepalez)

Compare v1.0.0...v1.1.0

1.0.0 2017-01-22

In this version the code has been rewritten for simplicity

Added

• support for reloading param and option definitions (nepalez)

  class User extend Dry::Initializer param :name param :phone, optional: true end

  User.new # => Boom!

  class Admin < User param :name, default: proc { 'Merlin' } end

  order of the param not changed

  Admin.new.name # => "Merlin"

• support for assignment of attributes via several options (nepalez)

  class User extend Dry::Initializer option :phone option :number, as: :phone end

  Both ways provide the same result

  User.new(phone: '1234567890').phone # => '1234567890' User.new(number: '1234567890').phone # => '1234567890'

Changed

• [BREAKING] when param or option was not defined, the corresponding variable is set to Dry::Initializer::UNDEFINED, but the reader (when defined) will return nil (nepalez)
• Dry::Initializer and Dry::Initializer::Mixin became aliases (nepalez)

Compare v0.11.0...v1.0.0

0.11.0 2017-01-02

Added

• Support of reloading #initializer with super (nepalez)

Compare v0.10.2...v0.11.0

0.10.2 2016-12-31

Added

• Support of Ruby 2.4 (flas-gordon)

Compare v0.10.1...v0.10.2

0.10.1 2016-12-27

Fixed

• Wrong arity when there were no options and the last param had a default (nolith)

Compare v0.10.0...v0.10.1

0.10.0 2016-11-20

Compare v0.9.3...v0.10.0

0.9.3 2016-11-20

Fixed

• Support of weird option names (nepalez)

  option :"First name", as: :first_name
  

Compare v0.9.2...v0.9.3

0.9.2 2016-11-10

Fixed

• Validation of attributes (params and options) (nepalez)

Compare v0.9.1...v0.9.2

0.9.1 2016-11-06

Added

• Support for renaming an option during initialization (nepalez)

  option :name, as: :username # to take :name option and create :username attribute

Compare v0.9.0...v0.9.1

0.9.0 2016-11-06

Added

• The method #initialize is defined when a class extended the module (nepalez)

  In previous versions the method was defined only by param and option calls.

Compare v0.8.1...v0.9.0

0.8.1 2016-11-05

Added

• Support for dry-structish syntax for constraints (type as a second parameter) (nepalez)

  option :name, Dry::Types['strict.string']

Compare v0.8.0...v0.8.1

0.8.0 2016-11-05

are deprecated and will be removed in the next version of the gem.

Added

• support for special options like option :end, option :begin etc. (nepalez)

Changed

• switched from key arguments to serialized hash argument in the initializer (nepalez)

Compare v0.7.0...v0.8.0

0.7.0 2016-10-11

Added

• Shared settings with #using method (nepalez)

Compare v0.6.0...v0.7.0

0.6.0 2016-10-09

Added

• Support for private and protected readers in the reader: option (jmgarnier)

Compare v0.5.0...v0.6.0

0.5.0 2016-08-21

Added

• Allow optional attribute to be left undefined (nepalez)

Compare v0.4.0...v0.5.0

0.4.0 2016-05-28

Compare v0.3.3...v0.4.0

0.3.3 2016-05-28

Compare v0.3.2...v0.3.3

0.3.2 2016-05-25

Fixed

• Add explicit requirement for ruby 'set' (rickenharp)

Compare v0.3.1...v0.3.2

0.3.1 2016-05-22

Added

• Support for tolerance to unknown options (nepalez)

Compare v0.3.0...v0.3.1

0.3.0 2016-05-19

its method #register doesn't mutate the builder instance.

Fixed

• Prevent plugin's registry from polluting superclass (nepalez)

Changed

• Made Mixin##initializer_builder method private (nepalez)
• Add Mixin#register_initializer_plugin(plugin) method (nepalez)
• Make all instances (Builder and Signature) immutable (nepalez)
• Decouple mixin from a builder to prevent pollution (nepalez)
• Ensure default value block can use private variables (jeremyf)

Compare v0.2.1...v0.3.0

0.2.1 2016-05-19

Fixed

• Fix polluting superclass with declarations from subclass (nepalez)

Changed

• Make all instances (Builder and Signature) immutable (nepalez)
• Decouple mixin from a builder to prevent pollution (nepalez)
• Ensure default value block can use private variables (jeremyf)

Compare v0.2.0...v0.2.1

0.2.0 2016-05-16

Default assignments became slower (while plain type constraint are not)!

Added

• Support type constraint via every object's case equality (nepalez)

  option :name, type: /foo/
  option :name, type: (1...14)
  

• Support defaults and type constraints for the "container" syntax (nepalez)

• Support adding extensions via plugin system (nepalez)

Changed

• Make dry-types constraint to coerce variables (nepalez)

  # This will coerce `name: :foo` to `"foo"`
  option :name, type: Dry::Types::Coercible::String
  

• Stop supporing proc type constraint (nepalez)

  option :name, type: ->(v) { String === v } # this does NOT work any more
  

  later it will be implemented via coercion plugin (not added by default):

  require 'dry/initializer/coercion'
  
  class MyClass
    extend Dry::Initializer::Mixin
    extend Dry::Initializer::Coercion
  
    option :name, coercer: ->(v) { (String === v) ? v.to_sym : fail }
  end
  

Compare v0.1.1...v0.2.0

0.1.1 2016-04-28

Added

• include Dry::Initializer.define -> do ... end syntax (flash-gordon)

Compare v0.1.0...v0.1.1

0.1.0 2016-04-26

Backward compatibility is broken.

Added

• Use include Dry::Initializer.define(&block) as an alternative to extending the class (nepalez)

Changed

• Use extend Dry::Initializer::Mixin instead of extend Dry::Initializer (nepalez)

Compare v0.0.1...v0.1.0

0.0.1 2016-04-09

First public release