r38y-aasm 2.1.5

data/lib/aasm/persistence/mongoid_persistence.rb

@@ -0,0 +1,247 @@
+module AASM
+  module Persistence
+    module MongoidPersistence
+      # 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
+      #
+      # As a result, it doesn't matter when you define your methods - the following 2 are equivalent
+      #
+      #   class Foo
+      #     include Mongoid::Document
+      #     def aasm_write_state(state)
+      #       "bar"
+      #     end
+      #     include AASM
+      #   end
+      #
+      #   class Foo
+      #     include Mongoid::Document
+      #     include AASM
+      #     def aasm_write_state(state)
+      #       "bar"
+      #     end
+      #   end
+      #
+      def self.included(base)
+        base.extend AASM::Persistence::MongoidPersistence::ClassMethods
+        base.send(:include, AASM::Persistence::MongoidPersistence::InstanceMethods)
+        base.send(:include, AASM::Persistence::MongoidPersistence::ReadState) unless base.method_defined?(:aasm_read_state)
+        base.send(:include, AASM::Persistence::MongoidPersistence::WriteState) unless base.method_defined?(:aasm_write_state)
+        base.send(:include, AASM::Persistence::MongoidPersistence::WriteStateWithoutPersistence) unless base.method_defined?(:aasm_write_state_without_persistence)
+
+        # if base.respond_to?(:named_scope)
+        #   base.extend(AASM::Persistence::MongoidPersistence::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
+
+        # Mongoid's Validatable gem dependency goes not have a before_validation_on_xxx hook yet.
+        # base.before_validation_on_create :aasm_ensure_initial_state
+        base.before_validation :aasm_ensure_initial_state
+      end
+
+      module ClassMethods
+        # Maps to the aasm_column in the database.  Deafults to "aasm_state".  You can write:
+        #
+        #   class Foo
+        #     include Mongoid::Document
+        #     include AASM
+        #     field :aasm_state
+        #   end
+        #
+        # OR:
+        #
+        #   class Foo
+        #     include Mongoid::Document
+        #     include AASM
+        #     field :status
+        #     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
+        # using update_attribute (which bypasses validation)
+        #
+        #   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(false)
+            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
+        #     include Mongoid::Document
+        #     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

data/lib/aasm/state_transition.rb

@@ -0,0 +1,46 @@
+class AASM::SupportingClasses::StateTransition
+  attr_reader :from, :to, :opts
+  alias_method :options, :opts
+
+  def initialize(opts)
+    @from, @to, @guard, @on_transition = opts[:from], opts[:to], opts[:guard], opts[:on_transition]
+    @opts = opts
+  end
+
+  def perform(obj)
+    case @guard
+      when Symbol, String
+        obj.send(@guard)
+      when Proc
+        @guard.call(obj)
+      else
+        true
+    end
+  end
+
+  def execute(obj, *args)
+    @on_transition.is_a?(Array) ?
+            @on_transition.each {|ot| _execute(obj, ot, *args)} :
+            _execute(obj, @on_transition, *args)
+  end
+
+  def ==(obj)
+    @from == obj.from && @to == obj.to
+  end
+
+  def from?(value)
+    @from == value
+  end
+
+  private
+
+  def _execute(obj, on_transition, *args)
+    case on_transition
+      when Symbol, String
+        obj.send(on_transition, *args)
+      when Proc
+        on_transition.call(obj, *args)
+    end
+  end
+
+end

data/lib/aasm/supporting_classes.rb

@@ -0,0 +1,6 @@
+module AASM::SupportingClasses
+end
+
+require File.join(File.dirname(__FILE__), 'state_transition')
+require File.join(File.dirname(__FILE__), 'event')
+require File.join(File.dirname(__FILE__), 'state')

data/r38y-aasm.gemspec

@@ -0,0 +1,97 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{r38y-aasm}
+  s.version = "2.1.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Barron", "Scott Petersen", "Travis Tilley"]
+  s.date = %q{2010-02-04}
+  s.description = %q{AASM is a continuation of the acts as state machine rails plugin, built for plain Ruby objects.}
+  s.email = %q{scott@elitists.net, ttilley@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "aasm.gemspec",
+     "lib/aasm.rb",
+     "lib/aasm/aasm.rb",
+     "lib/aasm/event.rb",
+     "lib/aasm/persistence.rb",
+     "lib/aasm/persistence/active_record_persistence.rb",
+     "lib/aasm/persistence/mongo_mapper_persistence.rb",
+     "lib/aasm/persistence/mongoid_persistence.rb",
+     "lib/aasm/state.rb",
+     "lib/aasm/state_machine.rb",
+     "lib/aasm/state_transition.rb",
+     "lib/aasm/supporting_classes.rb",
+     "r38y-aasm.gemspec",
+     "spec/functional/conversation.rb",
+     "spec/functional/conversation_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/unit/aasm_spec.rb",
+     "spec/unit/active_record_persistence_spec.rb",
+     "spec/unit/before_after_callbacks_spec.rb",
+     "spec/unit/event_spec.rb",
+     "spec/unit/state_spec.rb",
+     "spec/unit/state_transition_spec.rb",
+     "test/functional/auth_machine_test.rb",
+     "test/test_helper.rb",
+     "test/unit/aasm_test.rb",
+     "test/unit/event_test.rb",
+     "test/unit/state_test.rb",
+     "test/unit/state_transition_test.rb"
+  ]
+  s.homepage = %q{http://rubyist.github.com/aasm/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{State machine mixin for Ruby objects}
+  s.test_files = [
+    "spec/functional/conversation.rb",
+     "spec/functional/conversation_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/unit/aasm_spec.rb",
+     "spec/unit/active_record_persistence_spec.rb",
+     "spec/unit/before_after_callbacks_spec.rb",
+     "spec/unit/event_spec.rb",
+     "spec/unit/state_spec.rb",
+     "spec/unit/state_transition_spec.rb",
+     "test/functional/auth_machine_test.rb",
+     "test/test_helper.rb",
+     "test/unit/aasm_test.rb",
+     "test/unit/event_test.rb",
+     "test/unit/state_test.rb",
+     "test/unit/state_transition_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<sdoc>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<sdoc>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<sdoc>, [">= 0"])
+  end
+end
+