dry-initializer 2.4.0 → 3.0.3

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.3'.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

data/project.yml

@@ -0,0 +1,2 @@
+name: dry-initializer
+codacy_id: 03c8923afd734e9fb0f4bfe9cc893edb

data/spec/attributes_spec.rb

@@ -1,7 +1,7 @@
-describe Dry::Initializer, "dry_initializer.attributes" do
+describe Dry::Initializer, 'dry_initializer.attributes' do
   subject { instance.class.dry_initializer.attributes(instance) }
 
-  context "when class has params" do
+  context 'when class has params' do
     before do
       class Test::Foo
         extend Dry::Initializer
@@ -13,12 +13,12 @@ describe Dry::Initializer, "dry_initializer.attributes" do
 
     let(:instance) { Test::Foo.new(:FOO) }
 
-    it "collects coerced params with default values" do
-      expect(subject).to eq({ foo: "FOO", bar: 1 })
+    it 'collects coerced params with default values' do
+      expect(subject).to eq({ foo: 'FOO', bar: 1 })
     end
   end
 
-  context "when class has options" do
+  context 'when class has options' do
     before do
       class Test::Foo
         extend Dry::Initializer
@@ -31,8 +31,8 @@ describe Dry::Initializer, "dry_initializer.attributes" do
 
     let(:instance) { Test::Foo.new(foo: :FOO, qux: :QUX) }
 
-    it "collects coerced and renamed options with default values" do
-      expect(subject).to eq({ foo: :FOO, bar: 1, quxx: "QUX" })
+    it 'collects coerced and renamed options with default values' do
+      expect(subject).to eq({ foo: :FOO, bar: 1, quxx: 'QUX' })
     end
   end
 end

data/spec/coercion_of_nil_spec.rb

@@ -0,0 +1,25 @@
+describe 'coercion of nil' do
+  before do
+    class Test::Foo
+      extend Dry::Initializer
+      param :bar, proc(&:to_i)
+    end
+
+    class Test::Baz
+      include Dry::Initializer.define -> do
+        param :qux, proc(&:to_i)
+      end
+    end
+  end
+
+  let(:foo) { Test::Foo.new(nil) }
+  let(:baz) { Test::Baz.new(nil) }
+
+  it 'works with extend syntax' do
+    expect(foo.bar).to eq 0
+  end
+
+  it 'works with include syntax' do
+    expect(baz.qux).to eq 0
+  end
+end

data/spec/custom_dispatchers_spec.rb

@@ -1,12 +1,12 @@
-describe "custom dispatchers" do
-  subject { Test::Foo.new "123" }
+describe 'custom dispatchers' do
+  subject { Test::Foo.new '123' }
 
   before do
     dispatcher = ->(op) { op[:integer] ? op.merge(type: proc(&:to_i)) : op }
     Dry::Initializer::Dispatchers << dispatcher
   end
 
-  context "with extend syntax" do
+  context 'with extend syntax' do
     before do
       class Test::Foo
         extend Dry::Initializer
@@ -14,12 +14,12 @@ describe "custom dispatchers" do
       end
     end
 
-    it "adds syntax sugar" do
+    it 'adds syntax sugar' do
       expect(subject.id).to eq 123
     end
   end
 
-  context "with include syntax" do
+  context 'with include syntax' do
     before do
       class Test::Foo
         include Dry::Initializer.define -> do
@@ -28,7 +28,7 @@ describe "custom dispatchers" do
       end
     end
 
-    it "adds syntax sugar" do
+    it 'adds syntax sugar' do
       expect(subject.id).to eq 123
     end
   end

data/spec/custom_initializer_spec.rb

@@ -1,4 +1,4 @@
-describe "custom initializer" do
+describe 'custom initializer' do
   before do
     class Test::Foo
       extend Dry::Initializer
@@ -21,7 +21,7 @@ describe "custom initializer" do
     end
   end
 
-  it "reloads the initializer" do
+  it 'reloads the initializer' do
     baz = Test::Baz.new(5, 5)
 
     expect(baz.bar).to eq 15 # 5 * 3

data/spec/default_values_spec.rb

@@ -1,4 +1,4 @@
-describe "default values" do
+describe 'default values' do
   before do
     class Test::Foo
       extend Dry::Initializer
@@ -17,7 +17,7 @@ describe "default values" do
     end
   end
 
-  it "instantiate arguments" do
+  it 'instantiate arguments' do
     subject = Test::Foo.new(1, 2, baz: 3, qux: 4)
 
     expect(subject.foo).to eql 1
@@ -26,7 +26,7 @@ describe "default values" do
     expect(subject.qux).to eql 4
   end
 
-  it "applies default values" do
+  it 'applies default values' do
     subject = Test::Foo.new
 
     expect(subject.foo).to eql :FOO
@@ -35,7 +35,7 @@ describe "default values" do
     expect(subject.qux).to eql :FOO
   end
 
-  it "applies default values partially" do
+  it 'applies default values partially' do
     subject = Test::Foo.new 1, baz: 3
 
     expect(subject.foo).to eql 1
@@ -44,12 +44,12 @@ describe "default values" do
     expect(subject.qux).to eql 1
   end
 
-  it "applies default values from private methods" do
+  it 'applies default values from private methods' do
     subject = Test::Foo.new
     expect(subject.mox).to eql :MOX
   end
 
-  describe "when the last param has a default and there are no options" do
+  describe 'when the last param has a default and there are no options' do
     before do
       class Test::Bar
         extend Dry::Initializer
@@ -59,21 +59,21 @@ describe "default values" do
       end
     end
 
-    it "instantiates arguments" do
+    it 'instantiates arguments' do
       subject = Test::Bar.new(1, 2)
 
       expect(subject.foo).to eql 1
       expect(subject.bar).to eql 2
     end
 
-    it "applies default values" do
+    it 'applies default values' do
       subject = Test::Bar.new(1)
 
       expect(subject.foo).to eql 1
       expect(subject.bar).to eql({})
     end
 
-    it "instantiates arguments also if the last is an hash" do
+    it 'instantiates arguments also if the last is an hash' do
       subject = Test::Bar.new(1, { baz: 2, qux: 3 })
 
       expect(subject.foo).to eql 1

data/spec/definition_spec.rb

@@ -1,4 +1,4 @@
-describe "definition" do
+describe 'definition' do
   shared_examples :initializer do |in_context|
     subject { Test::Foo.new(1, bar: 2) }
 
@@ -8,7 +8,7 @@ describe "definition" do
     end
   end
 
-  it_behaves_like :initializer, "extend Dry::Initializer" do
+  it_behaves_like :initializer, 'extend Dry::Initializer' do
     before do
       class Test::Foo
         extend Dry::Initializer
@@ -17,24 +17,28 @@ describe "definition" do
       end
     end
 
-    it "preservers definition params" do
+    it 'preservers definition params' do
       params = Test::Foo.dry_initializer.params.map do |definition|
         [definition.source, definition.options]
       end
 
-      expect(params).to eq [[:foo, { as: :foo, reader: :public }]]
+      expect(params).to eq [
+        [:foo, { as: :foo, reader: :public, optional: false }]
+      ]
     end
 
-    it "preservers definition options" do
+    it 'preservers definition options' do
       options = Test::Foo.dry_initializer.options.map do |definition|
         [definition.source, definition.options]
       end
 
-      expect(options).to eq [[:bar, { as: :bar, reader: :public }]]
+      expect(options).to eq [
+        [:bar, { as: :bar, reader: :public, optional: false }]
+      ]
     end
   end
 
-  it_behaves_like :initializer, "extend Dry::Initializer" do
+  it_behaves_like :initializer, 'extend Dry::Initializer' do
     before do
       class Test::Foo
         extend Dry::Initializer
@@ -44,7 +48,7 @@ describe "definition" do
     end
   end
 
-  it_behaves_like :initializer, "extend Dry::Initializer[undefined: false]" do
+  it_behaves_like :initializer, 'extend Dry::Initializer[undefined: false]' do
     before do
       class Test::Foo
         extend Dry::Initializer[undefined: false]
@@ -54,7 +58,7 @@ describe "definition" do
     end
   end
 
-  it_behaves_like :initializer, "include Dry::Initializer with block" do
+  it_behaves_like :initializer, 'include Dry::Initializer with block' do
     before do
       class Test::Foo
         include(
@@ -67,7 +71,7 @@ describe "definition" do
     end
   end
 
-  it_behaves_like :initializer, "include Dry::Initializer with lambda" do
+  it_behaves_like :initializer, 'include Dry::Initializer with lambda' do
     before do
       class Test::Foo
         include Dry::Initializer.define -> do
@@ -78,7 +82,7 @@ describe "definition" do
     end
   end
 
-  it_behaves_like :initializer, "include Dry::Initializer[undefined: false]" do
+  it_behaves_like :initializer, 'include Dry::Initializer[undefined: false]' do
     before do
       class Test::Foo
         include(
@@ -92,7 +96,7 @@ describe "definition" do
   end
 
   # @deprecated
-  it_behaves_like :initializer, "include Dry::Initializer::Mixin" do
+  it_behaves_like :initializer, 'include Dry::Initializer::Mixin' do
     before do
       class Test::Foo
         include(