workflow-join 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09d63e2d8e1cc948a6cd156f826c75b8e3c0ac88
-  data.tar.gz: c6f9ef0cbfb2f147118ced9916ab77460f8bb127
+  metadata.gz: 40f7e69d9114f772e7a3057bdbbfedc974dd786d
+  data.tar.gz: 779672bcd9063eb69d6b5400ebe7318957df3669
 SHA512:
-  metadata.gz: 462f516b6ea0a7a980b11338668d358a46890ab157c08c1b1f7b46969a8c030ca6e94e7917ceb044ec4aa76b1b204363c8490a44fc5d73b72679e8d20228a901
-  data.tar.gz: 80b1130fd8a22d0a1baa6bb8a3574201d95bffd96b428596b7c226fb9ca65482d0a0a1c4f90330caeb7f859255be4dc67ef6fe962528ccb777891d394ddcf80e
+  metadata.gz: 684b92e932e55d231c37c57f49a43715b7369ad2fae41e8fca5ce1e56d64f3820b5241af20c845fc1423cc1361f428c2644b4fef82277c90edc2859b33b8fb86
+  data.tar.gz: 9c60b3ff584e173d0a91d9e2a9a5e7dbca12b1e707f4105081fe9882276f93de6c2f2b3944d63e99f0f952a9ec9df772043c77f196c6ab8041967e9442e43a98

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-09-15 16:00:14 +0200 using RuboCop version 0.42.0.
+# on 2016-09-16 13:15:05 +0200 using RuboCop version 0.42.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -16,12 +16,7 @@ Lint/BlockAlignment:
 
 # Offense count: 1
 Metrics/AbcSize:
-  Max: 49
-
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 46
+  Max: 57
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -37,18 +32,20 @@ Style/MutableConstant:
   Exclude:
     - 'lib/workflow/join/version.rb'
 
-# Offense count: 1
+# Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: PreferredDelimiters.
 Style/PercentLiteralDelimiters:
   Exclude:
+    - 'spec/workflow/active_record_spec.rb'
     - 'spec/workflow/join_spec.rb'
 
-# Offense count: 1
+# Offense count: 2
 # Cop supports --auto-correct.
 Style/RescueModifier:
   Exclude:
     - 'lib/workflow/join.rb'
+    - 'lib/workflow/join/active_record/pending_callbacks.rb'
 
 # Offense count: 4
 # Cop supports --auto-correct.

data/Rakefile

@@ -15,10 +15,17 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 
-desc 'Tests'
+desc 'Tests w/ActiveRecord'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.rspec_opts = '-Ispec'
   #  spec.rcov = true
 end
 
-task default: [:spec]
+desc 'Tests wo/ActiveRecord'
+RSpec::Core::RakeTask.new(:spec_simple) do |spec|
+  ENV['USE_SIMPLE_PERSISTENCE'] = 'true'
+  spec.rspec_opts = '-Ispec'
+  #  spec.rcov = true
+end
+
+task default: [:spec, :spec_simple]

data/lib/workflow/join.rb

@@ -1,57 +1,79 @@
 require 'workflow'
 require 'workflow/join/version'
 
+if ENV['USE_SIMPLE_PERSISTENCE'] == 'true'
+  require 'workflow/join/simple'
+  puts "☆ Using simple mode (no persistence,) due to ‘ENV['USE_SIMPLE_PERSISTENCE']’"
+else
+  begin
+    require 'active_record'
+    require 'workflow/join/active_record'
+  rescue LoadError => e
+    require 'workflow/join/simple'
+    puts "★ Error requiring ActiveRecord (message: “#{e.message}”.) Will run in simple mode (no persistence.)"
+  end
+end
+
 Workflow::ClassMethods.prepend(Module.new do
   def workflow(&specification)
     # extend instances
     prepend(Module.new do # this should be safe, since there could not be two subsequent workflow DSL
-      attr_reader :pending_transitions # FIXME PERSIST!!!
+      if Workflow::Join.const_defined?('ActiveRecord')
+        include Workflow::Join::ActiveRecord # AR pending transitions and callbacks implementation
+      else
+        include Workflow::Join::Simple # simple pending transitions and callbacks implementation
+      end
+
       def guards!
+        spec.instance_variable_set(:@original_before_transition_proc, spec.before_transition_proc) \
+          unless spec.instance_variable_defined?(:@original_before_transition_proc)
+
         λλs = spec.guards.map do |inner, outers|
                 outers.map do |getter, state|
                   guard! inner, getter, state
-                end
+                end.compact
               end.flatten
-        λλs << spec.before_transition_proc if spec.before_transition_proc
+
+        (original_before_transition_proc = spec.instance_variable_get(:@original_before_transition_proc)) && \
+          λλs << original_before_transition_proc
         spec.before_transition_proc = ->(from, to, name, *args) { λλs.each { |λ| λ.(from, to, name, *args) } }
       end
 
       def guard!(inner, getter, state)
-        slave = getter.call(self)
-        slave.instance_variable_set(:@☛, (slave.instance_variable_get(:@☛) || []) | [self])
-        slave_hook = "on_#{state}_entry".to_sym
-        slave.class.prepend(Module.new do
-          define_method slave_hook do |old_state, event, *args|
-            @☛.each do |master|
-              next unless master.pending_transitions.is_a?(Array)
-              master.pending_transitions.reject! do |transition|
-                begin
-                  master.send("#{transition}!".to_sym)
-                  true
-                rescue
-                  false # no transition no cry
-                end
-              end
-            end
-            super(old_state, event, *args) rescue nil # no super no cry
+        return if getter.nil? || (slave = getter.call(self)).nil? # I’ll be back, hasta la vista, baby :)
+
+        slave.class.send :define_method, "on_#{state}_entry".to_sym do |old_state, event, *args|
+          pending_callbacks.each do |master|
+            master.reload if master.respond_to?(:reload)
+            next unless master.pending_transitions?
+            master.try_pending_transitions!
+            # halted is automagically removed after successful transition
+            # the line below is unneeded
+            # master.halted = master.pending_transitions?
           end
-        end)
+          super(old_state, event, *args) rescue nil # no super no cry
+        end
+
         lambda do |_, to, name, *|
+          slave.reload if slave.respond_to?(:reload)
           if to.to_sym == inner && !slave.send("#{state}?".to_sym)
-            @pending_transitions ||= []
-            @pending_transitions |= [name]
+            pending_transition! name
+            slave.pending_callback!(self)
             halt("Waiting for guard workflow to enter “:#{state}” state")
           end
         end
       end
     end)
 
-    # extend singleton class to update guards in constructor
-    singleton_class.prepend(Module.new do
-      def new(*)
-        super.tap(&:guards!)
-      end
-    end)
+    if respond_to?(:after_commit)
+      after_commit { guards! }
+    else
+      singleton_class.prepend(Module.new do
+        def new(*)
+          super.tap(&:guards!)
+        end
+      end)
+    end
 
     super
   end
@@ -61,7 +83,7 @@ module Workflow
   module Join
     GUARD_PARAMS_ERROR = 'Either guard instance variable name or a code block is required'.freeze
     GUARD_POINTCUT_ERROR = 'Both :inner and :outer states are required'.freeze
-    GUARD_IS_NOT_WORKFLOW = 'Guard given must be a workflow instance'.freeze
+    GUARD_IS_NOT_WORKFLOW = 'Guard given must be a workflow instance, was: “%s”'.freeze
 
     def guards
       @guards ||= {}
@@ -79,10 +101,11 @@ module Workflow
                   case
                   when /\A@/ =~ g.to_s && host.instance_variable_defined?(g)
                     host.instance_variable_get(g)
-                  when host.methods.include?(g) && host.method(g).arity.zero?
+                  when host.methods.include?(g) && host.method(g).arity <= 0
                     host.send g
                   end.tap do |guard_instance|
-                    fail Workflow::WorkflowDefinitionError, GUARD_IS_NOT_WORKFLOW unless guard_instance.is_a?(Workflow)
+                    fail Workflow::WorkflowDefinitionError, GUARD_IS_NOT_WORKFLOW % guard_instance \
+                      unless guard_instance.nil? || guard_instance.is_a?(Workflow)
                   end
                 end
               end

data/lib/workflow/join/active_record.rb

@@ -0,0 +1,43 @@
+require 'workflow/join/active_record/pending_transitions'
+require 'workflow/join/active_record/pending_callbacks'
+
+module Workflow
+  module Join
+    module ActiveRecord
+      ENSURE_COLUMNS = lambda do |model, *columns|
+        columns.reduce(true) do |memo, column|
+          next memo if model.column_names.include?(column.to_s)
+
+          ::ActiveRecord::Base.connection.execute(
+            "ALTER TABLE #{model.table_name} ADD #{column} VARCHAR(255)"
+          )
+          false
+        end
+      end
+
+      include PendingTransitions
+      include PendingCallbacks
+
+      def self.included(base)
+        base.singleton_class.send :define_method, :prepended do |model|
+          fail LoadError, "This module might be included in ActiveRecord::Base instances only (#{base} given.)" \
+            unless model < ::ActiveRecord::Base
+
+          unless ENSURE_COLUMNS.call(model, :workflow_pending_transitions, :workflow_pending_callbacks)
+            fail LoadError, <<-MSG
+
+              =======================================================================================
+               This is an intended fail, next time the class is requested, it’ll be loaded properly!
+               To avoid this one should explicitly specify columns:
+                  — workflow_pending_transitions,
+                  — workflow_pending_callbacks
+               in all models, that are willing to use joined workflows.
+              =======================================================================================
+
+            MSG
+          end
+        end
+      end
+    end
+  end
+end

data/lib/workflow/join/active_record/pending_callbacks.rb

@@ -0,0 +1,31 @@
+module Workflow
+  module Join
+    module ActiveRecord
+      # table.column :workflow_pending_callbacks,   :string
+      module PendingCallbacks
+        def pending_callbacks
+          workflow_pending_callbacks.to_s.split(';').map do |wpc|
+            c, id = wpc.split(',')
+            Kernel.const_get(c).find(id) rescue nil
+          end.compact
+        end
+
+        def pending_callbacks!(value)
+          pcs = case value
+                when Array then value.map { |instance| [instance.class.name, instance.id].join(',') }.join(';')
+                when String, Symbol then value.to_s
+                end
+          update_column :workflow_pending_callbacks, pcs
+        end
+
+        def pending_callbacks?
+          !pending_callbacks.empty?
+        end
+
+        def pending_callback!(value)
+          pending_callbacks!(pending_callbacks | [value])
+        end
+      end
+    end
+  end
+end

data/lib/workflow/join/active_record/pending_transitions.rb

@@ -0,0 +1,41 @@
+module Workflow
+  module Join
+    module ActiveRecord
+      # table.column :workflow_pending_transitions, :string
+      module PendingTransitions
+        def pending_transitions
+          workflow_pending_transitions.to_s.split(',').map(&:to_sym)
+        end
+
+        def pending_transitions!(value)
+          pts = case value
+                when Array then value.map(&:to_s).join(',')
+                when String, Symbol then value.to_s
+                end
+          update_column :workflow_pending_transitions, pts
+        end
+
+        def pending_transitions?
+          !pending_transitions.empty?
+        end
+
+        def pending_transition!(value)
+          pending_transitions!(pending_transitions | [value])
+        end
+
+        def try_pending_transitions!
+          pending_transitions!(pending_transitions.reject do |transition|
+            begin
+              respond_to?("can_#{transition}?") && \
+                public_send("can_#{transition}?") && \
+                public_send("#{transition}!".to_sym) && \
+                true
+            rescue
+              false # no transition no cry
+            end
+          end)
+        end
+      end
+    end
+  end
+end

data/lib/workflow/join/simple.rb

@@ -0,0 +1,11 @@
+require 'workflow/join/simple/pending_transitions'
+require 'workflow/join/simple/pending_callbacks'
+
+module Workflow
+  module Join
+    module Simple
+      include PendingTransitions
+      include PendingCallbacks
+    end
+  end
+end

data/lib/workflow/join/simple/pending_callbacks.rb

@@ -0,0 +1,23 @@
+module Workflow
+  module Join
+    module Simple
+      module PendingCallbacks
+        def pending_callbacks
+          @pending_callbacks ||= []
+        end
+
+        def pending_callbacks!(value)
+          @pending_callbacks = value
+        end
+
+        def pending_callbacks?
+          !pending_callbacks.empty?
+        end
+
+        def pending_callback!(value)
+          pending_callbacks!(pending_callbacks | [value])
+        end
+      end
+    end
+  end
+end

data/lib/workflow/join/simple/pending_transitions.rb

@@ -0,0 +1,36 @@
+module Workflow
+  module Join
+    module Simple
+      module PendingTransitions
+        def pending_transitions
+          @pending_transitions ||= []
+        end
+
+        def pending_transitions!(value)
+          @pending_transitions = value
+        end
+
+        def pending_transitions?
+          !pending_transitions.empty?
+        end
+
+        def pending_transition!(value)
+          pending_transitions!(pending_transitions | [value])
+        end
+
+        def try_pending_transitions!
+          pending_transitions.reject! do |transition|
+            begin
+              respond_to?("can_#{transition}?") && \
+                public_send("can_#{transition}?") && \
+                public_send("#{transition}!".to_sym) && \
+                true
+            rescue
+              false # no transition no cry
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/workflow/join/version.rb

@@ -1,5 +1,5 @@
 module Workflow
   module Join
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/workflow-join.gemspec

@@ -29,6 +29,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'sqlite3'
 
   spec.add_dependency 'workflow', '~> 1.2'
+  spec.add_dependency 'activerecord'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workflow-join
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Aleksei Matiushkin
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: workflow
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Workflow extension that allows to fork workflows with other workflows
   and join them at specific states.
 email:
@@ -115,6 +143,12 @@ files:
 - bin/console
 - bin/setup
 - lib/workflow/join.rb
+- lib/workflow/join/active_record.rb
+- lib/workflow/join/active_record/pending_callbacks.rb
+- lib/workflow/join/active_record/pending_transitions.rb
+- lib/workflow/join/simple.rb
+- lib/workflow/join/simple/pending_callbacks.rb
+- lib/workflow/join/simple/pending_transitions.rb
 - lib/workflow/join/version.rb
 - workflow-join.gemspec
 homepage: https://github.com/am-kantox/workflow-join