flows 0.2.0 → 0.6.0

data/Rakefile

@@ -2,8 +2,42 @@ require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
+require 'reek/rake/task'
+require 'inch/rake'
+
+require 'forspell/cli'
+require 'mdl'
 
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:rubocop)
+Reek::Rake::Task.new
+Inch::Rake::Suggest.new
+
+PATHS_TO_SPELLCHECK = ['.'].freeze
+PATHS_FOR_MDL = ['README.md', 'CHANGELOG.md', Dir.glob('docs/**/*.md')].flatten.freeze
+
+desc 'Run self spellchecking'
+task :spellcheck do |_task|
+  puts 'Run forspell checker...'
+  Forspell::CLI.new(PATHS_TO_SPELLCHECK).call
+rescue SystemExit => err
+  if err.status.zero?
+    puts 'Everything is ok.'
+  else
+    exit err.status
+  end
+end
+
+desc 'Run markdown linter'
+task :mdl do |_task|
+  puts 'Run MDL linter...'
+  MarkdownLint.run(PATHS_FOR_MDL)
+rescue SystemExit => err
+  if err.status.zero?
+    puts 'Everything is ok.'
+  else
+    exit err.status
+  end
+end
 
-task default: %i[rubocop spec]
+task default: %i[rubocop reek spec spellcheck mdl]

data/bin/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from:
+  - ../.rubocop.yml
+
+Style/Documentation:
+  Enabled: false

data/bin/all_the_errors

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+"${BASH_SOURCE%/*}/errors" contract
+"${BASH_SOURCE%/*}/errors" router
+
+echo
+echo
+echo "---------------------------"
+echo "Dependency Injection plugin"
+echo "---------------------------"
+"${BASH_SOURCE%/*}/errors" di missing
+"${BASH_SOURCE%/*}/errors" di unexpected
+"${BASH_SOURCE%/*}/errors" di invalid_type
+"${BASH_SOURCE%/*}/errors" di missing_default
+
+echo
+echo
+echo "---------------------------"
+echo "Output Contract plugin"
+echo "---------------------------"
+"${BASH_SOURCE%/*}/errors" output_contract no_contract
+"${BASH_SOURCE%/*}/errors" output_contract contract
+"${BASH_SOURCE%/*}/errors" output_contract status
+"${BASH_SOURCE%/*}/errors" output_contract result_type
+
+echo
+echo
+echo "---------------------------"
+echo "Railway"
+echo "---------------------------"
+"${BASH_SOURCE%/*}/errors" railway no_steps
+
+echo
+echo
+echo "---------------------------"
+echo "Result"
+echo "---------------------------"
+"${BASH_SOURCE%/*}/errors" result ok_access
+"${BASH_SOURCE%/*}/errors" result err_access
+
+echo
+echo
+echo "---------------------------"
+echo "Shared Context Pipeline"
+echo "---------------------------"
+"${BASH_SOURCE%/*}/errors" scp no_steps
+"${BASH_SOURCE%/*}/errors" scp no_step_impl
+
+echo
+echo
+echo "---------------------------"
+echo "Flow"
+echo "---------------------------"
+"${BASH_SOURCE%/*}/errors" flow invalid_node_route
+"${BASH_SOURCE%/*}/errors" flow no_first_node

data/bin/benchmark

@@ -1,111 +1,79 @@
 #!/usr/bin/env ruby
-# rubocop:disable all
 
 require 'bundler/setup'
-require 'benchmark/ips'
-
-require_relative './examples'
-
-with_all = ENV['WITH_ALL']
-
-with_railway = ENV['WITH_RW'] || with_all
-with_operation = ENV['WITH_OP'] || with_all
-with_dry = ENV['WITH_DRY'] || with_all
-with_trailblazer = ENV['WITH_TB'] || with_all
-
-with_poro = ENV['WITH_PORO']
-
-no_prebuild = ENV['NO_PREBUILD']
-no_eachbuild = ENV['NO_EACHBUILD']
-
-
-puts '-' * 50
-puts '- task: A + B, one step implementation'
-puts '-' * 50
-
-flows_summator = FlowsSummator.new
-flows_railway_summator = FlowsRailwaySummator.new
-dry_summator = DrySummator.new
-
-Benchmark.ips do |b|
-  b.report 'Flows::Railway (build once)' do
-    flows_railway_summator.call(a: 1, b: 2)
-  end if with_railway && !no_prebuild
-
-  b.report 'Flows::Railway (build each time)' do
-    FlowsRailwaySummator.new.call(a: 1, b: 2)
-  end if with_railway && !no_eachbuild
-
-  b.report 'Flows::Operation (build once)' do
-    flows_summator.call(a: 1, b: 2)
-  end if with_operation && !no_prebuild
-
-  b.report 'Flows::Operation (build each time)' do
-    FlowsSummator.new.call(a: 1, b: 2)
-  end if with_operation && !no_eachbuild
-
-  b.report 'Dry::Transaction (build once)' do
-    dry_summator.call(a: 1, b: 2)
-  end if with_dry && !no_prebuild
-
-  b.report 'Dry::Transaction (build each time)' do
-    DrySummator.new.call(a: 1, b: 2)
-  end if with_dry && !no_eachbuild
+require 'flows'
 
-  b.report 'Trailblazer::Operation' do
-    TBSummator.call(a: 1, b: 2)
-  end if with_trailblazer
-
-  b.report 'PORO' do
-    POROSummator.call(a: 1, b: 2)
-  end if with_poro
-
-  b.compare!
+require 'benchmark/ips'
+require 'pry'
+require 'gli'
+require 'warning'
+
+require_relative 'benchmark_cli/helpers'
+require_relative 'benchmark_cli/examples'
+
+require_relative 'benchmark_cli/ruby'
+require_relative 'benchmark_cli/compare'
+
+Warning.ignore(/BigDecimal.new is deprecated/)
+
+# Benchmarking CLI application
+class BenchmarkCLI
+  extend GLI::App
+  extend Flows::Result::Helpers
+
+  program_desc 'Benchmark runner'
+
+  use_openstruct true
+
+  desc 'Run Ruby benchmarks'
+  ruby_benchmarks = Ruby::BENCHMARKS.keys.map(&:to_s)
+  command :ruby do |cmd|
+    cmd.flag(
+      %i[b benchmarks],
+      desc: "benchmarks to run. Pick from: #{ruby_benchmarks.join(', ')}. By default all the benchmarks are executed.",
+      type: String,
+      multiple: true,
+      must_match: ruby_benchmarks,
+      default_value: ruby_benchmarks
+    )
+
+    cmd.action do |_gopts, opts, _args|
+      result = Ruby::Command.new(opts.benchmarks).call
+
+      case result
+      when match_ok then puts 'Benchmark finished! Thank you for patience!'
+      when match_err then exit_now!(result.error)
+      end
+    end
+  end
+
+  desc 'Compare different Flows abstractions and alternatives from the other libraries'
+  command :compare do |cmd|
+    benchmarks = Compare::BENCHMARKS.keys.map(&:to_s)
+    cmd.flag %i[b benchmarks],
+             desc: 'benchmarks to run',
+             type: String,
+             multiple: true,
+             must_match: benchmarks,
+             default_value: benchmarks
+
+    implementations = Compare::IMPLEMENTATIONS.keys.map(&:to_s)
+    cmd.flag %i[i implementations],
+             desc: 'implementations to compare',
+             type: String,
+             multiple: true,
+             must_match: implementations,
+             default_value: implementations
+
+    cmd.action do |_gopts, opts, _args|
+      result = Compare::Command.new(opts.benchmarks, opts.implementations).call
+
+      case result
+      when match_ok then puts 'Benchmark finished! Thank you for patience!'
+      when match_err then exit_now!(result.error)
+      end
+    end
+  end
 end
-puts
-
-
-puts '-' * 50
-puts '- task: ten steps returns successful result'
-puts '-' * 50
-
-flows_ten_steps = FlowsTenSteps.new
-flows_railway_ten_steps = FlowsRailwayTenSteps.new
-dry_ten_steps = DryTenSteps.new
-
-Benchmark.ips do |b|
-  b.report 'Flows::Railway (build once)' do
-    flows_railway_ten_steps.call(a: 1, b: 2)
-  end if with_railway && !no_prebuild
-
-  b.report 'Flows::Railway (build each time)' do
-    FlowsRailwayTenSteps.new.call(a: 1, b: 2)
-  end if with_railway && !no_eachbuild
 
-  b.report 'Flows::Operation (build once)' do
-    flows_ten_steps.call(a: 1, b: 2)
-  end if with_operation && !no_prebuild
-
-  b.report 'Flows::Operation (build each time)' do
-    FlowsTenSteps.new.call(a: 1, b: 2)
-  end if with_operation && !no_eachbuild
-
-  b.report 'Dry::Transaction (build once)' do
-    dry_ten_steps.call(a: 1, b: 2)
-  end if with_dry && !no_prebuild
-
-  b.report 'Dry::Transaction (build each time)' do
-    DryTenSteps.new.call(a: 1, b: 2)
-  end if with_dry && !no_eachbuild
-
-  b.report 'Trailblazer::Operation' do
-    TBTenSteps.call(a: 1, b: 2)
-  end if with_trailblazer
-
-  b.report 'PORO' do
-    POROTenSteps.call
-  end if with_poro
-
-  b.compare!
-end
-puts
+exit BenchmarkCLI.run(ARGV)

data/bin/benchmark_cli/compare.rb

@@ -0,0 +1,118 @@
+require_relative 'compare/base'
+require_relative 'compare/a_plus_b'
+require_relative 'compare/ten_steps'
+
+require_relative 'compare/command'
+
+class BenchmarkCLI
+  module Compare # rubocop:disable Metrics/ModuleLength
+    BENCHMARKS = {
+      APlusB::NAME => APlusB,
+      TenSteps::NAME => TenSteps
+    }.freeze
+
+    MODES = {
+      class_call: 'execute `Implementation.call(...)`',
+      instance_call: 'execute `instance.call(...)`'
+    }.freeze
+
+    IMPLEMENTATIONS = {
+      flows_do: {
+        title: 'Flows Do-notation',
+        mode: :instance_call,
+        classes: {
+          APlusB::NAME => Examples::APlusB::FlowsDo,
+          TenSteps::NAME => Examples::TenSteps::FlowsDo
+        }
+      },
+      flows_railway_class: {
+        title: 'Flows Railway',
+        mode: :class_call,
+        classes: {
+          APlusB::NAME => Examples::APlusB::FlowsRailway,
+          TenSteps::NAME => Examples::TenSteps::FlowsRailway
+        }
+      },
+      flows_railway_instance: {
+        title: 'Flows Railway',
+        mode: :instance_call,
+        classes: {
+          APlusB::NAME => Examples::APlusB::FlowsRailway,
+          TenSteps::NAME => Examples::TenSteps::FlowsRailway
+        }
+      },
+      flows_scp_class: {
+        title: 'Flows Shared Context Pipeline, functional steps',
+        mode: :class_call,
+        classes: {
+          APlusB::NAME => Examples::APlusB::FlowsSCP,
+          TenSteps::NAME => Examples::TenSteps::FlowsSCP
+        }
+      },
+      flows_scp_instance: {
+        title: 'Flows Shared Context Pipeline, functional steps',
+        mode: :instance_call,
+        classes: {
+          APlusB::NAME => Examples::APlusB::FlowsSCP,
+          TenSteps::NAME => Examples::TenSteps::FlowsSCP
+        }
+      },
+      flows_scp_oc_class: {
+        title: 'Flows Shared Context Pipeline with contract for output, functional steps',
+        mode: :class_call,
+        classes: {
+          APlusB::NAME => Examples::APlusB::FlowsSCPOC,
+          TenSteps::NAME => Examples::TenSteps::FlowsSCPOC
+        }
+      },
+      flows_scp_oc_instance: {
+        title: 'Flows Shared Context Pipeline with contract for output, functional steps',
+        mode: :instance_call,
+        classes: {
+          APlusB::NAME => Examples::APlusB::FlowsSCPOC,
+          TenSteps::NAME => Examples::TenSteps::FlowsSCPOC
+        }
+      },
+      flows_scp_mut_class: {
+        title: 'Flows Shared Context Pipeline, mutation steps',
+        mode: :class_call,
+        classes: {
+          APlusB::NAME => Examples::APlusB::FlowsSCPMut,
+          TenSteps::NAME => Examples::TenSteps::FlowsSCPMut
+        }
+      },
+      flows_scp_mut_instance: {
+        title: 'Flows Shared Context Pipeline, mutation steps',
+        mode: :instance_call,
+        classes: {
+          APlusB::NAME => Examples::APlusB::FlowsSCPMut,
+          TenSteps::NAME => Examples::TenSteps::FlowsSCPMut
+        }
+      },
+      dry_do: {
+        title: 'dry-rb Do-notation',
+        mode: :instance_call,
+        classes: {
+          APlusB::NAME => Examples::APlusB::DryDo,
+          TenSteps::NAME => Examples::TenSteps::DryDo
+        }
+      },
+      dry_transaction: {
+        title: 'dry-rb Transaction',
+        mode: :instance_call,
+        classes: {
+          APlusB::NAME => Examples::APlusB::DryTransaction,
+          TenSteps::NAME => Examples::TenSteps::DryTransaction
+        }
+      },
+      trailblazer: {
+        title: 'Trailblazer Operation',
+        mode: :class_call,
+        classes: {
+          APlusB::NAME => Examples::APlusB::TB,
+          TenSteps::NAME => Examples::TenSteps::TB
+        }
+      }
+    }.freeze
+  end
+end

data/bin/benchmark_cli/compare/a_plus_b.rb

@@ -0,0 +1,22 @@
+class BenchmarkCLI
+  module Compare
+    # 'A + B' comparison.
+    class APlusB < Base
+      TITLE = 'A + B: one step implementation, input provided as kwargs'.freeze
+      NAME = :a_plus_b
+
+      def report_class_call(benchmark, title, klass)
+        benchmark.report title do
+          klass.call(a: 100, b: 200)
+        end
+      end
+
+      def report_instance_call(benchmark, title, klass)
+        instance = klass.new
+        benchmark.report title do
+          instance.call(a: 100, b: 200)
+        end
+      end
+    end
+  end
+end

data/bin/benchmark_cli/compare/base.rb

@@ -0,0 +1,45 @@
+class BenchmarkCLI
+  module Compare
+    # @abstract
+    #
+    # Base class for comparison benchmarks.
+    class Base
+      include Helpers
+
+      def initialize(implementations)
+        @implementations = implementations
+      end
+
+      def call
+        header self.class::TITLE
+
+        Benchmark.ips do |benchmark|
+          benchmark.config(stats: :bootstrap, confidence: 95)
+
+          report_implementations(benchmark)
+
+          benchmark.compare!
+        end
+      end
+
+      private
+
+      def report_implementations(benchmark)
+        @implementations.each do |implementation|
+          report_implementation(benchmark, IMPLEMENTATIONS[implementation])
+        end
+      end
+
+      def report_implementation(benchmark, cfg)
+        mode = cfg[:mode]
+        title = "#{cfg[:title]} (#{MODES[mode]})"
+        klass = cfg[:classes][self.class::NAME]
+
+        case mode
+        when :class_call then report_class_call(benchmark, title, klass)
+        when :instance_call then report_instance_call(benchmark, title, klass)
+        end
+      end
+    end
+  end
+end