rails-workflow 1.4.4.4 → 1.4.5.4

data/lib/workflow/specification.rb

@@ -1,7 +1,6 @@
 require 'workflow/state'
 require 'workflow/event'
 require 'workflow/errors'
-require 'active_support/callbacks'
 
 module Workflow
   # Metadata object describing available states and state transitions.
@@ -51,13 +50,14 @@ module Workflow
       end
     end
 
+    # Find the state with the given name.
+    #
+    # @param [Symbol] name Name of state to find.
+    # @return [Workflow::State] The state with the given name.
     def find_state(name)
       states.find{|t| t.name == name.to_sym}
     end
 
-
-
-
     # @api private
     #
     # @param [Hash] meta Metadata
@@ -79,7 +79,7 @@ module Workflow
     # @return [nil]
     def state(name, meta: {}, &events)
       name = name.to_sym
-      new_state = Workflow::State.new(name, self, meta)
+      new_state = Workflow::State.new(name, @states.length, meta: meta)
       @initial_state ||= new_state
       @states << new_state
       new_state.instance_eval(&events) if block_given?
@@ -110,7 +110,7 @@ module Workflow
     #   workflow do
     #     define_revert_events!
     #     state :foo do
-    #       event :bar, transitions_to: :bax
+    #       on :bar, to: :bax
     #     end
     #     state :bax
     #   end

data/lib/workflow/state.rb

@@ -1,14 +1,30 @@
 module Workflow
+  # Represents one state for the defined workflow,
+  # with a list of {Workflow::Event}s that can transition to
+  # other states.
   class State
     include Comparable
 
-    attr_accessor :name, :events, :meta, :on_entry, :on_exit
-    attr_reader :sequence
+    # @!attribute [r] name
+    #   @return [Symbol] The name of the state.
+    # @!attribute [r] events
+    #   @return [Array] Array of {Workflow::Event}s defined for this state.
+    # @!attribute [r] meta
+    #   @return [Hash] Extra information defined for this state.
+    attr_reader :name, :events, :meta
 
-    def initialize(name, sequence, **meta)
+    # @api private
+    # For creating {Workflow::State} objects please see {Specification#state}
+    # @param [Symbol] name The name of the state being created.  Should be unique within its workflow.
+    # @param [Fixnum] sequence Sequencing number that will affect sorting comparisons with other states.
+    # @param [Hash] meta: Optional metadata for this state.
+    def initialize(name, sequence, meta: {})
       @name, @sequence, @events, @meta = name.to_sym, sequence, [], meta
     end
 
+    # Returns the event with the given name.
+    # @param [Symbol] name name of event to find
+    # @return [Workflow::Event] The event with the given name, or `nil`
     def find_event(name)
       events.find{|t| t.name == name}
     end
@@ -17,10 +33,9 @@ module Workflow
     # Must be called within the scope of the block within a call to {#state}.
     #
     # @param [Symbol] name The name of the event
-    # @param [Hash] args
-    # @option args [Symbol] :transitions_to The state this event transitions to.
-    # @option args [Symbol] :if optional instance method name or [Proc] that will receive the object when called.
-    # @option args [Hash] :meta Optional metadata to be stored on the event object
+    # @param [Symbol] to: Optional name of {Workflow::State} this event will transition to.  Must be omitted if a block is provided.
+    # @param [Hash] meta: Optional hash of metadata to be stored on the event object.
+    # @yield [] Transitions definition for this event.
     # @return [nil]
     #
     #```ruby
@@ -45,7 +60,7 @@ module Workflow
     #  state :the_diner
     #end
     #```
-    def on(name, to: nil, meta: nil, &transitions)
+    def on(name, to: nil, meta: {}, &transitions)
       if to && block_given?
         raise Errors::WorkflowDefinitionError.new("Event target can only be received in the method call or the block, not both.")
       end
@@ -58,7 +73,7 @@ module Workflow
         raise Errors::WorkflowDefinitionError.new("Already defined an event [#{name}] for state[#{self.name}]")
       end
 
-      event = Workflow::Event.new(name, meta)
+      event = Workflow::Event.new(name, meta: meta)
 
       if to
         event.to to
@@ -74,15 +89,28 @@ module Workflow
       nil
     end
 
+    # @return [String] String representation of object
     def inspect
       "<State name=#{name.inspect} events(#{events.length})=#{events.inspect}>"
     end
 
+    # Overloaded comparison operator.  Workflow states are sorted according to the order
+    # in which they were defined.
+    #
+    # @param [Workflow::State] other_state state to be compared against.
+    # @return [Integer]
     def <=>(other_state)
       unless other_state.is_a?(State)
         raise StandardError.new "Other State #{other_state} is a #{other_state.class}.  I can only be compared with a Workflow::State."
       end
-      self.sequence <=> other_state.sequence
+      self.sequence <=> other_state.send(:sequence)
     end
+
+    private
+    # @api private
+    # @!attribute [r] sequence
+    #   @return [Fixnum] The position of this state within the order it was defined for in its workflow.
+    attr_reader :sequence
+
   end
 end

data/lib/workflow/version.rb

@@ -1,3 +1,3 @@
 module Workflow
-  VERSION = "1.4.4.4"
+  VERSION = "1.4.5.4"
 end

data/rails-workflow.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{A finite-state-machine-inspired API for managing state changes in ActiveModel objects.  Based on Vladimir Dobriakov's Workflow gem (https://github.com/geekq/workflow)}
   spec.description   = %q{Workflow specifically for ActiveModel objects.}
-  spec.homepage      = "https://github.com/tylergannon/rails-workflow"
+  spec.homepage      = "https://tylergannon.github.io/rails-workflow/"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-workflow
 version: !ruby/object:Gem::Version
-  version: 1.4.4.4
+  version: 1.4.5.4
 platform: ruby
 authors:
 - Tyler Gannon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-24 00:00:00.000000000 Z
+date: 2016-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -215,14 +215,16 @@ files:
 - gemfiles/Gemfile.rails-4.0
 - gemfiles/Gemfile.rails-5.0
 - gemfiles/Gemfile.rails-edge
+- lib/active_support/overloads.rb
 - lib/workflow.rb
 - lib/workflow/adapters/active_record.rb
 - lib/workflow/adapters/active_record_validations.rb
 - lib/workflow/adapters/remodel.rb
 - lib/workflow/callbacks.rb
 - lib/workflow/callbacks/callback.rb
-- lib/workflow/callbacks/transition_callback_method_wrapper.rb
-- lib/workflow/callbacks/transition_callback_wrapper.rb
+- lib/workflow/callbacks/transition_callback.rb
+- lib/workflow/callbacks/transition_callbacks/method_wrapper.rb
+- lib/workflow/callbacks/transition_callbacks/proc_wrapper.rb
 - lib/workflow/configuration.rb
 - lib/workflow/draw.rb
 - lib/workflow/errors.rb
@@ -233,7 +235,7 @@ files:
 - lib/workflow/version.rb
 - orders_workflow.png
 - rails-workflow.gemspec
-homepage: https://github.com/tylergannon/rails-workflow
+homepage: https://tylergannon.github.io/rails-workflow/
 licenses:
 - MIT
 metadata:

data/lib/workflow/callbacks/transition_callback_method_wrapper.rb

@@ -1,65 +0,0 @@
-module Workflow
-  module Callbacks
-    class TransitionCallbackMethodWrapper < TransitionCallbackWrapper
-      attr_reader :calling_class
-
-      def wrapper
-        cb_object = self
-        proc_string = build_proc(<<-EOF)
-          arguments = [
-            cb_object.send(:raw_proc).inspect,
-            cb_object.send(:name_arguments_string),
-            cb_object.send(:rest_param_string),
-            cb_object.send(:kw_arguments_string),
-            cb_object.send(:keyrest_string),
-            cb_object.send(:procedure_string)].compact.join(', ')
-          target.instance_eval("send(\#{arguments})")
-        EOF
-        p = eval(proc_string)
-        return overload_equality_operator(p)
-      end
-
-      # protected
-
-      def overload_equality_operator(outer_proc)
-        raw_proc = raw_proc
-        def outer_proc.raw_proc
-          raw_proc
-        end
-        def outer_proc.==(other)
-          if other.kind_of?(::Proc)
-            if other.respond_to?(:raw_proc)
-              self.raw_proc == other.raw_proc
-            else
-              self == other
-            end
-          elsif other.kind_of?(Symbol)
-            self.raw_proc == other
-          else
-            false
-          end
-        end
-        return outer_proc
-      end
-      def name_arguments_string
-        name_params.map{|name| "name_proc.call(:#{name})"} if name_params.any?
-      end
-
-      def procedure_string
-        '&callbacks' if around_callback?
-      end
-
-      def callback_method
-        @meth ||= calling_class.instance_method(raw_proc)
-      end
-
-      def parameters
-        callback_method.parameters
-      end
-
-      def arity
-        callback_method.arity
-      end
-    end
-  end
-end