flows 0.3.0 → 0.4.0

data/bin/benchmark_cli/compare/command.rb

@@ -0,0 +1,47 @@
+class BenchmarkCLI
+  module Compare
+    # Comparison benchmarks command.
+    class Command
+      include Helpers
+      include Flows::Result::Helpers
+      extend Flows::Result::Do
+
+      def initialize(benchmarks, implementations)
+        @benchmarks = benchmarks.map(&:to_sym)
+        @implementations = implementations.map(&:to_sym)
+      end
+
+      do_notation(:call)
+      def call
+        yield validate_benchmarks
+        yield validate_implementations
+
+        run
+      end
+
+      private
+
+      def validate_benchmarks
+        @benchmarks.each do |benchmark|
+          return err_data("Unexpected benchmark: #{benchmark}") unless BENCHMARKS.key?(benchmark)
+        end
+
+        ok
+      end
+
+      def validate_implementations
+        @implementations.each do |impl|
+          return err_data("Unexpected implementation: #{impl}") unless IMPLEMENTATIONS.key?(impl)
+        end
+
+        ok
+      end
+
+      def run
+        @benchmarks.each do |name|
+          BENCHMARKS[name].new(@implementations).call
+        end
+      end
+    end
+  end
+end

data/bin/benchmark_cli/compare/ten_steps.rb

@@ -0,0 +1,22 @@
+class BenchmarkCLI
+  module Compare
+    # '10 steps' comparison.
+    class TenSteps < Base
+      TITLE = '10 steps, each returns `true` or `{ step_name: true }`, no input'.freeze
+      NAME = :ten_steps
+
+      def report_class_call(benchmark, title, klass)
+        benchmark.report title do
+          klass.call
+        end
+      end
+
+      def report_instance_call(benchmark, title, klass)
+        instance = klass.new
+        benchmark.report title do
+          instance.call
+        end
+      end
+    end
+  end
+end

data/bin/benchmark_cli/examples.rb

@@ -0,0 +1,23 @@
+require_relative 'examples/a_plus_b/dry_do'
+require_relative 'examples/ten_steps/dry_do'
+
+require_relative 'examples/a_plus_b/dry_transaction'
+require_relative 'examples/ten_steps/dry_transaction'
+
+require_relative 'examples/a_plus_b/flows_do'
+require_relative 'examples/ten_steps/flows_do'
+
+require_relative 'examples/a_plus_b/flows_railway'
+require_relative 'examples/ten_steps/flows_railway'
+
+require_relative 'examples/a_plus_b/flows_scp'
+require_relative 'examples/ten_steps/flows_scp'
+
+require_relative 'examples/a_plus_b/flows_scp_oc'
+require_relative 'examples/ten_steps/flows_scp_oc'
+
+require_relative 'examples/a_plus_b/flows_scp_mut'
+require_relative 'examples/ten_steps/flows_scp_mut'
+
+require_relative 'examples/a_plus_b/trailblazer'
+require_relative 'examples/ten_steps/trailblazer'

data/bin/benchmark_cli/examples/.rubocop.yml

@@ -0,0 +1,19 @@
+inherit_from:
+  - ../../.rubocop.yml
+
+# Examples can contain inaccurate or meaningless code
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Lint/UselessAssignment:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/bin/benchmark_cli/examples/a_plus_b/dry_do.rb

@@ -0,0 +1,23 @@
+require 'dry/monads'
+require 'dry/monads/do'
+
+class BenchmarkCLI
+  module Examples
+    module APlusB
+      class DryDo
+        include Dry::Monads[:result]
+
+        include Dry::Monads::Do.for(:call)
+        def call(a:, b:)
+          Success(yield do_call(a, b))
+        end
+
+        private
+
+        def do_call(a, b)
+          Success(a + b)
+        end
+      end
+    end
+  end
+end

data/bin/benchmark_cli/examples/a_plus_b/dry_transaction.rb

@@ -0,0 +1,17 @@
+require 'dry/transaction'
+
+class BenchmarkCLI
+  module Examples
+    module APlusB
+      class DryTransaction
+        include Dry::Transaction
+
+        step :calculation
+
+        def calculation(a:, b:)
+          Success(a + b)
+        end
+      end
+    end
+  end
+end

data/bin/benchmark_cli/examples/a_plus_b/flows_do.rb

@@ -0,0 +1,22 @@
+class BenchmarkCLI
+  module Examples
+    module APlusB
+      class FlowsDo
+        include Flows::Result::Helpers
+
+        extend Flows::Result::Do
+
+        do_notation(:call)
+        def call(a:, b:)
+          ok_data(yield do_call(a, b))
+        end
+
+        private
+
+        def do_call(a, b)
+          ok_data(a + b)
+        end
+      end
+    end
+  end
+end

data/bin/benchmark_cli/examples/a_plus_b/flows_railway.rb

@@ -0,0 +1,13 @@
+class BenchmarkCLI
+  module Examples
+    module APlusB
+      class FlowsRailway < Flows::Railway
+        step :calculation
+
+        def calculation(a:, b:)
+          ok(sum: a + b)
+        end
+      end
+    end
+  end
+end

data/bin/benchmark_cli/examples/a_plus_b/flows_scp.rb

@@ -0,0 +1,13 @@
+class BenchmarkCLI
+  module Examples
+    module APlusB
+      class FlowsSCP < Flows::SharedContextPipeline
+        step :calculation
+
+        def calculation(a:, b:)
+          ok(sum: a + b)
+        end
+      end
+    end
+  end
+end

data/bin/benchmark_cli/examples/a_plus_b/flows_scp_mut.rb

@@ -0,0 +1,13 @@
+class BenchmarkCLI
+  module Examples
+    module APlusB
+      class FlowsSCPMut < Flows::SharedContextPipeline
+        mut_step :calculation
+
+        def calculation(ctx)
+          ctx[:cum] = ctx[:a] + ctx[:b]
+        end
+      end
+    end
+  end
+end

data/bin/benchmark_cli/examples/a_plus_b/flows_scp_oc.rb

@@ -0,0 +1,21 @@
+class BenchmarkCLI
+  module Examples
+    module APlusB
+      class FlowsSCPOC < Flows::SharedContextPipeline
+        include Flows::Plugin::OutputContract
+
+        step :calculation
+
+        success_with :ok do
+          hash_of(
+            sum: Integer
+          )
+        end
+
+        def calculation(a:, b:)
+          ok(sum: a + b)
+        end
+      end
+    end
+  end
+end

data/bin/benchmark_cli/examples/a_plus_b/trailblazer.rb

@@ -0,0 +1,15 @@
+require 'trailblazer/operation'
+
+class BenchmarkCLI
+  module Examples
+    module APlusB
+      class TB < ::Trailblazer::Operation
+        step :calculation
+
+        def calculation(opts, a:, b:)
+          opts[:sum] = a + b
+        end
+      end
+    end
+  end
+end

data/bin/benchmark_cli/examples/ten_steps/dry_do.rb

@@ -0,0 +1,70 @@
+require 'dry/monads'
+require 'dry/monads/do'
+
+class BenchmarkCLI
+  module Examples
+    module TenSteps
+      class DryDo
+        include Dry::Monads[:result]
+
+        include Dry::Monads::Do.for(:call)
+        def call
+          x1 = yield s1(:s1)
+          x2 = yield s2(:s2)
+          x3 = yield s3(:s3)
+          x4 = yield s4(:s4)
+          x5 = yield s5(:s5)
+          x6 = yield s6(:s6)
+          x7 = yield s7(:s7)
+          x8 = yield s8(:s8)
+          x9 = yield s9(:s9)
+          x10 = yield s10(:s10)
+
+          Success(x10)
+        end
+
+        private
+
+        def s1(_x)
+          Success(true)
+        end
+
+        def s2(_x)
+          Success(true)
+        end
+
+        def s3(_x)
+          Success(true)
+        end
+
+        def s4(_x)
+          Success(true)
+        end
+
+        def s5(_x)
+          Success(true)
+        end
+
+        def s6(_x)
+          Success(true)
+        end
+
+        def s7(_x)
+          Success(true)
+        end
+
+        def s8(_x)
+          Success(true)
+        end
+
+        def s9(_x)
+          Success(true)
+        end
+
+        def s10(_x)
+          Success(true)
+        end
+      end
+    end
+  end
+end

data/bin/benchmark_cli/examples/ten_steps/dry_transaction.rb

@@ -0,0 +1,64 @@
+require 'dry/transaction'
+
+class BenchmarkCLI
+  module Examples
+    module TenSteps
+      class DryTransaction
+        include Dry::Transaction
+
+        step :s1
+        step :s2
+        step :s3
+        step :s4
+        step :s5
+        step :s6
+        step :s7
+        step :s8
+        step :s9
+        step :s10
+
+        private
+
+        def s1(_x)
+          Success(true)
+        end
+
+        def s2(_x)
+          Success(true)
+        end
+
+        def s3(_x)
+          Success(true)
+        end
+
+        def s4(_x)
+          Success(true)
+        end
+
+        def s5(_x)
+          Success(true)
+        end
+
+        def s6(_x)
+          Success(true)
+        end
+
+        def s7(_x)
+          Success(true)
+        end
+
+        def s8(_x)
+          Success(true)
+        end
+
+        def s9(_x)
+          Success(true)
+        end
+
+        def s10(_x)
+          Success(true)
+        end
+      end
+    end
+  end
+end

data/bin/benchmark_cli/examples/ten_steps/flows_do.rb

@@ -0,0 +1,69 @@
+class BenchmarkCLI
+  module Examples
+    module TenSteps
+      class FlowsDo
+        include Flows::Result::Helpers
+
+        extend Flows::Result::Do
+
+        do_notation(:call)
+        def call
+          x1 = yield s1(:s1)
+          x2 = yield s2(:s2)
+          x3 = yield s3(:s3)
+          x4 = yield s4(:s4)
+          x5 = yield s5(:s5)
+          x6 = yield s6(:s6)
+          x7 = yield s7(:s7)
+          x8 = yield s8(:s8)
+          x9 = yield s9(:s9)
+          x10 = yield s10(:s10)
+
+          ok
+        end
+
+        private
+
+        def s1(_sym)
+          ok_data(true)
+        end
+
+        def s2(_sym)
+          ok_data(true)
+        end
+
+        def s3(_sym)
+          ok_data(true)
+        end
+
+        def s4(_sym)
+          ok_data(true)
+        end
+
+        def s5(_sym)
+          ok_data(true)
+        end
+
+        def s6(_sym)
+          ok_data(true)
+        end
+
+        def s7(_sym)
+          ok_data(true)
+        end
+
+        def s8(_sym)
+          ok_data(true)
+        end
+
+        def s9(_sym)
+          ok_data(true)
+        end
+
+        def s10(_sym)
+          ok_data(true)
+        end
+      end
+    end
+  end
+end