dry-initializer 3.0.2

data/spec/several_assignments_spec.rb

@@ -0,0 +1,41 @@
+describe "attribute with several assignments" do
+  before do
+    class Test::Foo
+      extend Dry::Initializer
+
+      option :bar, proc(&:to_s),    optional: true
+      option :"some foo", as: :bar, optional: true
+    end
+  end
+
+  context "when not defined" do
+    subject { Test::Foo.new }
+
+    it "is left undefined" do
+      expect(subject.bar).to be_nil
+      expect(subject.instance_variable_get :@bar)
+        .to eq Dry::Initializer::UNDEFINED
+    end
+  end
+
+  context "when set directly" do
+    subject { Test::Foo.new bar: :BAZ }
+
+    it "sets the attribute" do
+      expect(subject.bar).to eq "BAZ"
+    end
+  end
+
+  context "when renamed" do
+    subject { Test::Foo.new "some foo": :BAZ }
+
+    it "renames the attribute" do
+      expect(subject.bar).to eq :BAZ
+      expect(subject).not_to respond_to :foo
+    end
+
+    it "renames the variable" do
+      expect(subject.instance_variable_get(:@bar)).to eq :BAZ
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+if ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+
+require "dry/initializer"
+
+begin
+  require "pry"
+rescue LoadError
+  nil
+end
+
+RSpec.configure do |config|
+  config.order = :random
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  # Prepare the Test namespace for constants defined in specs
+  config.around(:each) do |example|
+    Test = Class.new(Module)
+    example.run
+    Object.send :remove_const, :Test
+  end
+
+  config.warnings = true
+end

data/spec/subclassing_spec.rb

@@ -0,0 +1,49 @@
+describe "subclassing" do
+  before do
+    class Test::Foo
+      extend Dry::Initializer[undefined: false]
+      param  :foo
+      option :bar
+    end
+
+    class Test::Bar < Test::Foo
+      param  :baz
+      option :qux
+    end
+  end
+
+  let(:instance_of_superclass) do
+    Test::Foo.new 1, bar: 3
+  end
+
+  let(:instance_of_subclass) do
+    Test::Bar.new 1, 2, bar: 3, qux: 4
+  end
+
+  it "preserves null definition" do
+    expect(Test::Foo.dry_initializer.null).to be_nil
+    expect(Test::Bar.dry_initializer.null).to be_nil
+  end
+
+  it "preserves definitions made in the superclass" do
+    expect(instance_of_subclass.foo).to eql 1
+    expect(instance_of_subclass.baz).to eql 2
+    expect(instance_of_subclass.bar).to eql 3
+    expect(instance_of_subclass.qux).to eql 4
+  end
+
+  it "does not pollute superclass with definitions from subclass" do
+    expect(instance_of_superclass).not_to respond_to :baz
+    expect(instance_of_superclass).not_to respond_to :qux
+  end
+
+  it "calls .inherited hook added by other mixin" do
+    called = false
+    mixin = Module.new { define_method(:inherited) { |_| called = true } }
+
+    base = Class.new { extend mixin; extend Dry::Initializer }
+    Class.new(base)
+
+    expect(called).to be true
+  end
+end

data/spec/type_argument_spec.rb

@@ -0,0 +1,35 @@
+require "dry-types"
+
+describe "type argument" do
+  before do
+    class Test::Foo
+      extend Dry::Initializer
+      param  :foo, Dry::Types["strict.string"]
+      option :bar, Dry::Types["strict.string"]
+    end
+  end
+
+  context "in case of param mismatch" do
+    subject { Test::Foo.new 1, bar: "2" }
+
+    it "raises TypeError" do
+      expect { subject }.to raise_error Dry::Types::ConstraintError, /1/
+    end
+  end
+
+  context "in case of option mismatch" do
+    subject { Test::Foo.new "1", bar: 2 }
+
+    it "raises TypeError" do
+      expect { subject }.to raise_error Dry::Types::ConstraintError, /2/
+    end
+  end
+
+  context "in case of match" do
+    subject { Test::Foo.new "1", bar: "2" }
+
+    it "completes the initialization" do
+      expect { subject }.not_to raise_error
+    end
+  end
+end

data/spec/type_constraint_spec.rb

@@ -0,0 +1,78 @@
+require "dry-types"
+
+describe "type constraint" do
+  context "by a proc with 1 argument" do
+    before do
+      class Test::Foo
+        extend Dry::Initializer
+        param :__foo__, proc(&:to_s), optional: true
+      end
+    end
+
+    subject { Test::Foo.new :foo }
+
+    it "coerces a value" do
+      expect(subject.__foo__).to eq "foo"
+    end
+  end
+
+  context "by a proc with 2 arguments" do
+    before do
+      class Test::Foo
+        extend Dry::Initializer
+        param :foo, proc { |val, obj| "#{obj.hash}:#{val}" }, optional: true
+      end
+    end
+
+    subject { Test::Foo.new :foo }
+
+    it "coerces a value with self as a second argument" do
+      expect(subject.foo).to eq "#{subject.hash}:foo"
+    end
+  end
+
+  context "by dry-type" do
+    before do
+      class Test::Foo
+        extend Dry::Initializer
+        param :foo, Dry::Types["strict.string"], optional: true
+      end
+    end
+
+    context "in case of mismatch" do
+      subject { Test::Foo.new 1 }
+
+      it "raises ArgumentError" do
+        expect { subject }.to raise_error Dry::Types::ConstraintError, /1/
+      end
+    end
+
+    context "in case of match" do
+      subject { Test::Foo.new "foo" }
+
+      it "completes the initialization" do
+        expect { subject }.not_to raise_error
+      end
+    end
+
+    context "if optional value not set" do
+      subject { Test::Foo.new }
+
+      it "not applicable to Dry::Initializer::UNDEFINED" do
+        expect(subject.instance_variable_get(:@foo))
+          .to eq Dry::Initializer::UNDEFINED
+      end
+    end
+  end
+
+  context "by invalid constraint" do
+    it "raises ArgumentError" do
+      expect do
+        class Test::Foo
+          extend Dry::Initializer
+          param :foo, type: String
+        end
+      end.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/value_coercion_via_dry_types_spec.rb

@@ -0,0 +1,29 @@
+require "dry-types"
+
+describe "value coercion via dry-types" do
+  before do
+    module Test::Types
+      include Dry.Types
+    end
+
+    class Test::Foo
+      extend Dry::Initializer
+
+      param  :foo, type: Test::Types::Coercible::String
+      option :bar, proc(&:to_i), default: proc { "16" }
+    end
+  end
+
+  it "coerces assigned values" do
+    subject = Test::Foo.new :foo, bar: "13"
+
+    expect(subject.foo).to eql "foo"
+    expect(subject.bar).to eql 13
+  end
+
+  it "coerces defaults as well" do
+    subject = Test::Foo.new :foo
+
+    expect(subject.bar).to eql 16
+  end
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: dry-initializer
+version: !ruby/object:Gem::Version
+  version: 3.0.2
+platform: ruby
+authors:
+- Vladimir Kochnev (marshall-lee)
+- Andrew Kozin (nepalez)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-06 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
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.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
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+- CHANGELOG.md
+files:
+- ".codeclimate.yml"
+- ".github/ISSUE_TEMPLATE/----please-don-t-ask-for-support-via-issues.md"
+- ".github/ISSUE_TEMPLATE/---bug-report.md"
+- ".github/ISSUE_TEMPLATE/---feature-request.md"
+- ".github/workflows/custom_ci.yml"
+- ".github/workflows/docsite.yml"
+- ".github/workflows/sync_configs.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE
+- LICENSE.txt
+- 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
+- docsite/source/attributes.html.md
+- docsite/source/container-version.html.md
+- docsite/source/index.html.md
+- docsite/source/inheritance.html.md
+- docsite/source/optionals-and-defaults.html.md
+- docsite/source/options-tolerance.html.md
+- docsite/source/params-and-options.html.md
+- docsite/source/rails-support.html.md
+- docsite/source/readers.html.md
+- docsite/source/skip-undefined.html.md
+- docsite/source/type-constraints.html.md
+- dry-initializer.gemspec
+- lib/dry-initializer.rb
+- lib/dry/initializer.rb
+- lib/dry/initializer/builders.rb
+- lib/dry/initializer/builders/attribute.rb
+- lib/dry/initializer/builders/initializer.rb
+- lib/dry/initializer/builders/reader.rb
+- lib/dry/initializer/builders/signature.rb
+- 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/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/list_type_spec.rb
+- spec/missed_default_spec.rb
+- spec/nested_type_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/dry-rb/dry-initializer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+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/list_type_spec.rb
+- spec/missed_default_spec.rb
+- spec/nested_type_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