core-pipeline 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: a40a0de02118c468488220555a57d531b738170f51bd61bbe165f71f5851ddb6
4
+ data.tar.gz: bd1d8c14350961d2011fad408748095c315d04b8e7d067332e259f0b9f644656
5
+ SHA512:
6
+ metadata.gz: 4b87d1a60bad4f85bbaedddcd956222c03380d957dcac7663c63ce56bda9c876f4a230907285982438ea33fc396b3c8de4497168c9eaa6eb451351a02444dbc9
7
+ data.tar.gz: f9c54d75eb9f2803326d422ab7efed3f27bec648bdccaf9222633c16e1078bf4b01bb2a9086b7eb9954d3c76e17cef4c6ff4bdb4f65a521b6d5d0dd25235ee15
data/CHANGELOG.md ADDED
@@ -0,0 +1,7 @@
1
+ ## [v0.0.0](https://github.com/metabahn/corerb/releases/tag/2021-07-07)
2
+
3
+ *released on 2021-07-07*
4
+
5
+ * `add` [#37](https://github.com/metabahn/corerb/pull/37) Initial implementation of core-pipeline ([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,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Core
4
+ module Pipeline
5
+ require_relative "pipeline/version"
6
+ end
7
+ end
8
+
9
+ require_relative "../is/pipeline"
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Core
4
+ module Pipeline
5
+ # [public] A pipeline action.
6
+ #
7
+ class Action
8
+ class << self
9
+ # [public] Builds an action for a given target.
10
+ #
11
+ def build(target = nil, *args, context:, before:, after:, &block)
12
+ if block
13
+ Actions::Block.new(target, before: before, after: after, &block)
14
+ else
15
+ build_target(target, *args, before: before, after: after)
16
+ end
17
+ end
18
+
19
+ private def build_target(first, *args, before:, after:)
20
+ case first
21
+ when String, Symbol
22
+ if (target = build_target(args[0], *args[1..], before: before, after: after))
23
+ target
24
+ else
25
+ Actions::Method.new(first, before: before, after: after)
26
+ end
27
+ when NilClass
28
+ nil
29
+ else
30
+ raise ArgumentError, "unsupported action type"
31
+ end
32
+ end
33
+ end
34
+
35
+ def initialize(before:, after:)
36
+ @before = before
37
+ @after = after
38
+ end
39
+
40
+ # [public] The action name.
41
+ #
42
+ attr_reader :name
43
+
44
+ # [public] The name of the action this action should be called before.
45
+ #
46
+ attr_reader :before
47
+
48
+ # [public] The name of the action this action should be called after.
49
+ #
50
+ attr_reader :after
51
+
52
+ # [public] Finalizes the action for the given context.
53
+ #
54
+ def finalize(context)
55
+ raise "not implemented"
56
+ end
57
+
58
+ require_relative "actions/block"
59
+ require_relative "actions/method"
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,33 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "securerandom"
4
+
5
+ module Core
6
+ module Pipeline
7
+ module Actions
8
+ # [public] A pipeline action defined as a block.
9
+ #
10
+ class Block < Action
11
+ class << self
12
+ def build_name
13
+ "action_#{SecureRandom.hex(8)}"
14
+ end
15
+ end
16
+
17
+ def initialize(name = nil, before:, after:, &block)
18
+ @name = name || self.class.build_name
19
+ @block = block
20
+
21
+ super(before: before, after: after)
22
+ end
23
+
24
+ # [public]
25
+ #
26
+ def finalize(context)
27
+ context.define_singleton_method(@name, &@block)
28
+ context.method(@name).to_proc
29
+ end
30
+ end
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,24 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Core
4
+ module Pipeline
5
+ module Actions
6
+ # [public] A pipeline action defined as a method.
7
+ #
8
+ class Method < Action
9
+ def initialize(name = nil, before:, after:)
10
+ @name = name
11
+ @method = nil
12
+
13
+ super(before: before, after: after)
14
+ end
15
+
16
+ # [public]
17
+ #
18
+ def finalize(context)
19
+ context.method(@name).to_proc
20
+ end
21
+ end
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,116 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "signals/halted"
4
+ require_relative "signals/rejected"
5
+
6
+ module Core
7
+ module Pipeline
8
+ # [public] Compiles a pipeline instance into a callable object.
9
+ #
10
+ class Compiler
11
+ class << self
12
+ # [public] Compiles a pipeline instance.
13
+ #
14
+ def compile(pipeline)
15
+ compiled = <<~CODE
16
+ def call(...)
17
+ #{compile_pipeline(pipeline)}
18
+ rescue Core::Pipeline::Signals::Halted => error
19
+ error.value
20
+ end
21
+ CODE
22
+
23
+ pipeline.instance_eval(compiled, __FILE__, __LINE__ - 1)
24
+ end
25
+
26
+ private def compile_pipeline(pipeline)
27
+ compiled = +""
28
+
29
+ finalized_actions(pipeline).each_key do |object_id|
30
+ compiled << "begin\n"
31
+ compiled << " @__finalized_actions[#{object_id}].call(...)\n"
32
+ compiled << "rescue Core::Pipeline::Signals::Rejected\n"
33
+ compiled << "end\n"
34
+ end
35
+
36
+ compiled
37
+ end
38
+
39
+ private def finalized_actions(pipeline)
40
+ validate_skipped_actions(pipeline)
41
+ finalized_actions = build_finalized_actions(pipeline)
42
+ pipeline.instance_variable_set(:@__finalized_actions, finalized_actions)
43
+ end
44
+
45
+ private def validate_skipped_actions(pipeline)
46
+ pipeline.__skipped_actions.each do |skipped_action|
47
+ unless pipeline.__actions.any? { |action| action.name == skipped_action }
48
+ raise "cannot skip unknown action `#{skipped_action}`"
49
+ end
50
+ end
51
+ end
52
+
53
+ private def build_finalized_actions(pipeline)
54
+ ordered_actions(pipeline).reject { |action|
55
+ pipeline.__skipped_actions.include?(action.name)
56
+ }.map { |action|
57
+ action.finalize(pipeline)
58
+ }.each_with_object({}) { |action, lookup|
59
+ lookup[action.object_id] = action
60
+ }
61
+ end
62
+
63
+ private def ordered_actions(pipeline)
64
+ return pipeline.__actions if pipeline.__actions.empty?
65
+
66
+ marked = []
67
+ ordered = []
68
+ working = pipeline.__actions.dup
69
+
70
+ pipeline.__actions.each do |action|
71
+ unless action.before || action.after
72
+ ordered << action
73
+ working.delete(action)
74
+ end
75
+ end
76
+
77
+ raise "pipeline cannot be finalized because all actions have dependencies" if ordered.empty?
78
+
79
+ until working.empty?
80
+ action = working[0]
81
+
82
+ anchor_action_name = action.before || action.after
83
+
84
+ anchor_action = ordered.find { |ordered_action|
85
+ ordered_action.name == anchor_action_name
86
+ }
87
+
88
+ if anchor_action
89
+ insertion_index = if action.before
90
+ ordered.index(anchor_action)
91
+ else
92
+ ordered.index(anchor_action) + 1
93
+ end
94
+
95
+ ordered.insert(insertion_index, action)
96
+ working.delete(action)
97
+ marked.delete(action)
98
+ elsif working.find { |working_action| working_action.name == anchor_action_name }
99
+ if marked.include?(action)
100
+ raise "pipeline has one or more recursive dependencies"
101
+ else
102
+ marked << action
103
+ working.delete(action)
104
+ working << action
105
+ end
106
+ else
107
+ raise "unknown action `#{anchor_action_name}`"
108
+ end
109
+ end
110
+
111
+ ordered
112
+ end
113
+ end
114
+ end
115
+ end
116
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Core
4
+ module Pipeline
5
+ module Signals
6
+ class Halted < Exception
7
+ def initialize(value)
8
+ @value = value
9
+ end
10
+
11
+ attr_reader :value
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,10 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Core
4
+ module Pipeline
5
+ module Signals
6
+ class Rejected < Exception
7
+ end
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Core
4
+ module Pipeline
5
+ VERSION = "0.0.0"
6
+
7
+ def self.version
8
+ VERSION
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,100 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "is/async"
4
+ require "is/extension"
5
+ require "is/stateful"
6
+
7
+ require_relative "../core/pipeline/action"
8
+ require_relative "../core/pipeline/compiler"
9
+ require_relative "../core/pipeline/signals/halted"
10
+ require_relative "../core/pipeline/signals/rejected"
11
+
12
+ module Is
13
+ # [public] Turns any object into a pipeline with actions.
14
+ #
15
+ module Pipeline
16
+ extend Is::Extension
17
+
18
+ extends dependencies: [
19
+ Is::Stateful
20
+ ]
21
+
22
+ extends :class do
23
+ # [public] Defines a pipeline action.
24
+ #
25
+ def action(*args, before: nil, after: nil, &block)
26
+ @__actions << Core::Pipeline::Action.build(*args, context: self, before: before, after: after, &block)
27
+ end
28
+
29
+ # [public] Skips the given action.
30
+ #
31
+ def skip_action(name)
32
+ @__skipped_actions << name.to_sym
33
+ end
34
+
35
+ # [public] Replaces existing actions with actions from the given pipeline.
36
+ #
37
+ def use_pipeline(pipeline)
38
+ if (pipeline.is_a?(Class) || pipeline.is_a?(Module)) && pipeline.ancestors.include?(Is::Pipeline)
39
+ @__actions.clear
40
+ @__actions.concat(pipeline.__actions)
41
+ else
42
+ raise ArgumentError, "expected a pipeline"
43
+ end
44
+ end
45
+
46
+ # [public] Includes actions from the given pipeline.
47
+ #
48
+ def include_pipeline(pipeline)
49
+ if (pipeline.is_a?(Class) || pipeline.is_a?(Module)) && pipeline.ancestors.include?(Is::Pipeline)
50
+ @__actions.concat(pipeline.__actions)
51
+ else
52
+ raise ArgumentError, "expected a pipeline"
53
+ end
54
+ end
55
+
56
+ # [public] Excludes actions from the given pipeline.
57
+ #
58
+ def exclude_pipeline(pipeline)
59
+ if (pipeline.is_a?(Class) || pipeline.is_a?(Module)) && pipeline.ancestors.include?(Is::Pipeline)
60
+ pipeline.__actions.each do |action|
61
+ @__actions.delete(action)
62
+ end
63
+ else
64
+ raise ArgumentError, "expected a pipeline"
65
+ end
66
+ end
67
+ end
68
+
69
+ extends :instance do
70
+ # [public] Calls a pipeline with arguments.
71
+ #
72
+ def call(...)
73
+ # Compiles the pipeline then redefines `call` to call the compiled pipeline.
74
+ #
75
+ Core::Pipeline::Compiler.compile(self)
76
+
77
+ call(...)
78
+ end
79
+ end
80
+
81
+ extends :instance, prepend: true do
82
+ # [public] Halts the execution of the pipeline, setting the pipeline's current value to the given object.
83
+ #
84
+ private def halt(value = nil)
85
+ raise Core::Pipeline::Signals::Halted.new(value)
86
+ end
87
+
88
+ # [public] Rejects the current action, skipping the rest of the action and calling remaining pipeline actions.
89
+ #
90
+ private def reject
91
+ raise Core::Pipeline::Signals::Rejected
92
+ end
93
+ end
94
+
95
+ applied do
96
+ state :__actions, default: []
97
+ state :__skipped_actions, default: []
98
+ end
99
+ end
100
+ end
metadata ADDED
@@ -0,0 +1,95 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: core-pipeline
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: 2021-07-07 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: core-async
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.6'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.6'
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.1'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '0.1'
41
+ - !ruby/object:Gem::Dependency
42
+ name: core-state
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '0.0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '0.0'
55
+ description: Turns Ruby objects into pipelines.
56
+ email: bryan@metabahn.com
57
+ executables: []
58
+ extensions: []
59
+ extra_rdoc_files: []
60
+ files:
61
+ - CHANGELOG.md
62
+ - LICENSE
63
+ - lib/core/pipeline.rb
64
+ - lib/core/pipeline/action.rb
65
+ - lib/core/pipeline/actions/block.rb
66
+ - lib/core/pipeline/actions/method.rb
67
+ - lib/core/pipeline/compiler.rb
68
+ - lib/core/pipeline/signals/halted.rb
69
+ - lib/core/pipeline/signals/rejected.rb
70
+ - lib/core/pipeline/version.rb
71
+ - lib/is/pipeline.rb
72
+ homepage: https://github.com/metabahn/corerb/
73
+ licenses:
74
+ - MPL-2.0
75
+ metadata: {}
76
+ post_install_message:
77
+ rdoc_options: []
78
+ require_paths:
79
+ - lib
80
+ required_ruby_version: !ruby/object:Gem::Requirement
81
+ requirements:
82
+ - - ">="
83
+ - !ruby/object:Gem::Version
84
+ version: '2.7'
85
+ required_rubygems_version: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ requirements: []
91
+ rubygems_version: 3.2.15
92
+ signing_key:
93
+ specification_version: 4
94
+ summary: Turns Ruby objects into pipelines.
95
+ test_files: []