dry-initializer 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0de7dd513351b39d831351662ec6268ebf1920a9
-  data.tar.gz: 1435433ffc6eabba75f481e302ea4b7dcc47d37b
+  metadata.gz: dc5b54635b8cfc7c85c33e0aac287c54919cb3de
+  data.tar.gz: dde1379e2f5f9f86ad1de906e8402a326a850c70
 SHA512:
-  metadata.gz: 7ed882e91dfeed3a4dcc8ade69792beca84334d9850e700de67462cead64434fdfeed5039d188b42799b204d1cb871394e0c9c0e8a7c26ba5d02d6a2c72c08d3
-  data.tar.gz: a477d334fd746c41d09bfc49bdde5af80f4aa22176996518092853bf3a660f3fa4f77f30a84f495d04f54f1592b95d077a3f17473dbd759bf7e310c9ef0396bd
+  metadata.gz: 512704ff1885b0c9bbb147020b950e97e70eacd4405548cad5478b728eee2861c47e58f19ff4603c21edf08965372820386645fb451e3c93edfdb61f3185d3e2
+  data.tar.gz: 7090b29b8c66d79c1b7c9f9ccb4019ec9ccc9ae07126a9c2b670eb4f6a0f6b4b669f450dd701514e24cab465a9d760b81443db5959d38834c4cec327ad9ec336

data/CHANGELOG.md

@@ -1,3 +1,53 @@
+## v0.8.0 2016-11-05
+
+In this version we switched from key arguments to ** to support special keys:
+
+    option :end
+    option :begin
+
+In previous versions this was translated to
+
+    def initialize(end:, begin:)
+      @end   = end   # BOOM! SyntaxError!
+      @begin = begin # Potential BOOM (unreached)
+    end
+
+Now the assignment is imlemented like this:
+
+    def initialize(**__options__)
+      @end   = __options__.fetch(:end)
+      @begin = __options__.fetch(:begin)
+    end
+
+As a side effect of the change the initializer becomes tolerant
+to any unknown option if, and only if some `option` was set explicitly.
+
+Methods `tolerant_to_unknown_options` and `intolerant_to_unknown_options`
+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)
+
+### Internals
+
+* switched from key arguments to serialized hash argument in the initializer (@nepalez)
+
+### Breaking Changes
+
+* the initializer becomes tolerant to unknown options when any `option` was set,
+  ignoring `intolerant_to_unknown_options` helper.
+
+* the initializer becomes intolerant to options when no `option` was set,
+  ignoring `tolerant_to_unknown_options` helper.
+
+### Deprecated
+
+* `tolerant_to_unknown_options`
+* `intolerant_to_unknown_options`
+
+[Compare v0.7.0...v0.8.0](https://github.com/dry-rb/dry-initializer/compare/v0.7.0..v0.8.0)
+
 ## v0.7.0 2016-10-11
 
 ### Added

data/README.md

@@ -43,15 +43,17 @@ $ gem install dry-initializer
 
 ```ruby
 require 'dry-initializer'
+require 'dry-types'
 
 class User
   extend Dry::Initializer::Mixin
 
   # Params of the initializer along with corresponding readers
-  param  :name
+  param  :name,  type: Dry::Types["strict.string"]
   param  :role,  default: proc { 'customer' }
   # Options of the initializer along with corresponding readers
   option :admin, default: proc { false }
+  option :vip,   optional: true
 end
 
 # Defines the initializer with params and options
@@ -61,6 +63,7 @@ user = User.new 'Vladimir', 'admin', admin: true
 user.name  # => 'Vladimir'
 user.role  # => 'admin'
 user.admin # => true
+user.vip   # => Dry::Initializer::UNDEFINED
 ```
 
 See full documentation on the [Dry project official site][docs]

data/dry-initializer.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "dry-initializer"
-  gem.version  = "0.7.0"
+  gem.version  = "0.8.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/builder.rb

@@ -25,22 +25,6 @@ module Dry::Initializer
       copy { @plugins = plugins }
     end
 
-    # Makes builder to provide options-tolerant initializer
-    #
-    # @return [Dry::Initializer::Builder]
-    #
-    def tolerant_to_unknown_options
-      copy { @tolerant = "**" }
-    end
-
-    # Makes builder to provide options-intolerant initializer
-    #
-    # @return [Dry::Initializer::Builder]
-    #
-    def intolerant_to_unknown_options
-      copy { @tolerant = nil }
-    end
-
     # Defines new agrument and reloads mixin definitions
     #
     # @param [#to_sym] name

data/lib/dry/initializer/mixin.rb

@@ -57,8 +57,13 @@ module Dry::Initializer
     # @return [self] itself
     #
     def tolerant_to_unknown_options
-      @initializer_builder = initializer_builder.tolerant_to_unknown_options
-      initializer_builder.call(self)
+      warn <<-MESSAGE.gsub(/ +\|/, "")
+        |[DEPRECATION] Helper method `tolerant_to_unknown_options` was deprecated,
+        |and will be removed in v0.9.0.
+        |If any `option` was defined, the initializer becomes tolerant to all the others.
+        |This is necessary to support "special" names in options like `option :end`.
+        |It forbids options only when no one was declared explicitly.
+      MESSAGE
     end
 
     # Makes initializer intolerant to unknown options
@@ -66,8 +71,13 @@ module Dry::Initializer
     # @return [self] itself
     #
     def intolerant_to_unknown_options
-      @initializer_builder = initializer_builder.intolerant_to_unknown_options
-      initializer_builder.call(self)
+      warn <<-MESSAGE.gsub(/ +\|/, "")
+        |[DEPRECATION] Helper method `intolerant_to_unknown_options` was deprecated.
+        |and will be removed in v0.9.0.
+        |If any `option` was defined, the initializer becomes tolerant to all the others.
+        |This is necessary to support "special" names in options like `option :end`.
+        |It forbids options only when no one was declared explicitly.
+      MESSAGE
     end
 
     private

data/lib/dry/initializer/plugins/signature.rb

@@ -2,38 +2,28 @@ module Dry::Initializer::Plugins
   # Plugin builds a chunk of code for the initializer's signature:
   #
   # @example
-  #   Signature.call(:user, option: true)
-  #   # => "user:"
+  #   Signature.call(:user)
+  #   # => "user"
   #
   #   Signature.call(:user, default: -> { nil })
   #   # => "user = Dry::Initializer::UNDEFINED"
   #
+  #   Signature.call(:user, option: true)
+  #   # => "**__options__"
+  #
   class Signature < Base
     def param?
       settings[:option] != true
     end
 
-    def default?
-      settings.key? :default
-    end
-
-    def optional?
-      default? || settings.key?(:optional)
+    def required?
+      !settings.key?(:default) && !settings[:optional]
     end
 
     def call
-      case [param?, optional?]
-      when [true, false]  then name.to_s
-      when [false, false] then "#{name}:"
-      when [true, true]   then "#{name} = #{undefined}"
-      when [false, true]  then "#{name}: #{undefined}"
-      end
-    end
-
-    private
-
-    def undefined
-      @undefined ||= "Dry::Initializer::UNDEFINED"
+      return "**__options__" unless param?
+      return name.to_s if required?
+      "#{name} = Dry::Initializer::UNDEFINED"
     end
   end
 end

data/lib/dry/initializer/plugins/variable_setter.rb

@@ -2,11 +2,28 @@ module Dry::Initializer::Plugins
   # Plugin builds a code for variable setter:
   #
   # @example
-  #   VariableSetter.call(:user, {}) # => "@user = user"
+  #   VariableSetter.call(:user, option: false)
+  #   # => "@user = user"
+  #
+  #   VariableSetter.call(:user, option: true)
+  #   # => "@user = __options__.fetch(:user)"
+  #
+  #   VariableSetter.call(:user, option: true, optional: true)
+  #   # => "@user = __options__.fetch(:user, Dry::Initializer::UNDEFINED)"
   #
   class VariableSetter < Base
+    def param?
+      settings[:option] != true
+    end
+
+    def required?
+      !settings.key?(:default) && !settings[:optional]
+    end
+
     def call
-      "@#{name} = #{name}"
+      return "@#{name} = #{name}" if param?
+      return "@#{name} = __options__.fetch(:#{name})" if required?
+      "@#{name} = __options__.fetch(:#{name}, Dry::Initializer::UNDEFINED)"
     end
   end
 end

data/lib/dry/initializer/signature.rb

@@ -25,7 +25,7 @@ module Dry::Initializer
     end
 
     def call
-      map(&:call).join(", ")
+      map(&:call).compact.uniq.join(", ")
     end
 
     private
@@ -43,8 +43,8 @@ module Dry::Initializer
     end
 
     def validates_order_of(signature)
-      return unless signature.param? && !signature.optional?
-      return unless any? { |item| item.param? && item.optional? }
+      return unless signature.param? && signature.required?
+      return unless any? { |item| item.param? && !item.required? }
 
       fail OrderError.new(signature.name)
     end

data/spec/options_tolerance_spec.rb

@@ -0,0 +1,20 @@
+describe "options tolerance" do
+  before do
+    class Test::Foo
+      extend Dry::Initializer::Mixin
+      option :foo
+    end
+
+    class Test::Bar
+      extend Dry::Initializer::Mixin
+    end
+  end
+
+  it "allows unknown options when someone defined" do
+    expect { Test::Foo.new foo: :bar, bar: :baz }.not_to raise_error
+  end
+
+  it "forbids options when no one defined" do
+    expect { Test::Bar.new bar: :baz }.to raise_error(ArgumentError)
+  end
+end

data/spec/shared_definitions_spec.rb

@@ -0,0 +1,35 @@
+describe "shared definition" do
+  subject do
+    class Test::Foo
+      extend Dry::Initializer::Mixin
+
+      using default: proc { nil } do
+        param  :foo
+        option :end
+        option :baz, default: proc { 0 }
+      end
+
+      using optional: true do
+        option :qux
+        option :quxx, optional: false
+      end
+    end
+  end
+
+  it "is applied to params and options" do
+    instance = subject.new(quxx: 1)
+
+    expect(instance.foo).to be_nil
+    expect(instance.end).to be_nil
+  end
+
+  it "can be reloaded" do
+    instance = subject.new(quxx: 1)
+
+    expect(instance.baz).to eq 0
+  end
+
+  it "can reload :optional setting" do
+    expect { subject.new }.to raise_error(KeyError, /quxx/)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-initializer
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Vladimir Kochnev (marshall-lee)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-11 00:00:00.000000000 Z
+date: 2016-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -121,22 +121,22 @@ files:
 - lib/dry/initializer/plugins/variable_setter.rb
 - lib/dry/initializer/scope.rb
 - lib/dry/initializer/signature.rb
-- spec/dry/base_spec.rb
-- spec/dry/container_spec.rb
-- spec/dry/default_nil_spec.rb
-- spec/dry/default_values_spec.rb
-- spec/dry/invalid_default_spec.rb
-- spec/dry/missed_default_spec.rb
-- spec/dry/optional_spec.rb
-- spec/dry/options_tolerance_spec.rb
-- spec/dry/plugin_registry_spec.rb
-- spec/dry/reader_spec.rb
-- spec/dry/repetitive_definitions_spec.rb
-- spec/dry/shared_definitions_spec.rb
-- spec/dry/subclassing_spec.rb
-- spec/dry/type_constraint_spec.rb
-- spec/dry/value_coercion_via_dry_types_spec.rb
+- spec/base_spec.rb
+- spec/container_spec.rb
+- spec/default_nil_spec.rb
+- spec/default_values_spec.rb
+- spec/invalid_default_spec.rb
+- spec/missed_default_spec.rb
+- spec/optional_spec.rb
+- spec/options_tolerance_spec.rb
+- spec/plugin_registry_spec.rb
+- spec/reader_spec.rb
+- spec/repetitive_definitions_spec.rb
+- spec/shared_definitions_spec.rb
 - spec/spec_helper.rb
+- spec/subclassing_spec.rb
+- spec/type_constraint_spec.rb
+- spec/value_coercion_via_dry_types_spec.rb
 homepage: https://github.com/dryrb/dry-initializer
 licenses:
 - MIT
@@ -162,19 +162,19 @@ signing_key:
 specification_version: 4
 summary: DSL for declaring params and options of the initializer
 test_files:
-- spec/dry/base_spec.rb
-- spec/dry/container_spec.rb
-- spec/dry/default_nil_spec.rb
-- spec/dry/default_values_spec.rb
-- spec/dry/invalid_default_spec.rb
-- spec/dry/missed_default_spec.rb
-- spec/dry/optional_spec.rb
-- spec/dry/options_tolerance_spec.rb
-- spec/dry/plugin_registry_spec.rb
-- spec/dry/reader_spec.rb
-- spec/dry/repetitive_definitions_spec.rb
-- spec/dry/shared_definitions_spec.rb
-- spec/dry/subclassing_spec.rb
-- spec/dry/type_constraint_spec.rb
-- spec/dry/value_coercion_via_dry_types_spec.rb
+- spec/base_spec.rb
+- spec/container_spec.rb
+- spec/default_nil_spec.rb
+- spec/default_values_spec.rb
+- spec/invalid_default_spec.rb
+- spec/missed_default_spec.rb
+- spec/optional_spec.rb
+- spec/options_tolerance_spec.rb
+- spec/plugin_registry_spec.rb
+- spec/reader_spec.rb
+- spec/repetitive_definitions_spec.rb
+- spec/shared_definitions_spec.rb
 - spec/spec_helper.rb
+- spec/subclassing_spec.rb
+- spec/type_constraint_spec.rb
+- spec/value_coercion_via_dry_types_spec.rb

data/spec/dry/options_tolerance_spec.rb

@@ -1,27 +0,0 @@
-describe "options tolerance" do
-  before do
-    class Test::Foo
-      extend Dry::Initializer::Mixin
-    end
-
-    class Test::Bar < Test::Foo
-      tolerant_to_unknown_options
-    end
-
-    class Test::Baz < Test::Bar
-      intolerant_to_unknown_options
-    end
-  end
-
-  it "is strict by default" do
-    expect { Test::Foo.new foo: :bar }.to raise_error(ArgumentError)
-  end
-
-  it "allows unknown options when switched on" do
-    expect { Test::Bar.new foo: :bar }.not_to raise_error
-  end
-
-  it "can be switched off" do
-    expect { Test::Baz.new foo: :bar }.to raise_error(ArgumentError)
-  end
-end

data/spec/dry/shared_definitions_spec.rb

@@ -1,22 +0,0 @@
-describe "shared definition" do
-  subject do
-    class Test::Foo
-      extend Dry::Initializer::Mixin
-
-      using default: proc { nil } do
-        param  :foo
-        option :bar
-        option :baz, default: proc { 0 }
-      end
-    end
-  end
-
-  it "is applied to params and options" do
-    expect(subject.new.foo).to be_nil
-    expect(subject.new.bar).to be_nil
-  end
-
-  it "can be reloaded" do
-    expect(subject.new.baz).to eq 0
-  end
-end