aasm 2.3.1 → 2.4.0

data/spec/unit/aasm_spec.rb

@@ -1,63 +1,5 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
 
-class Foo
-  include AASM
-  aasm_initial_state :open
-  aasm_state :open, :exit => :exit
-  aasm_state :closed, :enter => :enter
-
-  aasm_event :close, :success => :success_callback do
-    transitions :to => :closed, :from => [:open]
-  end
-
-  aasm_event :null do
-    transitions :to => :closed, :from => [:open], :guard => :always_false
-  end
-
-  def always_false
-    false
-  end
-
-  def success_callback
-  end
-
-  def enter
-  end
-  def exit
-  end
-end
-
-class FooTwo < Foo
-  include AASM
-  aasm_state :foo
-end
-
-class Bar
-  include AASM
-
-  aasm_state :read
-  aasm_state :ended
-
-  aasm_event :foo do
-    transitions :to => :ended, :from => [:read]
-  end
-end
-
-class Baz < Bar
-end
-
-class Banker
-  include AASM
-  aasm_initial_state  Proc.new { |banker| banker.rich? ? :retired : :selling_bad_mortgages }
-  aasm_state          :retired
-  aasm_state          :selling_bad_mortgages
-  RICH = 1_000_000
-  attr_accessor :balance
-  def initialize(balance = 0); self.balance = balance; end
-  def rich?; self.balance >= RICH; end
-end
-
-
 describe AASM, '- class level definitions' do
   it 'should define a class level aasm_initial_state() method on its including class' do
     Foo.should respond_to(:aasm_initial_state)
@@ -85,6 +27,20 @@ describe AASM, '- class level definitions' do
 
 end
 
+describe "naming" do
+  it "work for valid" do
+    Argument.aasm_states.should include(:invalid)
+    Argument.aasm_states.should include(:valid)
+
+    argument = Argument.new
+    argument.invalid?.should be_true
+    argument.aasm_current_state.should == :invalid
+
+    argument.valid!
+    argument.valid?.should be_true
+    argument.aasm_current_state.should == :valid
+  end
+end
 
 describe AASM, '- subclassing' do
   it 'should have the parent states' do
@@ -293,10 +249,10 @@ describe AASM, '- event callbacks' do
       @foo.stub!(:enter).and_raise(StandardError)
       lambda{@foo.safe_close!}.should raise_error(NoMethodError)
     end
-    
+
     it "should propagate an error if no error callback is declared" do
         @foo.stub!(:enter).and_raise("Cannot enter safe")
-        lambda{@foo.close!}.should raise_error(StandardError, "Cannot enter safe")  
+        lambda{@foo.close!}.should raise_error(StandardError, "Cannot enter safe")
     end
   end
 
@@ -377,35 +333,6 @@ describe Baz do
 end
 
 
-class ChetanPatil
-  include AASM
-  aasm_initial_state :sleeping
-  aasm_state :sleeping
-  aasm_state :showering
-  aasm_state :working
-  aasm_state :dating
-  aasm_state :prettying_up
-
-  aasm_event :wakeup do
-    transitions :from => :sleeping, :to => [:showering, :working]
-  end
-
-  aasm_event :dress do
-    transitions :from => :sleeping, :to => :working, :on_transition => :wear_clothes
-    transitions :from => :showering, :to => [:working, :dating], :on_transition => Proc.new { |obj, *args| obj.wear_clothes(*args) }
-    transitions :from => :showering, :to => :prettying_up, :on_transition => [:condition_hair, :fix_hair]
-  end
-
-  def wear_clothes(shirt_color, trouser_type)
-  end
-
-  def condition_hair
-  end
-
-  def fix_hair
-  end
-end
-
 
 describe ChetanPatil do
   it 'should transition to specified next state (sleeping to showering)' do

data/spec/unit/active_record_persistence_spec.rb

@@ -1,246 +1,250 @@
-begin
-  require 'rubygems'
-  require 'active_record'
-  require 'logger'
+require 'rubygems'
+require 'active_record'
+require 'logger'
 
-  load_schema
+load_schema
 
-  ActiveRecord::Base.logger = Logger.new(STDERR)
+ActiveRecord::Base.logger = Logger.new(STDERR)
 
-  class Gate < ActiveRecord::Base
-    include AASM
+class Gate < ActiveRecord::Base
+  include AASM
 
-    # Fake this column for testing purposes
-    attr_accessor :aasm_state
+  # Fake this column for testing purposes
+  attr_accessor :aasm_state
 
-    aasm_state :opened
-    aasm_state :closed
+  aasm_state :opened
+  aasm_state :closed
 
-    aasm_event :view do
-      transitions :to => :read, :from => [:needs_attention]
-    end
+  aasm_event :view do
+    transitions :to => :read, :from => [:needs_attention]
   end
+end
 
-  class Reader < ActiveRecord::Base
-    def aasm_read_state
-      "fi"
-    end
-    include AASM
+class Reader < ActiveRecord::Base
+  def aasm_read_state
+    "fi"
   end
+  include AASM
+end
 
-  class Writer < ActiveRecord::Base
-    def aasm_write_state(state)
-      "fo"
-    end
-    include AASM
+class Writer < ActiveRecord::Base
+  def aasm_write_state(state)
+    "fo"
   end
+  include AASM
+end
 
-  class Transient < ActiveRecord::Base
-    def aasm_write_state_without_persistence(state)
-      "fum"
-    end
-    include AASM
+class Transient < ActiveRecord::Base
+  def aasm_write_state_without_persistence(state)
+    "fum"
   end
+  include AASM
+end
 
-  class Simple < ActiveRecord::Base
-    include AASM
-    aasm_column :status
-  end
+class Simple < ActiveRecord::Base
+  include AASM
+  aasm_column :status
+end
 
-  class Derivate < Simple
-  end
+class SimpleNewDsl < ActiveRecord::Base
+  include AASM
+  aasm :column => :status
+end
 
-  class Thief < ActiveRecord::Base
-    set_table_name "thieves"
-    include AASM
-    aasm_initial_state  Proc.new { |thief| thief.skilled ? :rich : :jailed }
-    aasm_state          :rich
-    aasm_state          :jailed
-    attr_accessor :skilled, :aasm_state
-  end
+class Derivate < Simple
+end
 
-  shared_examples_for "aasm model" do
-    it "should include AASM::Persistence::ActiveRecordPersistence" do
-      @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence)
-    end
-    it "should include AASM::Persistence::ActiveRecordPersistence::InstanceMethods" do
-      @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::InstanceMethods)
-    end
-  end
+class DerivateNewDsl < SimpleNewDsl
+end
 
-  describe Gate, "class methods" do
-    before(:each) do
-      @klass = Gate
-    end
-    it_should_behave_like "aasm model"
-    it "should include AASM::Persistence::ActiveRecordPersistence::ReadState" do
-      @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::ReadState)
-    end
-    it "should include AASM::Persistence::ActiveRecordPersistence::WriteState" do
-      @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteState)
-    end
-    it "should include AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence" do
-      @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence)
-    end
-  end
+class Thief < ActiveRecord::Base
+  set_table_name "thieves"
+  include AASM
+  aasm_initial_state  Proc.new { |thief| thief.skilled ? :rich : :jailed }
+  aasm_state          :rich
+  aasm_state          :jailed
+  attr_accessor :skilled, :aasm_state
+end
 
-  describe Reader, "class methods" do
-    before(:each) do
-      @klass = Reader
-    end
-    it_should_behave_like "aasm model"
-    it "should not include AASM::Persistence::ActiveRecordPersistence::ReadState" do
-      @klass.included_modules.should_not be_include(AASM::Persistence::ActiveRecordPersistence::ReadState)
-    end
-    it "should include AASM::Persistence::ActiveRecordPersistence::WriteState" do
-      @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteState)
-    end
-    it "should include AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence" do
-      @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence)
-    end
+shared_examples_for "aasm model" do
+  it "should include AASM::Persistence::ActiveRecordPersistence" do
+    @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence)
+  end
+  it "should include AASM::Persistence::ActiveRecordPersistence::InstanceMethods" do
+    @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::InstanceMethods)
   end
+end
 
-  describe Writer, "class methods" do
-    before(:each) do
-      @klass = Writer
-    end
-    it_should_behave_like "aasm model"
-    it "should include AASM::Persistence::ActiveRecordPersistence::ReadState" do
-      @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::ReadState)
-    end
-    it "should not include AASM::Persistence::ActiveRecordPersistence::WriteState" do
-      @klass.included_modules.should_not be_include(AASM::Persistence::ActiveRecordPersistence::WriteState)
-    end
-    it "should include AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence" do
-      @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence)
-    end
+describe Gate, "class methods" do
+  before(:each) do
+    @klass = Gate
   end
+  it_should_behave_like "aasm model"
+  it "should include AASM::Persistence::ActiveRecordPersistence::ReadState" do
+    @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::ReadState)
+  end
+  it "should include AASM::Persistence::ActiveRecordPersistence::WriteState" do
+    @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteState)
+  end
+  it "should include AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence" do
+    @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence)
+  end
+end
 
-  describe Transient, "class methods" do
-    before(:each) do
-      @klass = Transient
-    end
-    it_should_behave_like "aasm model"
-    it "should include AASM::Persistence::ActiveRecordPersistence::ReadState" do
-      @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::ReadState)
-    end
-    it "should include AASM::Persistence::ActiveRecordPersistence::WriteState" do
-      @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteState)
-    end
-    it "should not include AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence" do
-      @klass.included_modules.should_not be_include(AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence)
-    end
+describe Reader, "class methods" do
+  before(:each) do
+    @klass = Reader
+  end
+  it_should_behave_like "aasm model"
+  it "should not include AASM::Persistence::ActiveRecordPersistence::ReadState" do
+    @klass.included_modules.should_not be_include(AASM::Persistence::ActiveRecordPersistence::ReadState)
+  end
+  it "should include AASM::Persistence::ActiveRecordPersistence::WriteState" do
+    @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteState)
+  end
+  it "should include AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence" do
+    @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence)
   end
+end
 
-  describe Gate, "instance methods" do
+describe Writer, "class methods" do
+  before(:each) do
+    @klass = Writer
+  end
+  it_should_behave_like "aasm model"
+  it "should include AASM::Persistence::ActiveRecordPersistence::ReadState" do
+    @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::ReadState)
+  end
+  it "should not include AASM::Persistence::ActiveRecordPersistence::WriteState" do
+    @klass.included_modules.should_not be_include(AASM::Persistence::ActiveRecordPersistence::WriteState)
+  end
+  it "should include AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence" do
+    @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence)
+  end
+end
 
-    it "should respond to aasm read state when not previously defined" do
-      Gate.new.should respond_to(:aasm_read_state)
-    end
+describe Transient, "class methods" do
+  before(:each) do
+    @klass = Transient
+  end
+  it_should_behave_like "aasm model"
+  it "should include AASM::Persistence::ActiveRecordPersistence::ReadState" do
+    @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::ReadState)
+  end
+  it "should include AASM::Persistence::ActiveRecordPersistence::WriteState" do
+    @klass.included_modules.should be_include(AASM::Persistence::ActiveRecordPersistence::WriteState)
+  end
+  it "should not include AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence" do
+    @klass.included_modules.should_not be_include(AASM::Persistence::ActiveRecordPersistence::WriteStateWithoutPersistence)
+  end
+end
 
-    it "should respond to aasm write state when not previously defined" do
-      Gate.new.should respond_to(:aasm_write_state)
-    end
+describe Gate, "instance methods" do
 
-    it "should respond to aasm write state without persistence when not previously defined" do
-      Gate.new.should respond_to(:aasm_write_state_without_persistence)
-    end
+  it "should respond to aasm read state when not previously defined" do
+    Gate.new.should respond_to(:aasm_read_state)
+  end
 
-    it "should return the initial state when new and the aasm field is nil" do
-      Gate.new.aasm_current_state.should == :opened
-    end
+  it "should respond to aasm write state when not previously defined" do
+    Gate.new.should respond_to(:aasm_write_state)
+  end
 
-    it "should return the aasm column when new and the aasm field is not nil" do
-      foo = Gate.new
-      foo.aasm_state = "closed"
-      foo.aasm_current_state.should == :closed
-    end
+  it "should respond to aasm write state without persistence when not previously defined" do
+    Gate.new.should respond_to(:aasm_write_state_without_persistence)
+  end
 
-    it "should return the aasm column when not new and the aasm_column is not nil" do
-      foo = Gate.new
-      foo.stub!(:new_record?).and_return(false)
-      foo.aasm_state = "state"
-      foo.aasm_current_state.should == :state
-    end
+  it "should return the initial state when new and the aasm field is nil" do
+    Gate.new.aasm_current_state.should == :opened
+  end
 
-    it "should allow a nil state" do
-      foo = Gate.new
-      foo.stub!(:new_record?).and_return(false)
-      foo.aasm_state = nil
-      foo.aasm_current_state.should be_nil
-    end
+  it "should return the aasm column when new and the aasm field is not nil" do
+    foo = Gate.new
+    foo.aasm_state = "closed"
+    foo.aasm_current_state.should == :closed
+  end
 
-    it "should have aasm_ensure_initial_state" do
-      foo = Gate.new
-      foo.send :aasm_ensure_initial_state
-    end
+  it "should return the aasm column when not new and the aasm_column is not nil" do
+    foo = Gate.new
+    foo.stub!(:new_record?).and_return(false)
+    foo.aasm_state = "state"
+    foo.aasm_current_state.should == :state
+  end
 
-    it "should call aasm_ensure_initial_state on validation before create" do
-      foo = Gate.new
-      foo.should_receive(:aasm_ensure_initial_state).and_return(true)
-      foo.valid?
-    end
+  it "should allow a nil state" do
+    foo = Gate.new
+    foo.stub!(:new_record?).and_return(false)
+    foo.aasm_state = nil
+    foo.aasm_current_state.should be_nil
+  end
 
-    it "should call aasm_ensure_initial_state on validation before create" do
-      foo = Gate.new
-      foo.stub!(:new_record?).and_return(false)
-      foo.should_not_receive(:aasm_ensure_initial_state)
-      foo.valid?
-    end
+  it "should have aasm_ensure_initial_state" do
+    foo = Gate.new
+    foo.send :aasm_ensure_initial_state
+  end
 
+  it "should call aasm_ensure_initial_state on validation before create" do
+    foo = Gate.new
+    foo.should_receive(:aasm_ensure_initial_state).and_return(true)
+    foo.valid?
   end
 
-  describe 'Derivates' do
-    it "should have the same states as it's parent" do
-      Derivate.aasm_states.should == Simple.aasm_states
-    end
+  it "should call aasm_ensure_initial_state on validation before create" do
+    foo = Gate.new
+    foo.stub!(:new_record?).and_return(false)
+    foo.should_not_receive(:aasm_ensure_initial_state)
+    foo.valid?
+  end
 
-    it "should have the same events as it's parent" do
-      Derivate.aasm_events.should == Simple.aasm_events
-    end
+end
 
-    it "should have the same column as it's parent" do
-      Derivate.aasm_column.should == :status
-    end
+describe 'Derivates' do
+  it "should have the same states as its parent" do
+    Derivate.aasm_states.should == Simple.aasm_states
   end
 
-  describe AASM::Persistence::ActiveRecordPersistence::NamedScopeMethods do
+  it "should have the same events as its parent" do
+    Derivate.aasm_events.should == Simple.aasm_events
+  end
 
-    context "Does not already respond_to? the scope name" do
-      it "should add a scope" do
-        Simple.should_not respond_to(:unknown_scope)
-        Simple.aasm_state :unknown_scope
-        Simple.should respond_to(:unknown_scope)
-        Simple.unknown_scope.class.should == ActiveRecord::Relation
-      end
-    end
+  it "should have the same column as its parent" do
+    Derivate.aasm_column.should == :status
+  end
 
-    context "Already respond_to? the scope name" do
-      it "should not add a scope" do
-        Simple.aasm_state :new
-        Simple.should respond_to(:new)
-        Simple.new.class.should == Simple
-      end
-    end
+  it "should have the same column as its parent even for the new dsl" do
+    SimpleNewDsl.aasm_column.should == :status
+    DerivateNewDsl.aasm_column.should == :status
   end
+end
 
-  describe 'Thieves' do
+describe AASM::Persistence::ActiveRecordPersistence::NamedScopeMethods do
 
-    it 'should be rich if they\'re skilled' do
-      Thief.new(:skilled => true).aasm_current_state.should == :rich
+  context "Does not already respond_to? the scope name" do
+    it "should add a scope" do
+      Simple.should_not respond_to(:unknown_scope)
+      Simple.aasm_state :unknown_scope
+      Simple.should respond_to(:unknown_scope)
+      Simple.unknown_scope.class.should == ActiveRecord::Relation
     end
+  end
 
-    it 'should be jailed if they\'re unskilled' do
-      Thief.new(:skilled => false).aasm_current_state.should == :jailed
+  context "Already respond_to? the scope name" do
+    it "should not add a scope" do
+      Simple.aasm_state :new
+      Simple.should respond_to(:new)
+      Simple.new.class.should == Simple
     end
   end
+end
 
-  # TODO: figure out how to test ActiveRecord reload! without a database
+describe 'Thieves' do
 
-rescue LoadError => e
-  if e.message == "no such file to load -- active_record"
-    puts "You must install active record to run this spec.  Install with sudo gem install activerecord"
-  else
-    raise
+  it 'should be rich if they\'re skilled' do
+    Thief.new(:skilled => true).aasm_current_state.should == :rich
+  end
+
+  it 'should be jailed if they\'re unskilled' do
+    Thief.new(:skilled => false).aasm_current_state.should == :jailed
   end
 end
+
+# TODO: figure out how to test ActiveRecord reload! without a database