dry-initializer 3.0.1 → 3.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (72) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +259 -242
  3. data/LICENSE +20 -0
  4. data/README.md +18 -78
  5. data/dry-initializer.gemspec +34 -19
  6. data/lib/dry/initializer/builders/attribute.rb +84 -69
  7. data/lib/dry/initializer/builders/initializer.rb +56 -58
  8. data/lib/dry/initializer/builders/reader.rb +55 -47
  9. data/lib/dry/initializer/builders/signature.rb +29 -23
  10. data/lib/dry/initializer/builders.rb +9 -5
  11. data/lib/dry/initializer/config.rb +162 -158
  12. data/lib/dry/initializer/definition.rb +58 -54
  13. data/lib/dry/initializer/dispatchers/build_nested_type.rb +54 -40
  14. data/lib/dry/initializer/dispatchers/check_type.rb +45 -39
  15. data/lib/dry/initializer/dispatchers/prepare_default.rb +32 -25
  16. data/lib/dry/initializer/dispatchers/prepare_ivar.rb +13 -6
  17. data/lib/dry/initializer/dispatchers/prepare_optional.rb +14 -7
  18. data/lib/dry/initializer/dispatchers/prepare_reader.rb +29 -22
  19. data/lib/dry/initializer/dispatchers/prepare_source.rb +12 -5
  20. data/lib/dry/initializer/dispatchers/prepare_target.rb +44 -37
  21. data/lib/dry/initializer/dispatchers/unwrap_type.rb +21 -10
  22. data/lib/dry/initializer/dispatchers/wrap_type.rb +25 -17
  23. data/lib/dry/initializer/dispatchers.rb +48 -43
  24. data/lib/dry/initializer/dsl.rb +42 -34
  25. data/lib/dry/initializer/errors.rb +22 -0
  26. data/lib/dry/initializer/mixin/local.rb +19 -13
  27. data/lib/dry/initializer/mixin/root.rb +12 -6
  28. data/lib/dry/initializer/mixin.rb +17 -12
  29. data/lib/dry/initializer/struct.rb +34 -30
  30. data/lib/dry/initializer/undefined.rb +7 -1
  31. data/lib/dry/initializer/version.rb +7 -0
  32. data/lib/dry/initializer.rb +3 -0
  33. data/lib/dry-initializer.rb +2 -0
  34. data/lib/tasks/benchmark.rake +2 -0
  35. data/lib/tasks/profile.rake +4 -0
  36. metadata +27 -106
  37. data/.codeclimate.yml +0 -23
  38. data/.gitignore +0 -10
  39. data/.rspec +0 -4
  40. data/.rubocop.yml +0 -51
  41. data/.travis.yml +0 -28
  42. data/Gemfile +0 -29
  43. data/Guardfile +0 -5
  44. data/LICENSE.txt +0 -21
  45. data/Rakefile +0 -8
  46. data/benchmarks/compare_several_defaults.rb +0 -82
  47. data/benchmarks/plain_options.rb +0 -63
  48. data/benchmarks/plain_params.rb +0 -84
  49. data/benchmarks/with_coercion.rb +0 -71
  50. data/benchmarks/with_defaults.rb +0 -66
  51. data/benchmarks/with_defaults_and_coercion.rb +0 -59
  52. data/spec/attributes_spec.rb +0 -38
  53. data/spec/coercion_of_nil_spec.rb +0 -25
  54. data/spec/custom_dispatchers_spec.rb +0 -35
  55. data/spec/custom_initializer_spec.rb +0 -30
  56. data/spec/default_values_spec.rb +0 -83
  57. data/spec/definition_spec.rb +0 -111
  58. data/spec/invalid_default_spec.rb +0 -13
  59. data/spec/list_type_spec.rb +0 -32
  60. data/spec/missed_default_spec.rb +0 -14
  61. data/spec/nested_type_spec.rb +0 -44
  62. data/spec/optional_spec.rb +0 -71
  63. data/spec/options_tolerance_spec.rb +0 -11
  64. data/spec/public_attributes_utility_spec.rb +0 -22
  65. data/spec/reader_spec.rb +0 -87
  66. data/spec/repetitive_definitions_spec.rb +0 -69
  67. data/spec/several_assignments_spec.rb +0 -41
  68. data/spec/spec_helper.rb +0 -22
  69. data/spec/subclassing_spec.rb +0 -49
  70. data/spec/type_argument_spec.rb +0 -35
  71. data/spec/type_constraint_spec.rb +0 -78
  72. data/spec/value_coercion_via_dry_types_spec.rb +0 -29
@@ -1,111 +0,0 @@
1
- describe "definition" do
2
- shared_examples :initializer do |in_context|
3
- subject { Test::Foo.new(1, bar: 2) }
4
-
5
- it "sets variables when defined via `#{in_context}`" do
6
- expect(subject.instance_variable_get(:@foo)).to eql 1
7
- expect(subject.instance_variable_get(:@bar)).to eql 2
8
- end
9
- end
10
-
11
- it_behaves_like :initializer, "extend Dry::Initializer" do
12
- before do
13
- class Test::Foo
14
- extend Dry::Initializer
15
- param :foo
16
- option :bar
17
- end
18
- end
19
-
20
- it "preservers definition params" do
21
- params = Test::Foo.dry_initializer.params.map do |definition|
22
- [definition.source, definition.options]
23
- end
24
-
25
- expect(params).to eq [
26
- [:foo, { as: :foo, reader: :public, optional: false }]
27
- ]
28
- end
29
-
30
- it "preservers definition options" do
31
- options = Test::Foo.dry_initializer.options.map do |definition|
32
- [definition.source, definition.options]
33
- end
34
-
35
- expect(options).to eq [
36
- [:bar, { as: :bar, reader: :public, optional: false }]
37
- ]
38
- end
39
- end
40
-
41
- it_behaves_like :initializer, "extend Dry::Initializer" do
42
- before do
43
- class Test::Foo
44
- extend Dry::Initializer
45
- param :foo
46
- option :bar
47
- end
48
- end
49
- end
50
-
51
- it_behaves_like :initializer, "extend Dry::Initializer[undefined: false]" do
52
- before do
53
- class Test::Foo
54
- extend Dry::Initializer[undefined: false]
55
- param :foo
56
- option :bar
57
- end
58
- end
59
- end
60
-
61
- it_behaves_like :initializer, "include Dry::Initializer with block" do
62
- before do
63
- class Test::Foo
64
- include(
65
- Dry::Initializer.define do
66
- param :foo
67
- option :bar
68
- end
69
- )
70
- end
71
- end
72
- end
73
-
74
- it_behaves_like :initializer, "include Dry::Initializer with lambda" do
75
- before do
76
- class Test::Foo
77
- include Dry::Initializer.define -> do
78
- param :foo
79
- option :bar
80
- end
81
- end
82
- end
83
- end
84
-
85
- it_behaves_like :initializer, "include Dry::Initializer[undefined: false]" do
86
- before do
87
- class Test::Foo
88
- include(
89
- Dry::Initializer[undefined: false].define do
90
- param :foo
91
- option :bar
92
- end
93
- )
94
- end
95
- end
96
- end
97
-
98
- # @deprecated
99
- it_behaves_like :initializer, "include Dry::Initializer::Mixin" do
100
- before do
101
- class Test::Foo
102
- include(
103
- Dry::Initializer::Mixin.define do
104
- param :foo
105
- option :bar
106
- end
107
- )
108
- end
109
- end
110
- end
111
- end
@@ -1,13 +0,0 @@
1
- describe "invalid default value assignment" do
2
- subject do
3
- class Test::Foo
4
- extend Dry::Initializer
5
-
6
- param :foo, default: 1
7
- end
8
- end
9
-
10
- it "raises TypeError" do
11
- expect { subject }.to raise_error TypeError
12
- end
13
- end
@@ -1,32 +0,0 @@
1
- require "dry-types"
2
-
3
- describe "list type argument" do
4
- before do
5
- class Test::Foo
6
- extend Dry::Initializer
7
- param :foo, [proc(&:to_s)]
8
- option :bar, [Dry::Types["strict.string"]]
9
- option :baz, []
10
- end
11
- end
12
-
13
- context "with single items" do
14
- subject { Test::Foo.new(1, bar: "2", baz: { qux: :QUX }) }
15
-
16
- it "coerces and wraps them to arrays" do
17
- expect(subject.foo).to eq %w[1]
18
- expect(subject.bar).to eq %w[2]
19
- expect(subject.baz).to eq [{ qux: :QUX }]
20
- end
21
- end
22
-
23
- context "with arrays" do
24
- subject { Test::Foo.new([1], bar: %w[2], baz: [{ qux: :QUX }]) }
25
-
26
- it "coerces elements" do
27
- expect(subject.foo).to eq %w[1]
28
- expect(subject.bar).to eq %w[2]
29
- expect(subject.baz).to eq [{ qux: :QUX }]
30
- end
31
- end
32
- end
@@ -1,14 +0,0 @@
1
- describe "missed default values" do
2
- subject do
3
- class Test::Foo
4
- extend Dry::Initializer
5
-
6
- param :foo, default: proc { :FOO }
7
- param :bar, required: true
8
- end
9
- end
10
-
11
- it "raises SyntaxError" do
12
- expect { subject }.to raise_error SyntaxError, /bar/
13
- end
14
- end
@@ -1,44 +0,0 @@
1
- describe "nested type argument" do
2
- subject { Test::Xyz.new("bar" => { "baz" => 42 }) }
3
-
4
- context "with nested definition only" do
5
- before do
6
- class Test::Xyz
7
- extend Dry::Initializer
8
-
9
- param :foo, as: :x do
10
- option :bar, as: :y do
11
- option :baz, proc(&:to_s), as: :z
12
- option :qux, as: :w, optional: true
13
- end
14
- end
15
- end
16
- end
17
-
18
- it "builds the type" do
19
- expect(subject.x.y.z).to eq "42"
20
- end
21
- end
22
-
23
- context "with nested and wrapped definitions" do
24
- before do
25
- class Test::Xyz
26
- extend Dry::Initializer
27
-
28
- param :foo, [], as: :x do
29
- option :bar, as: :y do
30
- option :baz, proc(&:to_s), as: :z
31
- option :qux, as: :w, optional: true
32
- end
33
- end
34
- end
35
- end
36
-
37
- it "builds the type" do
38
- x = subject.x
39
- expect(x).to be_instance_of Array
40
-
41
- expect(x.first.y.z).to eq "42"
42
- end
43
- end
44
- end
@@ -1,71 +0,0 @@
1
- describe "optional value" do
2
- context "when has no default value" do
3
- before do
4
- class Test::Foo
5
- extend Dry::Initializer
6
-
7
- param :foo
8
- param :bar, optional: true
9
- end
10
- end
11
-
12
- it "quacks like nil" do
13
- subject = Test::Foo.new(1)
14
-
15
- expect(subject.bar).to eq nil
16
- end
17
-
18
- it "keeps info about been UNDEFINED" do
19
- subject = Test::Foo.new(1)
20
-
21
- expect(subject.instance_variable_get(:@bar))
22
- .to eq Dry::Initializer::UNDEFINED
23
- end
24
-
25
- it "can be set explicitly" do
26
- subject = Test::Foo.new(1, "qux")
27
-
28
- expect(subject.bar).to eq "qux"
29
- end
30
- end
31
-
32
- context "with undefined: false" do
33
- before do
34
- class Test::Foo
35
- extend Dry::Initializer[undefined: false]
36
-
37
- param :foo
38
- param :bar, optional: true
39
- end
40
- end
41
-
42
- it "sets undefined values to nil" do
43
- subject = Test::Foo.new(1)
44
-
45
- expect(subject.instance_variable_get(:@bar)).to be_nil
46
- end
47
- end
48
-
49
- context "when has a default value" do
50
- before do
51
- class Test::Foo
52
- extend Dry::Initializer
53
-
54
- param :foo
55
- param :bar, optional: true, default: proc { "baz" }
56
- end
57
- end
58
-
59
- it "is takes default value" do
60
- subject = Test::Foo.new(1)
61
-
62
- expect(subject.bar).to eq "baz"
63
- end
64
-
65
- it "can be set explicitly" do
66
- subject = Test::Foo.new(1, "qux")
67
-
68
- expect(subject.bar).to eq "qux"
69
- end
70
- end
71
- end
@@ -1,11 +0,0 @@
1
- describe "options tolerance" do
2
- before do
3
- class Test::Foo
4
- extend Dry::Initializer
5
- end
6
- end
7
-
8
- it "allows options before any definition" do
9
- expect { Test::Foo.new bar: :baz }.not_to raise_error
10
- end
11
- end
@@ -1,22 +0,0 @@
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 DELETED
@@ -1,87 +0,0 @@
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
@@ -1,69 +0,0 @@
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
@@ -1,41 +0,0 @@
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 DELETED
@@ -1,22 +0,0 @@
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
@@ -1,49 +0,0 @@
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
@@ -1,35 +0,0 @@
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