dry-initializer 3.0.4 → 3.1.0

data/lib/dry/initializer/dsl.rb

@@ -1,43 +1,51 @@
-module Dry::Initializer
-  # Module-level DSL
-  module DSL
-    # Setting for null (undefined value)
-    # @return [nil, Dry::Initializer::UNDEFINED]
-    attr_reader :null
+# frozen_string_literal: true
 
-    # Returns a version of the module with custom settings
-    # @option settings [Boolean] :undefined
-    #   If unassigned params and options should be treated different from nil
-    # @return [Dry::Initializer]
-    def [](undefined: true, **)
-      null = (undefined == false) ? nil : UNDEFINED
-      Module.new.tap do |mod|
-        mod.extend DSL
-        mod.include self
-        mod.send(:instance_variable_set, :@null, null)
+module Dry
+  module Initializer
+    # Module-level DSL
+    module DSL
+      # Setting for null (undefined value)
+      # @return [nil, Dry::Initializer::UNDEFINED]
+      attr_reader :null
+
+      # Returns a version of the module with custom settings
+      # @option settings [Boolean] :undefined
+      #   If unassigned params and options should be treated different from nil
+      # @return [Dry::Initializer]
+      def [](undefined: true, **)
+        null = undefined == false ? nil : UNDEFINED
+        Module.new.tap do |mod|
+          mod.extend DSL
+          mod.include self
+          mod.send(:instance_variable_set, :@null, null)
+        end
       end
-    end
 
-    # Returns mixin module to be included to target class by hand
-    # @return [Module]
-    # @yield proc defining params and options
-    def define(procedure = nil, &block)
-      config = Config.new(null: null)
-      config.instance_exec(&(procedure || block))
-      config.mixin.include Mixin::Root
-      config.mixin
-    end
+      # Returns mixin module to be included to target class by hand
+      # @return [Module]
+      # @yield proc defining params and options
+      def define(procedure = nil, &block)
+        config = Config.new(null: null)
+        config.instance_exec(&(procedure || block))
+        config.mixin.include Mixin::Root
+        config.mixin
+      end
 
-    private
+      private
 
-    def extended(klass)
-      config = Config.new(klass, null: null)
-      klass.send :instance_variable_set, :@dry_initializer, config
-      klass.include Mixin::Root
-    end
+      def extended(klass)
+        config = Config.new(klass, null: null)
+        klass.send :instance_variable_set, :@dry_initializer, config
+        klass.include Mixin::Root
+      end
 
-    def self.extended(mod)
-      mod.instance_variable_set :@null, UNDEFINED
+      class << self
+        private
+
+        def extended(mod)
+          mod.instance_variable_set :@null, UNDEFINED
+        end
+      end
     end
   end
 end

data/lib/dry/initializer/errors.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Dry
+  module Initializer
+    class CoercionError < ::StandardError
+      def initialize(constraint_error, field)
+        @constraint_error = constraint_error
+        @field = field
+        super(message)
+      end
+
+      # Ensure that the field name is in the error message
+      def message
+        if @constraint_error.message =~ /#{@field}/
+          @constraint_error.message
+        else
+          "#{@constraint_error.message} for field :#{@field}"
+        end
+      end
+    end
+  end
+end

data/lib/dry/initializer/mixin/local.rb

@@ -1,19 +1,25 @@
-module Dry::Initializer::Mixin
-  # @private
-  module Local
-    attr_reader :klass
+# frozen_string_literal: true
 
-    def inspect
-      "Dry::Initializer::Mixin::Local[#{klass}]"
-    end
-    alias to_s   inspect
-    alias to_str inspect
+module Dry
+  module Initializer
+    module Mixin
+      # @private
+      module Local
+        attr_reader :klass
+
+        def inspect
+          "Dry::Initializer::Mixin::Local[#{klass}]"
+        end
+        alias_method :to_s, :inspect
+        alias_method :to_str, :inspect
 
-    private
+        private
 
-    def included(klass)
-      @klass = klass
-      super
+        def included(klass)
+          @klass = klass
+          super
+        end
+      end
     end
   end
 end

data/lib/dry/initializer/mixin/root.rb

@@ -1,11 +1,16 @@
-module Dry::Initializer::Mixin
-  # @private
-  module Root
-    private
+# frozen_string_literal: true
 
-    def initialize(*args)
-      __dry_initializer_initialize__(*args)
+module Dry
+  module Initializer
+    module Mixin
+      # @private
+      module Root
+        private
+
+        def initialize(...)
+          __dry_initializer_initialize__(...)
+        end
+      end
     end
-    ruby2_keywords(:initialize) if respond_to?(:ruby2_keywords, true)
   end
 end

data/lib/dry/initializer/mixin.rb

@@ -1,15 +1,20 @@
-module Dry::Initializer
-  # @private
-  module Mixin
-    extend  DSL              # @deprecated
-    include Dry::Initializer # @deprecated
-    def self.extended(klass) # @deprecated
-      warn '[DEPRECATED] Use Dry::Initializer instead of its alias' \
-           ' Dry::Initializer::Mixin. The later will be removed in v2.1.0'
-      super
-    end
+# frozen_string_literal: true
+
+module Dry
+  module Initializer
+    # @private
+    module Mixin
+      extend  DSL              # @deprecated
+      include Dry::Initializer # @deprecated
+      # @deprecated
+      def self.extended(klass)
+        warn "[DEPRECATED] Use Dry::Initializer instead of its alias" \
+            " Dry::Initializer::Mixin. The later will be removed in v2.1.0"
+        super
+      end
 
-    require_relative 'mixin/root'
-    require_relative 'mixin/local'
+      require_relative "mixin/root"
+      require_relative "mixin/local"
+    end
   end
 end

data/lib/dry/initializer/struct.rb

@@ -1,39 +1,44 @@
-#
+# frozen_string_literal: true
+
 # The nested structure that takes nested hashes with indifferent access
 #
-class Dry::Initializer::Struct
-  extend Dry::Initializer
+module Dry
+  module Initializer
+    class Struct
+      extend ::Dry::Initializer
 
-  class << self
-    undef_method :param
+      class << self
+        undef_method :param
 
-    def new(options)
-      super(**Hash(options).each_with_object({}) { |(k, v), h| h[k.to_sym] = v })
-    end
-    alias call new
-  end
+        def new(options)
+          super(**Hash(options).each_with_object({}) { |(k, v), h| h[k.to_sym] = v })
+        end
+        alias_method :call, :new
+      end
 
-  #
-  # Represents event data as a nested hash with deeply stringified keys
-  # @return [Hash<String, ...>]
-  #
-  def to_h
-    self
-      .class
-      .dry_initializer
-      .attributes(self)
-      .each_with_object({}) { |(k, v), h| h[k.to_s] = __hashify(v) }
-  end
+      #
+      # Represents event data as a nested hash with deeply stringified keys
+      # @return [Hash<String, ...>]
+      #
+      def to_h
+        self
+          .class
+          .dry_initializer
+          .attributes(self)
+          .each_with_object({}) { |(k, v), h| h[k.to_s] = __hashify(v) }
+      end
 
-  private
+      private
 
-  def __hashify(value)
-    case value
-    when Hash
-      value.each_with_object({}) { |(k, v), obj| obj[k.to_s] = __hashify(v) }
-    when Array then value.map { |v| __hashify(v) }
-    when Dry::Initializer::Struct then value.to_h
-    else value
+      def __hashify(value)
+        case value
+        when Hash
+          value.each_with_object({}) { |(k, v), obj| obj[k.to_s] = __hashify(v) }
+        when Array then value.map { |v| __hashify(v) }
+        when Dry::Initializer::Struct then value.to_h
+        else value
+        end
+      end
     end
   end
 end

data/lib/dry/initializer/undefined.rb

@@ -1,2 +1,8 @@
-module Dry::Initializer::UNDEFINED
+# frozen_string_literal: true
+
+module Dry
+  module Initializer
+    module UNDEFINED
+    end
+  end
 end

data/lib/dry/initializer/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Dry
   module Initializer
-    VERSION = '3.0.4'.freeze
+    VERSION = "3.1.0"
   end
 end

data/lib/dry/initializer.rb

@@ -1,4 +1,6 @@
-require 'set'
+# frozen_string_literal: true
+
+require "set"
 
 # Namespace for gems in a dry-rb community
 module Dry
@@ -6,13 +8,14 @@ module Dry
   # DSL for declaring params and options of class initializers
   #
   module Initializer
-    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'
+    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"
+    require_relative "initializer/errors"
 
     # Adds methods [.[]] and [.define]
     extend DSL
@@ -56,6 +59,6 @@ module Dry
       dry_initializer.children << config
     end
 
-    require_relative 'initializer/struct'
+    require_relative "initializer/struct"
   end
 end

data/lib/dry-initializer.rb

@@ -1 +1,3 @@
-require_relative 'dry/initializer'
+# frozen_string_literal: true
+
+require_relative "dry/initializer"

data/lib/tasks/benchmark.rake

@@ -1,36 +1,38 @@
+# frozen_string_literal: true
+
 namespace :benchmark do
-  desc 'Runs benchmarks for plain params'
+  desc "Runs benchmarks for plain params"
   task :plain_params do
-    system 'ruby benchmarks/plain_params.rb'
+    system "ruby benchmarks/plain_params.rb"
   end
 
-  desc 'Runs benchmarks for plain options'
+  desc "Runs benchmarks for plain options"
   task :plain_options do
-    system 'ruby benchmarks/plain_options.rb'
+    system "ruby benchmarks/plain_options.rb"
   end
 
-  desc 'Runs benchmarks for value coercion'
+  desc "Runs benchmarks for value coercion"
   task :with_coercion do
-    system 'ruby benchmarks/with_coercion.rb'
+    system "ruby benchmarks/with_coercion.rb"
   end
 
-  desc 'Runs benchmarks with defaults'
+  desc "Runs benchmarks with defaults"
   task :with_defaults do
-    system 'ruby benchmarks/with_defaults.rb'
+    system "ruby benchmarks/with_defaults.rb"
   end
 
-  desc 'Runs benchmarks with defaults and coercion'
+  desc "Runs benchmarks with defaults and coercion"
   task :with_defaults_and_coercion do
-    system 'ruby benchmarks/with_defaults_and_coercion.rb'
+    system "ruby benchmarks/with_defaults_and_coercion.rb"
   end
 
-  desc 'Runs benchmarks for several defaults'
+  desc "Runs benchmarks for several defaults"
   task :compare_several_defaults do
-    system 'ruby benchmarks/with_several_defaults.rb'
+    system "ruby benchmarks/with_several_defaults.rb"
   end
 end
 
-desc 'Runs all benchmarks'
+desc "Runs all benchmarks"
 task benchmark: %i[
   benchmark:plain_params
   benchmark:plain_options

data/lib/tasks/profile.rake

@@ -1,32 +1,35 @@
+# frozen_string_literal: true
+
+# rubocop: disable Lint/ConstantDefinitionInBlock
 namespace :profile do
   def profile(name, execution, &definition)
-    require 'dry-initializer'
-    require 'ruby-prof'
-    require 'fileutils'
+    require "dry-initializer"
+    require "ruby-prof"
+    require "fileutils"
 
     definition.call
     result = RubyProf.profile do
       1_000.times { execution.call }
     end
 
-    FileUtils.mkdir_p './tmp'
+    FileUtils.mkdir_p "./tmp"
 
     FileUtils.touch "./tmp/#{name}.dot"
-    File.open("./tmp/#{name}.dot", 'w+') do |output|
+    File.open("./tmp/#{name}.dot", "w+") do |output|
       RubyProf::DotPrinter.new(result).print(output, min_percent: 0)
     end
 
     FileUtils.touch "./tmp/#{name}.html"
-    File.open("./tmp/#{name}.html", 'w+') do |output|
+    File.open("./tmp/#{name}.html", "w+") do |output|
       RubyProf::CallStackPrinter.new(result).print(output, min_percent: 0)
     end
 
     system "dot -Tpng ./tmp/#{name}.dot > ./tmp/#{name}.png"
   end
 
-  desc 'Profiles initialization with required param and option'
+  desc "Profiles initialization with required param and option"
   task :required do
-    profile('required', -> { User.new :Andy, email: 'andy@example.com' }) do
+    profile("required", -> { User.new :Andy, email: "andy@example.com" }) do
       class User
         extend Dry::Initializer
         param  :name
@@ -35,20 +38,20 @@ namespace :profile do
     end
   end
 
-  desc 'Profiles initialization with default param and option'
+  desc "Profiles initialization with default param and option"
   task :defaults do
-    profile('defaults', -> { User.new }) do
+    profile("defaults", -> { User.new }) do
       class User
         extend Dry::Initializer
         param  :name,  default: -> { :Andy }
-        option :email, default: -> { 'andy@example.com' }
+        option :email, default: -> { "andy@example.com" }
       end
     end
   end
 
-  desc 'Profiles initialization with coerced param and option'
+  desc "Profiles initialization with coerced param and option"
   task :coercion do
-    profile('coercion', -> { User.new :Andy, email: :"andy@example.com" }) do
+    profile("coercion", -> { User.new :Andy, email: :"andy@example.com" }) do
       class User
         extend Dry::Initializer
         param  :name,  proc(&:to_s)
@@ -57,9 +60,9 @@ namespace :profile do
     end
   end
 
-  desc 'Profiles initialization with coerced defaults of param and option'
+  desc "Profiles initialization with coerced defaults of param and option"
   task :default_coercion do
-    profile('default_coercion', -> { User.new }) do
+    profile("default_coercion", -> { User.new }) do
       class User
         extend Dry::Initializer
         param  :name,  proc(&:to_s), default: -> { :Andy }
@@ -69,10 +72,11 @@ namespace :profile do
   end
 end
 
-desc 'Makes all profiling at once'
+desc "Makes all profiling at once"
 task profile: %i[
   profile:required
   profile:defaults
   profile:coercion
   profile:default_coercion
 ]
+# rubocop: enable Lint/ConstantDefinitionInBlock

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-initializer
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.1.0
 platform: ruby
 authors:
 - Vladimir Kochnev (marshall-lee)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-29 00:00:00.000000000 Z
+date: 2022-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -71,6 +71,7 @@ files:
 - lib/dry/initializer/dispatchers/unwrap_type.rb
 - lib/dry/initializer/dispatchers/wrap_type.rb
 - lib/dry/initializer/dsl.rb
+- lib/dry/initializer/errors.rb
 - lib/dry/initializer/mixin.rb
 - lib/dry/initializer/mixin/local.rb
 - lib/dry/initializer/mixin/root.rb
@@ -95,14 +96,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: DSL for declaring params and options of the initializer