flows 0.3.0 → 0.4.0

data/lib/flows/util/prepend_to_class.rb

@@ -0,0 +1,145 @@
+module Flows
+  module Util
+    # In the situation when a module is included into another module and only afterwards included into class,
+    # allows to force particular module to be prepended to a class only.
+    #
+    # When you write some module to abstract out some behaviour you may
+    # need a way to expand initializer behaviour of a target class.
+    # You can prepend a module with an initializer wrapper inside `.included(mod)`
+    # or `.extended(mod)` callbacks. But it will not work if you include your module into module
+    # and only after to a class. It's one of the cases when `PrependToClass` can help you.
+    #
+    # Let's show it on example: we need a module which expands initializer to accept `:data`
+    # keyword argument and sets its value:
+    #
+    #     class MyClass
+    #       prepend HasData
+    #
+    #       attr_reader :greeting
+    #
+    #       def initialize
+    #         @greeting = 'Hello'
+    #       end
+    #     end
+    #
+    #     module HasData
+    #       attr_reader :data
+    #
+    #       def initialize(*args, **kwargs, &block)
+    #         @data = kwargs[:data]
+    #
+    #         filtered_kwargs = kwargs.reject { |k, _| k == :data }
+    #
+    #         if filtered_kwargs.empty? # https://bugs.ruby-lang.org/issues/14415
+    #           super(*args, &block)
+    #         else
+    #           super(*args, **filtered_kwargs, &block)
+    #         end
+    #       end
+    #
+    #       def big_data
+    #         data.upcase
+    #       end
+    #     end
+    #
+    #     x = MyClass.new(data: 'aaa')
+    #
+    #     x.greeting
+    #     # => 'Hello'
+    #
+    #     x.data
+    #     # => 'aaa'
+    #
+    #     x.big_data
+    #     # => 'aaa'
+    #
+    # This implementation works, but has a problem:
+    #
+    #     class AnotherClass
+    #       include Stuff
+    #
+    #       attr_reader :greeting
+    #
+    #       def initialize
+    #         @greeting = 'Hello'
+    #       end
+    #     end
+    #
+    #     module Stuff
+    #       prepend HasData
+    #     end
+    #
+    #     x = AnotherClass.new(data: 'aaa')
+    #     # ArgumentError: wrong number of arguments (given 1, expected 0)
+    #
+    # This happens because `prepend` prepends our patch to `Stuff` module, not class.
+    # {PrependToClass} solves this problem:
+    #
+    #     module HasData
+    #       attr_reader :data
+    #
+    #       module InitializePatch
+    #         def initialize(*args, **kwargs, &block)
+    #           @data = kwargs[:data]
+    #
+    #           filtered_kwargs = kwargs.reject { |k, _| k == :data }
+    #
+    #           if filtered_kwargs.empty? # https://bugs.ruby-lang.org/issues/14415
+    #             super(*args, &block)
+    #           else
+    #             super(*args, **filtered_kwargs, &block)
+    #           end
+    #         end
+    #       end
+    #
+    #       Flows::Util::PrependToClass.call(self, InitializePatch)
+    #     end
+    #
+    #     module Stuff
+    #       include HasData
+    #     end
+    #
+    #     class MyClass
+    #       include Stuff
+    #
+    #       attr_reader :greeting
+    #
+    #       def initialize
+    #         @greeting = 'Hello'
+    #       end
+    #     end
+    #
+    #     x = MyClass.new(data: 'data')
+    #
+    #     x.data
+    #     # => 'data'
+    module PrependToClass
+      class << self
+        # When `mod` is included into class in any way `module_to_prepend`
+        # will be prepended to the class.
+        #
+        # @param mod [Module] host module
+        # @param module_to_prepend [Module] module to be prepended to a class
+        def call(mod, module_to_prepend)
+          mod.singleton_class.prepend injector(module_to_prepend)
+        end
+
+        private
+
+        def injector(module_to_prepend)
+          Module.new.tap do |injector|
+            injector.define_method(:included) do |target_mod|
+              if target_mod.class == Class
+                target_mod.prepend(module_to_prepend)
+              else # Module
+                target_mod.singleton_class.prepend injector
+              end
+
+              super(target_mod)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flows/version.rb

@@ -1,3 +1,3 @@
 module Flows
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flows
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Roman Kolesnev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2020-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: forspell
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mdl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +248,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: kalibera
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-prof
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +290,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: warning
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: dry-transaction
   requirement: !ruby/object:Gem::Requirement
@@ -241,70 +381,125 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/build.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".mdlrc"
+- ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".yardopts"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/.rubocop.yml
+- bin/all_the_errors
 - bin/benchmark
+- bin/benchmark_cli/compare.rb
+- bin/benchmark_cli/compare/a_plus_b.rb
+- bin/benchmark_cli/compare/base.rb
+- bin/benchmark_cli/compare/command.rb
+- bin/benchmark_cli/compare/ten_steps.rb
+- bin/benchmark_cli/examples.rb
+- bin/benchmark_cli/examples/.rubocop.yml
+- bin/benchmark_cli/examples/a_plus_b/dry_do.rb
+- bin/benchmark_cli/examples/a_plus_b/dry_transaction.rb
+- bin/benchmark_cli/examples/a_plus_b/flows_do.rb
+- bin/benchmark_cli/examples/a_plus_b/flows_railway.rb
+- bin/benchmark_cli/examples/a_plus_b/flows_scp.rb
+- bin/benchmark_cli/examples/a_plus_b/flows_scp_mut.rb
+- bin/benchmark_cli/examples/a_plus_b/flows_scp_oc.rb
+- bin/benchmark_cli/examples/a_plus_b/trailblazer.rb
+- bin/benchmark_cli/examples/ten_steps/dry_do.rb
+- bin/benchmark_cli/examples/ten_steps/dry_transaction.rb
+- bin/benchmark_cli/examples/ten_steps/flows_do.rb
+- bin/benchmark_cli/examples/ten_steps/flows_railway.rb
+- bin/benchmark_cli/examples/ten_steps/flows_scp.rb
+- bin/benchmark_cli/examples/ten_steps/flows_scp_mut.rb
+- bin/benchmark_cli/examples/ten_steps/flows_scp_oc.rb
+- bin/benchmark_cli/examples/ten_steps/trailblazer.rb
+- bin/benchmark_cli/helpers.rb
+- bin/benchmark_cli/ruby.rb
+- bin/benchmark_cli/ruby/command.rb
+- bin/benchmark_cli/ruby/method_exec.rb
+- bin/benchmark_cli/ruby/self_class.rb
+- bin/benchmark_cli/ruby/structs.rb
 - bin/console
-- bin/demo
-- bin/examples.rb
-- bin/profile_10steps
-- bin/ruby_benchmarks
+- bin/docserver
+- bin/errors
+- bin/errors_cli/contract_error_demo.rb
+- bin/errors_cli/di_error_demo.rb
+- bin/errors_cli/flows_router_error_demo.rb
+- bin/errors_cli/oc_error_demo.rb
+- bin/errors_cli/railway_error_demo.rb
+- bin/errors_cli/result_error_demo.rb
+- bin/errors_cli/scp_error_demo.rb
 - bin/setup
 - docs/.nojekyll
-- docs/CNAME
 - docs/README.md
 - docs/_sidebar.md
-- docs/contributing/benchmarks_profiling.md
-- docs/contributing/local_development.md
-- docs/flow/direct_usage.md
-- docs/flow/general_idea.md
 - docs/index.html
-- docs/operation/basic_usage.md
-- docs/operation/inject_steps.md
-- docs/operation/lambda_steps.md
-- docs/operation/result_shapes.md
-- docs/operation/routing_tracks.md
-- docs/operation/wrapping_steps.md
-- docs/overview/performance.md
-- docs/railway/basic_usage.md
-- docs/result_objects/basic_usage.md
-- docs/result_objects/do_notation.md
 - flows.gemspec
 - forspell.dict
 - lefthook.yml
 - lib/flows.rb
+- lib/flows/contract.rb
+- lib/flows/contract/array.rb
+- lib/flows/contract/case_eq.rb
+- lib/flows/contract/compose.rb
+- lib/flows/contract/either.rb
+- lib/flows/contract/error.rb
+- lib/flows/contract/hash.rb
+- lib/flows/contract/hash_of.rb
+- lib/flows/contract/helpers.rb
+- lib/flows/contract/predicate.rb
+- lib/flows/contract/transformer.rb
+- lib/flows/contract/tuple.rb
 - lib/flows/flow.rb
-- lib/flows/implicit_build.rb
-- lib/flows/node.rb
-- lib/flows/operation.rb
-- lib/flows/operation/builder.rb
-- lib/flows/operation/builder/build_router.rb
-- lib/flows/operation/dsl.rb
-- lib/flows/operation/errors.rb
-- lib/flows/operation/executor.rb
+- lib/flows/flow/node.rb
+- lib/flows/flow/router.rb
+- lib/flows/flow/router/custom.rb
+- lib/flows/flow/router/errors.rb
+- lib/flows/flow/router/simple.rb
+- lib/flows/plugin.rb
+- lib/flows/plugin/dependency_injector.rb
+- lib/flows/plugin/dependency_injector/dependency.rb
+- lib/flows/plugin/dependency_injector/dependency_definition.rb
+- lib/flows/plugin/dependency_injector/dependency_list.rb
+- lib/flows/plugin/dependency_injector/errors.rb
+- lib/flows/plugin/implicit_init.rb
+- lib/flows/plugin/output_contract.rb
+- lib/flows/plugin/output_contract/dsl.rb
+- lib/flows/plugin/output_contract/errors.rb
+- lib/flows/plugin/output_contract/wrapper.rb
 - lib/flows/railway.rb
-- lib/flows/railway/builder.rb
 - lib/flows/railway/dsl.rb
 - lib/flows/railway/errors.rb
-- lib/flows/railway/executor.rb
+- lib/flows/railway/step.rb
+- lib/flows/railway/step_list.rb
 - lib/flows/result.rb
 - lib/flows/result/do.rb
 - lib/flows/result/err.rb
 - lib/flows/result/errors.rb
 - lib/flows/result/helpers.rb
 - lib/flows/result/ok.rb
-- lib/flows/result_router.rb
-- lib/flows/router.rb
+- lib/flows/shared_context_pipeline.rb
+- lib/flows/shared_context_pipeline/dsl.rb
+- lib/flows/shared_context_pipeline/errors.rb
+- lib/flows/shared_context_pipeline/mutation_step.rb
+- lib/flows/shared_context_pipeline/router_definition.rb
+- lib/flows/shared_context_pipeline/step.rb
+- lib/flows/shared_context_pipeline/track.rb
+- lib/flows/shared_context_pipeline/track_list.rb
+- lib/flows/util.rb
+- lib/flows/util/inheritable_singleton_vars.rb
+- lib/flows/util/inheritable_singleton_vars/dup_strategy.rb
+- lib/flows/util/inheritable_singleton_vars/isolation_strategy.rb
+- lib/flows/util/prepend_to_class.rb
 - lib/flows/version.rb
 - profile/.keep
 homepage: https://github.com/ffloyd/flows
@@ -329,5 +524,6 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Ruby framework for building FSM-like data flows.
+summary: Ruby framework for building your Business Logic Layer inside Rails and other
+  frameworks.
 test_files: []