dry-initializer 2.5.0 → 3.0.4

data/lib/dry/initializer/dispatchers/prepare_source.rb

@@ -0,0 +1,28 @@
+#
+# The dispatcher verifies a correctness of the source name
+# of param or option, taken as a `:source` option.
+#
+# We allow any stringified name for the source.
+# For example, this syntax is correct because we accept any key
+# in the original hash of arguments, but give them proper names:
+#
+# ```ruby
+# class Foo
+#   extend Dry::Initializer
+#
+#   option "", as: :first
+#   option 1,  as: :second
+# end
+#
+# foo = Foo.new("": 42, 1: 666)
+# foo.first  # => 42
+# foo.second # => 666
+# ```
+#
+module Dry::Initializer::Dispatchers::PrepareSource
+  module_function
+
+  def call(source:, **options)
+    { source: source.to_s.to_sym, **options }
+  end
+end

data/lib/dry/initializer/dispatchers/prepare_target.rb

@@ -0,0 +1,44 @@
+#
+# Prepares the target name of a parameter or an option.
+#
+# Unlike source, the target must satisfy requirements for Ruby variable names.
+# It also shouldn't be in conflict with names used by the gem.
+#
+module Dry::Initializer::Dispatchers::PrepareTarget
+  extend self
+
+  # List of variable names reserved by the gem
+  RESERVED = %i[
+    __dry_initializer_options__
+    __dry_initializer_config__
+    __dry_initializer_value__
+    __dry_initializer_definition__
+    __dry_initializer_initializer__
+  ].freeze
+
+  def call(source:, target: nil, as: nil, **options)
+    target ||= as || source
+    target = target.to_s.to_sym.downcase
+
+    check_ruby_name!(target)
+    check_reserved_names!(target)
+
+    { source: source, target: target, **options }
+  end
+
+  private
+
+  def check_ruby_name!(target)
+    return if target[/\A[[:alpha:]_][[:alnum:]_]*\??\z/u]
+
+    raise ArgumentError,
+          "The name `#{target}` is not allowed for Ruby methods"
+  end
+
+  def check_reserved_names!(target)
+    return unless RESERVED.include?(target)
+
+    raise ArgumentError,
+          "The method name `#{target}` is reserved by the dry-initializer gem"
+  end
+end

data/lib/dry/initializer/dispatchers/unwrap_type.rb

@@ -0,0 +1,22 @@
+#
+# Looks at the `:type` option and counts how many nested arrays
+# it contains around either nil or a callable value.
+#
+# The counted number is preserved in the `:wrap` virtual option
+# used by the [WrapType] dispatcher.
+#
+module Dry::Initializer::Dispatchers::UnwrapType
+  extend self
+
+  def call(type: nil, wrap: 0, **options)
+    type, wrap = unwrap(type, 0)
+
+    { type: type, wrap: wrap, **options }
+  end
+
+  private
+
+  def unwrap(type, count)
+    type.is_a?(Array) ? unwrap(type.first, count + 1) : [type, count]
+  end
+end

data/lib/dry/initializer/dispatchers/wrap_type.rb

@@ -0,0 +1,28 @@
+#
+# Takes `:type` and `:wrap` to construct the final value coercer
+#
+module Dry::Initializer::Dispatchers::WrapType
+  extend self
+
+  def call(type: nil, wrap: 0, **options)
+    { type: wrapped_type(type, wrap), **options }
+  end
+
+  private
+
+  def wrapped_type(type, count)
+    return type if count.zero?
+
+    ->(value) { wrap_value(value, count, type) }
+  end
+
+  def wrap_value(value, count, type)
+    if count.zero?
+      type ? type.call(value) : value
+    else
+      return [wrap_value(value, count - 1, type)] unless value.is_a?(Array)
+
+      value.map { |item| wrap_value(item, count - 1, type) }
+    end
+  end
+end

data/lib/dry/initializer/mixin.rb

@@ -4,12 +4,12 @@ module Dry::Initializer
     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"
+      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

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

@@ -6,5 +6,6 @@ module Dry::Initializer::Mixin
     def initialize(*args)
       __dry_initializer_initialize__(*args)
     end
+    ruby2_keywords(:initialize) if respond_to?(:ruby2_keywords, true)
   end
 end

data/lib/dry/initializer/struct.rb

@@ -0,0 +1,39 @@
+#
+# The nested structure that takes nested hashes with indifferent access
+#
+class Dry::Initializer::Struct
+  extend Dry::Initializer
+
+  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
+
+  #
+  # 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
+
+  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

data/lib/dry/initializer/undefined.rb

@@ -0,0 +1,2 @@
+module Dry::Initializer::UNDEFINED
+end

data/lib/dry/initializer/version.rb

@@ -0,0 +1,5 @@
+module Dry
+  module Initializer
+    VERSION = '3.0.4'.freeze
+  end
+end

data/lib/tasks/benchmark.rake

@@ -1,36 +1,36 @@
 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,32 @@
 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 +35,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 +57,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,7 +69,7 @@ namespace :profile do
   end
 end
 
-desc "Makes all profiling at once"
+desc 'Makes all profiling at once'
 task profile: %i[
   profile:required
   profile:defaults

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-initializer
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 3.0.4
 platform: ruby
 authors:
 - Vladimir Kochnev (marshall-lee)
@@ -9,89 +9,46 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '10'
-- !ruby/object:Gem::Dependency
-  name: dry-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.0
-description: 
-email: andrew.kozin@gmail.com
+        version: '0'
+description: DSL for declaring params and options of the initializer
+email:
+- andrew.kozin@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.md
-- CHANGELOG.md
+extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
-- Guardfile
-- LICENSE.txt
+- LICENSE
 - README.md
-- Rakefile
-- benchmarks/compare_several_defaults.rb
-- benchmarks/plain_options.rb
-- benchmarks/plain_params.rb
-- benchmarks/with_coercion.rb
-- benchmarks/with_defaults.rb
-- benchmarks/with_defaults_and_coercion.rb
 - dry-initializer.gemspec
 - lib/dry-initializer.rb
 - lib/dry/initializer.rb
@@ -103,35 +60,33 @@ files:
 - lib/dry/initializer/config.rb
 - lib/dry/initializer/definition.rb
 - lib/dry/initializer/dispatchers.rb
+- lib/dry/initializer/dispatchers/build_nested_type.rb
+- lib/dry/initializer/dispatchers/check_type.rb
+- lib/dry/initializer/dispatchers/prepare_default.rb
+- lib/dry/initializer/dispatchers/prepare_ivar.rb
+- lib/dry/initializer/dispatchers/prepare_optional.rb
+- lib/dry/initializer/dispatchers/prepare_reader.rb
+- lib/dry/initializer/dispatchers/prepare_source.rb
+- lib/dry/initializer/dispatchers/prepare_target.rb
+- lib/dry/initializer/dispatchers/unwrap_type.rb
+- lib/dry/initializer/dispatchers/wrap_type.rb
 - lib/dry/initializer/dsl.rb
 - lib/dry/initializer/mixin.rb
 - lib/dry/initializer/mixin/local.rb
 - lib/dry/initializer/mixin/root.rb
+- lib/dry/initializer/struct.rb
+- lib/dry/initializer/undefined.rb
+- lib/dry/initializer/version.rb
 - lib/tasks/benchmark.rake
 - lib/tasks/profile.rake
-- spec/attributes_spec.rb
-- spec/coercion_of_nil_spec.rb
-- spec/custom_dispatchers_spec.rb
-- spec/custom_initializer_spec.rb
-- spec/default_values_spec.rb
-- spec/definition_spec.rb
-- spec/invalid_default_spec.rb
-- spec/missed_default_spec.rb
-- spec/optional_spec.rb
-- spec/options_tolerance_spec.rb
-- spec/public_attributes_utility_spec.rb
-- spec/reader_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
-- spec/type_constraint_spec.rb
-- spec/value_coercion_via_dry_types_spec.rb
-homepage: https://github.com/dryrb/dry-initializer
+homepage: https://dry-rb.org/gems/dry-initializer
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  changelog_uri: https://github.com/dry-rb/dry-initializer/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/dry-rb/dry-initializer
+  bug_tracker_uri: https://github.com/dry-rb/dry-initializer/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -140,35 +95,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: DSL for declaring params and options of the initializer
-test_files:
-- spec/attributes_spec.rb
-- spec/coercion_of_nil_spec.rb
-- spec/custom_dispatchers_spec.rb
-- spec/custom_initializer_spec.rb
-- spec/default_values_spec.rb
-- spec/definition_spec.rb
-- spec/invalid_default_spec.rb
-- spec/missed_default_spec.rb
-- spec/optional_spec.rb
-- spec/options_tolerance_spec.rb
-- spec/public_attributes_utility_spec.rb
-- spec/reader_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
-- spec/type_constraint_spec.rb
-- spec/value_coercion_via_dry_types_spec.rb
+test_files: []