opto-model 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 1fc7b5de1ee0451180c3feaff2750f695a26d5bf
4
+ data.tar.gz: 543ccd54e891ada07f9ab714b0aea8eba9e3d64d
5
+ SHA512:
6
+ metadata.gz: b0f32f636e27fecddc30cd3e92f48819d8ae6328694d0571fd5f062bd5c7839977691d9a6eec1c6a437f7c715f19fd4b4b16b5314bec16b4922516a16ba24840
7
+ data.tar.gz: a6916ed85314f65bd798c744f75e8b92254fd51eabe74d5f46cad492a7b4890608a142df3a4b88432877a6108011c6de47ef795fa51327f21748b4ae3a3a71e4
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,21 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.0.0-p648
4
+ - 2.1.8
5
+ - 2.2.3
6
+ - 2.3.1
7
+ - 2.3.3
8
+ - 2.4.0-preview3
9
+ - jruby-9.1.5.0
10
+ env:
11
+ - secure: "l6a3qDbzbCGmVuIcIq2n5rOCUztdumytt4mK/TkUIcCv36ZfYSlF1uWgFfPGg1vPsVFn6bexBL09/7RGMJl4iVyorluOJiwMxKixuOes6VHfuoi/fqW3yxFXL4tdWscAN6HfUtbCByxiH6BnbEKRuhr/C/crhNkZDnsT9GdBVOep9xYJ3L5T9cjWbceH1wk8+8i4OuchMwXPyh5Ybf3KsRqebN+IACSQW64OAgyYIncGVPOobo7Wm7/aNT/rN6MuA7gB9r4QWg17kbeP3V6Rc/G0R1P8vlJg7vq4tHMvEmuFtGF2UTAxQV8/C1AWrfdwonG3GWd0kFT8MDCW+vXvwavsiS5Ke5O7IvXqyhb0HzKTGVB3WqyQNJEVaCaHW+0JRO3mijVQFTfqfAScSF1nDpYsNkX0RhO8El58cNDPG8JcR8TMDyOIH/qbcF9RDNE3n/Es/QaTk8j+5ZTZffTFLQ+LogEnBRa3xUeb8FX23gmTk8a7sfkNpuQ9eRxl7nCCFBYWoe9viBpUsXiuGw1O+gSQAQjV/BcTopMLU6mpIf+1hLu5lUe+9mFvpzlyfXO+t8C7c9AF8g5h4lUPG/P5NsfS5OOWURxguIsBicaNro/D4S+HTQ+A47q9vy5vzIa05vYZ0rXYzczZs6J0ffSXN0Ns0h+L35s36TuXazHdGbY="
12
+ before_install: gem install bundler -v 1.12.5
13
+ cache: bundler
14
+ script: bundle install && bundle exec rspec spec/
15
+ deploy:
16
+ provider: rubygems
17
+ api_key: $GEM_TOKEN
18
+ gem: opto-model
19
+ on:
20
+ tags: true
21
+ rvm: 2.3.1
data/Gemfile ADDED
@@ -0,0 +1,10 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in opto-model.gemspec
4
+ gemspec
5
+
6
+ group :development do
7
+ gem 'simplecov', require: false, platforms: :ruby
8
+ gem 'byebug', require: false, platforms: :ruby
9
+ gem 'travis', require: false
10
+ end
data/LICENSE.txt ADDED
@@ -0,0 +1,191 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ Copyright 2015 Kontena, Inc.
180
+
181
+ Licensed under the Apache License, Version 2.0 (the "License");
182
+ you may not use this file except in compliance with the License.
183
+ You may obtain a copy of the License at
184
+
185
+ http://www.apache.org/licenses/LICENSE-2.0
186
+
187
+ Unless required by applicable law or agreed to in writing, software
188
+ distributed under the License is distributed on an "AS IS" BASIS,
189
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190
+ See the License for the specific language governing permissions and
191
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,122 @@
1
+ # Opto/Model
2
+
3
+ [![Build Status](https://travis-ci.org/kontena/opto-model.svg?branch=master)](https://travis-ci.org/kontena/opto-model)
4
+
5
+ Uses [Opto](https://github.com/kontena/opto/) as the engine to add validatable attributes and build nestable models from Ruby objects.
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'opto-model'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install opto-model
22
+
23
+ ## Why?
24
+
25
+ Why not use [Virtus](https://github.com/solnic/virtus) or [dry-types](http://dry-rb.org/gems/dry-types/) or [ModelAttribute](https://github.com/yammer/model_attribute) or X?
26
+ Why not indeed. While [Opto](https://github.com/kontena/opto/) based attributes bring some handy benefits, such as the resolvers, you will probably find the alternatives a lot more full featured and sophisticated.
27
+
28
+ ## Usage
29
+
30
+ See [Opto README](https://github.com/kontena/opto/blob/master/README.md) for attribute definition syntax reference.
31
+
32
+ ### Defining models
33
+
34
+ ```ruby
35
+ require 'opto-model'
36
+
37
+ class Name
38
+ include Opto.model
39
+
40
+ attribute :first_name, :string
41
+ attribute :last_name, :string
42
+ end
43
+
44
+ class Person
45
+ include Opto.model
46
+
47
+ has_one :name, Name, required: true
48
+ has_many :friends, Person
49
+
50
+ attribute :age, :integer, min: 18
51
+ end
52
+ ```
53
+
54
+ ### Interacting with models (yes please)
55
+
56
+ #### Create an instance
57
+ ```ruby
58
+ guy = Person.new
59
+ gal = Person.new(age: 20, name: { first_name: 'Elaine' }, friends: [guy])
60
+ ```
61
+
62
+ #### Validating
63
+
64
+ ```ruby
65
+ guy.valid?
66
+ => false
67
+ guy.errors
68
+ => { :name => { :presence => "Child missing: 'name'" }, :age => { :presence => "Required value missing" } }
69
+ ```
70
+
71
+ #### Relations
72
+
73
+ Using another model:
74
+
75
+ ```ruby
76
+ guy.name
77
+ => nil
78
+ guy.name = Name.new(first_name: 'Guybrush', last_name: 'Threepwood')
79
+ guy.name.first_name
80
+ => "Guybrush"
81
+ ```
82
+
83
+ Using `new`:
84
+
85
+ ```ruby
86
+ guy.name.new(first_name: 'Guybrush', last_name: 'Threepwood')
87
+ ```
88
+
89
+ Using a hash:
90
+
91
+ ```ruby
92
+ guy.name = {first_name: 'Guybrush', last_name: 'Threepwood'}
93
+ ```
94
+
95
+ Using nested attributes:
96
+
97
+ ```ruby
98
+ guy = Person.new(age: 18, name: { first_name: "Guybrush", last_name: "Threepwood" }, friends: [ { last_name: 'LeChuck' } ])
99
+ ```
100
+
101
+ Also validates and collects errors for children:
102
+
103
+ ```ruby
104
+ guy.valid?
105
+ => false
106
+ guy.errors
107
+ => { :friends => { 0 => { :first_name => { :presence => "Required value missing" } } } }
108
+ ```
109
+
110
+ ..unless told not to:
111
+
112
+ ```ruby
113
+ guy.valid?(false)
114
+ => true
115
+ guy.errors(false)
116
+ => {}
117
+ ```
118
+
119
+ ## Contributing
120
+
121
+ Bug reports and pull requests are welcome on GitHub at https://github.com/kontena/opto-model.
122
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,54 @@
1
+ require_relative 'proxy'
2
+
3
+ module Opto
4
+ module Model
5
+ module Association
6
+ module HasMany
7
+ module Declaration
8
+ def self.prepended(where)
9
+ where.extend ClassMethods
10
+ end
11
+
12
+ module ClassMethods
13
+ def has_many(relation, klass, options = {})
14
+ if relations.include?(relation)
15
+ raise RuntimeError, "Duplicate has_many relation '#{relation}'"
16
+ end
17
+ relations << relation
18
+
19
+ define_method relation do
20
+ if instance_variable_defined?("@#{relation}")
21
+ instance_variable_get("@#{relation}")
22
+ else
23
+ instance_variable_set("@#{relation}", Proxy.new(self, klass, relation, options))
24
+ end
25
+ end
26
+
27
+ define_method "#{relation}=" do |args|
28
+ if args.kind_of?(Array)
29
+ self.send(relation).clear
30
+ args.each do |arg|
31
+ if arg.kind_of?(klass)
32
+ self.send(relation).push(arg)
33
+ elsif arg.kind_of?(Hash)
34
+ self.send(relation).new(arg)
35
+ else
36
+ raise TypeError, "Expected an instance of #{klass} or Hash"
37
+ end
38
+ end
39
+ self.send(relation).members
40
+ elsif args.nil?
41
+ self.send(relation).clear
42
+ else
43
+ raise TypeError, "Expected an instance of Array"
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
52
+ end
53
+
54
+
@@ -0,0 +1,63 @@
1
+ module Opto
2
+ module Model
3
+ module Association
4
+ module HasMany
5
+ class Proxy
6
+ attr_reader :parent, :members, :target_class, :as, :options
7
+
8
+ extend Forwardable
9
+
10
+ def initialize(parent, target_class, as, options = {})
11
+ @parent, @target_class, @as, @options = parent, target_class, as, options
12
+ @members = []
13
+ end
14
+
15
+ def association_errors
16
+ errors = { }
17
+ if members.empty? && options[:required]
18
+ errors[:presence] = "Collection '#{as}' is empty"
19
+ end
20
+ errors
21
+ end
22
+
23
+ def association_valid?
24
+ association_errors.empty?
25
+ end
26
+
27
+ def method_missing(meth, *args)
28
+ members.send(meth, *args)
29
+ end
30
+
31
+ def respond_to_missing?(meth, include_private = false)
32
+ members.respond_to?(meth, include_private)
33
+ end
34
+
35
+ def new(*args)
36
+ target = target_class.new(*args)
37
+ members << target
38
+ target
39
+ end
40
+
41
+ def to_h
42
+ empty? ? {} : { as => map(&:to_h) }
43
+ end
44
+
45
+ def errors
46
+ result = { }
47
+ each_with_index do |member, idx|
48
+ errors = member.errors
49
+ result[idx] = errors unless errors.empty?
50
+ end
51
+ result.merge!(association_errors || {})
52
+ result.empty? ? {} : { as => result }
53
+ end
54
+
55
+ def_delegators :members, *::Array.instance_methods - [:__send__, :object_id, :to_h]
56
+ end
57
+ end
58
+ end
59
+ end
60
+ end
61
+
62
+
63
+
@@ -0,0 +1,43 @@
1
+ require_relative 'proxy'
2
+
3
+ module Opto
4
+ module Model
5
+ module Association
6
+ module HasOne
7
+ module Declaration
8
+ def self.prepended(where)
9
+ where.extend ClassMethods
10
+ end
11
+
12
+ module ClassMethods
13
+ def has_one(relation, klass, options = {})
14
+ if relations.include?(relation)
15
+ raise RuntimeError, "Duplicate has_one relation '#{relation}'"
16
+ end
17
+ relations << relation
18
+
19
+ define_method relation do
20
+ if instance_variable_defined?("@#{relation}")
21
+ instance_variable_get("@#{relation}")
22
+ else
23
+ instance_variable_set("@#{relation}", Proxy.new(self, klass, relation, nil, options))
24
+ end
25
+ end
26
+
27
+ define_method "#{relation}=" do |arg|
28
+ if arg.kind_of?(klass) || arg.nil?
29
+ instance_variable_set("@#{relation}", Proxy.new(self, klass, relation, arg, options))
30
+ elsif arg.kind_of?(Hash)
31
+ self.send(relation).new(arg)
32
+ else
33
+ raise TypeError, "Expected an instance of #{klass} or Hash or nil"
34
+ end
35
+ end
36
+ end
37
+ end
38
+ end
39
+ end
40
+ end
41
+ end
42
+ end
43
+
@@ -0,0 +1,68 @@
1
+ module Opto
2
+ module Model
3
+ module Association
4
+ module HasOne
5
+ class Proxy
6
+ attr_reader :parent, :target, :target_class, :as, :options
7
+
8
+ extend Forwardable
9
+
10
+ def initialize(parent, target_class, as, target = nil, options = {})
11
+ @parent, @target_class, @as, @target, @options = parent, target_class, as, target, options
12
+ end
13
+
14
+ def association_errors
15
+ errors = { }
16
+ if target.nil? && options[:required]
17
+ errors[:presence] = "Missing child '#{as}'"
18
+ end
19
+ errors
20
+ end
21
+
22
+ def association_valid?
23
+ association_errors.empty?
24
+ end
25
+
26
+ def method_missing(meth, *args)
27
+ target.send(meth, *args)
28
+ end
29
+
30
+ def respond_to_missing?(meth, include_private = false)
31
+ target.respond_to?(meth, include_private)
32
+ end
33
+
34
+ def new(*args)
35
+ @target = target_class.new(*args)
36
+ end
37
+
38
+ def to_h
39
+ target.nil? ? {} : { as => target.to_h }
40
+ end
41
+
42
+ def errors
43
+ result = {}
44
+ if target
45
+ target_errors = target.errors
46
+ else
47
+ target_errors = {}
48
+ end
49
+ assoc_errors = association_errors
50
+
51
+ if target_errors.empty? && assoc_errors.empty?
52
+ {}
53
+ else
54
+ { as => target_errors.merge(assoc_errors) }
55
+ end
56
+ end
57
+
58
+ def valid?
59
+ association_valid? && (target && target.valid?)
60
+ end
61
+
62
+ def_delegators :target, :nil?, :class, :inspect, :kind_of?, :instance_of?, :is_a?
63
+ end
64
+ end
65
+ end
66
+ end
67
+ end
68
+
@@ -0,0 +1,16 @@
1
+ module Opto
2
+ module Model
3
+ module Association
4
+
5
+ def self.prepended(where)
6
+ where.extend ClassMethods
7
+ end
8
+
9
+ module ClassMethods
10
+ def relations
11
+ @relations ||= []
12
+ end
13
+ end
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,25 @@
1
+ module Opto
2
+ module Model
3
+ class Attribute
4
+ attr_reader :definition
5
+ attr_reader :collection
6
+ attr_reader :handler
7
+ attr_reader :name
8
+
9
+ def initialize(collection, definition, handler)
10
+ @collection = collection
11
+ @definition = definition
12
+ @handler = handler
13
+ @name = definition[:name]
14
+ end
15
+
16
+ def set(value)
17
+ handler.set(value)
18
+ end
19
+
20
+ def value
21
+ handler.value
22
+ end
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,46 @@
1
+ require 'opto'
2
+ require_relative 'attribute'
3
+
4
+ module Opto
5
+ module Model
6
+ class AttributeCollection
7
+
8
+ extend Forwardable
9
+
10
+ attr_reader :members
11
+ attr_reader :group
12
+
13
+ def initialize(attribute_definitions = [])
14
+ @members = {}
15
+ @group = Opto::Group.new
16
+
17
+ build_members(attribute_definitions)
18
+ end
19
+
20
+ def inspect
21
+ string = "#<#{self.class.name}:#{self.object_id} "
22
+ string << "members: #{members.keys.inspect}"
23
+ string << ">"
24
+ string
25
+ end
26
+
27
+ def [](name)
28
+ members[name]
29
+ end
30
+
31
+ def build_member(definition)
32
+ members[definition[:name]] = Attribute.new(self, definition, group.build_option(definition))
33
+ end
34
+
35
+ def build_members(definitions)
36
+ definitions.each { |definition| build_member(definition) }
37
+ end
38
+
39
+ def errors
40
+ Hash[*group.errors.flat_map { |k,v| [k.to_sym, v] }]
41
+ end
42
+
43
+ def_delegators :group, :valid?, :all_true?, :any_true?, :to_h
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,36 @@
1
+ module Opto
2
+ module Model
3
+ module AttributeDeclaration
4
+
5
+ def self.prepended(where)
6
+ where.extend ClassMethods
7
+ end
8
+
9
+ module ClassMethods
10
+ def attribute_definitions
11
+ @attribute_definitions ||= []
12
+ end
13
+
14
+ def attribute(name, type, arguments = {})
15
+ if attribute_definitions.find { |d| d[:name] == name }
16
+ raise RuntimeError, "Duplicate attribute '#{name}'"
17
+ end
18
+ attribute_definitions << arguments.merge(name: name, type: type)
19
+
20
+ define_method "#{name}_handler" do
21
+ collection[name].handler
22
+ end
23
+
24
+ define_method name do
25
+ collection[name].value
26
+ end
27
+
28
+ define_method "#{name}=" do |value|
29
+ collection[name].set(value)
30
+ end
31
+ end
32
+ end
33
+ end
34
+ end
35
+ end
36
+
@@ -0,0 +1,32 @@
1
+ require_relative 'attribute_collection'
2
+
3
+ module Opto
4
+ module Model
5
+ module Initializer
6
+
7
+ def initialize(attributes = {})
8
+ initialize_collection
9
+ assign(attributes)
10
+ end
11
+
12
+ def initialize_collection
13
+ @collection = AttributeCollection.new(self.class.attribute_definitions)
14
+ end
15
+
16
+ def collection
17
+ @collection
18
+ end
19
+
20
+ def assign(attributes)
21
+ attributes.each do |key, value|
22
+ if self.respond_to?("#{key}=")
23
+ self.send("#{key}=", value)
24
+ else
25
+ raise ArgumentError, "Unknown attribute '#{key}'"
26
+ end
27
+ end
28
+ end
29
+
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,5 @@
1
+ module Opto
2
+ module Model
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
data/lib/opto/model.rb ADDED
@@ -0,0 +1,58 @@
1
+ require "opto/model/version"
2
+ require_relative 'model/initializer'
3
+ require_relative 'model/attribute_declaration'
4
+ require_relative 'model/association'
5
+ require_relative 'model/association/has_one/declaration'
6
+ require_relative 'model/association/has_many/declaration'
7
+
8
+ module Opto
9
+ module Model
10
+ def self.included(where)
11
+ where.send :prepend, Initializer
12
+ where.send :prepend, AttributeDeclaration
13
+ where.send :prepend, Association
14
+ where.send :prepend, Association::HasOne::Declaration
15
+ where.send :prepend, Association::HasMany::Declaration
16
+ end
17
+
18
+ def inspect
19
+ super.gsub(/\>\z/, " " + collection.members.map {|n, m| "#{m.handler.type}:#{n}: #{m.value.inspect}"}.join(', ') + ">")
20
+ end
21
+
22
+ def valid?(children = true)
23
+ if children
24
+ ([collection] + self.class.relations.map { |r| self.send(r) }).all?(&:valid?)
25
+ else
26
+ collection.valid?
27
+ end
28
+ end
29
+
30
+ def errors(children = true)
31
+ if children
32
+ result = collection.errors
33
+ self.class.relations.each do |relation|
34
+ result.merge!(self.send(relation).errors)
35
+ end
36
+ result
37
+ else
38
+ collection.errors
39
+ end
40
+ end
41
+
42
+ def to_h(children = true)
43
+ if children
44
+ result = to_h(false)
45
+ self.class.relations.each do |r|
46
+ result.merge!(self.send(r).to_h)
47
+ end
48
+ result
49
+ else
50
+ collection.to_h(values_only: true)
51
+ end
52
+ end
53
+ end
54
+
55
+ def self.model
56
+ Model
57
+ end
58
+ end
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'opto/model/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "opto-model"
8
+ spec.version = Opto::Model::VERSION
9
+ spec.authors = ["Kimmo Lehto"]
10
+ spec.email = ["info@kontena.io"]
11
+
12
+ spec.licenses = ['Apache-2.0']
13
+
14
+ spec.summary = %q{Uses Opto to add attributes to Ruby objects}
15
+ spec.homepage = "https://github.com/kontena/opto-model"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.require_paths = ["lib"]
19
+
20
+ spec.add_development_dependency "bundler", "~> 1.12"
21
+ spec.add_development_dependency "rake", "~> 10.0"
22
+ spec.add_development_dependency "rspec", "~> 3.0"
23
+
24
+ spec.add_runtime_dependency "opto", "~> 1.6"
25
+ end
metadata ADDED
@@ -0,0 +1,119 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: opto-model
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Kimmo Lehto
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2016-12-23 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.12'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.12'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: opto
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.6'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.6'
69
+ description:
70
+ email:
71
+ - info@kontena.io
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".travis.yml"
79
+ - Gemfile
80
+ - LICENSE.txt
81
+ - README.md
82
+ - Rakefile
83
+ - lib/opto/model.rb
84
+ - lib/opto/model/association.rb
85
+ - lib/opto/model/association/has_many/declaration.rb
86
+ - lib/opto/model/association/has_many/proxy.rb
87
+ - lib/opto/model/association/has_one/declaration.rb
88
+ - lib/opto/model/association/has_one/proxy.rb
89
+ - lib/opto/model/attribute.rb
90
+ - lib/opto/model/attribute_collection.rb
91
+ - lib/opto/model/attribute_declaration.rb
92
+ - lib/opto/model/initializer.rb
93
+ - lib/opto/model/version.rb
94
+ - opto-model.gemspec
95
+ homepage: https://github.com/kontena/opto-model
96
+ licenses:
97
+ - Apache-2.0
98
+ metadata: {}
99
+ post_install_message:
100
+ rdoc_options: []
101
+ require_paths:
102
+ - lib
103
+ required_ruby_version: !ruby/object:Gem::Requirement
104
+ requirements:
105
+ - - ">="
106
+ - !ruby/object:Gem::Version
107
+ version: '0'
108
+ required_rubygems_version: !ruby/object:Gem::Requirement
109
+ requirements:
110
+ - - ">="
111
+ - !ruby/object:Gem::Version
112
+ version: '0'
113
+ requirements: []
114
+ rubyforge_project:
115
+ rubygems_version: 2.4.5
116
+ signing_key:
117
+ specification_version: 4
118
+ summary: Uses Opto to add attributes to Ruby objects
119
+ test_files: []