dry-initializer 2.5.0 → 3.0.4

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2020 dry-rb team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,91 +1,29 @@
-# dry-initializer [![Join the chat at https://gitter.im/dry-rb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dry-rb/chat)
-
-[![Gem Version](https://badge.fury.io/rb/dry-initializer.svg)][gem]
-[![Build Status](https://travis-ci.org/dry-rb/dry-initializer.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/dry-rb/dry-initializer.svg)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/dry-rb/dry-initializer/badges/gpa.svg)][codeclimate]
-[![Test Coverage](https://codeclimate.com/github/dry-rb/dry-initializer/badges/coverage.svg)][coveralls]
-[![Inline docs](http://inch-ci.org/github/dry-rb/dry-initializer.svg?branch=master)][inchpages]
-
 [gem]: https://rubygems.org/gems/dry-initializer
-[travis]: https://travis-ci.org/dry-rb/dry-initializer
-[gemnasium]: https://gemnasium.com/dry-rb/dry-initializer
-[codeclimate]: https://codeclimate.com/github/dry-rb/dry-initializer
-[coveralls]: https://coveralls.io/r/dry-rb/dry-initializer
+[actions]: https://github.com/dry-rb/dry-initializer/actions
+[codacy]: https://www.codacy.com/gh/dry-rb/dry-initializer
+[chat]: https://dry-rb.zulipchat.com
 [inchpages]: http://inch-ci.org/github/dry-rb/dry-initializer
-[docs]: http://dry-rb.org/gems/dry-initializer/
-[benchmarks]: https://github.com/dry-rb/dry-initializer/wiki
-[license]: http://opensource.org/licenses/MIT
-
-DSL for building class initializer with params and options.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'dry-initializer'
-```
-
-And then execute:
-
-```shell
-$ bundle
-```
-
-Or install it yourself as:
 
-```shell
-$ gem install dry-initializer
-```
+# dry-initializer [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
-## Synopsis
-
-```ruby
-require 'dry-initializer'
-require 'dry-types'
-
-class User
-  extend Dry::Initializer
-
-  # Params of the initializer along with corresponding readers
-  param  :name,  proc(&:to_s)
-  param  :role,  default: -> { 'customer' }
-  # Options of the initializer along with corresponding readers
-  option :admin, default: -> { false }
-  option :vip,   optional: true
-end
-
-# Defines the initializer with params and options
-user = User.new 'Vladimir', 'admin', admin: true
-
-# Defines readers for single attributes
-user.name  # => 'Vladimir'
-user.role  # => 'admin'
-user.admin # => true
-user.vip   # => Dry::Initializer::UNDEFINED
-```
-
-See full documentation on the [Dry project official site][docs]
-
-## Benchmarks
+[![Gem Version](https://badge.fury.io/rb/dry-initializer.svg)][gem]
+[![CI Status](https://github.com/dry-rb/dry-initializer/workflows/ci/badge.svg)][actions]
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/03c8923afd734e9fb0f4bfe9cc893edb)][codacy]
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/03c8923afd734e9fb0f4bfe9cc893edb)][codacy]
+[![Inline docs](http://inch-ci.org/github/dry-rb/dry-initializer.svg?branch=master)][inchpages]
 
-The `dry-initializer` is pretty fast for rubies 2.3+ [comparing to other libraries][benchmarks].
+## Links
 
-## Compatibility
+* [User documentation](http://dry-rb.org/gems/dry-initializer)
+* [API documentation](http://rubydoc.info/gems/dry-initializer)
 
-Tested under rubies [compatible to MRI 2.3+](.travis.yml).
+## Supported Ruby versions
 
-## Contributing
+This library officially supports the following Ruby versions:
 
-* [Fork the project](https://github.com/dry-rb/dry-initializer)
-* Create your feature branch (`git checkout -b my-new-feature`)
-* Add tests for it
-* Commit your changes (`git commit -am '[UPDATE] Add some feature'`)
-* Push to the branch (`git push origin my-new-feature`)
-* Create a new Pull Request
+* MRI >= `2.4`
+* jruby >= `9.2`
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License][license].
-
+See `LICENSE` file.

data/dry-initializer.gemspec

@@ -1,20 +1,33 @@
-Gem::Specification.new do |gem|
-  gem.name     = "dry-initializer"
-  gem.version  = "2.5.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"
+# frozen_string_literal: true
+# this file is managed by dry-rb/devtools project
 
-  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"]
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dry/initializer/version'
 
-  gem.required_ruby_version = ">= 2.3"
+Gem::Specification.new do |spec|
+  spec.name          = 'dry-initializer'
+  spec.authors       = ["Vladimir Kochnev (marshall-lee)", "Andrew Kozin (nepalez)"]
+  spec.email         = ["andrew.kozin@gmail.com"]
+  spec.license       = 'MIT'
+  spec.version       = Dry::Initializer::VERSION.dup
 
-  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.49.0"
+  spec.summary       = "DSL for declaring params and options of the initializer"
+  spec.description   = spec.summary
+  spec.homepage      = 'https://dry-rb.org/gems/dry-initializer'
+  spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-initializer.gemspec", "lib/**/*"]
+  spec.bindir        = 'bin'
+  spec.executables   = []
+  spec.require_paths = ['lib']
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['changelog_uri']     = 'https://github.com/dry-rb/dry-initializer/blob/master/CHANGELOG.md'
+  spec.metadata['source_code_uri']   = 'https://github.com/dry-rb/dry-initializer'
+  spec.metadata['bug_tracker_uri']   = 'https://github.com/dry-rb/dry-initializer/issues'
+
+  spec.required_ruby_version = ">= 2.4.0"
+
+  # to update dependencies edit project.yml
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 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
@@ -32,18 +30,20 @@ module Dry
     # @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
 
@@ -55,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,18 +56,22 @@ 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 #{@null} == #{@val}"
     end
 
     def coercion_line
       return unless @type
+
       arity = @type.is_a?(Proc) ? @type.arity : @type.method(:call).arity
-      if arity.abs == 1
+
+      if arity.equal?(1) || arity.negative?
         "#{@val} = #{@item}.type.call(#{@val}) unless #{@null} == #{@val}"
       else
         "#{@val} = #{@item}.type.call(#{@val}, self) unless #{@null} == #{@val}"

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 Dry::Initializer::UNDEFINED == #{@ivar}",
-        "end"
+        '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

@@ -57,8 +57,8 @@ module Dry::Initializer
     # @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]
@@ -67,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]
@@ -78,6 +78,7 @@ 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 null == val
       end
@@ -114,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)
@@ -133,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)
@@ -151,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}"