dry-initializer 3.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.codeclimate.yml +23 -0
- data/.gitignore +10 -0
- data/.rspec +4 -0
- data/.rubocop.yml +51 -0
- data/.travis.yml +28 -0
- data/CHANGELOG.md +883 -0
- data/Gemfile +29 -0
- data/Guardfile +5 -0
- data/LICENSE.txt +21 -0
- data/README.md +90 -0
- data/Rakefile +8 -0
- data/benchmarks/compare_several_defaults.rb +82 -0
- data/benchmarks/plain_options.rb +63 -0
- data/benchmarks/plain_params.rb +84 -0
- data/benchmarks/with_coercion.rb +71 -0
- data/benchmarks/with_defaults.rb +66 -0
- data/benchmarks/with_defaults_and_coercion.rb +59 -0
- data/dry-initializer.gemspec +20 -0
- data/lib/dry-initializer.rb +1 -0
- data/lib/dry/initializer.rb +61 -0
- data/lib/dry/initializer/builders.rb +7 -0
- data/lib/dry/initializer/builders/attribute.rb +81 -0
- data/lib/dry/initializer/builders/initializer.rb +61 -0
- data/lib/dry/initializer/builders/reader.rb +50 -0
- data/lib/dry/initializer/builders/signature.rb +32 -0
- data/lib/dry/initializer/config.rb +184 -0
- data/lib/dry/initializer/definition.rb +65 -0
- data/lib/dry/initializer/dispatchers.rb +112 -0
- data/lib/dry/initializer/dispatchers/build_nested_type.rb +59 -0
- data/lib/dry/initializer/dispatchers/check_type.rb +43 -0
- data/lib/dry/initializer/dispatchers/prepare_default.rb +40 -0
- data/lib/dry/initializer/dispatchers/prepare_ivar.rb +12 -0
- data/lib/dry/initializer/dispatchers/prepare_optional.rb +13 -0
- data/lib/dry/initializer/dispatchers/prepare_reader.rb +30 -0
- data/lib/dry/initializer/dispatchers/prepare_source.rb +28 -0
- data/lib/dry/initializer/dispatchers/prepare_target.rb +44 -0
- data/lib/dry/initializer/dispatchers/unwrap_type.rb +22 -0
- data/lib/dry/initializer/dispatchers/wrap_type.rb +27 -0
- data/lib/dry/initializer/dsl.rb +43 -0
- data/lib/dry/initializer/mixin.rb +15 -0
- data/lib/dry/initializer/mixin/local.rb +19 -0
- data/lib/dry/initializer/mixin/root.rb +10 -0
- data/lib/dry/initializer/struct.rb +40 -0
- data/lib/dry/initializer/undefined.rb +2 -0
- data/lib/tasks/benchmark.rake +41 -0
- data/lib/tasks/profile.rake +78 -0
- data/spec/attributes_spec.rb +38 -0
- data/spec/coercion_of_nil_spec.rb +25 -0
- data/spec/custom_dispatchers_spec.rb +35 -0
- data/spec/custom_initializer_spec.rb +30 -0
- data/spec/default_values_spec.rb +83 -0
- data/spec/definition_spec.rb +111 -0
- data/spec/invalid_default_spec.rb +13 -0
- data/spec/list_type_spec.rb +32 -0
- data/spec/missed_default_spec.rb +14 -0
- data/spec/nested_type_spec.rb +44 -0
- data/spec/optional_spec.rb +71 -0
- data/spec/options_tolerance_spec.rb +11 -0
- data/spec/public_attributes_utility_spec.rb +22 -0
- data/spec/reader_spec.rb +87 -0
- data/spec/repetitive_definitions_spec.rb +69 -0
- data/spec/several_assignments_spec.rb +41 -0
- data/spec/spec_helper.rb +22 -0
- data/spec/subclassing_spec.rb +49 -0
- data/spec/type_argument_spec.rb +35 -0
- data/spec/type_constraint_spec.rb +78 -0
- data/spec/value_coercion_via_dry_types_spec.rb +29 -0
- metadata +189 -0
@@ -0,0 +1,22 @@
|
|
1
|
+
describe Dry::Initializer, ".dry_initializer.public_attributes" do
|
2
|
+
subject { instance.class.dry_initializer.public_attributes(instance) }
|
3
|
+
|
4
|
+
context "when class has params" do
|
5
|
+
before do
|
6
|
+
class Test::Foo
|
7
|
+
extend Dry::Initializer
|
8
|
+
param :foo, proc(&:to_s), desc: "a weird parameter"
|
9
|
+
option :moo, optional: true
|
10
|
+
option :bar, default: proc { 1 }, reader: false
|
11
|
+
option :baz, optional: true, reader: :protected
|
12
|
+
option :qux, proc(&:to_s), as: :quxx, reader: :private
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
let(:instance) { Test::Foo.new(:FOO, bar: :BAR, baz: :BAZ, qux: :QUX) }
|
17
|
+
|
18
|
+
it "collects public options only" do
|
19
|
+
expect(subject).to eq({ foo: "FOO", moo: nil })
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
data/spec/reader_spec.rb
ADDED
@@ -0,0 +1,87 @@
|
|
1
|
+
describe "reader" do
|
2
|
+
shared_examples "it has no public attr_reader" do
|
3
|
+
it "does not define a public attr_reader" do
|
4
|
+
expect(subject).not_to respond_to :foo
|
5
|
+
expect(subject).not_to respond_to :bar
|
6
|
+
end
|
7
|
+
end
|
8
|
+
|
9
|
+
context "with reader: :public or no reader: option" do
|
10
|
+
subject do
|
11
|
+
class Test::Foo
|
12
|
+
extend Dry::Initializer
|
13
|
+
|
14
|
+
param :foo
|
15
|
+
param :foo2, reader: :public
|
16
|
+
option :bar
|
17
|
+
option :bar2, reader: :public
|
18
|
+
end
|
19
|
+
|
20
|
+
Test::Foo.new 1, 2, bar: 3, bar2: 4
|
21
|
+
end
|
22
|
+
|
23
|
+
it "defines a public attr_reader by default" do
|
24
|
+
expect(subject).to respond_to(:foo, :foo2)
|
25
|
+
expect(subject).to respond_to :bar
|
26
|
+
expect(subject).to respond_to :bar2
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
context "with reader: false" do
|
31
|
+
before do
|
32
|
+
class Test::Foo
|
33
|
+
extend Dry::Initializer
|
34
|
+
|
35
|
+
param :foo, reader: false
|
36
|
+
option :bar, reader: false
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
subject { Test::Foo.new 1, bar: 2 }
|
41
|
+
|
42
|
+
it_behaves_like "it has no public attr_reader"
|
43
|
+
|
44
|
+
it "keeps assigning variables" do
|
45
|
+
expect(subject.instance_variable_get(:@foo)).to eql 1
|
46
|
+
expect(subject.instance_variable_get(:@bar)).to eql 2
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
50
|
+
context "with reader: :private" do
|
51
|
+
before do
|
52
|
+
class Test::Foo
|
53
|
+
extend Dry::Initializer
|
54
|
+
|
55
|
+
param :foo, reader: :private
|
56
|
+
option :bar, reader: :private
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
subject { Test::Foo.new 1, bar: 2 }
|
61
|
+
|
62
|
+
it_behaves_like "it has no public attr_reader"
|
63
|
+
|
64
|
+
it "adds a private attr_reader" do
|
65
|
+
expect(subject.send(:foo)).to eql 1
|
66
|
+
expect(subject.send(:bar)).to eql 2
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
context "with reader: :protected" do
|
71
|
+
subject do
|
72
|
+
class Test::Foo
|
73
|
+
extend Dry::Initializer
|
74
|
+
|
75
|
+
param :foo, reader: :protected
|
76
|
+
option :bar, reader: :protected
|
77
|
+
end
|
78
|
+
|
79
|
+
Test::Foo.new 1, bar: 2
|
80
|
+
end
|
81
|
+
|
82
|
+
it "adds a protected attr_reader" do
|
83
|
+
protected_instance_methods = subject.class.protected_instance_methods
|
84
|
+
expect(protected_instance_methods).to match_array(%i[foo bar])
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
@@ -0,0 +1,69 @@
|
|
1
|
+
describe "repetitive definitions" do
|
2
|
+
subject { Test::Foo.new }
|
3
|
+
|
4
|
+
context "of params" do
|
5
|
+
before do
|
6
|
+
class Test::Foo
|
7
|
+
extend Dry::Initializer
|
8
|
+
|
9
|
+
param :foo, default: proc { 0 }
|
10
|
+
param :bar, default: proc { 1 }
|
11
|
+
param :foo, default: proc { 2 }
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
it "reloads the attribute" do
|
16
|
+
expect(subject.foo).to eq 2
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
context "of options" do
|
21
|
+
before do
|
22
|
+
class Test::Foo
|
23
|
+
extend Dry::Initializer
|
24
|
+
|
25
|
+
option :foo, default: proc { 0 }
|
26
|
+
option :bar, default: proc { 1 }
|
27
|
+
option :foo, default: proc { 2 }
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
it "reloads the attribute" do
|
32
|
+
expect(subject.foo).to eq 2
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
context "of param and option" do
|
37
|
+
before do
|
38
|
+
class Test::Foo
|
39
|
+
extend Dry::Initializer
|
40
|
+
|
41
|
+
param :foo, default: proc { 0 }
|
42
|
+
option :bar, default: proc { 1 }
|
43
|
+
option :foo, default: proc { 2 }
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
it "reloads the attribute" do
|
48
|
+
expect(subject.foo).to eq 2
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
context "of optional param and option" do
|
53
|
+
before do
|
54
|
+
class Test::Foo
|
55
|
+
extend Dry::Initializer
|
56
|
+
|
57
|
+
param :baz, optional: true, as: :foo
|
58
|
+
option :bar, optional: true
|
59
|
+
option :foo, optional: true
|
60
|
+
end
|
61
|
+
end
|
62
|
+
|
63
|
+
it "allows various assignments" do
|
64
|
+
expect(Test::Foo.new(1).foo).to eq 1
|
65
|
+
expect(Test::Foo.new(foo: 2).foo).to eq 2
|
66
|
+
expect(Test::Foo.new(1, foo: 2).foo).to eq 2
|
67
|
+
end
|
68
|
+
end
|
69
|
+
end
|
@@ -0,0 +1,41 @@
|
|
1
|
+
describe "attribute with several assignments" do
|
2
|
+
before do
|
3
|
+
class Test::Foo
|
4
|
+
extend Dry::Initializer
|
5
|
+
|
6
|
+
option :bar, proc(&:to_s), optional: true
|
7
|
+
option :"some foo", as: :bar, optional: true
|
8
|
+
end
|
9
|
+
end
|
10
|
+
|
11
|
+
context "when not defined" do
|
12
|
+
subject { Test::Foo.new }
|
13
|
+
|
14
|
+
it "is left undefined" do
|
15
|
+
expect(subject.bar).to be_nil
|
16
|
+
expect(subject.instance_variable_get :@bar)
|
17
|
+
.to eq Dry::Initializer::UNDEFINED
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
context "when set directly" do
|
22
|
+
subject { Test::Foo.new bar: :BAZ }
|
23
|
+
|
24
|
+
it "sets the attribute" do
|
25
|
+
expect(subject.bar).to eq "BAZ"
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
context "when renamed" do
|
30
|
+
subject { Test::Foo.new "some foo": :BAZ }
|
31
|
+
|
32
|
+
it "renames the attribute" do
|
33
|
+
expect(subject.bar).to eq :BAZ
|
34
|
+
expect(subject).not_to respond_to :foo
|
35
|
+
end
|
36
|
+
|
37
|
+
it "renames the variable" do
|
38
|
+
expect(subject.instance_variable_get(:@bar)).to eq :BAZ
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
data/spec/spec_helper.rb
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
require "dry/initializer"
|
2
|
+
|
3
|
+
begin
|
4
|
+
require "pry"
|
5
|
+
rescue LoadError
|
6
|
+
nil
|
7
|
+
end
|
8
|
+
|
9
|
+
RSpec.configure do |config|
|
10
|
+
config.order = :random
|
11
|
+
config.filter_run focus: true
|
12
|
+
config.run_all_when_everything_filtered = true
|
13
|
+
|
14
|
+
# Prepare the Test namespace for constants defined in specs
|
15
|
+
config.around(:each) do |example|
|
16
|
+
Test = Class.new(Module)
|
17
|
+
example.run
|
18
|
+
Object.send :remove_const, :Test
|
19
|
+
end
|
20
|
+
|
21
|
+
config.warnings = true
|
22
|
+
end
|
@@ -0,0 +1,49 @@
|
|
1
|
+
describe "subclassing" do
|
2
|
+
before do
|
3
|
+
class Test::Foo
|
4
|
+
extend Dry::Initializer[undefined: false]
|
5
|
+
param :foo
|
6
|
+
option :bar
|
7
|
+
end
|
8
|
+
|
9
|
+
class Test::Bar < Test::Foo
|
10
|
+
param :baz
|
11
|
+
option :qux
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
let(:instance_of_superclass) do
|
16
|
+
Test::Foo.new 1, bar: 3
|
17
|
+
end
|
18
|
+
|
19
|
+
let(:instance_of_subclass) do
|
20
|
+
Test::Bar.new 1, 2, bar: 3, qux: 4
|
21
|
+
end
|
22
|
+
|
23
|
+
it "preserves null definition" do
|
24
|
+
expect(Test::Foo.dry_initializer.null).to be_nil
|
25
|
+
expect(Test::Bar.dry_initializer.null).to be_nil
|
26
|
+
end
|
27
|
+
|
28
|
+
it "preserves definitions made in the superclass" do
|
29
|
+
expect(instance_of_subclass.foo).to eql 1
|
30
|
+
expect(instance_of_subclass.baz).to eql 2
|
31
|
+
expect(instance_of_subclass.bar).to eql 3
|
32
|
+
expect(instance_of_subclass.qux).to eql 4
|
33
|
+
end
|
34
|
+
|
35
|
+
it "does not pollute superclass with definitions from subclass" do
|
36
|
+
expect(instance_of_superclass).not_to respond_to :baz
|
37
|
+
expect(instance_of_superclass).not_to respond_to :qux
|
38
|
+
end
|
39
|
+
|
40
|
+
it "calls .inherited hook added by other mixin" do
|
41
|
+
called = false
|
42
|
+
mixin = Module.new { define_method(:inherited) { |_| called = true } }
|
43
|
+
|
44
|
+
base = Class.new { extend mixin; extend Dry::Initializer }
|
45
|
+
Class.new(base)
|
46
|
+
|
47
|
+
expect(called).to be true
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,35 @@
|
|
1
|
+
require "dry-types"
|
2
|
+
|
3
|
+
describe "type argument" do
|
4
|
+
before do
|
5
|
+
class Test::Foo
|
6
|
+
extend Dry::Initializer
|
7
|
+
param :foo, Dry::Types["strict.string"]
|
8
|
+
option :bar, Dry::Types["strict.string"]
|
9
|
+
end
|
10
|
+
end
|
11
|
+
|
12
|
+
context "in case of param mismatch" do
|
13
|
+
subject { Test::Foo.new 1, bar: "2" }
|
14
|
+
|
15
|
+
it "raises TypeError" do
|
16
|
+
expect { subject }.to raise_error TypeError, /1/
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
context "in case of option mismatch" do
|
21
|
+
subject { Test::Foo.new "1", bar: 2 }
|
22
|
+
|
23
|
+
it "raises TypeError" do
|
24
|
+
expect { subject }.to raise_error TypeError, /2/
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
context "in case of match" do
|
29
|
+
subject { Test::Foo.new "1", bar: "2" }
|
30
|
+
|
31
|
+
it "completes the initialization" do
|
32
|
+
expect { subject }.not_to raise_error
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
@@ -0,0 +1,78 @@
|
|
1
|
+
require "dry-types"
|
2
|
+
|
3
|
+
describe "type constraint" do
|
4
|
+
context "by a proc with 1 argument" do
|
5
|
+
before do
|
6
|
+
class Test::Foo
|
7
|
+
extend Dry::Initializer
|
8
|
+
param :__foo__, proc(&:to_s), optional: true
|
9
|
+
end
|
10
|
+
end
|
11
|
+
|
12
|
+
subject { Test::Foo.new :foo }
|
13
|
+
|
14
|
+
it "coerces a value" do
|
15
|
+
expect(subject.__foo__).to eq "foo"
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
19
|
+
context "by a proc with 2 arguments" do
|
20
|
+
before do
|
21
|
+
class Test::Foo
|
22
|
+
extend Dry::Initializer
|
23
|
+
param :foo, proc { |val, obj| "#{obj.hash}:#{val}" }, optional: true
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
27
|
+
subject { Test::Foo.new :foo }
|
28
|
+
|
29
|
+
it "coerces a value with self as a second argument" do
|
30
|
+
expect(subject.foo).to eq "#{subject.hash}:foo"
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
context "by dry-type" do
|
35
|
+
before do
|
36
|
+
class Test::Foo
|
37
|
+
extend Dry::Initializer
|
38
|
+
param :foo, Dry::Types["strict.string"], optional: true
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
context "in case of mismatch" do
|
43
|
+
subject { Test::Foo.new 1 }
|
44
|
+
|
45
|
+
it "raises ArgumentError" do
|
46
|
+
expect { subject }.to raise_error TypeError, /1/
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
50
|
+
context "in case of match" do
|
51
|
+
subject { Test::Foo.new "foo" }
|
52
|
+
|
53
|
+
it "completes the initialization" do
|
54
|
+
expect { subject }.not_to raise_error
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
context "if optional value not set" do
|
59
|
+
subject { Test::Foo.new }
|
60
|
+
|
61
|
+
it "not applicable to Dry::Initializer::UNDEFINED" do
|
62
|
+
expect(subject.instance_variable_get(:@foo))
|
63
|
+
.to eq Dry::Initializer::UNDEFINED
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
context "by invalid constraint" do
|
69
|
+
it "raises ArgumentError" do
|
70
|
+
expect do
|
71
|
+
class Test::Foo
|
72
|
+
extend Dry::Initializer
|
73
|
+
param :foo, type: String
|
74
|
+
end
|
75
|
+
end.to raise_error(ArgumentError)
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
@@ -0,0 +1,29 @@
|
|
1
|
+
require "dry-types"
|
2
|
+
|
3
|
+
describe "value coercion via dry-types" do
|
4
|
+
before do
|
5
|
+
module Test::Types
|
6
|
+
include Dry::Types.module
|
7
|
+
end
|
8
|
+
|
9
|
+
class Test::Foo
|
10
|
+
extend Dry::Initializer
|
11
|
+
|
12
|
+
param :foo, type: Test::Types::Coercible::String
|
13
|
+
option :bar, proc(&:to_i), default: proc { "16" }
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
it "coerces assigned values" do
|
18
|
+
subject = Test::Foo.new :foo, bar: "13"
|
19
|
+
|
20
|
+
expect(subject.foo).to eql "foo"
|
21
|
+
expect(subject.bar).to eql 13
|
22
|
+
end
|
23
|
+
|
24
|
+
it "coerces defaults as well" do
|
25
|
+
subject = Test::Foo.new :foo
|
26
|
+
|
27
|
+
expect(subject.bar).to eql 16
|
28
|
+
end
|
29
|
+
end
|