flows 0.3.0 → 0.4.0
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/.github/workflows/{build.yml → test.yml} +5 -10
- data/.gitignore +1 -0
- data/.reek.yml +42 -0
- data/.rubocop.yml +20 -7
- data/.ruby-version +1 -1
- data/.yardopts +1 -0
- data/CHANGELOG.md +42 -0
- data/Gemfile +0 -6
- data/Gemfile.lock +139 -74
- data/README.md +158 -364
- data/Rakefile +35 -1
- data/bin/.rubocop.yml +5 -0
- data/bin/all_the_errors +47 -0
- data/bin/benchmark +73 -105
- data/bin/benchmark_cli/compare.rb +118 -0
- data/bin/benchmark_cli/compare/a_plus_b.rb +22 -0
- data/bin/benchmark_cli/compare/base.rb +45 -0
- data/bin/benchmark_cli/compare/command.rb +47 -0
- data/bin/benchmark_cli/compare/ten_steps.rb +22 -0
- data/bin/benchmark_cli/examples.rb +23 -0
- data/bin/benchmark_cli/examples/.rubocop.yml +19 -0
- data/bin/benchmark_cli/examples/a_plus_b/dry_do.rb +23 -0
- data/bin/benchmark_cli/examples/a_plus_b/dry_transaction.rb +17 -0
- data/bin/benchmark_cli/examples/a_plus_b/flows_do.rb +22 -0
- data/bin/benchmark_cli/examples/a_plus_b/flows_railway.rb +13 -0
- data/bin/benchmark_cli/examples/a_plus_b/flows_scp.rb +13 -0
- data/bin/benchmark_cli/examples/a_plus_b/flows_scp_mut.rb +13 -0
- data/bin/benchmark_cli/examples/a_plus_b/flows_scp_oc.rb +21 -0
- data/bin/benchmark_cli/examples/a_plus_b/trailblazer.rb +15 -0
- data/bin/benchmark_cli/examples/ten_steps/dry_do.rb +70 -0
- data/bin/benchmark_cli/examples/ten_steps/dry_transaction.rb +64 -0
- data/bin/benchmark_cli/examples/ten_steps/flows_do.rb +69 -0
- data/bin/benchmark_cli/examples/ten_steps/flows_railway.rb +58 -0
- data/bin/benchmark_cli/examples/ten_steps/flows_scp.rb +58 -0
- data/bin/benchmark_cli/examples/ten_steps/flows_scp_mut.rb +58 -0
- data/bin/benchmark_cli/examples/ten_steps/flows_scp_oc.rb +66 -0
- data/bin/benchmark_cli/examples/ten_steps/trailblazer.rb +60 -0
- data/bin/benchmark_cli/helpers.rb +12 -0
- data/bin/benchmark_cli/ruby.rb +15 -0
- data/bin/benchmark_cli/ruby/command.rb +38 -0
- data/bin/benchmark_cli/ruby/method_exec.rb +71 -0
- data/bin/benchmark_cli/ruby/self_class.rb +69 -0
- data/bin/benchmark_cli/ruby/structs.rb +90 -0
- data/bin/console +1 -0
- data/bin/docserver +7 -0
- data/bin/errors +118 -0
- data/bin/errors_cli/contract_error_demo.rb +49 -0
- data/bin/errors_cli/di_error_demo.rb +38 -0
- data/bin/errors_cli/flows_router_error_demo.rb +15 -0
- data/bin/errors_cli/oc_error_demo.rb +40 -0
- data/bin/errors_cli/railway_error_demo.rb +10 -0
- data/bin/errors_cli/result_error_demo.rb +13 -0
- data/bin/errors_cli/scp_error_demo.rb +17 -0
- data/docs/README.md +2 -186
- data/docs/_sidebar.md +0 -24
- data/docs/index.html +1 -1
- data/flows.gemspec +25 -2
- data/forspell.dict +9 -0
- data/lefthook.yml +9 -0
- data/lib/flows.rb +11 -5
- data/lib/flows/contract.rb +402 -0
- data/lib/flows/contract/array.rb +55 -0
- data/lib/flows/contract/case_eq.rb +41 -0
- data/lib/flows/contract/compose.rb +77 -0
- data/lib/flows/contract/either.rb +53 -0
- data/lib/flows/contract/error.rb +25 -0
- data/lib/flows/contract/hash.rb +75 -0
- data/lib/flows/contract/hash_of.rb +70 -0
- data/lib/flows/contract/helpers.rb +22 -0
- data/lib/flows/contract/predicate.rb +34 -0
- data/lib/flows/contract/transformer.rb +50 -0
- data/lib/flows/contract/tuple.rb +70 -0
- data/lib/flows/flow.rb +75 -7
- data/lib/flows/flow/node.rb +131 -0
- data/lib/flows/flow/router.rb +25 -0
- data/lib/flows/flow/router/custom.rb +54 -0
- data/lib/flows/flow/router/errors.rb +11 -0
- data/lib/flows/flow/router/simple.rb +20 -0
- data/lib/flows/plugin.rb +13 -0
- data/lib/flows/plugin/dependency_injector.rb +159 -0
- data/lib/flows/plugin/dependency_injector/dependency.rb +24 -0
- data/lib/flows/plugin/dependency_injector/dependency_definition.rb +16 -0
- data/lib/flows/plugin/dependency_injector/dependency_list.rb +57 -0
- data/lib/flows/plugin/dependency_injector/errors.rb +58 -0
- data/lib/flows/plugin/implicit_init.rb +45 -0
- data/lib/flows/plugin/output_contract.rb +84 -0
- data/lib/flows/plugin/output_contract/dsl.rb +36 -0
- data/lib/flows/plugin/output_contract/errors.rb +74 -0
- data/lib/flows/plugin/output_contract/wrapper.rb +53 -0
- data/lib/flows/railway.rb +140 -37
- data/lib/flows/railway/dsl.rb +8 -19
- data/lib/flows/railway/errors.rb +8 -12
- data/lib/flows/railway/step.rb +24 -0
- data/lib/flows/railway/step_list.rb +38 -0
- data/lib/flows/result.rb +188 -2
- data/lib/flows/result/do.rb +160 -16
- data/lib/flows/result/err.rb +12 -6
- data/lib/flows/result/errors.rb +29 -17
- data/lib/flows/result/helpers.rb +25 -3
- data/lib/flows/result/ok.rb +12 -6
- data/lib/flows/shared_context_pipeline.rb +216 -0
- data/lib/flows/shared_context_pipeline/dsl.rb +63 -0
- data/lib/flows/shared_context_pipeline/errors.rb +17 -0
- data/lib/flows/shared_context_pipeline/mutation_step.rb +31 -0
- data/lib/flows/shared_context_pipeline/router_definition.rb +21 -0
- data/lib/flows/shared_context_pipeline/step.rb +46 -0
- data/lib/flows/shared_context_pipeline/track.rb +67 -0
- data/lib/flows/shared_context_pipeline/track_list.rb +46 -0
- data/lib/flows/util.rb +17 -0
- data/lib/flows/util/inheritable_singleton_vars.rb +79 -0
- data/lib/flows/util/inheritable_singleton_vars/dup_strategy.rb +109 -0
- data/lib/flows/util/inheritable_singleton_vars/isolation_strategy.rb +104 -0
- data/lib/flows/util/prepend_to_class.rb +145 -0
- data/lib/flows/version.rb +1 -1
- metadata +233 -37
- data/bin/demo +0 -66
- data/bin/examples.rb +0 -195
- data/bin/profile_10steps +0 -106
- data/bin/ruby_benchmarks +0 -26
- data/docs/CNAME +0 -1
- data/docs/contributing/benchmarks_profiling.md +0 -3
- data/docs/contributing/local_development.md +0 -3
- data/docs/flow/direct_usage.md +0 -3
- data/docs/flow/general_idea.md +0 -3
- data/docs/operation/basic_usage.md +0 -1
- data/docs/operation/inject_steps.md +0 -3
- data/docs/operation/lambda_steps.md +0 -3
- data/docs/operation/result_shapes.md +0 -3
- data/docs/operation/routing_tracks.md +0 -3
- data/docs/operation/wrapping_steps.md +0 -3
- data/docs/overview/performance.md +0 -336
- data/docs/railway/basic_usage.md +0 -232
- data/docs/result_objects/basic_usage.md +0 -196
- data/docs/result_objects/do_notation.md +0 -139
- data/lib/flows/implicit_build.rb +0 -16
- data/lib/flows/node.rb +0 -27
- data/lib/flows/operation.rb +0 -55
- data/lib/flows/operation/builder.rb +0 -130
- data/lib/flows/operation/builder/build_router.rb +0 -37
- data/lib/flows/operation/dsl.rb +0 -93
- data/lib/flows/operation/errors.rb +0 -75
- data/lib/flows/operation/executor.rb +0 -78
- data/lib/flows/railway/builder.rb +0 -68
- data/lib/flows/railway/executor.rb +0 -23
- data/lib/flows/result_router.rb +0 -14
- data/lib/flows/router.rb +0 -22
@@ -1,68 +0,0 @@
|
|
1
|
-
module Flows
|
2
|
-
module Railway
|
3
|
-
# Flow builder
|
4
|
-
class Builder
|
5
|
-
attr_reader :steps, :method_source, :deps
|
6
|
-
|
7
|
-
def initialize(steps:, method_source:, deps:)
|
8
|
-
@method_source = method_source
|
9
|
-
@steps = steps
|
10
|
-
@deps = deps
|
11
|
-
end
|
12
|
-
|
13
|
-
def call
|
14
|
-
resolve_bodies_and_wiring!
|
15
|
-
|
16
|
-
nodes = build_nodes
|
17
|
-
Flows::Flow.new(start_node: nodes.first.name, nodes: nodes)
|
18
|
-
end
|
19
|
-
|
20
|
-
private
|
21
|
-
|
22
|
-
def resolve_bodies_and_wiring!
|
23
|
-
index = 0
|
24
|
-
|
25
|
-
while index < @steps.length
|
26
|
-
current_step = @steps[index]
|
27
|
-
|
28
|
-
current_step[:next_step] = @steps[index + 1]&.fetch(:name) || :term
|
29
|
-
current_step[:body] = current_step[:custom_body] || resolve_body_from_source(current_step[:name])
|
30
|
-
|
31
|
-
index += 1
|
32
|
-
end
|
33
|
-
end
|
34
|
-
|
35
|
-
def resolve_body_from_source(name)
|
36
|
-
return @deps[name] if @deps.key?(name)
|
37
|
-
|
38
|
-
raise(::Flows::Railway::NoStepImplementationError, name) unless @method_source.respond_to?(name)
|
39
|
-
|
40
|
-
@method_source.method(name)
|
41
|
-
end
|
42
|
-
|
43
|
-
def build_nodes
|
44
|
-
@nodes = @steps.map do |step|
|
45
|
-
Flows::Node.new(
|
46
|
-
name: step[:name],
|
47
|
-
body: step[:body],
|
48
|
-
preprocessor: method(:node_preprocessor),
|
49
|
-
postprocessor: method(:node_postprocessor),
|
50
|
-
router: Flows::ResultRouter.new(step[:next_step], :term),
|
51
|
-
|
52
|
-
meta: { name: step[:name] }
|
53
|
-
)
|
54
|
-
end
|
55
|
-
end
|
56
|
-
|
57
|
-
def node_preprocessor(input, _context, _meta)
|
58
|
-
input.unwrap
|
59
|
-
end
|
60
|
-
|
61
|
-
def node_postprocessor(output, context, meta)
|
62
|
-
context[:last_step] = meta[:name]
|
63
|
-
|
64
|
-
output
|
65
|
-
end
|
66
|
-
end
|
67
|
-
end
|
68
|
-
end
|
@@ -1,23 +0,0 @@
|
|
1
|
-
module Flows
|
2
|
-
module Railway
|
3
|
-
# Runner for railway steps
|
4
|
-
class Executor
|
5
|
-
include ::Flows::Result::Helpers
|
6
|
-
|
7
|
-
def initialize(flow:, class_name:)
|
8
|
-
@flow = flow
|
9
|
-
@railway_class_name = class_name
|
10
|
-
end
|
11
|
-
|
12
|
-
def call(**params)
|
13
|
-
context = {}
|
14
|
-
last_result = @flow.call(ok(params), context: context)
|
15
|
-
|
16
|
-
last_result.meta[:railway] = @railway_class_name
|
17
|
-
last_result.meta[:last_step] = context[:last_step]
|
18
|
-
|
19
|
-
last_result
|
20
|
-
end
|
21
|
-
end
|
22
|
-
end
|
23
|
-
end
|
data/lib/flows/result_router.rb
DELETED
@@ -1,14 +0,0 @@
|
|
1
|
-
module Flows
|
2
|
-
# Node router for simple case when result must be a `Flows::Result`
|
3
|
-
# and we don't care about result status key
|
4
|
-
class ResultRouter
|
5
|
-
def initialize(success_route, failure_route)
|
6
|
-
@success_route = success_route
|
7
|
-
@failure_route = failure_route
|
8
|
-
end
|
9
|
-
|
10
|
-
def call(output, **)
|
11
|
-
output.ok? ? @success_route : @failure_route
|
12
|
-
end
|
13
|
-
end
|
14
|
-
end
|
data/lib/flows/router.rb
DELETED
@@ -1,22 +0,0 @@
|
|
1
|
-
module Flows
|
2
|
-
# Node router: defines predicate rules to calculate next node.
|
3
|
-
class Router
|
4
|
-
class Error < Flows::Error; end
|
5
|
-
class NoRouteError < Error; end
|
6
|
-
|
7
|
-
def initialize(route_hash, preprocessor: nil)
|
8
|
-
@route_def = route_hash
|
9
|
-
@preprocessor = preprocessor
|
10
|
-
end
|
11
|
-
|
12
|
-
def call(output, context:, meta:)
|
13
|
-
data = @preprocessor ? @preprocessor.call(output, context, meta) : output
|
14
|
-
|
15
|
-
@route_def.each_pair do |predicate, route|
|
16
|
-
return route if predicate === data # rubocop:disable Style/CaseEquality
|
17
|
-
end
|
18
|
-
|
19
|
-
raise NoRouteError, "no route found found for output: #{output.inspect}"
|
20
|
-
end
|
21
|
-
end
|
22
|
-
end
|