dry-initializer 3.0.1 → 3.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2021 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,90 +1,30 @@
-# 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]
-[![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]
-
+<!--- this file is synced from dry-rb/template-gem project -->
 [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](https://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.7.0`
+* jruby `>= 9.3` (postponed until 2.7 is supported)
 
 ## 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,35 @@
-Gem::Specification.new do |gem|
-  gem.name     = "dry-initializer"
-  gem.version  = "3.0.1"
-  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.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.49.0"
+# frozen_string_literal: true
+
+# this file is synced from dry-rb/template-gem project
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dry/initializer/version"
+
+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
+
+  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.7.0"
+
+  # to update dependencies edit project.yml
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

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

@@ -1,81 +1,96 @@
-module Dry::Initializer::Builders
-  # @private
-  class Attribute
-    def self.[](definition)
-      new(definition).call
-    end
+# frozen_string_literal: true
 
-    def call
-      lines.compact
-    end
+module Dry
+  module Initializer
+    module Builders
+      # @private
+      class Attribute
+        def self.[](definition)
+          new(definition).call
+        end
 
-    private
-
-    # rubocop: disable Metrics/MethodLength
-    def initialize(definition)
-      @definition = definition
-      @option     = definition.option
-      @type       = definition.type
-      @optional   = definition.optional
-      @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
-    end
-    # rubocop: enable Metrics/MethodLength
-
-    def lines
-      [
-        "",
-        definition_line,
-        reader_line,
-        default_line,
-        coercion_line,
-        assignment_line
-      ]
-    end
+        def call
+          lines.compact
+        end
 
-    def reader_line
-      return unless @option
-      @optional ? optional_reader : required_reader
-    end
+        private
 
-    def optional_reader
-      "#{@val} = #{@opts}.fetch(:'#{@source}', #{@null})"
-    end
+        def initialize(definition)
+          @definition = definition
+          @option     = definition.option
+          @type       = definition.type
+          @optional   = definition.optional
+          @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
+        end
 
-    def required_reader
-      "#{@val} = #{@opts}.fetch(:'#{@source}')" \
-      " { raise KeyError, \"\#{self.class}: #{@definition} is required\" }"
-    end
+        def lines
+          [
+            "",
+            definition_line,
+            reader_line,
+            default_line,
+            coercion_line,
+            assignment_line
+          ]
+        end
 
-    def definition_line
-      return unless @type || @default
-      "#{@item} = __dry_initializer_config__.definitions[:'#{@source}']"
-    end
+        def reader_line
+          return unless @option
 
-    def default_line
-      return unless @default
-      "#{@val} = instance_exec(&#{@item}.default) if #{@null} == #{@val}"
-    end
+          @optional ? optional_reader : required_reader
+        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 #{@null} == #{@val}"
-      else
-        "#{@val} = #{@item}.type.call(#{@val}, self) unless #{@null} == #{@val}"
-      end
-    end
+        def optional_reader
+          "#{@val} = #{@opts}.fetch(:'#{@source}', #{@null})"
+        end
+
+        def required_reader
+          "#{@val} = #{@opts}.fetch(:'#{@source}')" \
+          " { raise KeyError, \"\#{self.class}: #{@definition} is required\" }"
+        end
+
+        def definition_line
+          return unless @type || @default
+
+          "#{@item} = __dry_initializer_config__.definitions[:'#{@source}']"
+        end
+
+        def default_line
+          return unless @default
 
-    def assignment_line
-      "#{@ivar} = #{@val}" \
-      " unless #{@null} == #{@val} && instance_variable_defined?(:#{@ivar})"
+          "#{@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
+          type_call_params = \
+            arity.equal?(1) || arity.negative? ? @val : "#{@val}, self"
+
+          <<-COERCE
+            begin
+              unless #{@null} == #{@val}
+                #{@val} = #{@item}.type.call(#{type_call_params})
+              end
+            rescue Dry::Types::ConstraintError => e
+              raise Dry::Initializer::CoercionError.new(e, '#{@source}')
+            end
+          COERCE
+        end
+
+        def assignment_line
+          "#{@ivar} = #{@val}" \
+          " unless #{@null} == #{@val} && instance_variable_defined?(:#{@ivar})"
+        end
+      end
     end
   end
 end

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

@@ -1,61 +1,59 @@
-module Dry::Initializer::Builders
-  # @private
-  class Initializer
-    require_relative "signature"
-    require_relative "attribute"
-
-    def self.[](config)
-      new(config).call
-    end
-
-    def call
-      lines.flatten.compact.join("\n")
-    end
-
-    private
-
-    def initialize(config)
-      @config = config
-      @definitions = config.definitions.values
-    end
-
-    def lines
-      [
-        undef_line,
-        define_line,
-        params_lines,
-        options_lines,
-        end_line
-      ]
-    end
-
-    def undef_line
-      "undef :__dry_initializer_initialize__" \
-      " if private_method_defined? :__dry_initializer_initialize__"
-    end
-
-    def define_line
-      "private def __dry_initializer_initialize__(#{Signature[@config]})"
-    end
-
-    def params_lines
-      @definitions.reject(&:option)
-                  .flat_map { |item| Attribute[item] }
-                  .map { |line| "  " << line }
-    end
-
-    def options_lines
-      @definitions.select(&:option)
-                  .flat_map { |item| Attribute[item] }
-                  .map { |line| "  " << line }
-    end
-
-    def end_line
-      "end"
-    end
-
-    def private_line
-      "private :__dry_initializer_initialize__"
+# frozen_string_literal: true
+
+module Dry
+  module Initializer
+    module Builders
+      # @private
+      class Initializer
+        require_relative "signature"
+        require_relative "attribute"
+
+        def self.[](config)
+          new(config).call
+        end
+
+        def call
+          lines.flatten.compact.join("\n")
+        end
+
+        private
+
+        def initialize(config)
+          @config = config
+          @definitions = config.definitions.values
+        end
+
+        def lines
+          [
+            undef_line,
+            define_line,
+            params_lines,
+            options_lines,
+            end_line
+          ]
+        end
+
+        def undef_line
+          "undef :__dry_initializer_initialize__" \
+          " if private_method_defined? :__dry_initializer_initialize__"
+        end
+
+        def define_line
+          "private def __dry_initializer_initialize__(#{Signature[@config]})"
+        end
+
+        def params_lines
+          @definitions.reject(&:option).flat_map { Attribute[_1] }.map { "  #{_1}" }
+        end
+
+        def options_lines
+          @definitions.select(&:option).flat_map { Attribute[_1] }.map { "  #{_1}" }
+        end
+
+        def end_line
+          "end"
+        end
+      end
     end
   end
 end

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

@@ -1,50 +1,58 @@
-module Dry::Initializer::Builders
-  # @private
-  class Reader
-    def self.[](definition)
-      new(definition).call
-    end
-
-    def call
-      lines.flatten.compact.join("\n")
-    end
-
-    private
-
-    def initialize(definition)
-      @target = definition.target
-      @ivar   = definition.ivar
-      @null   = definition.null
-      @reader = definition.reader
-    end
-
-    def lines
-      [undef_line, attribute_line, method_lines, type_line]
-    end
-
-    def undef_line
-      "undef :#{@target} if method_defined?(:#{@target})" \
-      "  || private_method_defined?(:#{@target})" \
-      "  || protected_method_defined?(:#{@target})"
-    end
-
-    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
-
-    def type_line
-      "#{@reader} :#{@target}" if %i[private protected].include? @reader
+# frozen_string_literal: true
+
+module Dry
+  module Initializer
+    module Builders
+      # @private
+      class Reader
+        def self.[](definition)
+          new(definition).call
+        end
+
+        def call
+          lines.flatten.compact.join("\n")
+        end
+
+        private
+
+        def initialize(definition)
+          @target = definition.target
+          @ivar   = definition.ivar
+          @null   = definition.null
+          @reader = definition.reader
+        end
+
+        def lines
+          [undef_line, attribute_line, method_lines, type_line]
+        end
+
+        def undef_line
+          "undef :#{@target} if method_defined?(:#{@target})" \
+          "  || private_method_defined?(:#{@target})" \
+          "  || protected_method_defined?(:#{@target})"
+        end
+
+        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
+
+        def type_line
+          "#{@reader} :#{@target}" if %i[private protected].include? @reader
+        end
+      end
     end
   end
 end

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

@@ -1,32 +1,38 @@
-module Dry::Initializer::Builders
-  # @private
-  class Signature
-    def self.[](config)
-      new(config).call
-    end
+# frozen_string_literal: true
 
-    def call
-      [*required_params, *optional_params, "*", options].compact.join(", ")
-    end
+module Dry
+  module Initializer
+    module Builders
+      # @private
+      class Signature
+        def self.[](config)
+          new(config).call
+        end
 
-    private
+        def call
+          [*required_params, *optional_params, "*", options].compact.join(", ")
+        end
 
-    def initialize(config)
-      @config  = config
-      @options = config.options.any?
-      @null    = config.null ? "Dry::Initializer::UNDEFINED" : "nil"
-    end
+        private
 
-    def required_params
-      @config.params.reject(&:optional).map(&:source)
-    end
+        def initialize(config)
+          @config  = config
+          @options = config.options.any?
+          @null    = config.null ? "Dry::Initializer::UNDEFINED" : "nil"
+        end
 
-    def optional_params
-      @config.params.select(&:optional).map { |rec| "#{rec.source} = #{@null}" }
-    end
+        def required_params
+          @config.params.reject(&:optional).map(&:source)
+        end
+
+        def optional_params
+          @config.params.select(&:optional).map { |rec| "#{rec.source} = #{@null}" }
+        end
 
-    def options
-      "**__dry_initializer_options__" if @options
+        def options
+          "**__dry_initializer_options__" if @options
+        end
+      end
     end
   end
 end

data/lib/dry/initializer/builders.rb

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