rails-workflow 1.4.5.4 → 1.4.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c00b8e437381e8b05f1f9b870667c24c06b9ec64
-  data.tar.gz: 429a9bbdff4aab6ff053d2f395d2be1bbafbba2c
+  metadata.gz: 5aea9261c6bf6fa5ab1c793179ef8440a67be0d6
+  data.tar.gz: aa69e4c243b24250f6880cfcfcf3efafc33b9a15
 SHA512:
-  metadata.gz: 732795994aa948a71b19bbe1fe1c5da5ea6814de9a146615d0eb5ae1fac2cd67c174619b9d1e6c64a943b94c32e6ccbab151c668bbcb8d56c532f02d4e7d46f1
-  data.tar.gz: a44fb7792d8f027fb953d9b789a12bbad7d837002f3a14b9acfda52375e3f274391fb352f3c29ad6f43477123b7f715726a91a38a2f794c7ce50aec8a698eef5
+  metadata.gz: ad8375bdbe64ae0ddadf8d9e272e22d198dfc87108327fba67d7c2852955c334334efafe24195b4f0d6ffe2d18ce726205fff343142a8c2cbe46c0e44721988e
+  data.tar.gz: ccb120fe43028613ab269556076cbee0a7113da2831d0c32308cd68a680080e99fc21e68b50142f8843bb57813fe67d82facc0bfa1d387e6eabac5ad2c40287c

data/.gitignore

@@ -22,3 +22,5 @@ tmp
 .byebug_history
 
 lib/active_support/callbacks.rb
+
+errors.html

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'vendor/**/*'
+    - 'config/initializers/*'
+    - 'tmp/**/*'
+    - 'db/**/*'
+    - 'spec/spec_helper.rb'
+    - 'lib/tasks/**/*'
+    - 'spec/rails_helper.rb'
+    - 'spec/support/*'
+    - 'spec/active_support_callbacks_spec.rb'
+    - 'rails-workflow.gemspec'
+    - 'bin/*'
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 14

data/Gemfile

@@ -1,3 +1,4 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+source 'http://rubygems.org'
 gem 'byebug'
 gemspec

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rubygems'
 require 'rake/testtask'
 require 'rdoc/task'
@@ -5,7 +6,7 @@ require 'rdoc/task'
 require 'bundler'
 Bundler.setup
 
-task :default => [:test]
+task default: [:test]
 
 require 'rake'
 Rake::TestTask.new do |t|
@@ -24,7 +25,6 @@ Rake::TestTask.new do |t|
 end
 
 Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_files.include("lib/**/*.rb")
-  rdoc.options << "-S"
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << '-S'
 end
-

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "workflow"
+require 'bundler/setup'
+require 'workflow'
 
 # 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.
@@ -10,5 +10,5 @@ require "workflow"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/active_support/overloads.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'active_support/callbacks'
 
 module ActiveSupport
@@ -6,16 +7,17 @@ module ActiveSupport
   # to a lambda for the present purposes.
   module CallbackOverloads
     private
+
     def make_lambda(filter)
-      if filter.kind_of? Workflow::Callbacks::TransitionCallback
-        super(filter.wrapper)
+      if filter.is_a? Workflow::Callbacks::TransitionCallback
+        filter
       else
         super
       end
     end
 
     def compute_identifier(filter)
-      if filter.kind_of? Workflow::Callbacks::TransitionCallback
+      if filter.is_a? Workflow::Callbacks::TransitionCallback
         super(filter.raw_proc)
       else
         super
@@ -24,9 +26,14 @@ module ActiveSupport
   end
 end
 
-# Overload {ActiveSupport::Callbacks::Callback} with methods from {ActiveSupport::CallbackOverloads}.
+# Overload {ActiveSupport::Callbacks::Callback} with methods from
+# {ActiveSupport::CallbackOverloads}.
 # {Workflow::Callbacks::TransitionCallback}, which is duck-type equivalent
 # to a lambda for the present purposes.
-class ::ActiveSupport::Callbacks::Callback
-  prepend ActiveSupport::CallbackOverloads
+module ActiveSupport
+  module Callbacks
+    class Callback
+      prepend ActiveSupport::CallbackOverloads
+    end
+  end
 end

data/lib/workflow.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rubygems'
 require 'active_support/concern'
 require 'active_support/callbacks'
@@ -5,21 +6,30 @@ require 'workflow/version'
 require 'workflow/configuration'
 require 'workflow/specification'
 require 'workflow/callbacks'
+require 'workflow/helper_method_configurator'
 require 'workflow/adapters/active_record'
 require 'workflow/adapters/remodel'
+require 'workflow/transitions'
+require 'workflow/definition'
+require 'workflow/adapters/adapter'
 require 'workflow/adapters/active_record_validations'
 require 'workflow/transition_context'
 require 'active_support/overloads'
 
-
 # See also README.markdown for documentation
 module Workflow
   # @!parse include Callbacks
+  # @!parse include Transitions
+  # @!parse include Definition
   # @!parse extend Callbacks::ClassMethods
 
   extend ActiveSupport::Concern
   include Callbacks
   include Errors
+  include Transitions
+  include Definition
+
+  include Adapters::Adapter
 
   # The application-wide Workflow configuration object
   CONFIGURATION = Configuration.new
@@ -30,283 +40,6 @@ module Workflow
   # @return [nil]
   def self.config(&block)
     block.call(CONFIGURATION) if block_given?
-    return CONFIGURATION
-  end
-
-  included do
-
-    # Look for a hook; otherwise detect based on ancestor class.
-    if respond_to?(:workflow_adapter)
-      include self.workflow_adapter
-    else
-      if Object.const_defined?(:ActiveRecord) && self < ActiveRecord::Base
-        include Adapter::ActiveRecord
-        include Adapter::ActiveRecordValidations
-      end
-      if Object.const_defined?(:Remodel) && klass < Adapter::Remodel::Entity
-        include Adapter::Remodel::InstanceMethods
-      end
-    end
-  end
-
-  # Returns a state object representing the current workflow state.
-  #
-  # @return [State] Current workflow state
-  def current_state
-    loaded_state = load_workflow_state
-    res = workflow_spec.states.find{|t| t.name==loaded_state.to_sym} if loaded_state
-    res || workflow_spec.initial_state
-  end
-
-  # Deprecated.  Check for false return value from {#transition!}
-  # @return [Boolean] true if the last transition was halted by one of the transition callbacks.
-  def halted?
-    @halted
-  end
-
-  # Returns the reason given to a call to {#halt} or {#halt!}, if any.
-  # @return [String] The reason the transition was aborted.
-  attr_reader :halted_because
-
-  # @api private
-  # @return [Workflow::TransitionContext] During transition, or nil if no transition is underway.
-  # During a state transition, contains transition-specific information:
-  # * The name of the {Workflow::State} being exited,
-  # * The name of the {Workflow::State} being entered,
-  # * The name of the {Workflow::Event} that was fired,
-  # * And whatever arguments were passed to the {Workflow#transition!} method.
-  attr_reader :transition_context
-
-  # Initiates state transition via the named event
-  #
-  # @param [Symbol] name name of event to initiate
-  # @param [Array] args State transition arguments.
-  # @return [Symbol] The name of the new state, or `false` if the transition failed.
-  # TODO: connect args to documentation on how arguments are accessed during state transitions.
-  def transition!(name, *args, **attributes)
-    name = name.to_sym
-    event = current_state.find_event(name)
-    raise NoTransitionAllowed.new(
-      "There is no event #{name} defined for the #{current_state.name} state") \
-      if event.nil?
-
-    @halted_because = nil
-    @halted = false
-
-    target = event.evaluate(self)
-    unless target
-      raise NoMatchingTransitionError.new("No matching transition found on #{name} for target #{target}.  Consider adding a catchall transition.")
-    end
-
-    from = current_state
-    return_value = false
-    begin
-      @transition_context = TransitionContext.new \
-        from: from.name,
-        to: target.name,
-        event: name,
-        event_args: args,
-        attributes: attributes,
-        named_arguments: workflow_spec.named_arguments
-
-      run_all_callbacks do
-        callback_value  = run_action_callback name, *args
-        persist_value   = persist_workflow_state(target.name)
-        return_value    = callback_value || persist_value
-      end
-    ensure
-      @transition_context = nil
-    end
-    return_value
-  end
-
-  # Stop the current transition and set the reason for the abort.
-  #
-  # @param [String] reason Optional reason for halting transition.
-  # @return [nil]
-  def halt(reason = nil)
-    @halted_because = reason
-    @halted = true
-    throw :abort
-  end
-
-  # Sets halt reason and raises [TransitionHaltedError] error.
-  #
-  # @param [String] reason Optional reason for halting
-  # @return [nil]
-  def halt!(reason = nil)
-    @halted_because = reason
-    @halted = true
-    raise TransitionHaltedError.new(reason)
-  end
-
-  #   The specification for this object.
-  #   Could be set on a singleton for the object, on the object's class,
-  #   Or else on a superclass of the object.
-  # @return [Specification] The Specification that applies to this object.
-  def workflow_spec
-    # check the singleton class first
-    class << self
-      return workflow_spec if workflow_spec
-    end
-
-    c = self.class
-    # using a simple loop instead of class_inheritable_accessor to avoid
-    # dependency on Rails' ActiveSupport
-    until c.workflow_spec || !(c.include? Workflow)
-      c = c.superclass
-    end
-    c.workflow_spec
-  end
-
-  private
-
-  def has_callback?(action)
-    # 1. public callback method or
-    # 2. protected method somewhere in the class hierarchy or
-    # 3. private in the immediate class (parent classes ignored)
-    action = action.to_sym
-    self.respond_to?(action) or
-      self.class.protected_method_defined?(action) or
-      self.private_methods(false).map(&:to_sym).include?(action)
-  end
-
-  def run_action_callback(action_name, *args)
-    action = action_name.to_sym
-    if has_callback?(action)
-      meth = method(action)
-      check_method_arity! meth, *args
-      meth.call *args
-    end
-  end
-
-  def check_method_arity!(method, *args)
-    arity = method.arity
-
-    unless (arity >= 0 && args.length == arity) || (arity < 0 && (args.length + 1) >= arity.abs)
-      raise CallbackArityError.new("Method #{method.name} has arity #{arity} but was called with #{args.length} arguments.")
-    end
-  end
-
-  # load_workflow_state and persist_workflow_state
-  # can be overriden to handle the persistence of the workflow state.
-  #
-  # Default (non ActiveRecord) implementation stores the current state
-  # in a variable.
-  #
-  # Default ActiveRecord implementation uses a 'workflow_state' database column.
-  def load_workflow_state
-    @workflow_state if instance_variable_defined? :@workflow_state
-  end
-
-  def persist_workflow_state(new_value)
-    @workflow_state = new_value
-  end
-
-  module ClassMethods
-    attr_reader :workflow_spec
-
-    # Instructs Workflow which column to use to persist workflow state.
-    #
-    # @param [Symbol] column_name If provided, will set a new workflow column name.
-    # @return [Symbol] The current (or new) name for the workflow column on this class.
-    def workflow_column(column_name=nil)
-      if column_name
-        @workflow_state_column_name = column_name.to_sym
-      end
-      if !instance_variable_defined?('@workflow_state_column_name') && superclass.respond_to?(:workflow_column)
-        @workflow_state_column_name = superclass.workflow_column
-      end
-      @workflow_state_column_name ||= :workflow_state
-    end
-
-
-    ##
-    # Define workflow for the class.
-    #
-    # @yield [] Specification of workflow. Example below and in README.markdown
-    # @return [nil]
-    #
-    # Workflow definition takes place inside the yielded block.
-    # @see Specification::state
-    # @see Specification::event
-    #
-    # ~~~ruby
-    #
-    # class Article
-    #   include Workflow
-    #   workflow do
-    #     state :new do
-    #       event :submit, :transitions_to => :awaiting_review
-    #     end
-    #     state :awaiting_review do
-    #       event :review, :transitions_to => :being_reviewed
-    #     end
-    #     state :being_reviewed do
-    #       event :accept, :transitions_to => :accepted
-    #       event :reject, :transitions_to => :rejected
-    #     end
-    #     state :accepted
-    #     state :rejected
-    #   end
-    # end
-    #
-    #~~~
-    #
-    def workflow(&specification)
-      assign_workflow Specification.new(Hash.new, &specification)
-    end
-
-    private
-
-    # Creates the convinience methods like `my_transition!`
-    def assign_workflow(specification_object)
-      # Merging two workflow specifications can **not** be done automically, so
-      # just make the latest specification win. Same for inheritance -
-      # definition in the subclass wins.
-      if self.superclass.respond_to?(:workflow_spec, true) && self.superclass.workflow_spec
-        undefine_methods_defined_by_workflow_spec superclass.workflow_spec
-      end
-
-      @workflow_spec = specification_object
-      @workflow_spec.states.each do |state|
-        state_name = state.name
-        module_eval do
-          define_method "#{state_name}?" do
-            state_name == current_state.name
-          end
-        end
-
-        state.events.each do |event|
-          event_name = event.name
-          module_eval do
-            define_method "#{event_name}!".to_sym do |*args|
-              transition!(event_name, *args)
-            end
-
-            define_method "can_#{event_name}?" do
-              return !!current_state.find_event(event_name)&.evaluate(self)
-            end
-          end
-        end
-      end
-    end
-
-    def undefine_methods_defined_by_workflow_spec(inherited_workflow_spec)
-      inherited_workflow_spec.states.each do |state|
-        state_name = state.name
-        module_eval do
-          undef_method "#{state_name}?"
-        end
-
-        state.events.each do |event|
-          event_name = event.name
-          module_eval do
-            undef_method "#{event_name}!".to_sym
-            undef_method "can_#{event_name}?"
-          end
-        end
-      end
-    end
+    CONFIGURATION
   end
 end