dry-initializer 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77c08e7da9990b73b8c94815830a19694b424317
-  data.tar.gz: df1ab88700f059cd3327e7c1745d41aaa901000a
+  metadata.gz: 1a64c90248831e6513871de4f8f489422f3522e0
+  data.tar.gz: bc6cfa16dd5a4922c54869d993fc3d8ac6e08bb6
 SHA512:
-  metadata.gz: 8b04de090fba7b94c917791ebdbff775e3dfd4ae4bfb2c7d51ec9785ae7007324802870c476daf348a397a0ef3ff8c34d70c17fa28777cbb338eb4de44acb137
-  data.tar.gz: 8bb88fc5ada80331a4c1a8d1a076200294db7d2c66009f6da79edef7742fe03e5094d69f5ac97ee57c336354504f00dcc95bf02ac527d21880dfb0ba2be043f4
+  metadata.gz: 615d1a7be21495edcfabe3d4884b637700c1ba032de7b8abc6cdd9d08c10abf00a1febcfc78ae98e6d4c2e0f25031c547326e6640fea561fc755236add5064e8
+  data.tar.gz: 2ca11b3bdaa8d57adc40c7ca07aa5f790a306aeb8d88facacb6233031eaa7be2524bce10e921c775b93edb6720791f8842946a492d2603dc0857b39cc94b6784

data/CHANGELOG.md

@@ -1,34 +1,63 @@
+## v1.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
+
+### Internals
+- Fixed method definitions for performance at the load time (nepalez, flash-gordon)
+
+[Compare v1.2.0...v1.3.0](https://github.com/dry-rb/dry-initializer/compare/v1.2.0...v1.3.0)
+
 ## v1.2.0 2017-03-05
 
-# Fixed
+### Fixed
 - The `@__options__` variable collects renamed options after default values and coercions were applied (nepalez)
 
 [Compare v1.1.3...v1.2.0](https://github.com/dry-rb/dry-initializer/compare/v1.1.3...v1.2.0)
 
 ## v1.1.3 2017-03-01
 
-# Added
+### Added
 - Support for lambdas as default values (nepalez, gzigzigzeo)
 
 [Compare v1.1.2...v1.1.3](https://github.com/dry-rb/dry-initializer/compare/v1.1.2...v1.1.3)
 
 ## v1.1.2 2017-02-06
 
-# Internals
+### Internals
 - Remove previously defined methods before redefining them (flash-gordon)
 
 [Compare v1.1.1...v1.1.2](https://github.com/dry-rb/dry-initializer/compare/v1.1.1...v1.1.2)
 
 ## v1.1.1 2017-02-04
 
-# Bugs Fixed
+### Bugs Fixed
 - `@__options__` collects defined options only (nepalez)
 
 [Compare v1.1.0...v1.1.1](https://github.com/dry-rb/dry-initializer/compare/v1.1.0...v1.1.1)
 
 ## v1.1.0 2017-01-28
 
-# Added:
+### Added:
 - enhancement via `Dry::Initializer::Attribute.dispatchers` registry (nepalez)
 
     # Register dispatcher for `:string` option
@@ -44,7 +73,7 @@
 
     User.new(:Andy).name # => "Andy"
 
-# Internals:
+### Internals:
 - optimize assignments for performance (nepalez)
 
 [Compare v1.0.0...v1.1.0](https://github.com/dry-rb/dry-initializer/compare/v1.0.0...v1.1.0)
@@ -53,10 +82,10 @@
 
 In this version the code has been rewritten for simplicity
 
-# BREAKING CHANGES
+### BREAKING CHANGES
 - 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)
 
-# Added:
+### Added:
 - support for reloading `param` and `option` definitions (nepalez)
 
     class User
@@ -86,7 +115,7 @@ In this version the code has been rewritten for simplicity
     User.new(phone: '1234567890').phone   # => '1234567890'
     User.new(number: '1234567890').phone # => '1234567890'
 
-# Internals
+### Internals
 - `Dry::Initializer` and `Dry::Initializer::Mixin` became aliases (nepalez)
 
 [Compare v0.11.0...v1.0.0](https://github.com/dry-rb/dry-initializer/compare/v0.11.0...v1.0.0)

data/dry-initializer.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "dry-initializer"
-  gem.version  = "1.2.0"
+  gem.version  = "1.3.0"
   gem.author   = ["Vladimir Kochnev (marshall-lee)", "Andrew Kozin (nepalez)"]
   gem.email    = ["hashtable@yandex.ru", "andrew.kozin@gmail.com"]
   gem.homepage = "https://github.com/dryrb/dry-initializer"

data/lib/dry/initializer.rb

@@ -8,6 +8,7 @@ module Dry
     require_relative "initializer/param"
     require_relative "initializer/option"
     require_relative "initializer/builder"
+    require_relative "initializer/dsl"
 
     # rubocop: disable Style/ConstantName
     Mixin = self # for compatibility to versions below 0.12
@@ -17,36 +18,7 @@ module Dry
       obj.define_singleton_method(:inspect) { "Dry::Initializer::UNDEFINED" }
     end.freeze
 
-    class << self
-      def extended(klass)
-        super
-        mixin   = klass.send(:__initializer_mixin__)
-        builder = klass.send(:__initializer_builder__)
-
-        builder.call(mixin)
-        klass.include(mixin)
-        klass.send(:define_method, :initialize) do |*args|
-          __initialize__(*args)
-        end
-      end
-
-      def define(fn = nil, &block)
-        mixin = Module.new do
-          def initialize(*args)
-            __initialize__(*args)
-          end
-        end
-
-        builder = Builder.new
-        builder.instance_exec(&(fn || block))
-        builder.call(mixin)
-        mixin
-      end
-
-      def mixin(fn = nil, &block)
-        define(fn, &block)
-      end
-    end
+    extend Dry::Initializer::DSL
 
     def param(*args)
       __initializer_builder__.param(*args).call(__initializer_mixin__)
@@ -66,8 +38,8 @@ module Dry
       end
     end
 
-    def __initializer_builder__
-      @__initializer_builder__ ||= Dry::Initializer::Builder.new
+    def __initializer_builder__(**settings)
+      @__initializer_builder__ ||= Dry::Initializer::Builder.new(settings)
     end
 
     def inherited(klass)

data/lib/dry/initializer/attribute.rb

@@ -40,12 +40,13 @@ module Dry::Initializer
     attr_reader :source, :target, :coercer, :default, :optional, :reader
 
     def initialize(options)
-      @source   = options[:source]
-      @target   = options[:target]
-      @coercer  = options[:type]
-      @default  = options[:default]
-      @optional = !!(options[:optional] || @default)
-      @reader   = options.fetch(:reader, :public)
+      @source    = options[:source]
+      @target    = options[:target]
+      @coercer   = options[:type]
+      @default   = options[:default]
+      @optional  = !!(options[:optional] || @default)
+      @reader    = options.fetch(:reader, :public)
+      @undefined = options.fetch(:undefined, true)
       validate
     end
 
@@ -58,12 +59,12 @@ module Dry::Initializer
       return unless reader
       command = %w(private protected).include?(reader.to_s) ? reader : :public
 
-      <<-RUBY.gsub(/^ *\|/, "")
-        |undef_method :#{target} if method_defined?(:#{target}) || protected_method_defined?(:#{target}) || private_method_defined?(:#{target})
-        |def #{target}
-        |  @#{target} unless @#{target} == Dry::Initializer::UNDEFINED
-        |end
-        |#{command} :#{target}
+      <<-RUBY
+        undef_method :#{target} if method_defined?(:#{target}) ||
+                                   protected_method_defined?(:#{target}) ||
+                                   private_method_defined?(:#{target})
+        #{reader_definition}
+        #{command} :#{target}
       RUBY
     end
 
@@ -75,6 +76,18 @@ module Dry::Initializer
       validate_coercer
     end
 
+    def undefined
+      @undefined ? "Dry::Initializer::UNDEFINED" : "nil"
+    end
+
+    def reader_definition
+      if @undefined
+        "def #{target}; @#{target} unless @#{target} == #{undefined}; end"
+      else
+        "attr_reader :#{target}"
+      end
+    end
+
     def validate_target
       return if target =~ /\A\w+\Z/
       fail ArgumentError.new("Invalid name '#{target}' for the target variable")
@@ -96,7 +109,10 @@ module Dry::Initializer
 
     def coercer_hash(type)
       return {} unless coercer
-      value = proc { |v| v == Dry::Initializer::UNDEFINED ? v : coercer.(v) }
+
+      value = coercer unless @undefined
+      value ||= proc { |v| v == Dry::Initializer::UNDEFINED ? v : coercer.(v) }
+
       { :"#{type}_#{source}" => value }
     end
   end

data/lib/dry/initializer/builder.rb

@@ -1,12 +1,12 @@
 module Dry::Initializer
   class Builder
-    def param(*args)
-      @params = insert(@params, Attribute.param(*args))
+    def param(*args, **opts)
+      @params = insert @params, Attribute.param(*args, **@config.merge(opts))
       validate_collections
     end
 
-    def option(*args)
-      @options = insert(@options, Attribute.option(*args))
+    def option(*args, **opts)
+      @options = insert @options, Attribute.option(*args, **@config.merge(opts))
       validate_collections
     end
 
@@ -20,12 +20,13 @@ module Dry::Initializer
 
       mixin.send(:define_method, :__defaults__) { defaults }
       mixin.send(:define_method, :__coercers__) { coercers }
-      mixin.class_eval(code, __FILE__, __LINE__ + 1)
+      mixin.class_eval(code)
     end
 
     private
 
-    def initialize
+    def initialize(**config)
+      @config  = config
       @params  = []
       @options = []
     end
@@ -40,18 +41,18 @@ module Dry::Initializer
     end
 
     def code
-      <<-RUBY.gsub(/^ +\|/, "")
-        |def __initialize__(#{initializer_signatures})
-        |  @__options__ = {}
-        |#{initializer_presetters}
-        |#{initializer_setters}
-        |#{initializer_postsetters}
-        |end
-        |private :__initialize__
-        |private :__defaults__
-        |private :__coercers__
-        |
-        |#{getters}
+      <<-RUBY
+        def __initialize__(#{initializer_signatures})
+          @__options__ = {}
+        #{initializer_presetters}
+        #{initializer_setters}
+        #{initializer_postsetters}
+        end
+        private :__initialize__
+        private :__defaults__
+        private :__coercers__
+        
+        #{getters}
       RUBY
     end
 

data/lib/dry/initializer/dsl.rb

@@ -0,0 +1,44 @@
+module Dry::Initializer
+  module DSL
+    attr_reader :config
+
+    def [](**settings)
+      Module.new do
+        extend  Dry::Initializer::DSL
+        include Dry::Initializer
+        @config = settings
+      end
+    end
+
+    def define(fn = nil, &block)
+      mixin = Module.new do
+        def initialize(*args)
+          __initialize__(*args)
+        end
+      end
+
+      builder = Builder.new Hash(config)
+      builder.instance_exec(&(fn || block))
+      builder.call(mixin)
+      mixin
+    end
+
+    private
+
+    def extended(klass)
+      super
+      mixin   = klass.send(:__initializer_mixin__)
+      builder = klass.send(:__initializer_builder__, Hash(config))
+
+      builder.call(mixin)
+      klass.include(mixin)
+      klass.send(:define_method, :initialize) do |*args|
+        __initialize__(*args)
+      end
+    end
+
+    def mixin(fn = nil, &block)
+      define(fn, &block)
+    end
+  end
+end

data/lib/dry/initializer/option.rb

@@ -7,7 +7,7 @@ module Dry::Initializer
 
     # parts of __initalizer__
     def presetter
-      "@#{target} = Dry::Initializer::UNDEFINED" if dispensable?
+      "@#{target} = #{undefined}" if dispensable? && @undefined
     end
 
     def safe_setter
@@ -16,13 +16,14 @@ module Dry::Initializer
 
     def fast_setter
       return safe_setter unless dispensable?
-      "@#{target} = __options__.key?(:'#{source}') ? #{safe_coerced} : " \
-      "Dry::Initializer::UNDEFINED"
+      "@#{target} = __options__.key?(:'#{source}')" \
+                  " ? #{safe_coerced}" \
+                  " : #{undefined}"
     end
 
     def postsetter
       "@__options__[:#{target}] = @#{target}" \
-      " unless @#{target} == Dry::Initializer::UNDEFINED"
+      " unless @#{target} == #{undefined}"
     end
 
     # part of __defaults__

data/lib/dry/initializer/param.rb

@@ -2,7 +2,7 @@ module Dry::Initializer
   class Param < Attribute
     # part of __initializer__ definition
     def initializer_signature
-      optional ? "#{target} = Dry::Initializer::UNDEFINED" : target
+      optional ? "#{target} = #{undefined}" : target
     end
 
     # parts of __initalizer__
@@ -46,7 +46,7 @@ module Dry::Initializer
 
     def default_part
       return unless default
-      " == Dry::Initializer::UNDEFINED ?" \
+      " == #{undefined} ?" \
       " instance_exec(&__defaults__[:param_#{target}]) :" \
       " #{target}"
     end

data/spec/definition_spec.rb

@@ -0,0 +1,84 @@
+describe "definition" do
+  shared_examples :initializer do |in_context|
+    subject { Test::Foo.new(1, bar: 2) }
+
+    it "sets variables when defined by #{in_context}" do
+      expect(subject.instance_variable_get(:@foo)).to eql 1
+      expect(subject.instance_variable_get(:@bar)).to eql 2
+    end
+  end
+
+  it_behaves_like :initializer, "extending Dry::Initializer" do
+    before do
+      class Test::Foo
+        extend Dry::Initializer
+        param  :foo
+        option :bar
+      end
+    end
+  end
+
+  it_behaves_like :initializer, "extending Dry::Initializer::Mixin" do
+    before do
+      class Test::Foo
+        extend Dry::Initializer::Mixin
+        param  :foo
+        option :bar
+      end
+    end
+  end
+
+  it_behaves_like :initializer, "extending Dry::Initializer[undefined: false]" do
+    before do
+      class Test::Foo
+        extend Dry::Initializer[undefined: false]
+        param  :foo
+        option :bar
+      end
+    end
+  end
+
+  it_behaves_like :initializer, "including Dry::Initializer with block" do
+    before do
+      class Test::Foo
+        include Dry::Initializer.define {
+          param  :foo
+          option :bar
+        }
+      end
+    end
+  end
+
+  it_behaves_like :initializer, "including Dry::Initializer with lambda" do
+    before do
+      class Test::Foo
+        include Dry::Initializer.define -> do
+          param  :foo
+          option :bar
+        end
+      end
+    end
+  end
+
+  it_behaves_like :initializer, "including Dry::Initializer[undefined: false]" do
+    before do
+      class Test::Foo
+        include Dry::Initializer[undefined: false].define {
+          param  :foo
+          option :bar
+        }
+      end
+    end
+  end
+
+  it_behaves_like :initializer, "including Dry::Initializer::Mixin" do
+    before do
+      class Test::Foo
+        include Dry::Initializer::Mixin.define {
+          param  :foo
+          option :bar
+        }
+      end
+    end
+  end
+end

data/spec/optional_spec.rb

@@ -29,6 +29,23 @@ describe "optional value" do
     end
   end
 
+  context "with undefined: false" do
+    before do
+      class Test::Foo
+        extend Dry::Initializer[undefined: false]
+
+        param :foo
+        param :bar, optional: true
+      end
+    end
+
+    it "sets undefined values to nil" do
+      subject = Test::Foo.new(1)
+
+      expect(subject.instance_variable_get(:@bar)).to be_nil
+    end
+  end
+
   context "when has a default value" do
     before do
       class Test::Foo

data/spec/value_coercion_via_dry_types_spec.rb

@@ -9,13 +9,21 @@ describe "value coercion via dry-types" do
     class Test::Foo
       extend Dry::Initializer::Mixin
 
-      param :foo, type: Test::Types::Coercible::String
+      param  :foo, type: Test::Types::Coercible::String
+      option :bar, proc(&:to_i), default: proc { "16" }
     end
   end
 
-  subject { Test::Foo.new :foo }
+  it "coerces assigned values" do
+    subject = Test::Foo.new :foo, bar: "13"
 
-  it "coerces values" do
     expect(subject.foo).to eql "foo"
+    expect(subject.bar).to eql 13
+  end
+
+  it "coerces defaults as well" do
+    subject = Test::Foo.new :foo
+
+    expect(subject.bar).to eql 16
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-initializer
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Vladimir Kochnev (marshall-lee)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-05 00:00:00.000000000 Z
+date: 2017-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -102,17 +102,16 @@ files:
 - lib/dry/initializer.rb
 - lib/dry/initializer/attribute.rb
 - lib/dry/initializer/builder.rb
+- lib/dry/initializer/dsl.rb
 - lib/dry/initializer/exceptions/default_value_error.rb
 - lib/dry/initializer/exceptions/params_order_error.rb
 - lib/dry/initializer/exceptions/type_constraint_error.rb
 - lib/dry/initializer/option.rb
 - lib/dry/initializer/param.rb
-- spec/base_spec.rb
-- spec/container_spec.rb
 - spec/custom_initializer_spec.rb
-- spec/default_nil_spec.rb
 - spec/default_values_spec.rb
-- spec/enhancement_spec.rb
+- spec/definition_spec.rb
+- spec/gem_enhancement_spec.rb
 - spec/invalid_default_spec.rb
 - spec/missed_default_spec.rb
 - spec/optional_spec.rb
@@ -151,12 +150,10 @@ signing_key:
 specification_version: 4
 summary: DSL for declaring params and options of the initializer
 test_files:
-- spec/base_spec.rb
-- spec/container_spec.rb
 - spec/custom_initializer_spec.rb
-- spec/default_nil_spec.rb
 - spec/default_values_spec.rb
-- spec/enhancement_spec.rb
+- spec/definition_spec.rb
+- spec/gem_enhancement_spec.rb
 - spec/invalid_default_spec.rb
 - spec/missed_default_spec.rb
 - spec/optional_spec.rb

data/spec/base_spec.rb

@@ -1,21 +0,0 @@
-describe "base example" do
-  before do
-    class Test::Foo
-      extend Dry::Initializer::Mixin
-
-      param  :foo
-      param  :bar
-      option :baz
-      option :qux
-    end
-  end
-
-  it "instantiates attributes" do
-    subject = Test::Foo.new(1, 2, baz: 3, qux: 4)
-
-    expect(subject.foo).to eql 1
-    expect(subject.bar).to eql 2
-    expect(subject.baz).to eql 3
-    expect(subject.qux).to eql 4
-  end
-end

data/spec/container_spec.rb

@@ -1,45 +0,0 @@
-describe "container" do
-  context "with block syntax" do
-    before do
-      class Test::Foo
-        include Dry::Initializer.define {
-          param  :foo
-          param  :bar
-          option :baz
-          option :qux
-        }
-      end
-    end
-
-    it "instantiates attributes" do
-      subject = Test::Foo.new(1, 2, baz: 3, qux: 4)
-
-      expect(subject.foo).to eql 1
-      expect(subject.bar).to eql 2
-      expect(subject.baz).to eql 3
-      expect(subject.qux).to eql 4
-    end
-  end
-
-  context "with lambda syntax" do
-    before do
-      class Test::Foo
-        include Dry::Initializer.define -> do
-          param  :foo
-          param  :bar
-          option :baz
-          option :qux
-        end
-      end
-    end
-
-    it "instantiates attributes" do
-      subject = Test::Foo.new(1, 2, baz: 3, qux: 4)
-
-      expect(subject.foo).to eql 1
-      expect(subject.bar).to eql 2
-      expect(subject.baz).to eql 3
-      expect(subject.qux).to eql 4
-    end
-  end
-end

data/spec/default_nil_spec.rb

@@ -1,17 +0,0 @@
-describe "default nil" do
-  before do
-    class Test::Foo
-      extend Dry::Initializer::Mixin
-
-      param :foo, default: proc { nil }
-      param :bar, default: -> { nil }
-    end
-  end
-
-  it "is assigned" do
-    subject = Test::Foo.new(1)
-
-    expect(subject.foo).to eql 1
-    expect(subject.bar).to be_nil
-  end
-end