workflow-join 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f609a97329dc400e969449c824e52ad91413eee
-  data.tar.gz: f441e161a922f387b0b5ee908873c6b8b1db265e
+  metadata.gz: 8c3c2da76cc4df53310b7bf849f82b376191ea55
+  data.tar.gz: 1c180e494c16da06665ceda094062e1da1825578
 SHA512:
-  metadata.gz: 7b7762a647e1133c54eb90734c5a8af1e3e18522d1b486f316d25c9d753a27a3b0a0a65f83afe6a50fad229395de36900ffbbfb4960ef6681ec3986786a630a9
-  data.tar.gz: 936d6597d74068ba6f79339b1098be00bcead2854fb1f08f4c138bfb57b192c8a198e31271230d983cde2e54e63f2f6d1523df99a783dd2df106b4e3d48ba7dc
+  metadata.gz: 8a3b94ed6356eca07083c260186f28ff580ee5b535ba53148b2baeb03f232710c3b45dd641d0371576d055f35db0b3110d80da1a44bab6e67f2712d566dbfce0
+  data.tar.gz: bbcf979a422528c2bade2bdbb26abf103c03d8866a7ec3f84528eb122035f386aa4c9906c85b1d564027a5617b2d7df69f304955c3e0e53d971ebfa708e657c9

data/.rubocop.yml

@@ -7,6 +7,9 @@ inherit_from: .rubocop_todo.yml
 Style/SignalException:
   EnforcedStyle: semantic
 
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
 Metrics/ClassLength:
   Max: 200
 

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-09-16 13:15:05 +0200 using RuboCop version 0.42.0.
+# on 2016-11-17 12:26:01 +0100 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
@@ -14,10 +14,6 @@ Lint/BlockAlignment:
   Exclude:
     - 'lib/workflow/join.rb'
 
-# Offense count: 1
-Metrics/AbcSize:
-  Max: 57
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
@@ -26,12 +22,6 @@ Style/LambdaCall:
   Exclude:
     - 'lib/workflow/join.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/MutableConstant:
-  Exclude:
-    - 'lib/workflow/join/version.rb'
-
 # Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: PreferredDelimiters.
@@ -47,14 +37,13 @@ Style/RescueModifier:
     - 'lib/workflow/join.rb'
     - 'lib/workflow/join/active_record/pending_callbacks.rb'
 
-# Offense count: 4
+# Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes
 Style/StringLiterals:
   Exclude:
     - 'bin/console'
-    - 'lib/workflow/join/version.rb'
 
 # Offense count: 2
 # Configuration parameters: EnforcedStyle, SupportedStyles.

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in workflow-join.gemspec
 gemspec
+
+gem 'rspec-sidekiq', '~> 1', group: :test

data/README.md

@@ -105,6 +105,43 @@ created and simple application restart will enable the feature.
 This part is hardly tested, though, that’s why the preferred way would be to
 create columns manually.
 
+### Use Sidekiq jobs as guards
+
+Starting with version `0.3.0`, we support sidekiq jobs as guards:
+
+```ruby
+  class LongRunningChecker
+    include ::Sidekiq::Worker
+
+    def perform(*_args)
+      do_requests(*args) # sleep 10
+    end
+  end
+
+  class Master < ActiveRecord::Base
+    include Workflow
+
+    workflow do
+      state :initial do
+        event :validate, transitions_to: :validated
+      end
+      state :validated
+
+      guard inner: :validated, job: LongRunningChecker
+    end
+  end
+```
+
+## Changelog
+
+#### `0.3.0` `Sidekiq` jobs as guards
+
+#### `0.2.4` `ActiveRecord` support
+
+## It is of any good?
+
+Yes.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/workflow/join.rb

@@ -1,19 +1,20 @@
 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
+with_ar = 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
 
+# rubocop:disable Metrics/AbcSize
 Workflow::ClassMethods.prepend(Module.new do
   def workflow(&specification)
     # extend instances
@@ -78,40 +79,59 @@ Workflow::ClassMethods.prepend(Module.new do
     super
   end
 end)
+# rubocop:enable Metrics/AbcSize
 
 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_PARAMS_ERROR = 'One of: [guard instance variable, code block, job] is required'.freeze
+    GUARD_POINTCUT_ERROR = 'Both :inner and :outer state / :job are required'.freeze
     GUARD_IS_NOT_WORKFLOW = 'Guard given must be a workflow instance, was: “%s”'.freeze
+    DEVELOPER_ERROR = 'Developer is an idiot, please excuse and file and issue'.freeze
 
     def guards
       @guards ||= {}
     end
 
-    def guard(getter = nil, inner: nil, outer: nil)
-      fail Workflow::WorkflowDefinitionError, GUARD_PARAMS_ERROR unless !getter.nil? ^ block_given?
-      fail Workflow::WorkflowDefinitionError, GUARD_POINTCUT_ERROR unless inner && outer
-
-      guard = if block_given?
-                Proc.new
-              else
-                g = getter.to_sym
-                lambda do |host|
-                  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 <= 0
-                    host.send g
-                  end.tap do |guard_instance|
-                    fail Workflow::WorkflowDefinitionError, GUARD_IS_NOT_WORKFLOW % guard_instance \
-                      unless guard_instance.nil? || guard_instance.is_a?(Workflow)
-                  end
-                end
+    def guard(getter = nil, inner: nil, outer: nil, job: nil)
+      fail Workflow::WorkflowDefinitionError, GUARD_PARAMS_ERROR unless [getter, job, block_given?].one?
+      fail Workflow::WorkflowDefinitionError, GUARD_POINTCUT_ERROR unless inner && (outer || job)
+
+      guard = case getter ||= job
+              when NilClass then Proc.new # block_given? == true, see L#97 check
+              when Symbol, String then guard_for_instance_variable(getter)
+              when Class then guard_for_class(getter)
+              else fail Workflow::WorkflowDefinitionError, DEVELOPER_ERROR
               end
-      (guards[inner.to_sym] ||= []) << [guard, outer.to_sym]
+      (guards[inner.to_sym] ||= []) << [guard, (outer || ::Workflow::Join::Sidekiq::Job::DONE).to_sym]
+    end
+
+    private
+
+    def guard_for_instance_variable(getter)
+      g = getter.to_sym
+      lambda do |host|
+        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 <= 0
+          host.send g
+        end.tap do |guard_instance|
+          fail Workflow::WorkflowDefinitionError, GUARD_IS_NOT_WORKFLOW % guard_instance \
+            unless guard_instance.nil? || guard_instance.is_a?(Workflow)
+        end
+      end
+    end
+
+    def guard_for_class(getter)
+      lambda do |host|
+        Workflow::Join::Sidekiq::Job.lookup!(host, getter).tap do |job|
+          job.run! if job.can_run?
+        end
+      end
     end
   end
 end
 
 Workflow::Specification.prepend Workflow::Join
+
+require 'workflow/join/sidekiq' if with_ar

data/lib/workflow/join/sidekiq.rb

@@ -0,0 +1,3 @@
+require 'sidekiq'
+
+require 'workflow/join/sidekiq/job'

data/lib/workflow/join/sidekiq/job.rb

@@ -0,0 +1,125 @@
+module Workflow
+  module Join
+    module Sidekiq
+      class Job < ::ActiveRecord::Base
+        # attr_accessor :worker, :args, :result, :fails
+        DONE = :done
+        TABLE_NAME = 'workflow_jobs'.freeze
+
+        self.table_name = TABLE_NAME
+
+        class << self
+          def migration(table_name = TABLE_NAME)
+            <<-MIGRATION
+            class CreateWorkflowJobs < ::ActiveRecord::Migration
+              def change
+                create_table :#{table_name} do |t|
+                  t.string   :workflow_state, default: 'scheduled', null: false
+
+                  t.string   :host
+                  t.integer  :host_id
+                  t.string   :worker
+
+                  t.text     :args
+                  t.text     :result
+                  t.text     :fails
+
+                  t.string   :workflow_pending_transitions
+                  t.string   :workflow_pending_callbacks
+
+                  t.timestamps
+                end
+
+                add_index :#{table_name}, :workflow_state, unique: false
+                add_index :#{table_name}, [:host, :host_id, :worker], unique: true
+              end
+            end
+            MIGRATION
+          end
+
+          def lookup!(host, worker)
+            params = { host: host.class.to_s, host_id: host.id, worker: worker.to_s }
+            where(**params).last || create!(**params)
+          end
+
+          def worker(worker)
+            case worker
+            when String, Symbol then Kernel.const_get(worker)
+            when Module then worker
+            else fail ArgumentError, "Workflow::Join::Sidekiq::Job#worker expects a string/class as an argument, got #{worker.inspect}."
+            end
+          end
+        end
+
+        private_class_method :new, :create, :create! # use lookup!, buddy
+
+        ########################################################################
+
+        include Workflow
+
+        workflow do
+          state :scheduled do
+            event :run, transitions_to: :running
+          end
+          state :running do
+            event :fail, transitions_to: :failed
+            event :success, transitions_to: DONE
+          end
+          state :failed do
+            event :success, transitions_to: DONE
+          end
+          state DONE
+        end
+
+        def on_running_entry(_old_state, _event, *args)
+          Job::Worker.perform_async(*args, ★: id) # FIXME: Anything more elegant?
+        end
+
+        def on_failed_entry(_old_state, _event, *args)
+          timestamp = Time.respond_to?(:zone) && Time.zone ? Time.zone.now : Time.now
+          (self.fails ||= {})[timestamp] = args
+        end
+
+        ########################################################################
+
+        serialize :args, Array
+        serialize :result, Hash
+        serialize :fails, Hash
+
+        def to_hash
+          {
+            # id: id,
+            host: host,
+            host_id: host_id,
+            worker: worker,
+            args: args,
+            result: result,
+            errors: fails,
+            workflow_state: workflow_state,
+            state: workflow_state.to_sym
+          }
+        end
+
+        ########################################################################
+
+        class Worker
+          include ::Sidekiq::Worker
+
+          def perform(*args)
+            Job.find(args.pop['★']).tap do |job|
+              # FIXME: Log this somehow
+              begin
+                job.args = args
+                job.result = Job.worker(job.worker).new.perform(*job.args)
+                job.success!
+              rescue => e
+                job.fail! e
+                raise e
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/workflow/join/version.rb

@@ -1,5 +1,5 @@
 module Workflow
   module Join
-    VERSION = "0.2.1"
+    VERSION = '0.3.0'.freeze
   end
 end

data/workflow-join.gemspec

@@ -24,13 +24,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'rake', '~> 10'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'awesome_print'
 
-  spec.add_dependency 'workflow', '~> 1.2'
-  spec.add_dependency 'activerecord', '>= 3.2.1', '< 5.0.0'
+  spec.add_dependency 'workflow', '~> 1'
+  spec.add_dependency 'activerecord', '~> 3'
+  spec.add_dependency 'sidekiq', '~> 3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workflow-join
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Aleksei Matiushkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-16 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,40 +94,62 @@ 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: workflow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.1
-    - - "<"
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '3'
 description: Workflow extension that allows to fork workflows with other workflows
   and join them at specific states.
 email:
@@ -152,6 +174,8 @@ files:
 - 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/sidekiq.rb
+- lib/workflow/join/sidekiq/job.rb
 - lib/workflow/join/simple.rb
 - lib/workflow/join/simple/pending_callbacks.rb
 - lib/workflow/join/simple/pending_transitions.rb