dry-initializer 0.11.0 → 2.5.0

data/spec/type_constraint_spec.rb

@@ -1,11 +1,41 @@
 require "dry-types"
 
 describe "type constraint" do
+  context "by a proc with 1 argument" do
+    before do
+      class Test::Foo
+        extend Dry::Initializer
+        param :foo, proc(&:to_s), optional: true
+      end
+    end
+
+    subject { Test::Foo.new :foo }
+
+    it "coerces a value" do
+      expect(subject.foo).to eq "foo"
+    end
+  end
+
+  context "by a proc with 2 arguments" do
+    before do
+      class Test::Foo
+        extend Dry::Initializer
+        param :foo, proc { |val, obj| "#{obj.hash}:#{val}" }, optional: true
+      end
+    end
+
+    subject { Test::Foo.new :foo }
+
+    it "coerces a value with self as a second argument" do
+      expect(subject.foo).to eq "#{subject.hash}:foo"
+    end
+  end
+
   context "by dry-type" do
     before do
       class Test::Foo
-        extend Dry::Initializer::Mixin
-        param :foo, type: Dry::Types["strict.string"], optional: true
+        extend Dry::Initializer
+        param :foo, Dry::Types["strict.string"], optional: true
       end
     end
 
@@ -28,20 +58,21 @@ describe "type constraint" do
     context "if optional value not set" do
       subject { Test::Foo.new }
 
-      it "completes the initialization" do
-        expect { subject }.not_to raise_error
+      it "not applicable to Dry::Initializer::UNDEFINED" do
+        expect(subject.instance_variable_get(:@foo))
+          .to eq Dry::Initializer::UNDEFINED
       end
     end
   end
 
   context "by invalid constraint" do
     it "raises TypeError" do
-      expect {
+      expect do
         class Test::Foo
-          extend Dry::Initializer::Mixin
+          extend Dry::Initializer
           param :foo, type: String
         end
-      }.to raise_error(TypeError)
+      end.to raise_error(TypeError)
     end
   end
 end

data/spec/value_coercion_via_dry_types_spec.rb

@@ -7,15 +7,23 @@ describe "value coercion via dry-types" do
     end
 
     class Test::Foo
-      extend Dry::Initializer::Mixin
+      extend Dry::Initializer
 
-      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: 0.11.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Vladimir Kochnev (marshall-lee)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-02 00:00:00.000000000 Z
+date: 2018-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -59,18 +59,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.42'
+        version: 0.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.42'
+        version: 0.49.0
 description: 
-email:
-- hashtable@yandex.ru
-- andrew.kozin@gmail.com
+email: andrew.kozin@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -88,45 +86,43 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- benchmarks/options.rb
-- benchmarks/params.rb
-- benchmarks/params_vs_options.rb
-- benchmarks/several_defaults.rb
+- benchmarks/compare_several_defaults.rb
+- benchmarks/plain_options.rb
+- benchmarks/plain_params.rb
+- benchmarks/with_coercion.rb
 - benchmarks/with_defaults.rb
-- benchmarks/with_types.rb
-- benchmarks/with_types_and_defaults.rb
-- benchmarks/without_options.rb
+- benchmarks/with_defaults_and_coercion.rb
 - dry-initializer.gemspec
 - lib/dry-initializer.rb
 - lib/dry/initializer.rb
-- lib/dry/initializer/builder.rb
-- lib/dry/initializer/errors.rb
-- lib/dry/initializer/errors/default_value_error.rb
-- lib/dry/initializer/errors/order_error.rb
-- lib/dry/initializer/errors/plugin_error.rb
-- lib/dry/initializer/errors/redefinition_error.rb
-- lib/dry/initializer/errors/type_constraint_error.rb
+- lib/dry/initializer/builders.rb
+- lib/dry/initializer/builders/attribute.rb
+- lib/dry/initializer/builders/initializer.rb
+- lib/dry/initializer/builders/reader.rb
+- lib/dry/initializer/builders/signature.rb
+- lib/dry/initializer/config.rb
+- lib/dry/initializer/definition.rb
+- lib/dry/initializer/dispatchers.rb
+- lib/dry/initializer/dsl.rb
 - lib/dry/initializer/mixin.rb
-- lib/dry/initializer/plugins.rb
-- lib/dry/initializer/plugins/base.rb
-- lib/dry/initializer/plugins/default_proc.rb
-- lib/dry/initializer/plugins/signature.rb
-- lib/dry/initializer/plugins/type_constraint.rb
-- lib/dry/initializer/plugins/variable_setter.rb
-- lib/dry/initializer/signature.rb
-- spec/base_spec.rb
-- spec/container_spec.rb
+- lib/dry/initializer/mixin/local.rb
+- lib/dry/initializer/mixin/root.rb
+- lib/tasks/benchmark.rake
+- lib/tasks/profile.rake
+- spec/attributes_spec.rb
+- spec/coercion_of_nil_spec.rb
+- spec/custom_dispatchers_spec.rb
 - spec/custom_initializer_spec.rb
-- spec/default_nil_spec.rb
 - spec/default_values_spec.rb
+- spec/definition_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/public_attributes_utility_spec.rb
 - spec/reader_spec.rb
-- spec/renaming_options_spec.rb
 - spec/repetitive_definitions_spec.rb
+- spec/several_assignments_spec.rb
 - spec/spec_helper.rb
 - spec/subclassing_spec.rb
 - spec/type_argument_spec.rb
@@ -144,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -152,24 +148,25 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 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/attributes_spec.rb
+- spec/coercion_of_nil_spec.rb
+- spec/custom_dispatchers_spec.rb
 - spec/custom_initializer_spec.rb
-- spec/default_nil_spec.rb
 - spec/default_values_spec.rb
+- spec/definition_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/public_attributes_utility_spec.rb
 - spec/reader_spec.rb
-- spec/renaming_options_spec.rb
 - spec/repetitive_definitions_spec.rb
+- spec/several_assignments_spec.rb
 - spec/spec_helper.rb
 - spec/subclassing_spec.rb
 - spec/type_argument_spec.rb

data/benchmarks/options.rb

@@ -1,54 +0,0 @@
-Bundler.require(:benchmarks)
-
-require "dry-initializer"
-class NoOptsTest
-  extend Dry::Initializer::Mixin
-
-  param  :foo
-  option :bar
-end
-
-class DefaultsTest
-  extend Dry::Initializer::Mixin
-
-  param  :foo, default: proc { "FOO" }
-  option :bar, default: proc { "BAR" }
-end
-
-class TypesTest
-  extend Dry::Initializer::Mixin
-
-  param  :foo, type: String
-  option :bar, type: String
-end
-
-class DefaultsAndTypesTest
-  extend Dry::Initializer::Mixin
-
-  param  :foo, type: String, default: proc { "FOO" }
-  option :bar, type: String, default: proc { "BAR" }
-end
-
-puts "Benchmark for various options"
-
-Benchmark.ips do |x|
-  x.config time: 15, warmup: 10
-
-  x.report("no opts") do
-    NoOptsTest.new "foo", bar: "bar"
-  end
-
-  x.report("with defaults") do
-    DefaultsTest.new
-  end
-
-  x.report("with types") do
-    TypesTest.new "foo", bar: "bar"
-  end
-
-  x.report("with defaults and types") do
-    DefaultsAndTypesTest.new
-  end
-
-  x.compare!
-end

data/benchmarks/params_vs_options.rb

@@ -1,35 +0,0 @@
-Bundler.require(:benchmarks)
-
-require "dry-initializer"
-
-class ParamDefaults
-  extend Dry::Initializer::Mixin
-
-  param :foo, default: proc { "FOO" }
-  param :bar, default: proc { "BAR" }
-  param :baz, default: proc { "BAZ" }
-end
-
-class OptionDefaults
-  extend Dry::Initializer::Mixin
-
-  option :foo, default: proc { "FOO" }
-  option :bar, default: proc { "BAR" }
-  option :baz, default: proc { "BAZ" }
-end
-
-puts "Benchmark for param's vs. option's defaults"
-
-Benchmark.ips do |x|
-  x.config time: 15, warmup: 10
-
-  x.report("param's defaults") do
-    ParamDefaults.new
-  end
-
-  x.report("option's defaults") do
-    OptionDefaults.new
-  end
-
-  x.compare!
-end

data/lib/dry/initializer/builder.rb

@@ -1,100 +0,0 @@
-require "set"
-module Dry::Initializer
-  # Rebuilds the initializer every time a new argument defined
-  #
-  # @api private
-  #
-  class Builder
-    include Plugins
-
-    def initialize
-      @signature = Signature.new
-      @plugins   = Set.new [VariableSetter, TypeConstraint, DefaultProc]
-      @parts     = []
-    end
-
-    # Register new plugin to be applied as a chunk of code, or a proc
-    # to be evaluated in the instance's scope
-    #
-    # @param [Dry::Initializer::Plugin]
-    #
-    # @return [Dry::Initializer::Builder]
-    #
-    def register(plugin)
-      plugins = @plugins + [plugin]
-      copy { @plugins = plugins }
-    end
-
-    # Defines new agrument and reloads mixin definitions
-    #
-    # @param [#to_sym] name
-    # @param [Hash<Symbol, Object>] settings
-    #
-    # @return [Dry::Initializer::Builder]
-    #
-    def define(name, settings)
-      signature = @signature.add(name, settings)
-      parts     = @parts + @plugins.map { |p| p.call(name, settings) }.compact
-
-      copy do
-        @signature = signature
-        @parts     = parts
-      end
-    end
-
-    # Redeclares initializer and readers in the mixin module
-    #
-    # @param [Module] mixin
-    #
-    def call(mixin)
-      define_readers(mixin)
-      reload_initializer(mixin)
-      reload_callback(mixin)
-      mixin
-    end
-
-    private
-
-    def copy(&block)
-      dup.tap { |instance| instance.instance_eval(&block) }
-    end
-
-    def define_readers(mixin)
-      define_reader(
-        mixin,
-        :attr_reader,
-        ->(item) { item.settings[:reader] != false }
-      )
-      define_reader mixin, :private
-      define_reader mixin, :protected
-    end
-
-    def define_reader(mixin, method, filter_lambda = nil)
-      filter_lambda ||= ->(item) { item.settings[:reader] == method }
-      readers = @signature.select(&filter_lambda).map(&:rename)
-      mixin.send method, *readers if readers.any?
-    end
-
-    def reload_initializer(mixin)
-      mixin.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def __initialize__(#{@signature.call})
-          @__options__ = __options__
-          #{@parts.select { |part| String === part }.join("\n")}
-          __after_initialize__
-        end
-      RUBY
-
-      mixin.send :private, :__initialize__
-    end
-
-    def reload_callback(mixin)
-      blocks = @parts.select { |part| Proc === part }
-
-      mixin.send :define_method, :__after_initialize__ do
-        blocks.each { |block| instance_eval(&block) }
-      end
-
-      mixin.send :private, :__after_initialize__
-    end
-  end
-end

data/lib/dry/initializer/errors/default_value_error.rb

@@ -1,6 +0,0 @@
-class Dry::Initializer::Errors::DefaultValueError < TypeError
-  def initialize(name, value)
-    super "Cannot set #{value.inspect} directly as a default value" \
-          " of the argument '#{name}'. Wrap it to either proc or lambda."
-  end
-end

data/lib/dry/initializer/errors/order_error.rb

@@ -1,7 +0,0 @@
-class Dry::Initializer::Errors::OrderError < SyntaxError
-  def initialize(name)
-    super "Cannot define the required param '#{name}' after optional ones." \
-          " Either provide a default value for the '#{name}', or declare it" \
-          " before params with default values."
-  end
-end

data/lib/dry/initializer/errors/plugin_error.rb

@@ -1,6 +0,0 @@
-class Dry::Initializer::Errors::PluginError < TypeError
-  def initialize(plugin)
-    super "#{plugin} is not a valid plugin." \
-          " Use a subclass of Dry::Initialier::Plugins::Base."
-  end
-end

data/lib/dry/initializer/errors/redefinition_error.rb

@@ -1,5 +0,0 @@
-class Dry::Initializer::Errors::RedefinitionError < SyntaxError
-  def initialize(name)
-    super "The argument '#{name}' is already defined."
-  end
-end

data/lib/dry/initializer/errors/type_constraint_error.rb

@@ -1,5 +0,0 @@
-class Dry::Initializer::Errors::TypeConstraintError < TypeError
-  def initialize(name, type)
-    super "#{type} used as constraint for argument '#{name}' is not a dry-type."
-  end
-end

data/lib/dry/initializer/errors.rb

@@ -1,10 +0,0 @@
-module Dry::Initializer
-  # Collection of gem-specific exceptions
-  module Errors
-    require_relative "errors/default_value_error"
-    require_relative "errors/order_error"
-    require_relative "errors/plugin_error"
-    require_relative "errors/redefinition_error"
-    require_relative "errors/type_constraint_error"
-  end
-end

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

@@ -1,47 +0,0 @@
-module Dry::Initializer::Plugins
-  # Base class for plugins
-  #
-  # A plugin should has class method [.call] that takes argument name and
-  # settings and return a chunk of code for the #initialize method body.
-  #
-  class Base
-    include Dry::Initializer::Errors
-
-    # Builds the proc for the `__after_initializer__` callback
-    #
-    # @param [#to_s] name
-    # @param [Hash<Symbol, Object>] settings
-    #
-    # @return [String, Proc, nil]
-    #
-    def self.call(name, settings)
-      new(name, settings).call
-    end
-
-    # @private
-    attr_reader :name, :settings
-
-    # Initializes a builder with argument name and settings
-    # @param (see .call)
-    def initialize(name, settings)
-      @name     = name
-      @settings = settings
-    end
-
-    # Checks equality to another instance by name
-    # @return [Boolean]
-    def ==(other)
-      other.instance_of?(self.class) && (other.name == name)
-    end
-
-    # Builds a chunk of code
-    # @return (see .call)
-    def call; end
-
-    # Returns the name for the attribute
-    # @return (see .name)
-    def rename
-      @rename ||= settings[:option] ? (settings[:as] || name) : name
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-module Dry::Initializer::Plugins
-  # Builds a block to be evaluated by initializer (__after_initialize__)
-  # to assign a default value to the argument
-  class DefaultProc < Base
-    def call
-      return unless default
-
-      ivar = :"@#{rename}"
-      default_proc = default
-
-      proc do
-        if instance_variable_get(ivar) == Dry::Initializer::UNDEFINED
-          instance_variable_set ivar, instance_eval(&default_proc)
-        end
-      end
-    end
-
-    private
-
-    def default
-      return unless settings.key? :default
-
-      @default ||= settings[:default].tap do |value|
-        fail DefaultValueError.new(name, value) unless Proc === value
-      end
-    end
-  end
-end

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

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

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

@@ -1,21 +0,0 @@
-module Dry::Initializer::Plugins
-  # Plugin builds either chunk of code for the #initializer,
-  # or a proc for the ##__after_initialize__ callback.
-  class TypeConstraint < Base
-    def call
-      return unless settings.key? :type
-
-      type = settings[:type]
-      fail TypeConstraintError.new(rename, type) unless type.respond_to? :call
-
-      ivar = :"@#{rename}"
-      lambda do |*|
-        value = instance_variable_get(ivar)
-
-        if value != Dry::Initializer::UNDEFINED
-          instance_variable_set ivar, type.call(value)
-        end
-      end
-    end
-  end
-end

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

@@ -1,30 +0,0 @@
-module Dry::Initializer::Plugins
-  # Plugin builds a code for variable setter:
-  #
-  # @example
-  #   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
-      return "@#{name} = #{name}" if param?
-      key = ":\"#{name}\""
-      return "@#{rename} = __options__.fetch(#{key})" if required?
-      "@#{rename} = __options__.fetch(#{key}, Dry::Initializer::UNDEFINED)"
-    end
-  end
-end

data/lib/dry/initializer/plugins.rb

@@ -1,10 +0,0 @@
-module Dry::Initializer
-  # Namespace for code plugins builders
-  module Plugins
-    require_relative "plugins/base"
-    require_relative "plugins/default_proc"
-    require_relative "plugins/signature"
-    require_relative "plugins/type_constraint"
-    require_relative "plugins/variable_setter"
-  end
-end