aasm 3.0.1 → 3.0.2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 3.0.2
+
+ * ActiveRecord persistence can ignore validation when trying to save invalid models
+
 ## 3.0.1
 
  * added support for Mongoid (Thanks, Michał Taberski)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008-2011 Scott Barron
+Copyright (c) 2006-2012 Scott Barron
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,7 +2,10 @@
 
 This package contains AASM, a library for adding finite state machines to Ruby classes.
 
-AASM started as the acts_as_state_machine plugin but has evolved into a more generic library that no longer targets only ActiveRecord models.
+AASM started as the acts_as_state_machine plugin but has evolved into a more generic library
+that no longer targets only ActiveRecord models. It currently provides adapters for
+[ActiveRecord](http://api.rubyonrails.org/classes/ActiveRecord/Base.html) and
+[Mongoid](http://mongoid.org/).
 
 ## Features ##
 
@@ -54,7 +57,9 @@ gem 'aasm'
 % sudo gem install pkg/aasm-x.y.z.gem
 ```
 
-## Simple Example ##
+## Examples ##
+
+### Simple Example ###
 
 Here's a quick example highlighting some of the features.
 
@@ -79,7 +84,7 @@ class Conversation
 end
 ```
 
-## A Slightly More Complex Example ##
+### A Slightly More Complex Example ###
 
 This example uses a few of the more complex features available.
 
@@ -114,7 +119,7 @@ This example uses a few of the more complex features available.
   end
 ```
 
-## Callbacks around events
+### Callbacks around events ###
 ```ruby
   class Relationship
     include AASM
@@ -132,6 +137,27 @@ This example uses a few of the more complex features available.
   end
 ```
 
+### Persistence example ###
+```ruby
+  class InvalidPersistor < ActiveRecord::Base
+    include AASM
+    aasm :column => :status, :skip_validation_on_save => true do
+      state :sleeping, :initial => true
+      state :running
+      event :run do
+        transitions :to => :running, :from => :sleeping
+      end
+      event :sleep do
+        transitions :to => :sleeping, :from => :running
+      end
+    end
+    validates_presence_of :name
+  end
+```
+This model can change AASM states which are stored into the database, even if the model itself is invalid!
+
+
+
 ## Changelog ##
 
 Look at the [CHANGELOG](https://github.com/rubyist/aasm/blob/master/CHANGELOG.md) for details.
@@ -153,7 +179,7 @@ purpose.
 
 ## License ##
 
-Copyright (c) 2006-2011 Scott Barron
+Copyright (c) 2006-2012 Scott Barron
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/aasm/base.rb

@@ -4,11 +4,18 @@ module AASM
       @clazz = clazz
       sm = AASM::StateMachine[@clazz]
       sm.config.column = options[:column].to_sym if options[:column]
+
       if options.key?(:whiny_transitions)
         sm.config.whiny_transitions = options[:whiny_transitions]
       else
         sm.config.whiny_transitions = true # this is the default, so let's cry
       end
+
+      if options.key?(:skip_validation_on_save)
+        sm.config.skip_validation_on_save = options[:skip_validation_on_save]
+      else
+        sm.config.skip_validation_on_save = false # this is the default, so don't store any new state if the model is invalid
+      end
     end
 
     def state(name, options={})

data/lib/aasm/persistence/active_record_persistence.rb

@@ -196,7 +196,12 @@ module AASM
           old_value = read_attribute(self.class.aasm_column)
           write_attribute(self.class.aasm_column, state.to_s)
 
-          unless self.save
+          success = if AASM::StateMachine[self.class].config.skip_validation_on_save && !self.valid?
+            self.class.update_all({ self.class.aasm_column => state.to_s }, self.class.primary_key => self.id) == 1
+          else
+            self.save
+          end
+          unless success
             write_attribute(self.class.aasm_column, old_value)
             return false
           end

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "3.0.1"
+  VERSION = "3.0.2"
 end

data/spec/models/invalid_persistor.rb

@@ -0,0 +1,16 @@
+require 'active_record'
+
+class InvalidPersistor < ActiveRecord::Base
+  include AASM
+  aasm :column => :status, :skip_validation_on_save => true do
+    state :sleeping, :initial => true
+    state :running
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+    event :sleep do
+      transitions :to => :sleeping, :from => :running
+    end
+  end
+  validates_presence_of :name
+end

data/spec/models/validator.rb

@@ -0,0 +1,16 @@
+require 'active_record'
+
+class Validator < ActiveRecord::Base
+  include AASM
+  aasm :column => :status do
+    state :sleeping, :initial => true
+    state :running
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+    event :sleep do
+      transitions :to => :sleeping, :from => :running
+    end
+  end
+  validates_presence_of :name
+end

data/spec/schema.rb

@@ -4,4 +4,14 @@ ActiveRecord::Schema.define(:version => 0) do
     create_table table_name, :force => true
   end
 
+  create_table "validators", :force => true do |t|
+    t.string "name"
+    t.string "status"
+  end
+
+  create_table "invalid_persistors", :force => true do |t|
+    t.string "name"
+    t.string "status"
+  end
+
 end

data/spec/unit/aasm_spec.rb

@@ -103,75 +103,16 @@ describe AASM, '- initial states' do
   end
 end
 
-describe AASM, '- event firing with persistence' do
-  it 'should update the current state' do
-    foo = Foo.new
-    foo.close!
-
-    foo.aasm_current_state.should == :closed
-  end
-
+describe AASM, 'success callbacks' do
   it 'should call the success callback if one was provided' do
     foo = Foo.new
-
     foo.should_receive(:success_callback)
-
     foo.close!
   end
 
-  it 'should attempt to persist if aasm_write_state is defined' do
-    foo = Foo.new
-
-    def foo.aasm_write_state
-    end
-
-    foo.should_receive(:aasm_write_state)
-
-    foo.close!
-  end
-
-  it 'should return true if aasm_write_state is defined and returns true' do
-    foo = Foo.new
-
-    def foo.aasm_write_state(state)
-      true
-    end
-
-    foo.close!.should be_true
-  end
-
-  it 'should return false if aasm_write_state is defined and returns false' do
-    foo = Foo.new
-
-    def foo.aasm_write_state(state)
-      false
-    end
-
-    foo.close!.should be_false
-  end
-
-  it "should not update the aasm_current_state if the write fails" do
-    foo = Foo.new
-
-    def foo.aasm_write_state
-      false
-    end
-
-    foo.should_receive(:aasm_write_state)
-
-    foo.close!
-    foo.aasm_current_state.should == :open
-  end
 end
 
 describe AASM, '- event firing without persistence' do
-  it 'should update the current state' do
-    foo = Foo.new
-    foo.close
-
-    foo.aasm_current_state.should == :closed
-  end
-
   it 'should attempt to persist if aasm_write_state is defined' do
     foo = Foo.new
 
@@ -184,18 +125,6 @@ describe AASM, '- event firing without persistence' do
   end
 end
 
-describe AASM, '- persistence' do
-  it 'should read the state if it has not been set and aasm_read_state is defined' do
-    foo = Foo.new
-    def foo.aasm_read_state
-    end
-
-    foo.should_receive(:aasm_read_state)
-
-    foo.aasm_current_state
-  end
-end
-
 describe AASM, '- getting events for a state' do
   it '#aasm_events_for_current_state should use current state' do
     foo = Foo.new

data/spec/unit/active_record_persistence_spec.rb

@@ -246,3 +246,52 @@ describe 'Thieves' do
     Thief.new(:skilled => false).aasm_current_state.should == :jailed
   end
 end
+
+describe 'transitions with persistence' do
+
+  it 'should not store states for invalid models' do
+    validator = Validator.create(:name => 'name')
+    validator.should be_valid
+    validator.should be_sleeping
+
+    validator.name = nil
+    validator.should_not be_valid
+    validator.run!.should be_false
+    validator.should be_sleeping
+
+    validator.reload
+    validator.should_not be_running
+    validator.should be_sleeping
+
+    validator.name = 'another name'
+    validator.should be_valid
+    validator.run!.should be_true
+    validator.should be_running
+
+    validator.reload
+    validator.should be_running
+    validator.should_not be_sleeping
+  end
+
+  it 'should store states for invalid models if configured' do
+    persistor = InvalidPersistor.create(:name => 'name')
+    persistor.should be_valid
+    persistor.should be_sleeping
+
+    persistor.name = nil
+    persistor.should_not be_valid
+    persistor.run!.should be_true
+    persistor.should be_running
+
+    persistor = InvalidPersistor.find(persistor.id)
+    persistor.valid?
+    persistor.should be_valid
+    persistor.should be_running
+    persistor.should_not be_sleeping
+
+    persistor.reload
+    persistor.should be_running
+    persistor.should_not be_sleeping
+  end
+
+end

data/spec/unit/localizer_spec.rb

@@ -22,16 +22,19 @@ describe AASM::SupportingClasses::Localizer do
   before(:all) do
     I18n.load_path << 'spec/en.yml'
     I18n.default_locale = :en
+    I18n.reload!
   end
 
-  after(:all) { I18n.load_path.clear }
+  after(:all) do
+    I18n.load_path.clear
+  end
 
   let (:foo_opened) { LocalizerTestModel.new }
   let (:foo_closed) { LocalizerTestModel.new.tap { |x| x.aasm_state = :closed  } }
 
   context 'aasm_human_state' do
     it 'should return translated state value' do
-       foo_opened.aasm_human_state.should == "It's opened now!"
+      foo_opened.aasm_human_state.should == "It's opened now!"
     end
 
     it 'should return humanized value if not localized' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: aasm
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: 
   segments: 
   - 3
   - 0
-  - 1
-  version: 3.0.1
+  - 2
+  version: 3.0.2
 platform: ruby
 authors: 
 - Scott Barron
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-21 00:00:00 +01:00
+date: 2012-01-16 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -182,9 +182,11 @@ files:
 - spec/database.yml
 - spec/en.yml
 - spec/models/conversation.rb
+- spec/models/invalid_persistor.rb
 - spec/models/not_auto_loaded/process.rb
 - spec/models/process_with_new_dsl.rb
 - spec/models/silencer.rb
+- spec/models/validator.rb
 - spec/schema.rb
 - spec/spec_helper.rb
 - spec/spec_helpers/models_spec_helper.rb
@@ -237,9 +239,11 @@ test_files:
 - spec/database.yml
 - spec/en.yml
 - spec/models/conversation.rb
+- spec/models/invalid_persistor.rb
 - spec/models/not_auto_loaded/process.rb
 - spec/models/process_with_new_dsl.rb
 - spec/models/silencer.rb
+- spec/models/validator.rb
 - spec/schema.rb
 - spec/spec_helper.rb
 - spec/spec_helpers/models_spec_helper.rb