dry-initializer 2.4.0 → 3.0.3

data/dry-initializer.gemspec

@@ -1,20 +1,20 @@
+require File.expand_path('lib/dry/initializer/version', __dir__)
+
 Gem::Specification.new do |gem|
-  gem.name     = "dry-initializer"
-  gem.version  = "2.4.0"
-  gem.author   = ["Vladimir Kochnev (marshall-lee)", "Andrew Kozin (nepalez)"]
-  gem.email    = "andrew.kozin@gmail.com"
-  gem.homepage = "https://github.com/dryrb/dry-initializer"
-  gem.summary  = "DSL for declaring params and options of the initializer"
-  gem.license  = "MIT"
+  gem.name     = 'dry-initializer'
+  gem.version  = Dry::Initializer::VERSION
+  gem.author   = ['Vladimir Kochnev (marshall-lee)', 'Andrew Kozin (nepalez)']
+  gem.email    = 'andrew.kozin@gmail.com'
+  gem.homepage = 'https://github.com/dry-rb/dry-initializer'
+  gem.summary  = 'DSL for declaring params and options of the initializer'
+  gem.license  = 'MIT'
 
   gem.files            = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.test_files       = gem.files.grep(/^spec/)
-  gem.extra_rdoc_files = Dir["README.md", "LICENSE", "CHANGELOG.md"]
+  gem.extra_rdoc_files = Dir['README.md', 'LICENSE', 'CHANGELOG.md']
 
-  gem.required_ruby_version = ">= 2.3"
+  gem.required_ruby_version = '>= 2.3'
 
-  gem.add_development_dependency "rspec", "~> 3.0"
-  gem.add_development_dependency "rake", "> 10"
-  gem.add_development_dependency "dry-types", "> 0.5.1"
-  gem.add_development_dependency "rubocop", "~> 0.42"
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rake', '> 10'
 end

data/lib/dry-initializer.rb

@@ -1 +1 @@
-require_relative "dry/initializer"
+require_relative 'dry/initializer'

data/lib/dry/initializer.rb

@@ -1,4 +1,4 @@
-require "set"
+require 'set'
 
 # Namespace for gems in a dry-rb community
 module Dry
@@ -6,15 +6,13 @@ module Dry
   # DSL for declaring params and options of class initializers
   #
   module Initializer
-    # Singleton for unassigned values
-    UNDEFINED = Object.new.freeze
-
-    require_relative "initializer/dsl"
-    require_relative "initializer/definition"
-    require_relative "initializer/builders"
-    require_relative "initializer/config"
-    require_relative "initializer/mixin"
-    require_relative "initializer/dispatchers"
+    require_relative 'initializer/undefined'
+    require_relative 'initializer/dsl'
+    require_relative 'initializer/definition'
+    require_relative 'initializer/builders'
+    require_relative 'initializer/config'
+    require_relative 'initializer/mixin'
+    require_relative 'initializer/dispatchers'
 
     # Adds methods [.[]] and [.define]
     extend DSL
@@ -27,24 +25,25 @@ module Dry
 
     # Adds or redefines a parameter of [#dry_initializer]
     # @param  [Symbol]       name
-    # @param  [#call, nil]   coercer (nil)
-    # @option opts [#call]   :type
+    # @param  [#call, nil]   type (nil)
     # @option opts [Proc]    :default
     # @option opts [Boolean] :optional
     # @option opts [Symbol]  :as
     # @option opts [true, false, :protected, :public, :private] :reader
+    # @yield block with nested definition
     # @return [self] itself
-    def param(name, type = nil, **opts)
-      dry_initializer.param(name, type, Dispatchers[opts])
+    def param(name, type = nil, **opts, &block)
+      dry_initializer.param(name, type, **opts, &block)
       self
     end
 
     # Adds or redefines an option of [#dry_initializer]
     # @param  (see #param)
     # @option (see #param)
+    # @yield  (see #param)
     # @return (see #param)
-    def option(name, type = nil, **opts)
-      dry_initializer.option(name, type, Dispatchers[opts])
+    def option(name, type = nil, **opts, &block)
+      dry_initializer.option(name, type, **opts, &block)
       self
     end
 
@@ -56,5 +55,7 @@ module Dry
       klass.send(:instance_variable_set, :@dry_initializer, config)
       dry_initializer.children << config
     end
+
+    require_relative 'initializer/struct'
   end
 end

data/lib/dry/initializer/builders.rb

@@ -1,7 +1,7 @@
 module Dry::Initializer
   # @private
   module Builders
-    require_relative "builders/reader"
-    require_relative "builders/initializer"
+    require_relative 'builders/reader'
+    require_relative 'builders/initializer'
   end
 end

data/lib/dry/initializer/builders/attribute.rb

@@ -20,17 +20,17 @@ module Dry::Initializer::Builders
       @default    = definition.default
       @source     = definition.source
       @ivar       = definition.ivar
-      @null       = definition.null ? "Dry::Initializer::UNDEFINED" : "nil"
-      @opts       = "__dry_initializer_options__"
-      @congif     = "__dry_initializer_config__"
-      @item       = "__dry_initializer_definition__"
-      @val        = @option ? "__dry_initializer_value__" : @source
+      @null       = definition.null ? 'Dry::Initializer::UNDEFINED' : 'nil'
+      @opts       = '__dry_initializer_options__'
+      @congif     = '__dry_initializer_config__'
+      @item       = '__dry_initializer_definition__'
+      @val        = @option ? '__dry_initializer_value__' : @source
     end
     # rubocop: enable Metrics/MethodLength
 
     def lines
       [
-        "",
+        '',
         definition_line,
         reader_line,
         default_line,
@@ -41,6 +41,7 @@ module Dry::Initializer::Builders
 
     def reader_line
       return unless @option
+
       @optional ? optional_reader : required_reader
     end
 
@@ -55,27 +56,31 @@ module Dry::Initializer::Builders
 
     def definition_line
       return unless @type || @default
+
       "#{@item} = __dry_initializer_config__.definitions[:'#{@source}']"
     end
 
     def default_line
       return unless @default
-      "#{@val} = instance_exec(&#{@item}.default) if #{@val} == #{@null}"
+
+      "#{@val} = instance_exec(&#{@item}.default) if #{@null} == #{@val}"
     end
 
     def coercion_line
       return unless @type
+
       arity = @type.is_a?(Proc) ? @type.arity : @type.method(:call).arity
-      if arity.abs == 1
-        "#{@val} = #{@item}.type.call(#{@val}) unless #{@val} == #{@null}"
+
+      if arity.abs == 1 || Dry::Types::Type.equal?(@type)
+        "#{@val} = #{@item}.type.call(#{@val}) unless #{@null} == #{@val}"
       else
-        "#{@val} = #{@item}.type.call(#{@val}, self) unless #{@val} == #{@null}"
+        "#{@val} = #{@item}.type.call(#{@val}, self) unless #{@null} == #{@val}"
       end
     end
 
     def assignment_line
       "#{@ivar} = #{@val}" \
-      " unless #{@val} == #{@null} && instance_variable_defined?(:#{@ivar})"
+      " unless #{@null} == #{@val} && instance_variable_defined?(:#{@ivar})"
     end
   end
 end

data/lib/dry/initializer/builders/initializer.rb

@@ -1,8 +1,8 @@
 module Dry::Initializer::Builders
   # @private
   class Initializer
-    require_relative "signature"
-    require_relative "attribute"
+    require_relative 'signature'
+    require_relative 'attribute'
 
     def self.[](config)
       new(config).call
@@ -30,8 +30,8 @@ module Dry::Initializer::Builders
     end
 
     def undef_line
-      "undef :__dry_initializer_initialize__" \
-      " if private_method_defined? :__dry_initializer_initialize__"
+      'undef :__dry_initializer_initialize__' \
+      ' if private_method_defined? :__dry_initializer_initialize__'
     end
 
     def define_line
@@ -40,22 +40,18 @@ module Dry::Initializer::Builders
 
     def params_lines
       @definitions.reject(&:option)
-                  .flat_map { |item| Attribute[item] }
-                  .map { |line| "  " << line }
+        .flat_map { |item| Attribute[item] }
+        .map { |line| '  ' << line }
     end
 
     def options_lines
       @definitions.select(&:option)
-                  .flat_map { |item| Attribute[item] }
-                  .map { |line| "  " << line }
+        .flat_map { |item| Attribute[item] }
+        .map { |line| '  ' << line }
     end
 
     def end_line
-      "end"
-    end
-
-    def private_line
-      "private :__dry_initializer_initialize__"
+      'end'
     end
   end
 end

data/lib/dry/initializer/builders/reader.rb

@@ -30,16 +30,18 @@ module Dry::Initializer::Builders
 
     def attribute_line
       return unless @reader
+
       "attr_reader :#{@target}" unless @null
     end
 
     def method_lines
       return unless @reader
       return unless @null
+
       [
         "def #{@target}",
-        "  #{@ivar} unless #{@ivar} == Dry::Initializer::UNDEFINED",
-        "end"
+        "  #{@ivar} unless Dry::Initializer::UNDEFINED == #{@ivar}",
+        'end'
       ]
     end
 

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

@@ -6,7 +6,7 @@ module Dry::Initializer::Builders
     end
 
     def call
-      [*required_params, *optional_params, "*", options].compact.join(", ")
+      [*required_params, *optional_params, '*', options].compact.join(', ')
     end
 
     private
@@ -14,7 +14,7 @@ module Dry::Initializer::Builders
     def initialize(config)
       @config  = config
       @options = config.options.any?
-      @null    = config.null ? "Dry::Initializer::UNDEFINED" : "nil"
+      @null    = config.null ? 'Dry::Initializer::UNDEFINED' : 'nil'
     end
 
     def required_params
@@ -26,7 +26,7 @@ module Dry::Initializer::Builders
     end
 
     def options
-      "**__dry_initializer_options__" if @options
+      '**__dry_initializer_options__' if @options
     end
   end
 end

data/lib/dry/initializer/config.rb

@@ -51,15 +51,14 @@ module Dry::Initializer
 
     # Adds or redefines a parameter
     # @param  [Symbol]       name
-    # @param  [#call, nil]   coercer (nil)
-    # @option opts [#call]   :type
+    # @param  [#call, nil]   type (nil)
     # @option opts [Proc]    :default
     # @option opts [Boolean] :optional
     # @option opts [Symbol]  :as
     # @option opts [true, false, :protected, :public, :private] :reader
     # @return [self] itself
-    def param(name, type = nil, **opts)
-      add_definition(false, name, type, opts)
+    def param(name, type = nil, **opts, &block)
+      add_definition(false, name, type, block, **opts)
     end
 
     # Adds or redefines an option of [#dry_initializer]
@@ -68,8 +67,8 @@ module Dry::Initializer
     # @option (see #param)
     # @return (see #param)
     #
-    def option(name, type = nil, **opts)
-      add_definition(true, name, type, opts)
+    def option(name, type = nil, **opts, &block)
+      add_definition(true, name, type, block, **opts)
     end
 
     # The hash of public attributes for an instance of the [#extended_class]
@@ -79,8 +78,9 @@ module Dry::Initializer
       definitions.values.each_with_object({}) do |item, obj|
         key = item.target
         next unless instance.respond_to? key
+
         val = instance.send(key)
-        obj[key] = val unless val == null
+        obj[key] = val unless null == val
       end
     end
 
@@ -91,7 +91,7 @@ module Dry::Initializer
       definitions.values.each_with_object({}) do |item, obj|
         key = item.target
         val = instance.send(:instance_variable_get, item.ivar)
-        obj[key] = val unless val == null
+        obj[key] = val unless null == val
       end
     end
 
@@ -115,7 +115,7 @@ module Dry::Initializer
     # @return [String]
     def inch
       line  =  Builders::Signature[self]
-      line  =  line.gsub("__dry_initializer_options__", "options")
+      line  =  line.gsub('__dry_initializer_options__', 'options')
       lines =  ["@!method initialize(#{line})"]
       lines += ["Initializes an instance of #{extended_class}"]
       lines += definitions.values.map(&:inch)
@@ -134,13 +134,25 @@ module Dry::Initializer
       finalize
     end
 
-    def add_definition(option, name, type, opts)
-      definition = Definition.new(option, null, name, type, Dispatchers[opts])
+    # rubocop: disable Metrics/MethodLength
+    def add_definition(option, name, type, block, **opts)
+      opts = {
+        parent: extended_class,
+        option: option,
+        null: null,
+        source: name,
+        type: type,
+        block: block,
+        **opts
+      }
+
+      options = Dispatchers.call(**opts)
+      definition = Definition.new(**options)
       definitions[definition.source] = definition
       finalize
-
       mixin.class_eval definition.code
     end
+    # rubocop: enable Metrics/MethodLength
 
     def final_definitions
       parent_definitions = Hash(parent&.definitions&.dup)
@@ -152,6 +164,7 @@ module Dry::Initializer
     def check_type(previous, current)
       return current unless previous
       return current if previous.option == current.option
+
       raise SyntaxError,
             "cannot reload #{previous} of #{extended_class.superclass}" \
             " by #{current} of its subclass #{extended_class}"

data/lib/dry/initializer/definition.rb

@@ -14,17 +14,17 @@ module Dry::Initializer
 
     def options
       {
-        as:       target,
-        type:     type,
+        as: target,
+        type: type,
         optional: optional,
-        default:  default,
-        reader:   reader,
-        desc:     desc
+        default: default,
+        reader: reader,
+        desc: desc
       }.reject { |_, value| value.nil? }
     end
 
     def name
-      @name ||= (option ? "option" : "parameter") << " '#{source}'"
+      @name ||= (option ? 'option' : 'parameter') << " '#{source}'"
     end
     alias to_s    name
     alias to_str  name
@@ -39,78 +39,27 @@ module Dry::Initializer
     end
 
     def inch
-      @inch ||= (option ? "@option" : "@param ").tap do |text|
-        text << " [Object]"
+      @inch ||= (option ? '@option' : '@param ').tap do |text|
+        text << ' [Object]'
         text << (option ? " :#{source}" : " #{source}")
-        text << (optional ? " (optional)" : " (required)")
+        text << (optional ? ' (optional)' : ' (required)')
         text << " #{desc}" if desc
       end
     end
 
     private
 
-    def initialize(option, null, source, coercer = nil, **options)
-      @option   = !!option
-      @null     = null
-      @source   = source.to_sym
-      @target   = check_target options.fetch(:as, source).to_sym
-      @ivar     = :"@#{target}"
-      @type     = check_type(coercer || options[:type])
-      @reader   = prepare_reader options.fetch(:reader, true)
-      @default  = check_default options[:default]
-      @optional = options.fetch(:optional, @default)
-      @desc     = options[:desc]&.to_s&.capitalize
+    def initialize(**options)
+      @option   = options[:option]
+      @null     = options[:null]
+      @source   = options[:source]
+      @target   = options[:target]
+      @ivar     = "@#{@target}"
+      @type     = options[:type]
+      @reader   = options[:reader]
+      @default  = options[:default]
+      @optional = options[:optional]
+      @desc     = options[:desc]
     end
-
-    def check_source(value)
-      if RESERVED.include? value
-        raise ArgumentError, "Name #{value} is reserved by dry-initializer gem"
-      end
-
-      unless option || value[ATTRIBUTE]
-        raise ArgumentError, "Invalid parameter name :'#{value}'"
-      end
-
-      value
-    end
-
-    def check_target(value)
-      return value if value[ATTRIBUTE]
-      raise ArgumentError, "Invalid variable name :'#{value}'"
-    end
-
-    def check_type(value)
-      return if value.nil?
-      arity =   value.arity               if value.is_a? Proc
-      arity ||= value.method(:call).arity if value.respond_to? :call
-      return value if [1, 2].include? arity.to_i.abs
-      raise TypeError,
-            "type of #{inspect} should respond to #call with 1..2 arguments"
-    end
-
-    def check_default(value)
-      return if value.nil?
-      return value if value.is_a?(Proc) && value.arity < 1
-      raise TypeError,
-            "default value of #{inspect} should be a proc without params"
-    end
-
-    def prepare_reader(value)
-      case value.to_s
-      when "", "false" then false
-      when "private"   then :private
-      when "protected" then :protected
-      else :public
-      end
-    end
-
-    ATTRIBUTE = /\A\w+\z/
-    RESERVED  = %i[
-      __dry_initializer_options__
-      __dry_initializer_config__
-      __dry_initializer_value__
-      __dry_initializer_definition__
-      __dry_initializer_initializer__
-    ].freeze
   end
 end