aasm 4.12.2 → 4.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13bde38e3731e93db61f6058f32cba8a1a1f6fa0
-  data.tar.gz: a5ab477ba4a18e4e90d2d61c9010421fb39e2011
+  metadata.gz: 485dd737c1e66c6abf9ad6beec5b88610e282cf5
+  data.tar.gz: dc4e4de44fbb182924bc28b13aff6708766f2cfc
 SHA512:
-  metadata.gz: f51ca4fab23d2e61bdb392ae49a63b2a003a6de07251e39c8dcab892e2282073ed420f35c9bf131f2261ed68bd7d4fdbabd338acd5dbe4ec7f98e1eefaa6c757
-  data.tar.gz: a4eb3ffcceee128b4b3f33bc9e27d69993887a4f7ce2d56a0d4fa0541f154eb3c7cb16d2d9b75a9c4f86fced4af73cf9415b90ca5dd3fcd3d79f3cd81fa981ad
+  metadata.gz: 8211acf5c307b6c04b04ff0aad09aecece63d8df1fc6dbe3de14e363ab415a1e0291510b2d4783cf9cd22391415a25e4ac72d7f43f35ea612b60f939ab6def2a
+  data.tar.gz: a95bd160171a94dfc8ac1a4de0594372c336cf546f38727cacc95ca73af43369419bc6b3637634faa02b7eae6b8c668d29c5b74a5eb930aba4a03af190f8364a

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # CHANGELOG
 
 ## unreleased
+## 4.12.3
+
+* Add to AASM fire(event) and fire!(event) methods [#494](https://github.com/aasm/aasm/pull/494), thanks to [slayer](https://github.com/slayer)
+* Add `use_transactions` flag to persist changes to the database even when some error occurs. [#493](https://github.com/aasm/aasm/pull/493), thanks to Peter Lampesberger.
+
 ## 4.12.2
 
 * Fix guards parameter [#484](https://github.com/aasm/aasm/pull/484), thanks to [teohm](https://github.com/teohm)

data/Gemfile

@@ -4,4 +4,4 @@ gemspec
 
 gem 'sqlite3',                          :platforms => :ruby
 gem 'activerecord-jdbcsqlite3-adapter', :platforms => :jruby
-gem 'rails', '5.0.2'
+gem 'rails', '5.1.3'

data/Gemfile.lock_old

@@ -0,0 +1,151 @@
+PATH
+  remote: .
+  specs:
+    aasm (4.11.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.7.1)
+      actionview (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+    activerecord (4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      arel (~> 6.0)
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (6.0.4)
+    builder (3.2.3)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    erubis (2.7.0)
+    generator_spec (0.9.3)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.8.1)
+    json (1.8.6)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    nokogiri (1.7.0.1)
+      mini_portile2 (~> 2.1.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.5)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.7.1)
+      actionmailer (= 4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activerecord (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.7.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.8)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    rdoc (4.3.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    sdoc (0.4.2)
+      json (~> 1.7, >= 1.7.7)
+      rdoc (~> 4.0)
+    slop (3.6.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aasm!
+  appraisal
+  generator_spec
+  pry
+  rails (= 4.2.7.1)
+  rake
+  rspec (>= 3)
+  sdoc
+  sqlite3
+
+BUNDLED WITH
+   1.12.4

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2016 Scott Barron
+Copyright (c) 2006-2017 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

@@ -5,6 +5,50 @@
 [![Dependency Status](https://gemnasium.com/aasm/aasm.svg)](https://gemnasium.com/aasm/aasm)
 [![Code Climate](https://codeclimate.com/github/aasm/aasm/badges/gpa.svg)](https://codeclimate.com/github/aasm/aasm)
 
+## Index
+- [Upgrade from version 3 to 4](#upgrade-from-version-3-to-4)
+- [Usage](#usage)
+  - [Callbacks](#callbacks)
+    - [Lifecycle](#lifecycle)
+    - [The current event triggered](#the-current-event-triggered)
+  - [Guards](#guards)
+  - [Transitions](#transitions)
+  - [Multiple state machines per class](#multiple-state-machines-per-class)
+    - [Handling naming conflicts between multiple state machines](#handling-naming-conflicts-between-multiple-state-machines)
+    - [Binding event](#binding-event)
+  - [Auto-generated Status Constants](#auto-generated-status-constants)
+  - [Extending AASM](#extending-aasm)
+  - [ActiveRecord](#activerecord)
+  - [Bang events](#bang-events)
+  - [ActiveRecord enums](#activerecord-enums)
+  - [Sequel](#sequel)
+  - [Dynamoid](#dynamoid)
+  - [Mongoid](#mongoid)
+  - [Redis](#redis)
+  - [Automatic Scopes](#automatic-scopes)
+  - [Transaction support](#transaction-support)
+  - [Pessimistic Locking](#pessimistic-locking)
+  - [Column name & migration](#column-name--migration)
+  - [Inspection](#inspection)
+  - [Warning output](#warning-output)
+  - [RubyMotion support](#rubymotion-support)
+  - [Testing](#testing)
+    - [RSpec](#rspec)
+    - [Minitest](#minitest)
+      - [Assertions](#assertions)
+      - [Expectations](#expectations)
+ - [Installation](#installation)
+   - [Manually from RubyGems.org](#manually-from-rubygemsorg)
+   - [Bundler](#or-if-you-are-using-bundler)
+   - [Building your own gems](#building-your-own-gems)
+  - [Generators](#generators)
+  - [Latest changes](#latest-changes)
+  - [Questions?](#questions)
+  - [Maintainers](#maintainers)
+- [Contributing](CONTRIBUTING.md)
+- [Warranty](#warranty)
+- [License](#license)
+
 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
@@ -282,7 +326,7 @@ class Cleaner
       end
       transitions :from => :idle, :to => :idle
     end
-    
+
     event :clean_if_dirty do
       transitions :from => :idle, :to => :cleaning, :guard => :if_dirty?
     end
@@ -291,7 +335,7 @@ class Cleaner
   def cleaning_needed?
     false
   end
-  
+
   def if_dirty?(status)
     status == :dirty
   end
@@ -425,10 +469,56 @@ simple.aasm(:work).current
 
 ```
 
-_AASM_ doesn't prohibit to define the same event in more than one state machine. The
-latest definition "wins" and overrides previous definitions. Nonetheless, a warning is issued:
+#### Handling naming conflicts between multiple state machines
+
+_AASM_ doesn't prohibit to define the same event in more than one state
+machine. If no namespace is provided, the latest definition "wins" and
+overrides previous definitions. Nonetheless, a warning is issued:
 `SimpleMultipleExample: overriding method 'run'!`.
 
+Alternatively, you can provide a namespace for each state machine:
+
+```ruby
+class NamespacedMultipleExample
+  include AASM
+  aasm(:status) do
+    state :unapproved, :initial => true
+    state :approved
+
+    event :approve do
+      transitions :from => :unapproved, :to => :approved
+    end
+
+    event :unapprove do
+      transitions :from => :approved, :to => :unapproved
+    end
+  end
+
+  aasm(:review_status, namespace: :review) do
+    state :unapproved, :initial => true
+    state :approved
+
+    event :approve do
+      transitions :from => :unapproved, :to => :approved
+    end
+
+    event :unapprove do
+      transitions :from => :approved, :to => :unapproved
+    end
+  end
+end
+
+namespaced = NamespacedMultipleExample.new
+
+namespaced.aasm(:status).current_state
+# => :unapproved
+namespaced.aasm(:review_status).current_state
+# => :unapproved
+namespaced.approve_review
+namespaced.aasm(:review_status).current_state
+# => :approved
+```
+
 All _AASM_ class- and instance-level `aasm` methods accept a state machine selector.
 So, for example, to use inspection on a class level, you have to use
 
@@ -599,6 +689,10 @@ You can tell AASM to auto-save the object or leave it unsaved
 job = Job.new
 job.run   # not saved
 job.run!  # saved
+
+# or
+job.aasm.fire(:run) # not saved
+job.aasm.fire!(:run) # saved
 ```
 
 Saving includes running all validations on the `Job` class. If
@@ -867,6 +961,24 @@ end
 
 which then leads to `transaction(:requires_new => false)`, the Rails default.
 
+Additionally, if you do not want any of your active record actions to be
+wrapped in a transaction, you can specify the `use_transactions` flag. This can
+be useful if you want want to persist things to the database that happen as a
+result of a transaction or callback, even when some error occurs. The
+`use_transactions` flag is true by default.
+
+```ruby
+class Job < ActiveRecord::Base
+  include AASM
+
+  aasm :use_transactions => false do
+    ...
+  end
+
+  ...
+end
+```
+
 ### Pessimistic Locking
 
 AASM supports [Active Record pessimistic locking via `with_lock`](http://api.rubyonrails.org/classes/ActiveRecord/Locking/Pessimistic.html#method-i-with_lock) for database persistence layers.
@@ -1231,7 +1343,7 @@ purpose.
 
 ## License ##
 
-Copyright (c) 2006-2016 Scott Barron
+Copyright (c) 2006-2017 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

@@ -26,6 +26,9 @@ module AASM
       # raise if the model is invalid (in ActiveRecord)
       configure :whiny_persistence, false
 
+      # Use transactions (in ActiveRecord)
+      configure :use_transactions, true
+
       # use requires_new for nested transactions (in ActiveRecord)
       configure :requires_new_transaction, true
 

data/lib/aasm/configuration.rb

@@ -15,6 +15,9 @@ module AASM
     # for ActiveRecord: store the new state even if the model is invalid and return true
     attr_accessor :skip_validation_on_save
 
+    # for ActiveRecord: use transactions
+    attr_accessor :use_transactions
+
     # for ActiveRecord: use requires_new for nested transactions?
     attr_accessor :requires_new_transaction
 

data/lib/aasm/instance_base.rb

@@ -103,6 +103,14 @@ module AASM
       end
     end
 
+    def fire(event_name, *args, &block)
+      @instance.send(:aasm_fire_event, @name, event_name, {persist: false}, *args, &block)
+    end
+
+    def fire!(event_name, *args, &block)
+      @instance.send(:aasm_fire_event, @name, event_name, {persist: true}, *args, &block)
+    end
+
     def set_current_state_with_persistence(state)
       save_success = @instance.aasm_write_state(state, @name)
       self.current_state = state if save_success

data/lib/aasm/persistence/orm.rb

@@ -102,6 +102,10 @@ module AASM
         AASM::StateMachineStore.fetch(self.class, true).machine(state_machine_name).config.skip_validation_on_save
       end
 
+      def use_transactions?(state_machine_name)
+        AASM::StateMachineStore.fetch(self.class, true).machine(state_machine_name).config.use_transactions
+      end
+
       def requires_new?(state_machine_name)
         AASM::StateMachineStore.fetch(self.class, true).machine(state_machine_name).config.requires_new_transaction
       end
@@ -118,7 +122,11 @@ module AASM
           event.fire_global_callbacks(:before_all_transactions, self, *args)
 
           begin
-            success = aasm_transaction(requires_new?(state_machine_name), requires_lock?(state_machine_name)) do
+            success = if options[:persist] && use_transactions?(state_machine_name)
+              aasm_transaction(requires_new?(state_machine_name), requires_lock?(state_machine_name)) do
+                super
+              end
+            else
               super
             end
 

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "4.12.2"
+  VERSION = "4.12.3"
 end

data/spec/database.rb

@@ -24,7 +24,7 @@ ActiveRecord::Migration.suppress_messages do
     end
   end
 
-  %w(transactors no_lock_transactors lock_transactors lock_no_wait_transactors multiple_transactors).each do |table_name|
+  %w(transactors no_lock_transactors lock_transactors lock_no_wait_transactors no_transactors multiple_transactors).each do |table_name|
     ActiveRecord::Migration.create_table table_name, :force => true do |t|
       t.string "name"
       t.string "status"

data/spec/models/active_record/transactor.rb

@@ -72,6 +72,31 @@ class LockNoWaitTransactor < ActiveRecord::Base
   end
 end
 
+class NoTransactor < ActiveRecord::Base
+
+ belongs_to :worker
+
+  include AASM
+  aasm :column => :status, use_transactions: false do
+    state :sleeping, :initial => true
+    state :running, :before_enter => :start_worker, :after_enter => :fail
+
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+  end
+
+  private
+
+  def start_worker
+    worker.update_attribute(:status, 'running')
+  end
+
+  def fail
+    raise StandardError.new('failed on purpose')
+  end
+end
+
 class MultipleTransactor < ActiveRecord::Base
 
   belongs_to :worker

data/spec/unit/complex_example_spec.rb

@@ -77,6 +77,16 @@ describe 'when being unsuspended' do
     expect(auth.aasm.may_fire_event?(:activate)).to be true
   end
 
+  it "should be able to fire event by name" do
+    expect(auth.aasm.fire(:activate)).to be true
+    expect(auth.aasm.current_state).to eq(:active)
+  end
+
+  it "should be able to fire! event by name" do
+    expect(auth.aasm.fire!(:activate)).to be true
+    expect(auth.aasm.current_state).to eq(:active)
+  end
+
   it "should not be able to fire unknown events" do
     expect(auth.aasm.may_fire_event?(:unknown)).to be false
   end

data/spec/unit/complex_multiple_example_spec.rb

@@ -91,9 +91,25 @@ describe 'when being unsuspended' do
     expect(auth.aasm(:right).may_fire_event?(:right_activate)).to be true
   end
 
-  it "should not be able to fire unknown events" do
+  it 'should not be able to fire unknown events' do
     expect(auth.aasm(:left).may_fire_event?(:unknown)).to be false
     expect(auth.aasm(:right).may_fire_event?(:unknown)).to be false
   end
 
+  it 'should be able to fire event by name' do
+    expect(auth.aasm(:left).fire(:left_activate)).to be true
+    expect(auth.aasm(:left).current_state).to eq(:active)
+
+    expect(auth.aasm(:right).fire(:right_activate)).to be true
+    expect(auth.aasm(:right).current_state).to eq(:active)
+  end
+
+  it 'should be able to fire! event by name' do
+    expect(auth.aasm(:left).fire!(:left_activate)).to be true
+    expect(auth.aasm(:left).current_state).to eq(:active)
+
+    expect(auth.aasm(:right).fire!(:right_activate)).to be true
+    expect(auth.aasm(:right).current_state).to eq(:active)
+  end
+
 end

data/spec/unit/persistence/active_record_persistence_multiple_spec.rb

@@ -123,7 +123,7 @@ if defined?(ActiveRecord)
           let(:multiple_with_enum_without_column) {MultipleWithEnumWithoutColumn.new}
 
           it "should raise NoMethodError for transitions" do
-            expect{multiple_with_enum_without_column.send(:view, :left)}.to raise_error(NoMethodError, "undefined method 'status' for MultipleWithEnumWithoutColumn")
+            expect{multiple_with_enum_without_column.send(:view, :left)}.to raise_error(NoMethodError, /undefined method .status./)
           end
         end
 

data/spec/unit/persistence/active_record_persistence_spec.rb

@@ -123,7 +123,7 @@ if defined?(ActiveRecord)
           let(:with_enum_without_column) {WithEnumWithoutColumn.new}
 
           it "should raise NoMethodError for transitions" do
-            expect{with_enum_without_column.send(:view)}.to raise_error(NoMethodError, "undefined method 'status' for WithEnumWithoutColumn")
+            expect{with_enum_without_column.send(:view)}.to raise_error(NoMethodError, /undefined method .status./)
           end
         end
 
@@ -506,6 +506,20 @@ if defined?(ActiveRecord)
       end
     end
 
+    describe 'without transactions' do
+      let(:worker) { Worker.create!(:name => 'worker', :status => 'sleeping') }
+      let(:no_transactor) { NoTransactor.create!(:name => 'transactor', :worker => worker) }
+
+      it 'should not rollback all changes' do
+        expect(no_transactor).to be_sleeping
+        expect(worker.status).to eq('sleeping')
+
+        expect {no_transactor.run!}.to raise_error(StandardError, 'failed on purpose')
+        expect(no_transactor).to be_running
+        expect(worker.reload.status).to eq('running')
+      end
+    end
+
     describe 'transactions' do
       let(:worker) { Worker.create!(:name => 'worker', :status => 'sleeping') }
       let(:transactor) { Transactor.create!(:name => 'transactor', :worker => worker) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 4.12.2
+  version: 4.12.3
 platform: ruby
 authors:
 - Thorsten Boettger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -125,6 +125,7 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
+- Gemfile.lock_old
 - HOWTO
 - LICENSE
 - PLANNED_CHANGES.md