opera 0.6.0 → 0.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/Gemfile.lock +1 -1
- data/README.md +32 -0
- data/docs/examples/inner-operations.md +7 -3
- data/lib/opera/operation/builder/options_builder.rb +29 -0
- data/lib/opera/operation/builder.rb +18 -15
- data/lib/opera/operation/executor.rb +5 -0
- data/lib/opera/operation.rb +1 -0
- data/lib/opera/version.rb +1 -1
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ae5c55f72cf9337e2974bc15f8a834d8e2ec8517f092dcd62c986ebcfe81ef22
|
|
4
|
+
data.tar.gz: f89c957b5c457d1a3981523dffdc608778a4b3d7e5baeb1c2cbbe10a0f0aacb1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9371d589bfa9d5d24cf67d1cbd065aa0622a7e768901fa0430c4510c64934b0a1b13c679cf044554facf9dc53684d597aed3e2ed228b96236642f1edba2b8978
|
|
7
|
+
data.tar.gz: c6810a27ce251b4c1db8cf5f2884e49ffd74467d7fb8015d536cef79c646bd1b393401009075515c21a72b64aa036bbe73710b14f93b2ffb3ded561d0ba516e4
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Opera Changelog
|
|
2
2
|
|
|
3
|
+
### 0.7.1 - Sep 07, 2026
|
|
4
|
+
|
|
5
|
+
- Automatically define a `<method>_output` reader for every `operation` / `operations` instruction, so the output of an inner operation is readable in later steps without a manual `context { attr_reader :<method>_output }` declaration. The reader returns the value stored at `context[:<method>_output]`, which remains accessible directly as before. If a reader with that name is already declared before the instruction (following the convention of declaring `context` / `params` / `dependencies` above the DSL steps), the manual one is kept and no automatic reader is created.
|
|
6
|
+
|
|
7
|
+
### 0.7.0 - Apr 30, 2026
|
|
8
|
+
|
|
9
|
+
- Add `:if` / `:unless` options to all instructions except `always` (`validate`, `transaction`, `step`, `success`, `finish_if`, `operation`, `operations`, `within`) for declarative conditional execution. Conditions accept a Symbol (method name) or a Proc/Lambda (evaluated via `instance_exec` in the operation instance scope). Skipped instructions do not execute and are not recorded in `result.executions`; for block instructions (`transaction`, `within`) the whole block, including nested instructions, is skipped. For `operation` / `operations`, the conventional `<method>_output` slot in context is set to `nil` when skipped, matching the historical `return Opera::Operation::Result.new` early-exit behavior. Passing both `:if` and `:unless` on the same instruction raises `ArgumentError` at class load time.
|
|
10
|
+
|
|
3
11
|
### 0.6.0 - Apr 15, 2026
|
|
4
12
|
|
|
5
13
|
- Add `always` executor: runs its step unconditionally after all regular steps, regardless of failure or an early finish
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -124,6 +124,38 @@ end
|
|
|
124
124
|
| `within :method do ... end` | Wraps nested steps with a custom method that must `yield`. If it doesn't yield, nested steps are skipped. |
|
|
125
125
|
| `always :method` | Executes a step unconditionally after all regular steps, even after a failure or an early finish. Must appear at the end of the operation — only other `always` steps may follow. Cannot be used inside blocks. Use `result.success?` / `result.failure?` inside the method to branch on outcome. |
|
|
126
126
|
|
|
127
|
+
### Conditional execution (`:if` / `:unless`)
|
|
128
|
+
|
|
129
|
+
The `:if` and `:unless` keyword arguments provide declarative conditional
|
|
130
|
+
execution. They are supported on `validate`, `transaction`, `step`, `success`,
|
|
131
|
+
`finish_if`, `operation`, `operations`, and `within` (every instruction except
|
|
132
|
+
`always`). For block instructions (`transaction`, `within`), a falsy condition
|
|
133
|
+
skips the whole block, including its nested instructions.
|
|
134
|
+
|
|
135
|
+
The condition is evaluated **before** the instruction runs -- if the condition
|
|
136
|
+
is not met the instruction is skipped entirely (no method invocation, no side
|
|
137
|
+
effects, not recorded in `result.executions`).
|
|
138
|
+
|
|
139
|
+
The condition value can be a **Symbol** (method name on the operation) or a
|
|
140
|
+
**Proc/Lambda** (evaluated via `instance_exec` in the operation instance
|
|
141
|
+
scope).
|
|
142
|
+
|
|
143
|
+
```ruby
|
|
144
|
+
# Symbol form
|
|
145
|
+
step :notify_user, if: :notifications_enabled?
|
|
146
|
+
|
|
147
|
+
# Lambda form
|
|
148
|
+
step :recalculate, unless: -> { params[:skip_recalculation] }
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
When an `operation` or `operations` instruction is skipped, its
|
|
152
|
+
`context[:<method>_output]` slot is set to `nil` (matching the historical
|
|
153
|
+
`return Opera::Operation::Result.new` early-exit behavior). For other
|
|
154
|
+
instructions no context output is set.
|
|
155
|
+
|
|
156
|
+
Passing both `:if` and `:unless` on the same instruction raises `ArgumentError`
|
|
157
|
+
at class load time.
|
|
158
|
+
|
|
127
159
|
### Combining instructions
|
|
128
160
|
|
|
129
161
|
```ruby
|
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Use `operation` to call another Opera operation from within a step. The method must return an `Opera::Operation::Result`. If the inner operation fails, errors are propagated and execution stops. If it succeeds, its output is stored in context as `:<method_name>_output`.
|
|
6
6
|
|
|
7
|
+
Opera also defines a `<method_name>_output` reader automatically, so you can access the output directly in later steps without declaring `context { attr_reader :<method_name>_output }` yourself. Both `context[:<method_name>_output]` and the reader return the same value.
|
|
8
|
+
|
|
7
9
|
```ruby
|
|
8
10
|
class Profile::Find < Opera::Operation::Base
|
|
9
11
|
step :find
|
|
@@ -33,12 +35,13 @@ class Profile::Create < Opera::Operation::Base
|
|
|
33
35
|
end
|
|
34
36
|
|
|
35
37
|
def create
|
|
36
|
-
|
|
38
|
+
# `find_output` is the auto-generated reader for `operation :find`
|
|
39
|
+
return if find_output
|
|
37
40
|
puts 'not found'
|
|
38
41
|
end
|
|
39
42
|
|
|
40
43
|
def output
|
|
41
|
-
result.output = { model:
|
|
44
|
+
result.output = { model: find_output }
|
|
42
45
|
end
|
|
43
46
|
end
|
|
44
47
|
```
|
|
@@ -82,7 +85,8 @@ class Profile::CreateMultiple < Opera::Operation::Base
|
|
|
82
85
|
end
|
|
83
86
|
|
|
84
87
|
def output
|
|
85
|
-
|
|
88
|
+
# `create_multiple_output` is the auto-generated reader for `operations :create_multiple`
|
|
89
|
+
result.output = create_multiple_output
|
|
86
90
|
end
|
|
87
91
|
end
|
|
88
92
|
```
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Opera
|
|
4
|
+
module Operation
|
|
5
|
+
module Builder
|
|
6
|
+
class OptionsBuilder
|
|
7
|
+
ALLOWED_OPTIONS = %i[if unless].freeze
|
|
8
|
+
|
|
9
|
+
def self.build(opts)
|
|
10
|
+
return {} if opts.empty?
|
|
11
|
+
|
|
12
|
+
unknown = opts.keys - ALLOWED_OPTIONS
|
|
13
|
+
raise ArgumentError, "Unknown option(s): #{unknown.inspect}. Allowed: #{ALLOWED_OPTIONS}" if unknown.any?
|
|
14
|
+
|
|
15
|
+
{ predicate: build_predicate(opts) }.compact
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
def self.build_predicate(opts)
|
|
19
|
+
return nil unless opts[:if] || opts[:unless]
|
|
20
|
+
raise ArgumentError, 'Cannot use :if and :unless together' if opts[:if] && opts[:unless]
|
|
21
|
+
|
|
22
|
+
cond = opts[:if] || opts[:unless]
|
|
23
|
+
condition_proc = cond.is_a?(Symbol) ? proc { send(cond) } : cond
|
|
24
|
+
opts.key?(:if) ? condition_proc : proc { !instance_exec(&condition_proc) }
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
@@ -5,6 +5,7 @@ module Opera
|
|
|
5
5
|
module Builder
|
|
6
6
|
INSTRUCTIONS = %I[validate transaction step success finish_if operation operations within always].freeze
|
|
7
7
|
INNER_INSTRUCTIONS = (INSTRUCTIONS - %I[always]).freeze
|
|
8
|
+
OUTPUT_INSTRUCTIONS = %I[operation operations].freeze
|
|
8
9
|
|
|
9
10
|
def self.included(base)
|
|
10
11
|
base.extend(ClassMethods)
|
|
@@ -16,7 +17,7 @@ module Opera
|
|
|
16
17
|
end
|
|
17
18
|
|
|
18
19
|
INNER_INSTRUCTIONS.each do |instruction|
|
|
19
|
-
define_method instruction do |method = nil, &blk|
|
|
20
|
+
define_method instruction do |method = nil, **opts, &blk|
|
|
20
21
|
if instructions.any? { |i| i[:kind] == :always }
|
|
21
22
|
raise ArgumentError,
|
|
22
23
|
"`#{instruction}` cannot appear after `always`. " \
|
|
@@ -24,7 +25,8 @@ module Opera
|
|
|
24
25
|
end
|
|
25
26
|
|
|
26
27
|
check_method_availability!(method) if method
|
|
27
|
-
|
|
28
|
+
define_output_reader(method) if method && OUTPUT_INSTRUCTIONS.include?(instruction)
|
|
29
|
+
instructions.concat(InnerBuilder.new.send(instruction, method, **opts, &blk))
|
|
28
30
|
end
|
|
29
31
|
end
|
|
30
32
|
|
|
@@ -32,6 +34,13 @@ module Opera
|
|
|
32
34
|
check_method_availability!(method)
|
|
33
35
|
instructions << { kind: :always, method: method }
|
|
34
36
|
end
|
|
37
|
+
|
|
38
|
+
def define_output_reader(method)
|
|
39
|
+
reader = :"#{method}_output"
|
|
40
|
+
return unless instance_methods(false).none?(reader)
|
|
41
|
+
|
|
42
|
+
context { attr_reader(reader) }
|
|
43
|
+
end
|
|
35
44
|
end
|
|
36
45
|
|
|
37
46
|
class InnerBuilder
|
|
@@ -43,19 +52,13 @@ module Opera
|
|
|
43
52
|
end
|
|
44
53
|
|
|
45
54
|
INNER_INSTRUCTIONS.each do |instruction|
|
|
46
|
-
define_method instruction do |method = nil, &blk|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
else
|
|
54
|
-
{
|
|
55
|
-
kind: instruction,
|
|
56
|
-
method: method
|
|
57
|
-
}
|
|
58
|
-
end
|
|
55
|
+
define_method instruction do |method = nil, **opts, &blk|
|
|
56
|
+
entry = if blk
|
|
57
|
+
{ kind: instruction, label: method, instructions: InnerBuilder.new(&blk).instructions }
|
|
58
|
+
else
|
|
59
|
+
{ kind: instruction, method: method }
|
|
60
|
+
end
|
|
61
|
+
instructions << entry.merge(OptionsBuilder.build(opts))
|
|
59
62
|
end
|
|
60
63
|
end
|
|
61
64
|
|
|
@@ -41,6 +41,11 @@ module Opera
|
|
|
41
41
|
|
|
42
42
|
# rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
|
|
43
43
|
def evaluate_instruction(instruction)
|
|
44
|
+
if instruction[:predicate] && !operation.instance_exec(&instruction[:predicate])
|
|
45
|
+
add_instruction_output(instruction, nil) if %i[operation operations].include?(instruction[:kind])
|
|
46
|
+
return
|
|
47
|
+
end
|
|
48
|
+
|
|
44
49
|
case instruction[:kind]
|
|
45
50
|
when :step
|
|
46
51
|
Instructions::Executors::Step.new(operation).call(instruction)
|
data/lib/opera/operation.rb
CHANGED
data/lib/opera/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: opera
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.7.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- ProFinda Development Team
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-
|
|
11
|
+
date: 2026-09-07 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: dry-validation
|
|
@@ -92,6 +92,7 @@ files:
|
|
|
92
92
|
- lib/opera/operation/attributes_dsl.rb
|
|
93
93
|
- lib/opera/operation/base.rb
|
|
94
94
|
- lib/opera/operation/builder.rb
|
|
95
|
+
- lib/opera/operation/builder/options_builder.rb
|
|
95
96
|
- lib/opera/operation/config.rb
|
|
96
97
|
- lib/opera/operation/executor.rb
|
|
97
98
|
- lib/opera/operation/instructions/executors/always.rb
|