aasm 4.10.1 → 4.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f62dfd355dcd559e5f9b2d00afc1d858c2b9a1f8
-  data.tar.gz: 168ae1576773a1e9e56444818704cfa74284f226
+  metadata.gz: 7c0f9cf1b1303a1269e84ada192ce2d56b2ad29b
+  data.tar.gz: 8ad1ec953454bb5fbf113d9a47494fae24238744
 SHA512:
-  metadata.gz: a93b62dad3157b2b731859ba126b427d0cc6401e30d215a73dcd6182fd9126b5f0fc183cc467108937c4ff9be2d60147074f017c88b5044f2e5e80959444547a
-  data.tar.gz: 91014f1d7a04436d98121a506ce34a3ed6777fe382dba29978f36257b17481d3d909b04562fcd747fe1e9498d2665850408da8ef8e195cba126719df5f659135
+  metadata.gz: 29373b642050f83f1d44a5241857b9e75b0aa1dd4b224b161f057acdde5595bf79e57554229b610ce3288e058816dbb096c8b344e6f0c056706273dcbbf55b80
+  data.tar.gz: 93dff92101055f58ef493c1e1574c716683315a452add2b43522ef6a4e7b25c6d38caf9e2791a2ed8162c9b541b465d275ec09e699c6f3ad794b537ba8fb3e74

data/.travis.yml

@@ -43,3 +43,7 @@ matrix:
       gemfile: gemfiles/rails_3.2_stable.gemfile
     - rvm: jruby-1.7
       gemfile: gemfiles/rails_5.0.gemfile
+
+notifications:
+  slack:
+    secure: MsPY8sUW5TVblcWc5NGkkWJlHxCMnhNa3IFPSVWthlk0fz+CLfOrLjQ+brQup/AJ7BRtyBKQ8udpqLj/R7CJKAiVVDAlUBcHqXk/WDusssGzJkDMrLVDefq++YCg5TdbcIaHt8WBVg6pD8H4kQJMJxmtcziQtiW1Qt0pwfuNJ+k=

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 4.11.0
+
+ * support `logger` configuration (see [issue #370](https://github.com/aasm/aasm/pull/370) for details, thanks to [@HoyaBoya](https://github.com/HoyaBoya))
+ * support configuration to let bang transitions fail if object is invalid (see [issue #366](https://github.com/aasm/aasm/pull/366) and [issue #262](https://github.com/aasm/aasm/issues/262) for details, thanks to [@Wildebeest](https://github.com/Wildebeest))
+
+
 ## 4.10.1
 
  * fix: suppress warnings when using ActiveRecord enums feature (see [issue #346](https://github.com/aasm/aasm/pull/346) for details, thanks to [@110y](https://github.com/110y), and [issue #353](https://github.com/aasm/aasm/pull/353) for details, thanks to [@nathanstitt](https://github.com/nathanstitt))

data/README.md

@@ -522,7 +522,7 @@ Saving includes running all validations on the `Job` class, and returns `true` i
 successful or `false` if errors occur. Exceptions are not raised.
 
 If you want make sure the state gets saved without running validations (and
-thereby maybe persisting aninvalid object state), simply tell AASM to skip the
+thereby maybe persisting an invalid object state), simply tell AASM to skip the
 validations. Be aware that when skipping validations, only the state column will
 be updated in the database (just like ActiveRecord `update_column` is working).
 
@@ -869,6 +869,7 @@ end
 AASM supports query methods for states and events
 
 Given the following `Job` class:
+
 ```ruby
 class Job
   include AASM
@@ -889,7 +890,7 @@ class Job
       transitions :from => [:running, :cleaning], :to => :sleeping
     end
   end
-  
+
   def cleaning_needed?
     false
   end
@@ -937,6 +938,23 @@ Job.aasm.states_for_select
 ```
 
 
+### Warning output
+
+Warnings are by default printed to `STDERR`. If you want to log those warnings to another output,
+use
+
+```ruby
+class Job
+  include AASM
+
+  aasm :logger => Rails.logger do
+    ...
+  end
+end
+```
+
+Be aware though, that this is not yet released. It will be part of _AASM_ version `4.11.0`.
+
 ### RubyMotion support
 
 Now supports [CodeDataQuery](https://github.com/infinitered/cdq.git) !

data/lib/aasm/base.rb

@@ -1,3 +1,5 @@
+require 'logger'
+
 module AASM
   class Base
 
@@ -21,6 +23,9 @@ module AASM
       # don't store any new state if the model is invalid (in ActiveRecord)
       configure :skip_validation_on_save, false
 
+      # raise if the model is invalid (in ActiveRecord)
+      configure :whiny_persistence, false
+
       # use requires_new for nested transactions (in ActiveRecord)
       configure :requires_new_transaction, true
 
@@ -40,6 +45,9 @@ module AASM
       # Set to true to namespace reader methods and constants
       configure :namespace, false
 
+      # Configure a logger, with default being a Logger to STDERR
+      configure :logger, Logger.new(STDERR)
+
       # make sure to raise an error if no_direct_assignment is enabled
       # and attribute is directly assigned though
       aasm_name = @name
@@ -200,7 +208,7 @@ module AASM
              klass.defined_enums.values.any?{ |methods|
                  methods.keys{| enum | enum + '?' == method_name }
              })
-        warn "#{klass.name}: overriding method '#{method_name}'!"
+         @state_machine.config.logger.warn "#{klass.name}: overriding method '#{method_name}'!"
       end
 
       klass.send(:define_method, method_name, method_definition)

data/lib/aasm/configuration.rb

@@ -9,7 +9,10 @@ module AASM
     # for all persistence layers: create named scopes for each state
     attr_accessor :create_scopes
 
-    # for ActiveRecord: don't store any new state if the model is invalid
+    # for ActiveRecord: when the model is invalid, true -> raise, false -> return false
+    attr_accessor :whiny_persistence
+
+    # for ActiveRecord: store the new state even if the model is invalid and return true
     attr_accessor :skip_validation_on_save
 
     # for ActiveRecord: use requires_new for nested transactions?
@@ -28,5 +31,8 @@ module AASM
 
     # namespace reader methods and constants
     attr_accessor :namespace
+
+    # Configure a logger, with default being a Logger to STDERR
+    attr_accessor :logger
   end
 end

data/lib/aasm/persistence/active_record_persistence.rb

@@ -76,7 +76,12 @@ module AASM
             self.save
           end
 
-          success ? true : aasm_rollback(name, old_value)
+          unless success
+            aasm_rollback(name, old_value)
+            raise ActiveRecord::RecordInvalid.new(self) if aasm_whiny_persistence(name)
+          end
+
+          success
         end
 
         # Writes <tt>state</tt> to the state column, but does not persist it to the database
@@ -130,6 +135,10 @@ module AASM
           AASM::StateMachineStore.fetch(self.class, true).machine(state_machine_name).config.skip_validation_on_save
         end
 
+        def aasm_whiny_persistence(state_machine_name)
+          AASM::StateMachineStore.fetch(self.class, true).machine(state_machine_name).config.whiny_persistence
+        end
+
         def aasm_write_attribute(state, name=:default)
           write_attribute(self.class.aasm(name).attribute_name, aasm_raw_attribute_value(state, name))
         end

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "4.10.1"
+  VERSION = "4.11.0"
 end

data/spec/database.rb

@@ -17,7 +17,7 @@ ActiveRecord::Migration.suppress_messages do
     t.string "right"
   end
 
-  %w(validators multiple_validators).each do |table_name|
+  %w(validators multiple_validators workers invalid_persistors multiple_invalid_persistors silent_persistors multiple_silent_persistors).each do |table_name|
     ActiveRecord::Migration.create_table table_name, :force => true do |t|
       t.string "name"
       t.string "status"
@@ -32,20 +32,6 @@ ActiveRecord::Migration.suppress_messages do
     end
   end
 
-  ActiveRecord::Migration.create_table "workers", :force => true do |t|
-    t.string "name"
-    t.string "status"
-  end
-
-  ActiveRecord::Migration.create_table "invalid_persistors", :force => true do |t|
-    t.string "name"
-    t.string "status"
-  end
-  ActiveRecord::Migration.create_table "multiple_invalid_persistors", :force => true do |t|
-    t.string "name"
-    t.string "status"
-  end
-
   ActiveRecord::Migration.create_table "fathers", :force => true do |t|
     t.string "aasm_state"
     t.string "type"

data/spec/models/silent_persistor.rb

@@ -0,0 +1,31 @@
+require 'active_record'
+
+class SilentPersistor < ActiveRecord::Base
+  include AASM
+  aasm :column => :status, :whiny_persistence => false 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
+
+class MultipleSilentPersistor < ActiveRecord::Base
+  include AASM
+  aasm :left, :column => :status, :whiny_persistence => false 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

@@ -10,7 +10,7 @@ class Validator < ActiveRecord::Base
 
   include AASM
 
-  aasm :column => :status do
+  aasm :column => :status, :whiny_persistence => true do
     before_all_transactions :before_all_transactions
     after_all_transactions  :after_all_transactions
 
@@ -78,7 +78,7 @@ end
 class MultipleValidator < ActiveRecord::Base
 
   include AASM
-  aasm :left, :column => :status do
+  aasm :left, :column => :status, :whiny_persistence => true do
     state :sleeping, :initial => true
     state :running
     state :failed, :after_enter => :fail

data/spec/unit/override_warning_spec.rb

@@ -28,42 +28,59 @@ describe 'warns when overrides a method' do
   end
 
   describe 'state' do
-    class Base
-      def valid?; end
+    let(:base_klass) do
+      Class.new do
+        def valid?; end
+      end
     end
-    it do
-      expect { Base.send :include, Clumsy }.
-        to output(/Base: overriding method 'valid\?'!/).to_stderr
+
+    subject { base_klass.send :include, Clumsy }
+
+    it 'should log to warn' do
+      expect_any_instance_of(Logger).to receive(:warn).with(": overriding method 'valid?'!")
+      subject
     end
   end
 
   describe 'enum' do
-    class EnumBase
-      def valid?; end
+    let(:enum_base_klass) do
+      Class.new do
+        def valid?; end
+      end
     end
-    it "dosn't warn when overriding an enum" do
-      expect { EnumBase.send :include, WithEnumBase }.
-        not_to output(/EnumBase: overriding method 'valid\?'!/).to_stderr
+
+    subject { enum_base_klass.send :include, WithEnumBase }
+
+    it 'should not log to warn' do
+      expect_any_instance_of(Logger).to receive(:warn).never
+      subject
     end
   end
 
   describe 'event' do
     context 'may?' do
-      class Base
-        def may_save?; end
-        def save!; end
-        def save; end
+      let(:base_klass) do
+        Class.new do
+          def may_save?; end
+          def save!; end
+          def save; end
+        end
       end
-      let(:klass) { Base }
-      it do
-        expect { Base.send :include, Clumsy }.
-          to output(/Base: overriding method 'may_save\?'!/).to_stderr
-        expect { Base.send :include, Clumsy }.
-          to output(/Base: overriding method 'save!'!/).to_stderr
-        expect { Base.send :include, Clumsy }.
-          to output(/Base: overriding method 'save'!/).to_stderr
+
+      subject { base_klass.send :include, Clumsy }
+
+      it 'should log to warn' do
+        expect_any_instance_of(Logger).to receive(:warn).exactly(3).times do |logger, message|
+          expect(
+            [
+              ": overriding method 'may_save?'!",
+              ": overriding method 'save!'!",
+              ": overriding method 'save'!"
+            ]
+          ).to include(message)
+        end
+        subject
       end
     end
   end
-
 end

data/spec/unit/persistence/active_record_persistence_multiple_spec.rb

@@ -384,6 +384,30 @@ describe 'transitions with persistence' do
     expect(validator).to be_valid
     expect(validator).to be_sleeping
 
+    validator.name = nil
+    expect(validator).not_to be_valid
+    expect { validator.run! }.to raise_error(ActiveRecord::RecordInvalid)
+    expect(validator).to be_sleeping
+
+    validator.reload
+    expect(validator).not_to be_running
+    expect(validator).to be_sleeping
+
+    validator.name = 'another name'
+    expect(validator).to be_valid
+    expect(validator.run!).to be_truthy
+    expect(validator).to be_running
+
+    validator.reload
+    expect(validator).to be_running
+    expect(validator).not_to be_sleeping
+  end
+
+  it 'should not store states for invalid models silently if configured' do
+    validator = MultipleSilentPersistor.create(:name => 'name')
+    expect(validator).to be_valid
+    expect(validator).to be_sleeping
+
     validator.name = nil
     expect(validator).not_to be_valid
     expect(validator.run!).to be_falsey

data/spec/unit/persistence/active_record_persistence_spec.rb

@@ -385,6 +385,30 @@ describe 'transitions with persistence' do
     expect(validator).to be_valid
     expect(validator).to be_sleeping
 
+    validator.name = nil
+    expect(validator).not_to be_valid
+    expect { validator.run! }.to raise_error(ActiveRecord::RecordInvalid)
+    expect(validator).to be_sleeping
+
+    validator.reload
+    expect(validator).not_to be_running
+    expect(validator).to be_sleeping
+
+    validator.name = 'another name'
+    expect(validator).to be_valid
+    expect(validator.run!).to be_truthy
+    expect(validator).to be_running
+
+    validator.reload
+    expect(validator).to be_running
+    expect(validator).not_to be_sleeping
+  end
+
+  it 'should not store states for invalid models silently if configured' do
+    validator = SilentPersistor.create(:name => 'name')
+    expect(validator).to be_valid
+    expect(validator).to be_sleeping
+
     validator.name = nil
     expect(validator).not_to be_valid
     expect(validator.run!).to be_falsey

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 4.10.1
+  version: 4.11.0
 platform: ruby
 authors:
 - Scott Barron
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2016-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -220,6 +220,7 @@ files:
 - spec/models/sequel/sequel_multiple.rb
 - spec/models/sequel/sequel_simple.rb
 - spec/models/silencer.rb
+- spec/models/silent_persistor.rb
 - spec/models/simple_custom_example.rb
 - spec/models/simple_example.rb
 - spec/models/simple_multiple_example.rb
@@ -377,6 +378,7 @@ test_files:
 - spec/models/sequel/sequel_multiple.rb
 - spec/models/sequel/sequel_simple.rb
 - spec/models/silencer.rb
+- spec/models/silent_persistor.rb
 - spec/models/simple_custom_example.rb
 - spec/models/simple_example.rb
 - spec/models/simple_multiple_example.rb