mylescarrick-aasm 2.1.5

data/lib/aasm/event.rb

@@ -0,0 +1,109 @@
+class AASM::SupportingClasses::Event
+  attr_reader :name, :success, :options
+
+  def initialize(name, options = {}, &block)
+    @name = name
+    @transitions = []
+    update(options, &block)
+  end
+
+  def fire(obj, to_state=nil, *args)
+    transitions = @transitions.select { |t| t.from == obj.aasm_current_state }
+    raise AASM::InvalidTransition, "Event '#{name}' cannot transition from '#{obj.aasm_current_state}'" if transitions.size == 0
+
+    next_state = nil
+    transitions.each do |transition|
+      next if to_state and !Array(transition.to).include?(to_state)
+      if transition.perform(obj)
+        next_state = to_state || Array(transition.to).first
+        transition.execute(obj, *args)
+        break
+      end
+    end
+    next_state
+  end
+
+  def transitions_from_state?(state)
+    @transitions.any? { |t| t.from == state }
+  end
+
+  def transitions_from_state(state)
+    @transitions.select { |t| t.from == state }
+  end
+
+  def all_transitions
+    @transitions
+  end
+
+  def call_action(action, record)
+    action = @options[action]
+    action.is_a?(Array) ?
+            action.each {|a| _call_action(a, record)} :
+            _call_action(action, record)
+  end
+
+  def ==(event)
+    if event.is_a? Symbol
+      name == event
+    else
+      name == event.name
+    end
+  end
+
+  def update(options = {}, &block)
+    if options.key?(:success) then
+      @success = options[:success]
+    end
+    if options.key?(:error) then
+      @error = options[:error]
+    end
+    if block then
+      instance_eval(&block)
+    end
+    @options = options
+    self
+  end
+
+  def execute_success_callback(obj, success = nil)
+    callback = success || @success
+    case(callback)
+      when String, Symbol
+        obj.send(callback)
+      when Proc
+        callback.call(obj)
+      when Array
+        callback.each{|meth|self.execute_success_callback(obj, meth)}
+    end
+  end
+
+  def execute_error_callback(obj, error, error_callback=nil)
+    callback = error_callback || @error
+    raise error unless callback
+    case(callback)
+      when String, Symbol
+        raise NoMethodError unless obj.respond_to?(callback.to_sym)
+        obj.send(callback, error)
+      when Proc
+        callback.call(obj, error)
+      when Array
+        callback.each{|meth|self.execute_error_callback(obj, error, meth)}
+    end
+  end
+
+  private
+
+  def _call_action(action, record)
+    case action
+      when Symbol, String
+        record.send(action)
+      when Proc
+        action.call(record)
+    end
+  end
+
+  def transitions(trans_opts)
+    Array(trans_opts[:from]).each do |s|
+      @transitions << AASM::SupportingClasses::StateTransition.new(trans_opts.merge({:from => s.to_sym}))
+    end
+  end
+end

data/lib/aasm/persistence.rb

@@ -0,0 +1,14 @@
+module AASM::Persistence
+
+  # Checks to see this class or any of it's superclasses inherit from
+  # ActiveRecord::Base and if so includes ActiveRecordPersistence
+  def self.set_persistence(base)
+    # Use a fancier auto-loading thingy, perhaps.  When there are more persistence engines.
+    hierarchy = base.ancestors.map {|klass| klass.to_s}
+
+    if hierarchy.include?("ActiveRecord::Base")
+      require File.join(File.dirname(__FILE__), 'persistence', 'active_record_persistence')
+      base.send(:include, AASM::Persistence::ActiveRecordPersistence)
+    end
+  end
+end

data/lib/aasm/persistence/active_record_persistence.rb

@@ -0,0 +1,246 @@
+module AASM
+  module Persistence
+    module ActiveRecordPersistence
+      # This method:
+      #
+      # * extends the model with ClassMethods
+      # * includes InstanceMethods
+      #
+      # Unless the corresponding methods are already defined, it includes
+      # * ReadState
+      # * WriteState
+      # * WriteStateWithoutPersistence
+      #
+      # Adds
+      #
+      #   before_validation :aasm_ensure_initial_state, :on => :create
+      #
+      # As a result, it doesn't matter when you define your methods - the following 2 are equivalent
+      #
+      #   class Foo < ActiveRecord::Base
+      #     def aasm_write_state(state)
+      #       "bar"
+      #     end
+      #     include AASM
+      #   end
+      #
+      #   class Foo < ActiveRecord::Base
+      #     include AASM
+      #     def aasm_write_state(state)
+      #       "bar"
+      #     end
+      #   end
+      #
+      def self.included(base)
+        base.extend AASM::Persistence::ActiveRecordPersistence::ClassMethods
+        base.send(:include, AASM::Persistence::ActiveRecordPersistence::InstanceMethods)
+        base.send(:include, AASM::Persistence::ActiveRecordPersistence::ReadState) unless base.method_defined?(:aasm_read_state)
+        base.send(:include, AASM::Persistence::ActiveRecordPersistence::WriteState) unless base.method_defined?(:aasm_write_state)
+        base.send(:include, AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence) unless base.method_defined?(:aasm_write_state_without_persistence)
+
+        if base.respond_to?(:named_scope)
+          base.extend(AASM::Persistence::ActiveRecordPersistence::NamedScopeMethods)
+
+          base.class_eval do
+            class << self
+              unless method_defined?(:aasm_state_without_named_scope)
+                alias_method :aasm_state_without_named_scope, :aasm_state
+                alias_method :aasm_state, :aasm_state_with_named_scope
+              end
+            end
+          end
+        end
+        base.respond_to?(:before_validation_on_create) ? base.before_validation_on_create(:aasm_ensure_initial_state) : base.before_validation(:aasm_ensure_initial_state, :on => :create)
+      end
+
+      module ClassMethods
+        # Maps to the aasm_column in the database.  Deafults to "aasm_state".  You can write:
+        #
+        #   create_table :foos do |t|
+        #     t.string :name
+        #     t.string :aasm_state
+        #   end
+        #
+        #   class Foo < ActiveRecord::Base
+        #     include AASM
+        #   end
+        #
+        # OR:
+        #
+        #   create_table :foos do |t|
+        #     t.string :name
+        #     t.string :status
+        #   end
+        #
+        #   class Foo < ActiveRecord::Base
+        #     include AASM
+        #     aasm_column :status
+        #   end
+        #
+        # This method is both a getter and a setter
+        def aasm_column(column_name=nil)
+          if column_name
+            AASM::StateMachine[self].config.column = column_name.to_sym
+            # @aasm_column = column_name.to_sym
+          else
+            AASM::StateMachine[self].config.column ||= :aasm_state
+            # @aasm_column ||= :aasm_state
+          end
+          # @aasm_column
+          AASM::StateMachine[self].config.column
+        end
+
+        def find_in_state(number, state, *args)
+          with_state_scope state do
+            find(number, *args)
+          end
+        end
+
+        def count_in_state(state, *args)
+          with_state_scope state do
+            count(*args)
+          end
+        end
+
+        def calculate_in_state(state, *args)
+          with_state_scope state do
+            calculate(*args)
+          end
+        end
+
+        protected
+        def with_state_scope(state)
+          with_scope :find => {:conditions => ["#{table_name}.#{aasm_column} = ?", state.to_s]} do
+            yield if block_given?
+          end
+        end
+      end
+
+      module InstanceMethods
+
+        # Returns the current aasm_state of the object.  Respects reload and
+        # any changes made to the aasm_state field directly
+        #
+        # Internally just calls <tt>aasm_read_state</tt>
+        #
+        #   foo = Foo.find(1)
+        #   foo.aasm_current_state # => :pending
+        #   foo.aasm_state = "opened"
+        #   foo.aasm_current_state # => :opened
+        #   foo.close # => calls aasm_write_state_without_persistence
+        #   foo.aasm_current_state # => :closed
+        #   foo.reload
+        #   foo.aasm_current_state # => :pending
+        #
+        def aasm_current_state
+          @current_state = aasm_read_state
+        end
+
+        private
+
+        # Ensures that if the aasm_state column is nil and the record is new
+        # that the initial state gets populated before validation on create
+        #
+        #   foo = Foo.new
+        #   foo.aasm_state # => nil
+        #   foo.valid?
+        #   foo.aasm_state # => "open" (where :open is the initial state)
+        #
+        #
+        #   foo = Foo.find(:first)
+        #   foo.aasm_state # => 1
+        #   foo.aasm_state = nil
+        #   foo.valid?
+        #   foo.aasm_state # => nil
+        #
+        def aasm_ensure_initial_state
+          send("#{self.class.aasm_column}=", self.aasm_enter_initial_state.to_s) if send(self.class.aasm_column).blank?
+        end
+
+      end
+
+      module WriteStateWithoutPersistence
+        # Writes <tt>state</tt> to the state column, but does not persist it to the database
+        #
+        #   foo = Foo.find(1)
+        #   foo.aasm_current_state # => :opened
+        #   foo.close
+        #   foo.aasm_current_state # => :closed
+        #   Foo.find(1).aasm_current_state # => :opened
+        #   foo.save
+        #   foo.aasm_current_state # => :closed
+        #   Foo.find(1).aasm_current_state # => :closed
+        #
+        # NOTE: intended to be called from an event
+        def aasm_write_state_without_persistence(state)
+          write_attribute(self.class.aasm_column, state.to_s)
+        end
+      end
+
+      module WriteState
+        # Writes <tt>state</tt> to the state column and persists it to the database
+        #
+        #   foo = Foo.find(1)
+        #   foo.aasm_current_state # => :opened
+        #   foo.close!
+        #   foo.aasm_current_state # => :closed
+        #   Foo.find(1).aasm_current_state # => :closed
+        #
+        # NOTE: intended to be called from an event
+        def aasm_write_state(state)
+          old_value = read_attribute(self.class.aasm_column)
+          write_attribute(self.class.aasm_column, state.to_s)
+
+          unless self.save
+            write_attribute(self.class.aasm_column, old_value)
+            return false
+          end
+
+          true
+        end
+      end
+
+      module ReadState
+
+        # Returns the value of the aasm_column - called from <tt>aasm_current_state</tt>
+        #
+        # If it's a new record, and the aasm state column is blank it returns the initial state:
+        #
+        #   class Foo < ActiveRecord::Base
+        #     include AASM
+        #     aasm_column :status
+        #     aasm_state :opened
+        #     aasm_state :closed
+        #   end
+        #
+        #   foo = Foo.new
+        #   foo.current_state # => :opened
+        #   foo.close
+        #   foo.current_state # => :closed
+        #
+        #   foo = Foo.find(1)
+        #   foo.current_state # => :opened
+        #   foo.aasm_state = nil
+        #   foo.current_state # => nil
+        #
+        # NOTE: intended to be called from an event
+        #
+        # This allows for nil aasm states - be sure to add validation to your model
+        def aasm_read_state
+          if new_record?
+            send(self.class.aasm_column).blank? ? aasm_determine_state_name(self.class.aasm_initial_state) : send(self.class.aasm_column).to_sym
+          else
+            send(self.class.aasm_column).nil? ? nil : send(self.class.aasm_column).to_sym
+          end
+        end
+      end
+
+      module NamedScopeMethods
+        def aasm_state_with_named_scope name, options = {}
+          aasm_state_without_named_scope name, options
+          self.named_scope name, :conditions => { "#{table_name}.#{self.aasm_column}" => name.to_s} unless self.respond_to?(name)
+        end
+      end
+    end
+  end
+end

data/lib/aasm/state.rb

@@ -0,0 +1,53 @@
+class AASM::SupportingClasses::State
+  attr_reader :name, :options
+
+  def initialize(name, options={})
+    @name = name
+    update(options)
+  end
+
+  def ==(state)
+    if state.is_a? Symbol
+      name == state
+    else
+      name == state.name
+    end
+  end
+
+  def call_action(action, record)
+    action = @options[action]
+    catch :halt_aasm_chain do
+      action.is_a?(Array) ?
+              action.each {|a| _call_action(a, record)} :
+              _call_action(action, record)
+    end
+  end
+
+  def display_name
+    @display_name ||= name.to_s.gsub(/_/, ' ').capitalize
+  end
+
+  def for_select
+    [display_name, name.to_s]
+  end
+
+  def update(options = {})
+    if options.key?(:display) then
+      @display_name = options.delete(:display)
+    end
+    @options = options
+    self
+  end
+
+  private
+
+  def _call_action(action, record)
+    case action
+      when Symbol, String
+        record.send(action)
+      when Proc
+        action.call(record)
+    end
+  end
+
+end

data/lib/aasm/state_machine.rb

@@ -0,0 +1,32 @@
+class AASM::StateMachine
+  def self.[](*args)
+    (@machines ||= {})[args]
+  end
+
+  def self.[]=(*args)
+    val = args.pop
+    (@machines ||= {})[args] = val
+  end
+
+  attr_accessor :states, :events, :initial_state, :config
+  attr_reader :name
+
+  def initialize(name)
+    @name = name
+    @initial_state = nil
+    @states = []
+    @events = {}
+    @config = OpenStruct.new
+  end
+
+  def clone
+    klone = super
+    klone.states = states.clone
+    klone.events = events.clone
+    klone
+  end
+
+  def create_state(name, options)
+    @states << AASM::SupportingClasses::State.new(name, options) unless @states.include?(name)
+  end
+end