core-boundary 0.0.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
+ SHA256:
3
+ metadata.gz: 7519df2dd502a20bf7cf9d8130d39aaa6fee7f4e9a6061e0672761d8d0db0a88
4
+ data.tar.gz: 82e316357bc106d70ff4f582c57e178322b6656a55411552834d59a980930e9e
5
+ SHA512:
6
+ metadata.gz: 3047d3db5bec3971987a991bd085fdaa7301ed6c63bd50b4f033a1c8c07d09abb89e6db66cb7dd6393db732837dea3555c0682e8cbef8f1044a67b8c6400ef91
7
+ data.tar.gz: 295c51602ade49d1e198367b6eecfbd543f422d7e6b6c48ab9bf8c03c042130f2d2ecd28e635332c3f279fc5e1b2a487bfcff7c3918b30b5f4dd5daca6d7faae
data/CHANGELOG.md ADDED
@@ -0,0 +1,7 @@
1
+ ## [v0.0.0](https://github.com/bryanp/corerb/releases/tag/2023-12-19)
2
+
3
+ *released on 2023-12-19*
4
+
5
+ * `add` [#136](https://github.com/bryanp/corerb/pull/136) Initial implementation of core-boundary ([bryanp](https://github.com/bryanp))
6
+
7
+
data/LICENSE ADDED
@@ -0,0 +1,353 @@
1
+ Mozilla Public License, version 2.0
2
+
3
+ 1. Definitions
4
+
5
+ 1.1. “Contributor”
6
+
7
+ means each individual or legal entity that creates, contributes to the
8
+ creation of, or owns Covered Software.
9
+
10
+ 1.2. “Contributor Version”
11
+
12
+ means the combination of the Contributions of others (if any) used by a
13
+ Contributor and that particular Contributor’s Contribution.
14
+
15
+ 1.3. “Contribution”
16
+
17
+ means Covered Software of a particular Contributor.
18
+
19
+ 1.4. “Covered Software”
20
+
21
+ means Source Code Form to which the initial Contributor has attached the
22
+ notice in Exhibit A, the Executable Form of such Source Code Form, and
23
+ Modifications of such Source Code Form, in each case including portions
24
+ thereof.
25
+
26
+ 1.5. “Incompatible With Secondary Licenses”
27
+ means
28
+
29
+ a. that the initial Contributor has attached the notice described in
30
+ Exhibit B to the Covered Software; or
31
+
32
+ b. that the Covered Software was made available under the terms of version
33
+ 1.1 or earlier of the License, but not also under the terms of a
34
+ Secondary License.
35
+
36
+ 1.6. “Executable Form”
37
+
38
+ means any form of the work other than Source Code Form.
39
+
40
+ 1.7. “Larger Work”
41
+
42
+ means a work that combines Covered Software with other material, in a separate
43
+ file or files, that is not Covered Software.
44
+
45
+ 1.8. “License”
46
+
47
+ means this document.
48
+
49
+ 1.9. “Licensable”
50
+
51
+ means having the right to grant, to the maximum extent possible, whether at the
52
+ time of the initial grant or subsequently, any and all of the rights conveyed by
53
+ this License.
54
+
55
+ 1.10. “Modifications”
56
+
57
+ means any of the following:
58
+
59
+ a. any file in Source Code Form that results from an addition to, deletion
60
+ from, or modification of the contents of Covered Software; or
61
+
62
+ b. any new file in Source Code Form that contains any Covered Software.
63
+
64
+ 1.11. “Patent Claims” of a Contributor
65
+
66
+ means any patent claim(s), including without limitation, method, process,
67
+ and apparatus claims, in any patent Licensable by such Contributor that
68
+ would be infringed, but for the grant of the License, by the making,
69
+ using, selling, offering for sale, having made, import, or transfer of
70
+ either its Contributions or its Contributor Version.
71
+
72
+ 1.12. “Secondary License”
73
+
74
+ means either the GNU General Public License, Version 2.0, the GNU Lesser
75
+ General Public License, Version 2.1, the GNU Affero General Public
76
+ License, Version 3.0, or any later versions of those licenses.
77
+
78
+ 1.13. “Source Code Form”
79
+
80
+ means the form of the work preferred for making modifications.
81
+
82
+ 1.14. “You” (or “Your”)
83
+
84
+ means an individual or a legal entity exercising rights under this
85
+ License. For legal entities, “You” includes any entity that controls, is
86
+ controlled by, or is under common control with You. For purposes of this
87
+ definition, “control” means (a) the power, direct or indirect, to cause
88
+ the direction or management of such entity, whether by contract or
89
+ otherwise, or (b) ownership of more than fifty percent (50%) of the
90
+ outstanding shares or beneficial ownership of such entity.
91
+
92
+
93
+ 2. License Grants and Conditions
94
+
95
+ 2.1. Grants
96
+
97
+ Each Contributor hereby grants You a world-wide, royalty-free,
98
+ non-exclusive license:
99
+
100
+ a. under intellectual property rights (other than patent or trademark)
101
+ Licensable by such Contributor to use, reproduce, make available,
102
+ modify, display, perform, distribute, and otherwise exploit its
103
+ Contributions, either on an unmodified basis, with Modifications, or as
104
+ part of a Larger Work; and
105
+
106
+ b. under Patent Claims of such Contributor to make, use, sell, offer for
107
+ sale, have made, import, and otherwise transfer either its Contributions
108
+ or its Contributor Version.
109
+
110
+ 2.2. Effective Date
111
+
112
+ The licenses granted in Section 2.1 with respect to any Contribution become
113
+ effective for each Contribution on the date the Contributor first distributes
114
+ such Contribution.
115
+
116
+ 2.3. Limitations on Grant Scope
117
+
118
+ The licenses granted in this Section 2 are the only rights granted under this
119
+ License. No additional rights or licenses will be implied from the distribution
120
+ or licensing of Covered Software under this License. Notwithstanding Section
121
+ 2.1(b) above, no patent license is granted by a Contributor:
122
+
123
+ a. for any code that a Contributor has removed from Covered Software; or
124
+
125
+ b. for infringements caused by: (i) Your and any other third party’s
126
+ modifications of Covered Software, or (ii) the combination of its
127
+ Contributions with other software (except as part of its Contributor
128
+ Version); or
129
+
130
+ c. under Patent Claims infringed by Covered Software in the absence of its
131
+ Contributions.
132
+
133
+ This License does not grant any rights in the trademarks, service marks, or
134
+ logos of any Contributor (except as may be necessary to comply with the
135
+ notice requirements in Section 3.4).
136
+
137
+ 2.4. Subsequent Licenses
138
+
139
+ No Contributor makes additional grants as a result of Your choice to
140
+ distribute the Covered Software under a subsequent version of this License
141
+ (see Section 10.2) or under the terms of a Secondary License (if permitted
142
+ under the terms of Section 3.3).
143
+
144
+ 2.5. Representation
145
+
146
+ Each Contributor represents that the Contributor believes its Contributions
147
+ are its original creation(s) or it has sufficient rights to grant the
148
+ rights to its Contributions conveyed by this License.
149
+
150
+ 2.6. Fair Use
151
+
152
+ This License is not intended to limit any rights You have under applicable
153
+ copyright doctrines of fair use, fair dealing, or other equivalents.
154
+
155
+ 2.7. Conditions
156
+
157
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in
158
+ Section 2.1.
159
+
160
+
161
+ 3. Responsibilities
162
+
163
+ 3.1. Distribution of Source Form
164
+
165
+ All distribution of Covered Software in Source Code Form, including any
166
+ Modifications that You create or to which You contribute, must be under the
167
+ terms of this License. You must inform recipients that the Source Code Form
168
+ of the Covered Software is governed by the terms of this License, and how
169
+ they can obtain a copy of this License. You may not attempt to alter or
170
+ restrict the recipients’ rights in the Source Code Form.
171
+
172
+ 3.2. Distribution of Executable Form
173
+
174
+ If You distribute Covered Software in Executable Form then:
175
+
176
+ a. such Covered Software must also be made available in Source Code Form,
177
+ as described in Section 3.1, and You must inform recipients of the
178
+ Executable Form how they can obtain a copy of such Source Code Form by
179
+ reasonable means in a timely manner, at a charge no more than the cost
180
+ of distribution to the recipient; and
181
+
182
+ b. You may distribute such Executable Form under the terms of this License,
183
+ or sublicense it under different terms, provided that the license for
184
+ the Executable Form does not attempt to limit or alter the recipients’
185
+ rights in the Source Code Form under this License.
186
+
187
+ 3.3. Distribution of a Larger Work
188
+
189
+ You may create and distribute a Larger Work under terms of Your choice,
190
+ provided that You also comply with the requirements of this License for the
191
+ Covered Software. If the Larger Work is a combination of Covered Software
192
+ with a work governed by one or more Secondary Licenses, and the Covered
193
+ Software is not Incompatible With Secondary Licenses, this License permits
194
+ You to additionally distribute such Covered Software under the terms of
195
+ such Secondary License(s), so that the recipient of the Larger Work may, at
196
+ their option, further distribute the Covered Software under the terms of
197
+ either this License or such Secondary License(s).
198
+
199
+ 3.4. Notices
200
+
201
+ You may not remove or alter the substance of any license notices (including
202
+ copyright notices, patent notices, disclaimers of warranty, or limitations
203
+ of liability) contained within the Source Code Form of the Covered
204
+ Software, except that You may alter any license notices to the extent
205
+ required to remedy known factual inaccuracies.
206
+
207
+ 3.5. Application of Additional Terms
208
+
209
+ You may choose to offer, and to charge a fee for, warranty, support,
210
+ indemnity or liability obligations to one or more recipients of Covered
211
+ Software. However, You may do so only on Your own behalf, and not on behalf
212
+ of any Contributor. You must make it absolutely clear that any such
213
+ warranty, support, indemnity, or liability obligation is offered by You
214
+ alone, and You hereby agree to indemnify every Contributor for any
215
+ liability incurred by such Contributor as a result of warranty, support,
216
+ indemnity or liability terms You offer. You may include additional
217
+ disclaimers of warranty and limitations of liability specific to any
218
+ jurisdiction.
219
+
220
+ 4. Inability to Comply Due to Statute or Regulation
221
+
222
+ If it is impossible for You to comply with any of the terms of this License
223
+ with respect to some or all of the Covered Software due to statute, judicial
224
+ order, or regulation then You must: (a) comply with the terms of this License
225
+ to the maximum extent possible; and (b) describe the limitations and the code
226
+ they affect. Such description must be placed in a text file included with all
227
+ distributions of the Covered Software under this License. Except to the
228
+ extent prohibited by statute or regulation, such description must be
229
+ sufficiently detailed for a recipient of ordinary skill to be able to
230
+ understand it.
231
+
232
+ 5. Termination
233
+
234
+ 5.1. The rights granted under this License will terminate automatically if You
235
+ fail to comply with any of its terms. However, if You become compliant,
236
+ then the rights granted under this License from a particular Contributor
237
+ are reinstated (a) provisionally, unless and until such Contributor
238
+ explicitly and finally terminates Your grants, and (b) on an ongoing basis,
239
+ if such Contributor fails to notify You of the non-compliance by some
240
+ reasonable means prior to 60 days after You have come back into compliance.
241
+ Moreover, Your grants from a particular Contributor are reinstated on an
242
+ ongoing basis if such Contributor notifies You of the non-compliance by
243
+ some reasonable means, this is the first time You have received notice of
244
+ non-compliance with this License from such Contributor, and You become
245
+ compliant prior to 30 days after Your receipt of the notice.
246
+
247
+ 5.2. If You initiate litigation against any entity by asserting a patent
248
+ infringement claim (excluding declaratory judgment actions, counter-claims,
249
+ and cross-claims) alleging that a Contributor Version directly or
250
+ indirectly infringes any patent, then the rights granted to You by any and
251
+ all Contributors for the Covered Software under Section 2.1 of this License
252
+ shall terminate.
253
+
254
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user
255
+ license agreements (excluding distributors and resellers) which have been
256
+ validly granted by You or Your distributors under this License prior to
257
+ termination shall survive termination.
258
+
259
+ 6. Disclaimer of Warranty
260
+
261
+ Covered Software is provided under this License on an “as is” basis, without
262
+ warranty of any kind, either expressed, implied, or statutory, including,
263
+ without limitation, warranties that the Covered Software is free of defects,
264
+ merchantable, fit for a particular purpose or non-infringing. The entire
265
+ risk as to the quality and performance of the Covered Software is with You.
266
+ Should any Covered Software prove defective in any respect, You (not any
267
+ Contributor) assume the cost of any necessary servicing, repair, or
268
+ correction. This disclaimer of warranty constitutes an essential part of this
269
+ License. No use of any Covered Software is authorized under this License
270
+ except under this disclaimer.
271
+
272
+ 7. Limitation of Liability
273
+
274
+ Under no circumstances and under no legal theory, whether tort (including
275
+ negligence), contract, or otherwise, shall any Contributor, or anyone who
276
+ distributes Covered Software as permitted above, be liable to You for any
277
+ direct, indirect, special, incidental, or consequential damages of any
278
+ character including, without limitation, damages for lost profits, loss of
279
+ goodwill, work stoppage, computer failure or malfunction, or any and all
280
+ other commercial damages or losses, even if such party shall have been
281
+ informed of the possibility of such damages. This limitation of liability
282
+ shall not apply to liability for death or personal injury resulting from such
283
+ party’s negligence to the extent applicable law prohibits such limitation.
284
+ Some jurisdictions do not allow the exclusion or limitation of incidental or
285
+ consequential damages, so this exclusion and limitation may not apply to You.
286
+
287
+ 8. Litigation
288
+
289
+ Any litigation relating to this License may be brought only in the courts of
290
+ a jurisdiction where the defendant maintains its principal place of business
291
+ and such litigation shall be governed by laws of that jurisdiction, without
292
+ reference to its conflict-of-law provisions. Nothing in this Section shall
293
+ prevent a party’s ability to bring cross-claims or counter-claims.
294
+
295
+ 9. Miscellaneous
296
+
297
+ This License represents the complete agreement concerning the subject matter
298
+ hereof. If any provision of this License is held to be unenforceable, such
299
+ provision shall be reformed only to the extent necessary to make it
300
+ enforceable. Any law or regulation which provides that the language of a
301
+ contract shall be construed against the drafter shall not be used to construe
302
+ this License against a Contributor.
303
+
304
+
305
+ 10. Versions of the License
306
+
307
+ 10.1. New Versions
308
+
309
+ Mozilla Foundation is the license steward. Except as provided in Section
310
+ 10.3, no one other than the license steward has the right to modify or
311
+ publish new versions of this License. Each version will be given a
312
+ distinguishing version number.
313
+
314
+ 10.2. Effect of New Versions
315
+
316
+ You may distribute the Covered Software under the terms of the version of
317
+ the License under which You originally received the Covered Software, or
318
+ under the terms of any subsequent version published by the license
319
+ steward.
320
+
321
+ 10.3. Modified Versions
322
+
323
+ If you create software not governed by this License, and you want to
324
+ create a new license for such software, you may create and use a modified
325
+ version of this License if you rename the license and remove any
326
+ references to the name of the license steward (except to note that such
327
+ modified license differs from this License).
328
+
329
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses
330
+ If You choose to distribute Source Code Form that is Incompatible With
331
+ Secondary Licenses under the terms of this version of the License, the
332
+ notice described in Exhibit B of this License must be attached.
333
+
334
+ Exhibit A - Source Code Form License Notice
335
+
336
+ This Source Code Form is subject to the
337
+ terms of the Mozilla Public License, v.
338
+ 2.0. If a copy of the MPL was not
339
+ distributed with this file, You can
340
+ obtain one at
341
+ http://mozilla.org/MPL/2.0/.
342
+
343
+ If it is not possible or desirable to put the notice in a particular file, then
344
+ You may include the notice in a location (such as a LICENSE file in a relevant
345
+ directory) where a recipient would be likely to look for such a notice.
346
+
347
+ You may add additional accurate notices of copyright ownership.
348
+
349
+ Exhibit B - “Incompatible With Secondary Licenses” Notice
350
+
351
+ This Source Code Form is “Incompatible
352
+ With Secondary Licenses”, as defined by
353
+ the Mozilla Public License, v. 2.0.
@@ -0,0 +1,30 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "is/extension"
4
+ require "is/stateful"
5
+
6
+ require_relative "../normalizer"
7
+
8
+ module Core
9
+ module Boundary
10
+ module Behavior
11
+ # [public]
12
+ #
13
+ module Normalization
14
+ extend Is::Extension
15
+
16
+ # [public]
17
+ #
18
+ def normalize(&block)
19
+ normalizer.action(&block)
20
+ end
21
+
22
+ extends dependencies: [Is::Stateful]
23
+
24
+ applies do
25
+ state :normalizer, default: Normalizer.new
26
+ end
27
+ end
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,30 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "is/extension"
4
+ require "is/stateful"
5
+
6
+ require_relative "../validator"
7
+
8
+ module Core
9
+ module Boundary
10
+ module Behavior
11
+ # [public]
12
+ #
13
+ module Validation
14
+ extend Is::Extension
15
+
16
+ # [public]
17
+ #
18
+ def validate(name = :invalid, &block)
19
+ validator.action(name, &block)
20
+ end
21
+
22
+ extends dependencies: [Is::Stateful]
23
+
24
+ applies do
25
+ state :validator, default: Validator.new
26
+ end
27
+ end
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "is/extension"
4
+ require "is/stateful"
5
+
6
+ require_relative "../verifier"
7
+
8
+ module Core
9
+ module Boundary
10
+ module Behavior
11
+ # [public]
12
+ #
13
+ module Verifiable
14
+ extend Is::Extension
15
+
16
+ # [public]
17
+ #
18
+ def required(...)
19
+ verifier.required(...)
20
+ end
21
+
22
+ # [public]
23
+ #
24
+ def optional(...)
25
+ verifier.optional(...)
26
+ end
27
+
28
+ extends dependencies: [Is::Stateful]
29
+
30
+ applies do
31
+ state :verifier, default: Verifier.new
32
+ end
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,4 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "behavior/verifiable"
4
+ Core::Boundary::Reference.include(Core::Boundary::Behavior::Verifiable)
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Core
4
+ module Boundary
5
+ # [public]
6
+ #
7
+ class Error < StandardError
8
+ def initialize(message = nil, result:)
9
+ super(message)
10
+
11
+ @result = result
12
+ end
13
+
14
+ attr_reader :result
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,69 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Core
4
+ module Boundary
5
+ # [public]
6
+ #
7
+ class Errors
8
+ def initialize
9
+ @errors = {}
10
+ end
11
+
12
+ # [public]
13
+ #
14
+ def add(*path, message)
15
+ (@errors[normalize_path(path)] ||= []) << message
16
+ end
17
+
18
+ def merge!(*merge_path, errors)
19
+ errors.each do |path, error|
20
+ add(*merge_path, *normalize_path(path), error)
21
+ end
22
+ end
23
+
24
+ # [public]
25
+ #
26
+ def each(&block)
27
+ return to_enum(:each) unless block
28
+
29
+ @errors.each_pair do |path, errors|
30
+ errors.each do |error|
31
+ yield path, error
32
+ end
33
+ end
34
+ end
35
+
36
+ # [public]
37
+ #
38
+ def any?(*path)
39
+ if path.empty?
40
+ @errors.any?
41
+ else
42
+ errors = @errors[normalize_path(path)]
43
+ !!errors && errors.any?
44
+ end
45
+ end
46
+
47
+ # [public]
48
+ #
49
+ def empty?(*path)
50
+ if path.empty?
51
+ @errors.empty?
52
+ else
53
+ errors = @errors[normalize_path(path)]
54
+ !errors || errors.empty?
55
+ end
56
+ end
57
+
58
+ # [public]
59
+ #
60
+ def for(*path)
61
+ @errors.fetch(path) { [] }
62
+ end
63
+
64
+ private def normalize_path(path)
65
+ path.map(&:to_sym)
66
+ end
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,41 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "is/copyable"
4
+ require "is/inspectable"
5
+
6
+ require "refine/object/copy"
7
+
8
+ module Core
9
+ module Boundary
10
+ # [public]
11
+ #
12
+ class Normalizer
13
+ include Is::Copyable
14
+ include Is::Inspectable
15
+
16
+ using Refine::Object::Copy
17
+
18
+ def initialize
19
+ @actions = []
20
+ end
21
+
22
+ callback "core.copy" do
23
+ @actions = @actions.copy
24
+ end
25
+
26
+ # [public]
27
+ #
28
+ def action(&block)
29
+ @actions << block
30
+ end
31
+
32
+ # [public]
33
+ #
34
+ def call(value)
35
+ @actions.inject(value) { |current, action|
36
+ action.call(current)
37
+ }
38
+ end
39
+ end
40
+ end
41
+ end
@@ -0,0 +1,80 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "core/type"
4
+ require "is/inspectable"
5
+
6
+ require_relative "behavior/normalization"
7
+ require_relative "behavior/validation"
8
+
9
+ module Core
10
+ module Boundary
11
+ # [public]
12
+ #
13
+ class Reference
14
+ include Behavior::Normalization
15
+ include Behavior::Validation
16
+
17
+ include Is::Inspectable
18
+ inspects without: [:@stringified]
19
+
20
+ UNDEFINED = Object.new
21
+
22
+ def initialize(reference, message: nil, required: false, default: UNDEFINED, type: Core::Type::Object)
23
+ @reference = reference.to_sym
24
+ @stringified = reference.to_s
25
+ @message = message
26
+ @required = required
27
+ @default = default
28
+ @type = type
29
+ end
30
+
31
+ attr_reader :reference
32
+
33
+ # [public]
34
+ #
35
+ def resolve(object, result:)
36
+ catch :__core_boundary_value_error__ do
37
+ value = case object
38
+ when Hash
39
+ object.fetch(@reference) {
40
+ object.fetch(@stringified) {
41
+ if @required
42
+ result.errors.add(@reference, @message)
43
+ throw :__core_boundary_value_error__
44
+ elsif @default != UNDEFINED
45
+ @default
46
+ end
47
+ }
48
+ }
49
+ else
50
+ if object.respond_to?(@reference)
51
+ object.__send__(@reference)
52
+ elsif @required
53
+ result.errors.add(@reference, @message)
54
+ throw :__core_boundary_value_error__
55
+ elsif @default != UNDEFINED
56
+ @default
57
+ end
58
+ end
59
+
60
+ begin
61
+ value = @type.build(@normalizer.call(value))
62
+ rescue Core::Type::CheckFailed
63
+ result.errors.add(@reference, :type_failure)
64
+ throw :__core_boundary_value_error__
65
+ end
66
+
67
+ @validator.call(value, result: result, reference: @reference)
68
+
69
+ result[@reference] = if @verifier.empty?
70
+ value
71
+ else
72
+ nested = @verifier.verify(value)
73
+ result.errors.merge!(*@reference, nested.errors)
74
+ nested.values
75
+ end
76
+ end
77
+ end
78
+ end
79
+ end
80
+ end
@@ -0,0 +1,64 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "is/inspectable"
4
+
5
+ require_relative "errors"
6
+
7
+ module Core
8
+ module Boundary
9
+ # [public]
10
+ #
11
+ class Result
12
+ include Is::Inspectable
13
+ inspects :@values, :@errors
14
+
15
+ def initialize
16
+ @values = {}
17
+ @errors = Errors.new
18
+ end
19
+
20
+ # [public]
21
+ #
22
+ attr_reader :values
23
+
24
+ # [public]
25
+ #
26
+ def error?(*path)
27
+ @errors.any?(*path)
28
+ end
29
+
30
+ # [public]
31
+ #
32
+ def success?(*path)
33
+ @errors.empty?(*path)
34
+ end
35
+
36
+ # [public]
37
+ #
38
+ def errors(*path)
39
+ if path.any?
40
+ @errors.for(*path)
41
+ else
42
+ @errors
43
+ end
44
+ end
45
+
46
+ # [public]
47
+ #
48
+ def []=(key, value)
49
+ @values[key.to_sym] = value
50
+ end
51
+
52
+ def finalize
53
+ freeze
54
+ self
55
+ end
56
+
57
+ def freeze
58
+ @arguments.freeze
59
+ @values.freeze
60
+ super
61
+ end
62
+ end
63
+ end
64
+ end
@@ -0,0 +1,42 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "is/copyable"
4
+ require "is/inspectable"
5
+
6
+ require "refine/object/copy"
7
+
8
+ module Core
9
+ module Boundary
10
+ # [public]
11
+ #
12
+ class Validator
13
+ include Is::Copyable
14
+ include Is::Inspectable
15
+
16
+ using Refine::Object::Copy
17
+
18
+ def initialize
19
+ @validations = []
20
+ end
21
+
22
+ callback "core.copy" do
23
+ @validations = @validations.copy
24
+ end
25
+
26
+ # [public]
27
+ #
28
+ def action(name, &block)
29
+ @validations << {name: name, block: block}
30
+ end
31
+
32
+ # [public]
33
+ #
34
+ def call(value, result:, reference:)
35
+ @validations.each do |validation|
36
+ next if validation[:block].call(value)
37
+ result.errors.add(reference, validation[:name])
38
+ end
39
+ end
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,120 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "is/copyable"
4
+ require "is/inspectable"
5
+
6
+ require "refine/object/copy"
7
+
8
+ require_relative "error"
9
+ require_relative "result"
10
+ require_relative "reference"
11
+
12
+ module Core
13
+ module Boundary
14
+ # [public]
15
+ #
16
+ class Verifier
17
+ include Is::Copyable
18
+ include Is::Inspectable
19
+
20
+ using Refine::Object::Copy
21
+
22
+ def initialize
23
+ @references = []
24
+ end
25
+
26
+ callback "core.copy" do
27
+ @references = @references.map(&:copy)
28
+ end
29
+
30
+ # [public]
31
+ #
32
+ def required(reference, message: :missing, type: type_omitted = true, &block)
33
+ options = {
34
+ message: message,
35
+ required: true
36
+ }
37
+
38
+ unless type_omitted
39
+ options[:type] = type
40
+ end
41
+
42
+ reference = Reference.new(reference, **options)
43
+
44
+ if block
45
+ case block.arity
46
+ when 0
47
+ reference.instance_eval(&block)
48
+ else
49
+ block.call(reference)
50
+ end
51
+ end
52
+
53
+ @references << reference
54
+ end
55
+
56
+ # [public]
57
+ #
58
+ def optional(reference, default: default_omitted = true, type: type_omitted = true, &block)
59
+ options = {
60
+ required: false
61
+ }
62
+
63
+ unless default_omitted
64
+ options[:default] = default
65
+ end
66
+
67
+ unless type_omitted
68
+ options[:type] = type
69
+ end
70
+
71
+ reference = Reference.new(reference, **options)
72
+
73
+ if block
74
+ case block.arity
75
+ when 0
76
+ reference.instance_eval(&block)
77
+ else
78
+ block.call(reference)
79
+ end
80
+ end
81
+
82
+ @references << reference
83
+ end
84
+
85
+ # [public]
86
+ #
87
+ def verify(object, result: result_omitted = true)
88
+ if result_omitted
89
+ result = Result.new
90
+ end
91
+
92
+ @references.each do |reference|
93
+ reference.resolve(object, result: result)
94
+ end
95
+
96
+ if result_omitted
97
+ result.finalize
98
+ end
99
+ end
100
+
101
+ # [public]
102
+ #
103
+ def verify!(...)
104
+ result = verify(...)
105
+
106
+ if result.error?
107
+ raise Error.new("one or more values failed verification", result: result)
108
+ else
109
+ result
110
+ end
111
+ end
112
+
113
+ # [public]
114
+ #
115
+ def empty?
116
+ @references.empty?
117
+ end
118
+ end
119
+ end
120
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Core
4
+ module Boundary
5
+ VERSION = "0.0.0"
6
+
7
+ # [public]
8
+ #
9
+ def self.version
10
+ VERSION
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Core
4
+ module Boundary
5
+ require_relative "boundary/validator"
6
+ require_relative "boundary/verifier"
7
+ require_relative "boundary/version"
8
+
9
+ require_relative "boundary/bootstrap"
10
+ end
11
+ end
12
+
13
+ require_relative "../is/boundary"
@@ -0,0 +1,107 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "is/extension"
4
+ require "is/stateful"
5
+
6
+ require_relative "../core/boundary/verifier"
7
+ require_relative "../core/boundary/bootstrap"
8
+
9
+ module Is
10
+ # [public]
11
+ #
12
+ module Boundary
13
+ extend Is::Extension
14
+
15
+ extends dependencies: [Is::Stateful]
16
+
17
+ extends :definition do
18
+ # [public]
19
+ #
20
+ def boundary(method, default: false, &block)
21
+ method = method.to_sym
22
+
23
+ unless (verifier = __boundary_verifiers__[method])
24
+ verifier = (__boundary_verifiers__[method] = Core::Boundary::Verifier.new)
25
+
26
+ __boundaries_module__.module_eval(<<~CODE, __FILE__, __LINE__ + 1)
27
+ def #{method}(*arguments, **values, &block)
28
+ result = self.class.__boundary_verifiers__[#{method.inspect}].verify!(values)
29
+
30
+ super(*arguments, **result.values, &block)
31
+ end
32
+ CODE
33
+ end
34
+
35
+ if default == true
36
+ @__default_boundary__verifier__ = verifier
37
+ end
38
+
39
+ if block
40
+ case block.arity
41
+ when 0
42
+ verifier.instance_eval(&block)
43
+ else
44
+ block.call(verifier)
45
+ end
46
+ end
47
+
48
+ unless ancestors.include?(__boundaries_module__)
49
+ prepend(__boundaries_module__)
50
+ end
51
+ end
52
+ end
53
+
54
+ DELEGATED_METHODS = %i[required optional].freeze
55
+
56
+ extends :definition, prepend: true do
57
+ def method_missing(name, ...)
58
+ if delegate_to_default_boundary?(name)
59
+ __default_boundary__verifier__.__send__(name, ...)
60
+ else
61
+ super
62
+ end
63
+ end
64
+
65
+ def respond_to_missing?(name, ...)
66
+ delegate_to_default_boundary?(name) || super
67
+ end
68
+
69
+ private def delegate_to_default_boundary?(name)
70
+ DELEGATED_METHODS.include?(name) && __default_boundary__verifier__
71
+ end
72
+ end
73
+
74
+ extends :definition, :implementation do
75
+ # [public]
76
+ #
77
+ def verify(object, &block)
78
+ build_verifier(&block).verify(object)
79
+ end
80
+
81
+ # [public]
82
+ #
83
+ def verify!(object, &block)
84
+ build_verifier(&block).verify!(object)
85
+ end
86
+
87
+ private def build_verifier(&block)
88
+ verifier = Core::Boundary::Verifier.new
89
+
90
+ case block.arity
91
+ when 0
92
+ verifier.instance_eval(&block)
93
+ else
94
+ block.call(verifier)
95
+ end
96
+
97
+ verifier
98
+ end
99
+ end
100
+
101
+ applies do
102
+ state :__default_boundary__verifier__
103
+ state :__boundaries_module__, default: Module.new
104
+ state :__boundary_verifiers__, default: {}
105
+ end
106
+ end
107
+ end
metadata ADDED
@@ -0,0 +1,128 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: core-boundary
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Bryan Powell
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2023-12-20 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: core-copy
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.2'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.2'
27
+ - !ruby/object:Gem::Dependency
28
+ name: core-extension
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '0.4'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '0.4'
41
+ - !ruby/object:Gem::Dependency
42
+ name: core-inspect
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '0.1'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '0.1'
55
+ - !ruby/object:Gem::Dependency
56
+ name: core-state
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '0.1'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '0.1'
69
+ - !ruby/object:Gem::Dependency
70
+ name: core-type
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '0.0'
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '0.0'
83
+ description: Define boundaries for verification, validation, and normalization.
84
+ email: bryan@bryanp.org
85
+ executables: []
86
+ extensions: []
87
+ extra_rdoc_files: []
88
+ files:
89
+ - CHANGELOG.md
90
+ - LICENSE
91
+ - lib/core/boundary.rb
92
+ - lib/core/boundary/behavior/normalization.rb
93
+ - lib/core/boundary/behavior/validation.rb
94
+ - lib/core/boundary/behavior/verifiable.rb
95
+ - lib/core/boundary/bootstrap.rb
96
+ - lib/core/boundary/error.rb
97
+ - lib/core/boundary/errors.rb
98
+ - lib/core/boundary/normalizer.rb
99
+ - lib/core/boundary/reference.rb
100
+ - lib/core/boundary/result.rb
101
+ - lib/core/boundary/validator.rb
102
+ - lib/core/boundary/verifier.rb
103
+ - lib/core/boundary/version.rb
104
+ - lib/is/boundary.rb
105
+ homepage: https://github.com/bryanp/corerb/
106
+ licenses:
107
+ - MPL-2.0
108
+ metadata: {}
109
+ post_install_message:
110
+ rdoc_options: []
111
+ require_paths:
112
+ - lib
113
+ required_ruby_version: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '3.0'
118
+ required_rubygems_version: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: '0'
123
+ requirements: []
124
+ rubygems_version: 3.4.22
125
+ signing_key:
126
+ specification_version: 4
127
+ summary: Define boundaries for verification, validation, and normalization.
128
+ test_files: []