flow_object 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b6e87c3678c7dfc6a5b2293cdde82114f9f5630d
-  data.tar.gz: c1cd29c871342cc8a434cf60026fabd2a5d23394
+SHA256:
+  metadata.gz: db5d4237447ea9da647afab9214f2a37e10e3446353933dd6dd9f929d1b4a021
+  data.tar.gz: 0ca51ffecc9b02fe9f6a92f9382b0a91d18812645e844cfc02e22dc95997e4a4
 SHA512:
-  metadata.gz: bd56f181a60349d8dbfa029d5da3d6e2fd9746fbf1bbbb05b70745082af186ea2985c9928a659f9d9346ee8515f9b1e437bcd513c2845650da6b6c94d62cc2f0
-  data.tar.gz: bfa56fa807813ffe8dce4c3c8fd3d8e2d90587a9e14355fd9ea3d2b7a619fe16039145a87501748b96273145cff6f2186b4ae1fe04866406f489df5f9f7f5ef5
+  metadata.gz: 2fe85a38185bc79f41c3000ca80e8079578e591317dede9a2615a632a3e5756eb0c50b6f9a2def175bf781d50d9c00c50a645c2b623b8e8796a7904a3bb3dcf4
+  data.tar.gz: a63a10e4d35e722f28cb641711509653c44dfc0763c8cee77fc9f3da7b790f6bf49cf5c1a945dbedb395261aaa4d7e87096e071b8f4dd602c5f43d22b20111ff

data/.rubocop.yml

@@ -0,0 +1,78 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - flow_object.gemspec
+Gemspec/DateAssignment: # (new in 1.10)
+  Enabled: true
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+Lint/DeprecatedConstants: # (new in 1.8)
+  Enabled: true
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+  Exclude:
+    - lib/flow_object/callbacks.rb
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+  Exclude:
+    - spec/**/*.rb
+Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+  Enabled: true
+Lint/NumberedParameterAssignment: # (new in 1.9)
+  Enabled: true
+Lint/OrAssignmentToConstant: # (new in 1.9)
+  Enabled: true
+Lint/RedundantDirGlobSort: # (new in 1.8)
+  Enabled: true
+Lint/SymbolConversion: # (new in 1.9)
+  Enabled: true
+Lint/ToEnumArguments: # (new in 1.1)
+  Enabled: true
+Lint/TripleQuotes: # (new in 1.9)
+  Enabled: true
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+  Enabled: true
+Style/ArgumentsForwarding: # (new in 1.1)
+  Enabled: true
+Style/CollectionCompact: # (new in 1.2)
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/EndlessMethod: # (new in 1.8)
+  Enabled: true
+Style/HashConversion: # (new in 1.10)
+  Enabled: true
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # (new in 1.9)
+  Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+Style/StringChars: # (new in 1.12)
+  Enabled: true
+Style/SwapValues: # (new in 1.1)
+  Enabled: true
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+Naming/MethodParameterName:
+  Exclude:
+    - spec/**/*.rb
+Style/Semicolon:
+  Exclude:
+    - spec/**/*.rb
+

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.4.0

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in flow_object.gemspec
 gemspec

data/Gemfile.lock

@@ -1,23 +1,32 @@
 PATH
   remote: .
   specs:
-    flow_object (0.2.1)
-      mature_factory (~> 0.2.14)
+    flow_object (0.3.1)
+      hospodar (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    dry-inflector (0.1.2)
-    mature_factory (0.2.14)
+    docile (1.3.5)
+    dry-inflector (0.2.0)
+    hospodar (1.0.1)
       dry-inflector (~> 0.1)
-      simple_facade (~> 0.2)
+    json (2.5.1)
     method_source (1.0.0)
+      dry-inflector (~> 0.1)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    rainbow (3.0.0)
     rake (10.5.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -33,7 +42,24 @@ GEM
     rspec-support (3.9.3)
     rspec_vars_helper (0.1.0)
       rspec (>= 2.4)
-    simple_facade (0.2.1)
+    rubocop (1.12.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    simplecov (0.17.0)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
@@ -45,6 +71,8 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.0)
   rspec_vars_helper (~> 0.1)
+  rubocop
+  simplecov (= 0.17)
 
 BUNDLED WITH
-   1.17.0
+   1.17.3

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,13 +1,14 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "flow_object"
+require 'bundler/setup'
+require 'flow_object'
 
 # 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.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-require "pry"
+require 'pry'
 Pry.start
 
 # require "irb"

data/flow_object.gemspec

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'flow_object/version'
 
@@ -9,10 +10,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Andrii Baran']
   spec.email         = ['andriy.baran.v@gmail.com']
 
-  spec.summary       = %q{Create objects for storing application flows}
-  spec.description   = %q{General purpose software library designed for happiness}
+  spec.summary       = 'Create objects for storing application flows'
+  spec.description   = 'General purpose software library designed for happiness'
   spec.homepage      = 'https://github.com/andriy-baran/flow_object'
   spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -29,18 +31,20 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'mature_factory', '~> 0.2.14'
+  spec.add_dependency 'hospodar', '~> 1'
 
   spec.add_development_dependency 'bundler', '~> 1.17'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec_vars_helper', '~> 0.1'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov', '0.17'
 end

data/lib/flow_object/base.rb

@@ -1,23 +1,31 @@
+# frozen_string_literal: true
+
 module FlowObject
+  # Provides DSL for flows definitions
   class Base
-    include MatureFactory
-    include MatureFactory::Features::Assemble
+    include Hospodar
+    include Hospodar::Builder
 
     produces :stages, :inputs, :outputs
 
     class << self
-      extend Forwardable
-      attr_reader :in, :out, :initial_values
-      def_delegators :callbacks, :after_input_initialize, :after_flow_initialize,
-        :after_input_check, :after_flow_check, :after_output_initialize
+      attr_reader :in, :out
     end
 
-    attr_reader :output
+    extend Forwardable
+    def_delegators :callbacks, :output_initialized
+
+    attr_reader :output, :callbacks
 
-    def initialize(flow, step_name = :flow)
-      @output = self.class.send(:__fo_wrap_output__)
-      self.class.link_with_delegation(@output, flow, step_name, true)
-      self.class.after_output_initialize.call(@output)
+    def initialize(flow, callbacks, step_name = :flow)
+      @output = self.class.send(:fo_wrap_output)
+      @callbacks = callbacks
+      Hospodar::Builder.def_accessor(step_name, on: @output, to: flow, delegate: true)
+      output_initialized.call(@output)
+    end
+
+    def on_exception(exception = nil)
+      # NOOP
     end
 
     def on_failure(failed_step = nil)
@@ -28,20 +36,12 @@ module FlowObject
       # NOOP
     end
 
+    # Class-level interface for flow objects
     module ClassMethods
       def inherited(subclass)
         super
         subclass.from(self.in)
-        subclass.to(self.out)
-        subclass.after_input_initialize(&self.after_input_initialize)
-        subclass.after_flow_initialize(&self.after_flow_initialize)
-        subclass.after_input_check(&self.after_input_check)
-        subclass.after_flow_check(&self.after_flow_check)
-        subclass.after_output_initialize(&self.after_output_initialize)
-      end
-
-      def callbacks
-        @callbacks ||= Callbacks.new
+        subclass.to(out)
       end
 
       def from(input)
@@ -54,67 +54,80 @@ module FlowObject
         self
       end
 
-      def accept(*values)
-        @initial_values = values
-        self
-      end
-
-      def call(flow: :main)
-        __fo_resolve__(__fo_process__(flow: flow))
+      def call(input:, flow: :main, &block)
+        fo_resolve(fo_process(input, flow: flow, &block))
       end
 
       def flow(name = :main, &block)
-        wrap(name, delegate: true, &block)
-      end
-
-      def link_with_delegation(target, object, accessor, delegate)
-        MatureFactory::Features::Assemble::AbstractBuilder
-          .link_with_delegation(target, object, accessor, delegate)
+        wrap(name, delegate: true, on_exception: :halt, &block)
       end
 
       private
 
-      def halt_flow?(object, id)
+      def halt_flow?(_object, _id)
         false
       end
 
-      def __fo_process__(flow: :main)
-        plan    = __fo_build_flow__(flow, self.in, :input, __fo_wrap_input__)
+      def fo_process(input, flow: :main, &block)
+        plan = fo_build_flow(flow, self.in, :input, fo_wrap_input(input))
+        callbacks = Callbacks.new(@callbacks_allowlist)
+        block.call(callbacks) if block_given?
         Runner.new(plan, callbacks, method(:halt_flow?)).execute_plan
       end
 
-      def __fo_build_flow__(flow, step_name, group, object)
-        public_send(:"build_#{flow}", title: step_name, group: group, object: object)
+      def fo_build_flow(flow, step_name, group, object)
+        plan = send(:"hospodar_perform_planing_for_#{flow}", object, step_name, group)
+        @callbacks_allowlist = plan.map(&:last).map(&:to_sym) + [:"#{out}_output"]
+        send(:"hospodar_execute_plan_for_#{flow}", plan)
       end
 
-      def __fo_wrap_input__
+      def fo_wrap_input(*initial_values)
         return initial_values if self.in.nil?
+
         input_class = public_send(:"#{self.in}_input_class")
         return initial_values if input_class.nil?
+
         public_send(:"new_#{self.in}_input_instance", *initial_values)
       end
 
-      def __fo_wrap_output__
+      def fo_wrap_output
         # rescue NoMethodError => ex
         # "You have not define output class. Please add `output :#{self.out}`"
-        return if self.out.nil?
-        return unless self.respond_to?(:"#{self.out}_output_class")
-        output_class = public_send(:"#{self.out}_output_class")
+        return if out.nil?
+        return unless respond_to?(:"#{out}_output_class")
+
+        output_class = public_send(:"#{out}_output_class")
         return if output_class.nil?
-        public_send(:"new_#{self.out}_output_instance")
+
+        public_send(:"new_#{out}_output_instance")
       end
 
-      def __fo_resolve__(runner)
-        new(runner.flow, runner.step_name).tap do |handler|
-          if runner.failure
-            __fo_notify_error__(handler, runner.step_name)
+      def fo_resolve(runner)
+        new(runner.flow.public_send(runner.step_name), runner.callbacks, runner.step_name).tap do |handler|
+          if runner.flow.exceptional?
+            fo_notify_exception(handler, runner.flow.exception)
+          elsif runner.failure
+            fo_notify_error(handler, runner.step_name)
           else
-            __fo_notify_success__(handler)
+            fo_notify_success(handler)
           end
         end
       end
 
-      def __fo_notify_error__(handler, step)
+      def fo_notify_exception(handler, exception)
+        callback = :"on_#{exception.step_id.title}_exception"
+        if handler.output.respond_to?(callback)
+          handler.output.public_send(callback, exception)
+        elsif handler.output.respond_to?(:on_exception)
+          handler.output.on_exception(exception)
+        elsif handler.respond_to?(callback)
+          handler.public_send(callback, exception)
+        else
+          handler.on_exception(exception)
+        end
+      end
+
+      def fo_notify_error(handler, step)
         if handler.output.respond_to?(:"on_#{step}_failure")
           handler.output.public_send(:"on_#{step}_failure")
         elsif handler.output.respond_to?(:on_failure)
@@ -126,7 +139,7 @@ module FlowObject
         end
       end
 
-      def __fo_notify_success__(handler)
+      def fo_notify_success(handler)
         if handler.output.respond_to?(:on_success)
           handler.output.on_success
         else

data/lib/flow_object/callbacks.rb

@@ -1,29 +1,73 @@
+# frozen_string_literal: true
+
 module FlowObject
+  # Storage for users callbacks
   class Callbacks
-    SUPPORTED = %i[
-      after_input_initialize
-      after_flow_initialize
-      after_input_check
-      after_flow_check
-      after_output_initialize
-    ].freeze
-
     NOOP = proc {}.freeze
 
-    def initialize
-      @callbacks = Hash.new { |hash, key| hash[key] = NOOP }
+    Iteration = Struct.new(:idx, :type, :list_size) do
+      def output_checked?
+        output? && checked?
+      end
+
+      def generic_alias
+        return :"input_#{type}" if input?
+        return :flow_initialized if flow_initialized?
+        return :flow_checked if flow_checked?
+        return :output_initialized if output_initialized?
+      end
+
+      private
+
+      def flow_initialized?
+        idx == 1 && initialized?
+      end
+
+      def flow_checked?
+        idx == list_size - 2 && checked?
+      end
+
+      def output_initialized?
+        output? && initialized?
+      end
+
+      def input?
+        idx.zero?
+      end
+
+      def initialized?
+        type == :initialized
+      end
+
+      def checked?
+        type == :checked
+      end
+
+      def output?
+        idx == list_size - 1
+      end
     end
 
-    def method_missing(name, *_attrs, &block)
-      if SUPPORTED.include?(name)
-        block_given? ? @callbacks[name] = block : @callbacks[name]
-      else
-        super
+    def initialize(list)
+      @callbacks = Hash.new { |hash, key| hash[key] = NOOP }
+      each_callback(list) do |callback, callback_alias|
+        define_singleton_method(callback) do |&block|
+          block.nil? ? @callbacks[callback] : @callbacks[callback] = block
+        end
+        singleton_class.class_eval { alias_method(callback_alias, callback) } if callback_alias
       end
     end
 
-    def respond_to_missing?(name, *)
-      SUPPORTED.include?(name)
+    private
+
+    def each_callback(list)
+      list_size = list.size
+      list.each.with_index do |method_name, idx|
+        { initialized: :"#{method_name}_initialized", checked: :"#{method_name}_checked" }.each do |type, callback|
+          callback_alias = Iteration.new(idx, type, list_size).generic_alias
+          yield(callback, callback_alias)
+        end
+      end
     end
   end
 end

data/lib/flow_object/runner.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module FlowObject
+  # Triggers flow execution and users callbacks
   class Runner
-    attr_reader :step_name, :failure, :flow
+    attr_reader :step_name, :failure, :flow, :callbacks
 
     def initialize(plan, callbacks, halt_if_proc)
       @plan = plan
@@ -8,60 +11,34 @@ module FlowObject
       @failure = false
       @step_name = nil
       @callbacks = callbacks
-      @step_index = 0
       @halt_if_proc = halt_if_proc
     end
 
     def execute_plan
-      @flow = call_flow_builder
-      after_flow_check(flow.public_send(@step_name))
+      @flow = flow_builder.call
       self
     end
 
     private
 
-    def call_flow_builder
-      @plan.call do |object, id|
-        handle_step(object, id) { throw :halt }
-      end
-    end
-
-    def after_flow_check(object)
-      @callbacks.after_flow_check.call(object)
-    end
-
-    def after_input_initialize(object)
-      @callbacks.after_input_initialize.call(object)
-    end
+    def flow_builder
+      @plan.do_until do |object, id|
+        @step_name = id.title
+        after_initialize(object, id)
+        @failure = @halt_if_proc.call(object, id)
+        next true if @failure
 
-    def after_flow_initialize(object)
-      @callbacks.after_flow_initialize.call(object)
-    end
-
-    def after_input_check(object)
-      @callbacks.after_input_check.call(object)
-    end
-
-    def second_step?
-      @step_index == 1
-    end
-
-    def input_step?(id)
-      id.group == :input
+        after_check(object, id)
+      end
     end
 
-    def flow_step?(id)
-      id.group == :stage
+    def after_initialize(object, id)
+      @callbacks.public_send(:"#{id}_initialized").call(object)
     end
 
-    def handle_step(object, id)
-      after_input_initialize(object) if input_step?(id)
-      after_flow_initialize(object) if second_step? && flow_step?(id)
-      @step_name = id.title
-      @step_index += 1
-      yield if @failure = @halt_if_proc.call(object, id)
-      after_input_check(object) if input_step?(id)
+    def after_check(object, id)
+      @callbacks.public_send(:"#{id}_checked").call(object)
+      false
     end
-
   end
 end

data/lib/flow_object/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FlowObject
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.1'
 end

data/lib/flow_object.rb

@@ -1,4 +1,6 @@
-require 'mature_factory'
+# frozen_string_literal: true
+
+require 'hospodar'
 require 'flow_object/callbacks'
 require 'flow_object/runner'
 require 'flow_object/base'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: flow_object
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Andrii Baran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mature_factory
+  name: hospodar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.14
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.14
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.17'
 description: General purpose software library designed for happiness
 email:
 - andriy.baran.v@gmail.com
@@ -103,6 +131,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -134,15 +163,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.2.30
 signing_key: 
 specification_version: 4
 summary: Create objects for storing application flows