dry-initializer 0.11.0 → 1.1.0

data/spec/type_constraint_spec.rb

@@ -5,7 +5,7 @@ describe "type constraint" do
     before do
       class Test::Foo
         extend Dry::Initializer::Mixin
-        param :foo, type: Dry::Types["strict.string"], optional: true
+        param :foo, Dry::Types["strict.string"], optional: true
       end
     end
 
@@ -28,20 +28,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
           param :foo, type: String
         end
-      }.to raise_error(TypeError)
+      end.to raise_error(TypeError)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-initializer
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.1.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: 2017-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -91,6 +91,7 @@ files:
 - benchmarks/options.rb
 - benchmarks/params.rb
 - benchmarks/params_vs_options.rb
+- benchmarks/profiler.rb
 - benchmarks/several_defaults.rb
 - benchmarks/with_defaults.rb
 - benchmarks/with_types.rb
@@ -99,34 +100,27 @@ files:
 - dry-initializer.gemspec
 - lib/dry-initializer.rb
 - lib/dry/initializer.rb
+- lib/dry/initializer/attribute.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/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
+- 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/invalid_default_spec.rb
 - spec/missed_default_spec.rb
 - spec/optional_spec.rb
 - spec/options_tolerance_spec.rb
-- spec/plugin_registry_spec.rb
+- spec/options_var_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
@@ -162,14 +156,15 @@ test_files:
 - spec/custom_initializer_spec.rb
 - spec/default_nil_spec.rb
 - spec/default_values_spec.rb
+- spec/enhancement_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/options_var_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/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/mixin.rb

@@ -1,77 +0,0 @@
-module Dry::Initializer
-  # Class-level DSL for the initializer
-  module Mixin
-    # Declares a plain argument
-    #
-    # @param [#to_sym] name
-    #
-    # @option options [Object]  :default The default value
-    # @option options [#call]   :type    The type constraings via `dry-types`
-    # @option options [Boolean] :reader (true) Whether to define attr_reader
-    #
-    # @return [self] itself
-    #
-    def param(name, type = nil, **options)
-      options[:type]   = type if type
-      options[:option] = false
-      @__initializer_builder__ = __initializer_builder__.define(name, **options)
-      __initializer_builder__.call(__initializer_mixin__)
-    end
-
-    # Declares a named argument
-    #
-    # @param  (see #param)
-    # @option (see #param)
-    # @return (see #param)
-    #
-    def option(name, type = nil, **options)
-      options[:type]   = type if type
-      options[:option] = true
-      @__initializer_builder__ = __initializer_builder__.define(name, **options)
-      __initializer_builder__.call(__initializer_mixin__)
-    end
-
-    # Adds new plugin to the builder
-    #
-    # @param  [Dry::Initializer::Plugins::Base] plugin
-    # @return [self] itself
-    #
-    def register_initializer_plugin(plugin)
-      @__initializer_builder__ = __initializer_builder__.register(plugin)
-      __initializer_builder__.call(__initializer_mixin__)
-    end
-
-    private
-
-    def __initializer_mixin__
-      @__initializer_mixin__ ||= Module.new do
-        def initialize(*args)
-          __initialize__(*args)
-        end
-      end
-    end
-
-    def __initializer_builder__
-      @__initializer_builder__ ||= Builder.new
-    end
-
-    def inherited(klass)
-      new_builder = __initializer_builder__.dup
-      klass.instance_variable_set :@__initializer_builder__, new_builder
-
-      new_mixin = Module.new
-      new_builder.call(new_mixin)
-      klass.instance_variable_set :@__initializer_mixin__, new_mixin
-      klass.include new_mixin
-
-      super
-    end
-
-    def self.extended(klass)
-      super
-      mixin = klass.send(:__initializer_mixin__)
-      klass.send(:__initializer_builder__).call(mixin)
-      klass.include mixin
-    end
-  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

data/lib/dry/initializer/signature.rb

@@ -1,61 +0,0 @@
-module Dry::Initializer
-  # Immutable container for chunks of code describing argument signatures.
-  # Responcible for building the resulting signature for the initializer args.
-  class Signature
-    include Enumerable
-    include Errors
-
-    def initialize(*list)
-      @list = list
-    end
-
-    def add(*args)
-      signature = Plugins::Signature.new(*args)
-
-      validate_order_of signature
-      validate_param_uniqueness_of signature
-      validate_option_uniqueness_of signature
-      validate_attribute_uniqueness_of signature
-
-      self.class.new(*@list, signature)
-    end
-
-    def each
-      @list.each { |item| yield item }
-    end
-
-    def call
-      options = all?(&:param?) ? %w(__options__={}) : %w(**__options__)
-      (select(&:param?).map(&:call) + options).compact.join(", ")
-    end
-
-    private
-
-    def validate_param_uniqueness_of(signature)
-      return unless signature.param?
-      return unless select(&:param?).map(&:name).include? signature.name
-
-      fail RedefinitionError.new(signature.name)
-    end
-
-    def validate_option_uniqueness_of(signature)
-      return if signature.param?
-      return unless reject(&:param?).map(&:name).include? signature.name
-
-      fail RedefinitionError.new(signature.name)
-    end
-
-    def validate_attribute_uniqueness_of(signature)
-      return unless map(&:rename).include? signature.rename
-
-      fail RedefinitionError.new(signature.name)
-    end
-
-    def validate_order_of(signature)
-      return unless signature.required? && signature.param?
-      return unless reject(&:required?).any?(&:param?)
-
-      fail OrderError.new(signature.name)
-    end
-  end
-end