flows 0.3.0 → 0.4.0

data/bin/benchmark_cli/ruby/self_class.rb

@@ -0,0 +1,69 @@
+class BenchmarkCLI
+  module Ruby
+    class SelfClass
+      include Helpers
+
+      def call
+        header 'Check if repeatative `self.class` impacts performance'
+
+        Benchmark.ips do |benchmark|
+          benchmark.config(stats: :bootstrap, confidence: 95)
+
+          run_benchmarks(benchmark)
+
+          benchmark.compare!
+        end
+      end
+
+      private
+
+      def run_benchmarks(benchmark)
+        report_self_class(benchmark)
+        report_klass(benchmark)
+      end
+
+      def report_self_class(benchmark)
+        benchmark.report '[self.class, ... 10 times]' do
+          self_class_10_times
+        end
+      end
+
+      def self_class_10_times # rubocop:disable Metrics/MethodLength
+        [
+          self.class,
+          self.class,
+          self.class,
+          self.class,
+          self.class,
+          self.class,
+          self.class,
+          self.class,
+          self.class,
+          self.class
+        ]
+      end
+
+      def report_klass(benchmark)
+        benchmark.report 'klass = self.class; [klass, ... 10 times]' do
+          klass_10_times
+        end
+      end
+
+      def klass_10_times # rubocop:disable Metrics/MethodLength
+        klass = self.class
+        [
+          klass,
+          klass,
+          klass,
+          klass,
+          klass,
+          klass,
+          klass,
+          klass,
+          klass,
+          klass
+        ]
+      end
+    end
+  end
+end

data/bin/benchmark_cli/ruby/structs.rb

@@ -0,0 +1,90 @@
+require 'ostruct'
+
+class BenchmarkCLI
+  module Ruby
+    class Structs
+      include Helpers
+
+      def call
+        header 'Creates a struct with 3 random number fields and calculates the sum of the fields'
+
+        Benchmark.ips do |benchmark|
+          benchmark.config(stats: :bootstrap, confidence: 95)
+
+          run_benchmarks(benchmark)
+
+          benchmark.compare!
+        end
+      end
+
+      RubyStruct = Struct.new(:a, :b, :c, keyword_init: true)
+
+      class CustomStruct
+        attr_reader :a, :b, :c
+
+        def initialize(a:, b:, c:) # rubocop:disable Naming/MethodParameterName
+          @a = a
+          @b = b
+          @c = c
+        end
+      end
+
+      private
+
+      def run_benchmarks(benchmark)
+        report_hash(benchmark)
+        report_ruby_struct(benchmark)
+        report_custom_class(benchmark)
+        report_ostruct(benchmark)
+      end
+
+      def report_hash(benchmark)
+        benchmark.report 'Hash' do
+          hash = {
+            a: rand(10),
+            b: rand(20),
+            c: rand(30)
+          }
+
+          hash[:a] + hash[:b] + hash[:c]
+        end
+      end
+
+      def report_ruby_struct(benchmark)
+        benchmark.report 'Ruby Struct' do
+          rstruct = RubyStruct.new(
+            a: rand(10),
+            b: rand(20),
+            c: rand(30)
+          )
+
+          rstruct.a + rstruct.b + rstruct.c
+        end
+      end
+
+      def report_custom_class(benchmark)
+        benchmark.report 'Custom Class' do
+          custom_struct = CustomStruct.new(
+            a: rand(10),
+            b: rand(10),
+            c: rand(10)
+          )
+
+          custom_struct.a + custom_struct.b + custom_struct.c
+        end
+      end
+
+      def report_ostruct(benchmark)
+        benchmark.report 'Open Struct' do
+          ostruct = OpenStruct.new(
+            a: rand(10),
+            b: rand(10),
+            c: rand(10)
+          )
+
+          ostruct.a + ostruct.b + ostruct.c
+        end
+      end
+    end
+  end
+end

data/bin/console

@@ -6,5 +6,6 @@ require 'flows'
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
+require 'awesome_print'
 require 'pry'
 Pry.start

data/bin/docserver

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+rm -rf .yardoc/ && bundle exec yard server --reload
+rm -rf .yardoc/

data/bin/errors

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'flows'
+
+require 'pry'
+require 'gli'
+
+require 'rainbow/refinement'
+using Rainbow
+
+require_relative 'errors_cli/contract_error_demo'
+require_relative 'errors_cli/flows_router_error_demo'
+require_relative 'errors_cli/di_error_demo'
+require_relative 'errors_cli/oc_error_demo'
+require_relative 'errors_cli/railway_error_demo'
+require_relative 'errors_cli/result_error_demo'
+require_relative 'errors_cli/scp_error_demo'
+
+class ErrorsCLI
+  extend GLI::App
+
+  program_desc 'Error reporting demo'
+
+  use_openstruct true
+
+  def self.make_cmd(ctx, title, name) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    ctx.desc title
+    ctx.command name do |cmd|
+      cmd.action do |_, _, _|
+        puts title.green
+        puts(('BEGIN' + '-' * (title.length - 5)).color(:darkgray))
+        yield
+      rescue StandardError => err
+        puts err.message
+        puts(('END' + '-' * (title.length - 3)).color(:darkgray))
+        puts
+      end
+    end
+  end
+
+  make_cmd self, 'Flows::Contract error', :contract do
+    ContractErrorDemo.call
+  end
+
+  make_cmd self, 'Flows::Flow::Router::NoRouteError', :router do
+    FlowsRouterErrorDemo.call
+  end
+
+  desc 'Flows::Plugin::DependencyInjector errors'
+  command :di do |cmd|
+    make_cmd cmd, 'Missing Dependency', :missing do
+      DIErrorDemo.missing_dependency
+    end
+
+    make_cmd cmd, 'Unexpected Dependency', :unexpected do
+      DIErrorDemo.unexpected_dependency
+    end
+
+    make_cmd cmd, 'Invalid Type', :invalid_type do
+      DIErrorDemo.invalid_type_dependency
+    end
+
+    make_cmd cmd, 'Missing Default', :missing_default do
+      DIErrorDemo.missing_default
+    end
+  end
+
+  desc 'OutputContract plugin errors'
+  command :output_contract do |cmd|
+    make_cmd cmd, 'No Contract error', :no_contract do
+      OCErrorDemo.no_contract
+    end
+
+    make_cmd cmd, 'Contract error', :contract do
+      OCErrorDemo.contract_error
+    end
+
+    make_cmd cmd, 'Status error', :status do
+      OCErrorDemo.status_error
+    end
+
+    make_cmd cmd, 'Result type error', :result_type do
+      OCErrorDemo.result_type_error
+    end
+  end
+
+  desc 'Railway errors'
+  command :railway do |cmd|
+    make_cmd cmd, 'No Steps error', :no_steps do
+      RailwayErrorDemo.call
+    end
+  end
+
+  desc 'Result errors'
+  command :result do |cmd|
+    make_cmd cmd, 'Access error for successful result', :ok_access do
+      ResultErrorDemo.success_access_error
+    end
+
+    make_cmd cmd, 'Access error for failure result', :err_access do
+      ResultErrorDemo.failure_access_error
+    end
+  end
+
+  desc 'Shared Context Pipeline errors'
+  command :scp do |cmd|
+    make_cmd cmd, 'No Steps error', :no_steps do
+      SCPErrorDemo.no_steps
+    end
+
+    make_cmd cmd, 'Missing Step Implementation error', :no_step_impl do
+      SCPErrorDemo.no_step_impl
+    end
+  end
+end
+
+exit ErrorsCLI.run(ARGV)

data/bin/errors_cli/contract_error_demo.rb

@@ -0,0 +1,49 @@
+module ContractErrorDemo
+  class << self
+    def call
+      contract.transform!(invalid_data)
+    end
+
+    private
+
+    def invalid_data # rubocop:disable Metrics/MethodLength
+      {
+        str_array_field: ['aaa', 'bbb', :ccc],
+        hash_array_field: [
+          {
+            x: 1,
+            y: 2
+          },
+          {
+            'x' => 1,
+            'y' => 2
+          }
+        ],
+        array_compose_predicate: ['aaaa', 'bbbb', 'a', :xxx],
+        int_field: '10',
+        array_either: ['a', :a, 1],
+        tuple: [1, 1]
+      }
+    end
+
+    def contract # rubocop:disable Metrics/MethodLength
+      Flows::Contract.make do
+        hash_of(
+          str_array_field: array(String),
+          hash_array_field: array(
+            hash(Symbol, String)
+          ),
+          array_compose_predicate: array(
+            compose(String, predicate('must be longer that 3') { |str| str.size > 3 })
+          ),
+          int_field: Integer,
+          array_either: array(
+            either(String, Symbol)
+          ),
+          tuple: tuple(Float, Float),
+          field_to_be_missed: String
+        )
+      end
+    end
+  end
+end

data/bin/errors_cli/di_error_demo.rb

@@ -0,0 +1,38 @@
+module DIErrorDemo
+  class WithDI
+    include Flows::Plugin::DependencyInjector
+
+    dependency :req_str_dep, required: true, type: String
+
+    def call
+      'Hi!'
+    end
+  end
+
+  class WithEmptyDI
+    include Flows::Plugin::DependencyInjector
+  end
+
+  class << self
+    def missing_dependency
+      WithDI.new
+    end
+
+    def unexpected_dependency
+      WithDI.new(dependencies: {
+                   req_str_dep: 'AAA',
+                   my_extra_dependency: 'III'
+                 })
+    end
+
+    def invalid_type_dependency
+      WithDI.new(dependencies: {
+                   req_str_dep: :AAA
+                 })
+    end
+
+    def missing_default
+      WithEmptyDI.dependency :my_opt_dep
+    end
+  end
+end

data/bin/errors_cli/flows_router_error_demo.rb

@@ -0,0 +1,15 @@
+module FlowsRouterErrorDemo
+  class << self
+    include Flows::Result::Helpers
+
+    def call
+      router.call(ok(some: :data))
+    end
+
+    private
+
+    def router
+      Flows::Flow::Router::Custom.new(match_err => :end)
+    end
+  end
+end

data/bin/errors_cli/oc_error_demo.rb

@@ -0,0 +1,40 @@
+module OCErrorDemo
+  class WithoutContract
+    include Flows::Plugin::OutputContract
+  end
+
+  class WithContract
+    include Flows::Plugin::OutputContract
+
+    success_with :ok do
+      hash_of(
+        x: Integer,
+        y: Integer
+      )
+    end
+
+    def call(result)
+      result
+    end
+  end
+
+  class << self
+    include Flows::Result::Helpers
+
+    def no_contract
+      WithoutContract.new
+    end
+
+    def contract_error
+      WithContract.new.call(ok(z: 100))
+    end
+
+    def status_error
+      WithContract.new.call(ok(:unexpeted_status, x: 1, y: 2))
+    end
+
+    def result_type_error
+      WithContract.new.call(z: 100)
+    end
+  end
+end

data/bin/errors_cli/railway_error_demo.rb

@@ -0,0 +1,10 @@
+module RailwayErrorDemo
+  class MyRailway < ::Flows::Railway
+  end
+
+  class << self
+    def call
+      MyRailway.new
+    end
+  end
+end