edge-state-machine 0.9.0 → 0.9.1

data/README.rdoc

@@ -1,7 +1,7 @@
 = Edge State Machine
 
 Edge State Machine is a complete state machine solution.
-It offers support for ActiveRecord and Mongoid for persistence.
+It offers support for ActiveRecord, Mongoid and MongoMapper for persistence.
 
 {<img src="https://secure.travis-ci.org/danpersa/edge-state-machine.png"/>}[http://travis-ci.org/danpersa/edge-state-machine]
 
@@ -67,6 +67,31 @@ If you're using Rails + Mongoid + Bundler
     end
   end
 
+If you're using Rails + MongoMapper + Bundler
+
+  # in your Gemfile
+  gem "edge-state-machine", :require => ["edge-state-machine", "mongo_mapper/edge-state-machine"]
+
+  # in your models that will use the state machine
+  include ::EdgeStateMachine
+  include MongoMapper::EdgeStateMachine
+
+  state_machine do
+    state :available # first one is initial state
+    state :out_of_stock
+    state :discontinue
+
+    event :discontinue do
+      transitions :to => :discontinue, :from => [:available, :out_of_stock], :on_transition => :do_discontinue
+    end
+    event :out_of_stock do
+      transitions :to => :out_of_stock, :from => [:available, :discontinue]
+    end
+    event :available do
+      transitions :to => :available, :from => [:out_of_stock], :on_transition => :send_alerts
+    end
+  end
+
 == State Machine Examples
 
 === Microwave State Machine
@@ -174,7 +199,8 @@ For other (more complex) examples, please check the following links:
 * {Examples without Persistence}[https://github.com/danpersa/edge-state-machine/tree/master/spec/non_persistent/samples]
 * {Examples with ActiveRecord}[https://github.com/danpersa/edge-state-machine/tree/master/spec/active_record/samples]
 * {Examples with Mongoid}[https://github.com/danpersa/edge-state-machine/tree/master/spec/mongoid/samples]
-
+* {Examples with Mongoid}[https://github.com/danpersa/edge-state-machine/tree/master/spec/mongoid/samples]
+* {Examples with MongoMapper}[https://github.com/danpersa/edge-state-machine/tree/master/spec/mongo_mapper/samples]
 == Notes
 
 For classes with multiple state machines, the state names, machine names must be unique per class.

data/edge-state-machine.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["dan.persa@gmail.com"]
   s.homepage    = "http://github.com/danpersa/edge-state-machine"
   s.summary     = %q{Edge State Machine}
-  s.description = %q{Edge State Machine is a complete state machine solution. It offers support for ActiveRecord and Mongoid for persistence.}
+  s.description = %q{Edge State Machine is a complete state machine solution. It offers support for ActiveRecord, Mongoid and MongoMapper for persistence.}
 
   s.rubyforge_project = "edge-state-machine"
 
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 2.6'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'mongoid'
+  s.add_development_dependency 'mongo_mapper'
   s.add_development_dependency 'bson_ext'
   s.add_development_dependency 'sqlite3-ruby'
   s.add_development_dependency 'activerecord'

data/lib/edge-state-machine/state.rb

@@ -34,13 +34,13 @@ module EdgeStateMachine
       @display_name ||= name.to_s.gsub(/_/, ' ').capitalize
     end
 
-    def ==(state)
-      if state.is_a? Symbol
-        name == state
-      elsif state.is_a? String
-        name == state
+    def ==(st)
+      if st.is_a? Symbol
+        name == st
+      elsif st.is_a? String
+        name == st
       else
-        name == state.name
+        name == st.name
       end
     end
   end

data/lib/edge-state-machine/version.rb

@@ -1,3 +1,3 @@
 module EdgeStateMachine
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

data/lib/mongo_mapper/edge-state-machine.rb

@@ -0,0 +1,79 @@
+module MongoMapper
+  module EdgeStateMachine
+    extend ActiveSupport::Concern
+
+    included do
+      include ::EdgeStateMachine
+      # mongo mapper does not have an after_initalize callback
+      before_validation :set_initial_state
+      validate :state_variables_presence
+      validate :state_inclusion
+    end
+
+    # The optional options argument is passed to find when reloading so you may
+    # do e.g. record.reload(:lock => true) to reload the same record with an
+    # exclusive row lock.
+    def reload
+      super.tap do
+        @current_states = {}
+      end
+    end
+
+    protected
+
+    def load_from_persistence(machine_name)
+      machine = self.class.state_machines[machine_name]
+      send machine.persisted_variable_name.to_s
+    end
+
+    def save_to_persistence(new_state, machine_name, options = {})
+      machine = self.class.state_machines[machine_name]
+      send("#{machine.persisted_variable_name}=".to_sym, new_state)
+      save! if options[:save]
+    end
+
+    def set_initial_state
+      # set the initial state for each state machine in this class
+      self.class.state_machines.keys.each do |machine_name|
+        machine = self.class.state_machines[machine_name]
+
+        if persisted_variable_value(machine.persisted_variable_name).blank?
+          if load_from_persistence(machine_name)
+            send("#{machine.persisted_variable_name}=".to_sym, load_from_persistence(machine_name))
+          else
+            send("#{machine.persisted_variable_name}=".to_sym, machine.initial_state_name)
+          end
+        end
+      end
+    end
+
+    def persisted_variable_value(name)
+      send(name.to_s)
+    end
+
+    def state_variables_presence
+      # validate that state is in the right set of values
+      self.class.state_machines.keys.each do |machine_name|
+        machine = self.class.state_machines[machine_name]
+        validates_presence_of machine.persisted_variable_name.to_sym
+      end
+    end
+
+    def state_inclusion
+      # validate that state is in the right set of values
+      self.class.state_machines.keys.each do |machine_name|
+        machine = self.class.state_machines[machine_name]
+        unless machine.states.keys.include?(persisted_variable_value(machine.persisted_variable_name).to_sym)
+          self.errors.add(machine.persisted_variable_name.to_sym, :inclusion, :value => persisted_variable_value(machine.persisted_variable_name))
+        end
+      end
+    end
+
+    module ClassMethods
+      def add_scope(state, machine_name)
+        machine = state_machines[machine_name]
+        scope state.name, where(machine.persisted_variable_name.to_sym => state.name.to_s)
+      end
+    end
+  end
+end

data/spec/mongo_mapper/double_machine_spec.rb

@@ -0,0 +1,72 @@
+require 'mongo_mapper/mongo_mapper_helper'
+
+describe DoubleMachineMongoMapper do
+
+  before do
+    MongoMapper.database.collections.reject { |c| c.name =~ /^system\./ }.each(&:remove)
+  end
+
+  let :double_machine do
+    DoubleMachineMongoMapper.create!
+  end
+
+  it 'should have a current state equals with the initial state for each machine' do
+    double_machine.current_state.should == :first_state
+    double_machine.current_state(:second).should == :red
+  end
+
+  it 'should have the corresponding methods for verifying the states' do
+    double_machine.first_state?.should == true
+    double_machine.second_state?.should == false
+    double_machine.red?.should == true
+    double_machine.green?.should == false
+  end
+
+  it 'should trigger events from the state machines' do
+    double_machine.first_move
+    double_machine.current_state.should == :second_state
+    double_machine.second_state?.should == true
+
+    double_machine.go_green
+    double_machine.current_state(:second).should == :green
+    double_machine.green?.should == true
+
+    double_machine.second_move
+    double_machine.current_state.should == :third_state
+    double_machine.third_state?.should == true
+  end
+
+  it 'should execute the on_transition method' do
+    double_machine.should_receive :do_move
+    double_machine.first_move
+    double_machine.go_green
+
+    double_machine.should_receive :turn_off
+    double_machine.should_receive :color_in_red
+    double_machine.go_red
+  end
+
+  context 'persistence ' do
+    it 'should create scopes for each state machine' do
+      3.times { DoubleMachineMongoMapper.create(:state => 'second_state', :second_state => 'blue') }
+      3.times { DoubleMachineMongoMapper.create(:state => 'first_state', :second_state => 'blue') }
+      DoubleMachineMongoMapper.first_state.count.should == 3
+      DoubleMachineMongoMapper.second_state.count.should == 3
+      DoubleMachineMongoMapper.blue.count.should == 6 end
+
+    it 'should save the state machines in the database' do
+      machine = DoubleMachineMongoMapper.create(:state => 'second_state', :second_state => 'blue')
+      machine.go_red!
+      machine.current_state(:second).should == :red
+      machine.red?.should == true
+
+      machine.second_move!
+      machine.third_state?.should == true
+      machine.current_state.should == :third_state
+
+      loaded_machine = DoubleMachineMongoMapper.find(machine.id)
+      loaded_machine.third_state?.should == true
+      loaded_machine.current_state.should == :third_state
+    end
+  end
+end

data/spec/mongo_mapper/mongo_mapper_helper.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'mongo_mapper'
+
+
+MongoMapper.connection = Mongo::Connection.new('localhost', 27017)
+MongoMapper.database = "edge_state_machine_mongo_mapper_test"
+MongoMapper.database.collections.each { |c| c.drop_indexes }
+
+require 'mongo_mapper/samples/traffic_light'
+require 'mongo_mapper/samples/order'
+require 'mongo_mapper/samples/double_machine'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'mongo_mapper/edge-state-machine'
+
+

data/spec/mongo_mapper/mongo_mapper_spec.rb

@@ -0,0 +1,134 @@
+require 'mongo_mapper/mongo_mapper_helper'
+
+describe 'mongo_mapper state machine' do
+  before do
+    MongoMapper.database.collections.reject { |c| c.name =~ /^system\./ }.each(&:remove)
+  end
+
+  context 'existing mongo document' do
+
+    let :light do
+      MongoMapperTrafficLight.create!
+    end
+
+    it 'should have an initial state' do
+      light.off?.should == true
+      light.current_state.should == :off
+    end
+
+    it 'should go to a valid state on transition' do
+      light.reset
+      light.red?.should == true
+      light.current_state.should == :red
+
+      light.green_on
+      light.green?.should == true
+      light.current_state.should == :green
+    end
+
+    it 'should not persist state on transition' do
+      light.reset
+      light.current_state.should == :red
+      light.reload
+      light.state.should == 'off'
+    end
+
+    it 'should persists state on transition' do
+      light.reset!
+      light.current_state.should == :red
+      light.reload
+      light.state.should == 'red'
+    end
+
+    it 'should initialize the current state when loaded from database' do
+      light.reset!
+      loaded_light = MongoMapperTrafficLight.find(light.id)
+      loaded_light.current_state.should == :red
+    end
+
+    it 'should raise error on transition to an invalid state' do
+      expect { light.yellow_on }.should raise_error EdgeStateMachine::NoTransitionFound
+      light.current_state.should == :off
+    end
+
+    it 'should persist state when state is protected on transition' do
+      protected_light = MongoMapperProtectedTrafficLight.create!
+      protected_light.reset!
+      protected_light.current_state.should == :red
+      protected_light.reload
+      protected_light.state.should == 'red'
+    end
+
+    it 'should not validate when try transition with wrong state ' do
+      for s in light.class.state_machines[:default].states.keys
+        light.state = s
+        light.valid?.should == true
+      end
+      light.state = 'invalid_one'
+      light.valid?.should_not == true
+    end
+
+    it 'should raise exception when model validation fails on transition' do
+      validating_light = MongoMapperValidatingTrafficLight.create!
+      expect {validating_light.reset!}.should raise_error MongoMapper::DocumentNotValid
+    end
+
+    it 'should state query method used in a validation condition' do
+      validating_light = MongoMapperConditionalValidatingTrafficLight.create!
+      #expect {validating_light.reset!}.should raise_error Mongoid::RecordInvalid
+      validating_light.off?.should == true
+    end
+
+    it 'should reload the model when current state resets' do
+      light.reset
+      light.red?.should == true
+      light.update_attribute(:state, 'green')
+      light.reload.green?.should == true # reloaded state should come from database
+    end
+
+    describe 'scopes' do
+      it 'should be added for each state' do
+        MongoMapperTrafficLight.should respond_to(:off)
+        MongoMapperTrafficLight.should respond_to(:red)
+      end
+
+      it 'should not be added for each state' do
+        MongoMapperTrafficLightNoScope.should_not respond_to(:off)
+        MongoMapperTrafficLightNoScope.should_not respond_to(:red)
+      end
+
+      it 'should behave like scopes' do
+        3.times { MongoMapperTrafficLight.create(:state => 'off') }
+        3.times { MongoMapperTrafficLight.create(:state => 'red') }
+        MongoMapperTrafficLight.off.count.should == 3
+        MongoMapperTrafficLight.red.count.should == 3
+      end
+    end
+  end
+
+  context 'new active record' do
+    let :light do
+      MongoMapperTrafficLight.new
+    end
+
+    it 'should have the initial state set after validation' do
+      # mongo mapper does not have an after_initalize callback
+      light.valid?
+      light.current_state.should == :off
+    end
+  end
+
+  context 'timestamp' do
+
+    def create_order(state = nil)
+      MongoMapperOrder.create! order_number: 234, state: state
+    end
+
+    # control case, no timestamp has been set so we should expect default behaviour
+    it 'should not raise any exceptions when moving to placed' do
+      @order = create_order
+      expect { @order.place! }.should_not raise_error
+      @order.state.should == 'placed'
+    end
+  end
+end

data/spec/mongo_mapper/samples/double_machine.rb

@@ -0,0 +1,61 @@
+require 'mongo_mapper'
+require 'mongo_mapper/edge-state-machine'
+
+class DoubleMachineMongoMapper
+  include MongoMapper::Document
+  include MongoMapper::EdgeStateMachine
+  
+  key :state, String
+  key :second_state, String
+
+  state_machine do
+    # the machine is automatically named :default
+    # the scopes are not created by default
+    create_scopes true
+    # the persistence instance variable is the default one (:state)
+    state :first_state # first one is initial state
+    state :second_state
+    state :third_state # the user in this state can't sign in
+
+    event :first_move do
+      transition :from => :first_state, :to => :second_state, :on_transition => :do_move
+    end
+
+    event :second_move do
+      transition :from => :second_state, :to => :third_state
+    end
+  end
+
+  state_machine :second do
+    # the scopes are not created by default
+    create_scopes true
+    # for the second machine we must specify the name of the persistence instance variable
+    # so there are no conflicts between the state machines
+    persisted_to :second_state
+    initial_state :red
+    state :blue
+    state :green
+    state :red
+
+    event :go_blue do
+      transition :from => [:red, :green], :to => :blue
+    end
+
+    event :go_red do
+      transition :from => [:blue, :green], :to => :red, :on_transition => [:turn_off, :color_in_red]
+    end
+
+    event :go_green do
+      transition :from => [:blue, :red], :to => :green
+    end
+  end
+
+  def do_move
+  end
+
+  def turn_off
+  end
+
+  def color_in_red
+  end
+end

data/spec/mongo_mapper/samples/order.rb

@@ -0,0 +1,54 @@
+require 'mongo_mapper'
+require 'mongo_mapper/edge-state-machine'
+
+class MongoMapperOrder
+  include MongoMapper::Document
+  include MongoMapper::EdgeStateMachine
+
+  key :state, String
+  key :order_number, Integer
+  key :paid_at, DateTime
+  key :prepared_on, DateTime
+  key :dispatched_at, DateTime
+  key :cancellation_date, Date
+
+  state_machine do
+    state :opened
+    state :placed
+    state :paid
+    state :prepared
+    state :delivered
+    state :cancelled
+
+    # no timestamp col is being specified here - should be ignored
+    event :place do
+      transition :from => :opened, :to => :placed
+    end
+
+    # should set paid_at timestamp
+    event :pay do
+      transition :from => :placed, :to => :paid
+    end
+
+    # should set prepared_on
+    event :prepare do
+      transition :from => :paid, :to => :prepared
+    end
+
+    # should set dispatched_at
+    event :deliver do
+      transition :from => :prepared, :to => :delivered
+    end
+
+    # should set cancellation_date
+    event :cancel do
+      transition :from => [:placed, :paid, :prepared], :to => :cancelled
+    end
+
+    # should raise an exception as there is no timestamp col
+    event :reopen do
+      transition :from => :cancelled, :to => :opened
+    end
+
+  end
+end

data/spec/mongo_mapper/samples/traffic_light.rb

@@ -0,0 +1,79 @@
+require 'mongo_mapper'
+require 'mongo_mapper/edge-state-machine'
+
+class MongoMapperTrafficLight
+  include MongoMapper::Document
+  include MongoMapper::EdgeStateMachine
+
+  key :state, String
+
+  state_machine do
+    create_scopes true
+    persisted_to :state
+    state :off
+
+    state :red
+    state :green
+    state :yellow
+
+    event :red_on do
+      transition :to => :red, :from => [:yellow]
+    end
+
+    event :green_on do
+      transition :to => :green, :from => [:red]
+    end
+
+    event :yellow_on do
+      transition :to => :yellow, :from => [:green]
+    end
+
+    event :reset do
+      transition :to => :red, :from => [:off]
+    end
+  end
+end
+
+class MongoMapperProtectedTrafficLight < MongoMapperTrafficLight
+  attr_protected :state
+end
+
+class MongoMapperValidatingTrafficLight < MongoMapperTrafficLight
+  validate {|t| errors.add(:base, 'This TrafficLight will never validate after creation') unless t.new_record? }
+end
+
+class MongoMapperConditionalValidatingTrafficLight < MongoMapperTrafficLight
+  validates :name, :presence => true, :length  => { :within => 20..40 }, :confirmation => true, :if => :red?
+end
+
+class MongoMapperTrafficLightNoScope
+  include MongoMapper::Document
+  include MongoMapper::EdgeStateMachine
+
+  key :state, String
+
+  state_machine do
+    persisted_to :state
+    state :off
+
+    state :red
+    state :green
+    state :yellow
+
+    event :red_on do
+      transition :to => :red, :from => [:yellow]
+    end
+
+    event :green_on do
+      transition :to => :green, :from => [:red]
+    end
+
+    event :yellow_on do
+      transition :to => :yellow, :from => [:green]
+    end
+
+    event :reset do
+      transition :to => :red, :from => [:off]
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: edge-state-machine
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-16 00:00:00.000000000 Z
+date: 2012-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &7346820 !ruby/object:Gem::Requirement
+  requirement: &17648880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *7346820
+  version_requirements: *17648880
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &7346300 !ruby/object:Gem::Requirement
+  requirement: &17648460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7346300
+  version_requirements: *17648460
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &7345700 !ruby/object:Gem::Requirement
+  requirement: &17648000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7345700
+  version_requirements: *17648000
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: &17647580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *17647580
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &7345060 !ruby/object:Gem::Requirement
+  requirement: &17647160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7345060
+  version_requirements: *17647160
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
-  requirement: &7344560 !ruby/object:Gem::Requirement
+  requirement: &17646740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7344560
+  version_requirements: *17646740
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &7343800 !ruby/object:Gem::Requirement
+  requirement: &17646320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,9 +87,9 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7343800
+  version_requirements: *17646320
 description: Edge State Machine is a complete state machine solution. It offers support
-  for ActiveRecord and Mongoid for persistence.
+  for ActiveRecord, Mongoid and MongoMapper for persistence.
 email:
 - dan.persa@gmail.com
 executables: []
@@ -100,6 +111,7 @@ files:
 - lib/edge-state-machine/state.rb
 - lib/edge-state-machine/transition.rb
 - lib/edge-state-machine/version.rb
+- lib/mongo_mapper/edge-state-machine.rb
 - lib/mongoid/edge-state-machine.rb
 - spec/active_record/active_record_helper.rb
 - spec/active_record/active_record_spec.rb
@@ -112,6 +124,12 @@ files:
 - spec/active_record/samples/traffic_light.rb
 - spec/event_spec.rb
 - spec/machine_spec.rb
+- spec/mongo_mapper/double_machine_spec.rb
+- spec/mongo_mapper/mongo_mapper_helper.rb
+- spec/mongo_mapper/mongo_mapper_spec.rb
+- spec/mongo_mapper/samples/double_machine.rb
+- spec/mongo_mapper/samples/order.rb
+- spec/mongo_mapper/samples/traffic_light.rb
 - spec/mongoid/double_machine_spec.rb
 - spec/mongoid/mongoid_helper.rb
 - spec/mongoid/mongoid_spec.rb
@@ -150,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: edge-state-machine
-rubygems_version: 1.8.15
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Edge State Machine