aasm 5.0.6 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 51dfd1ad2a78034c409ddc556625e765260dd067
-  data.tar.gz: f934e43d4a35fc75a06d161190a8794e36066c02
+SHA256:
+  metadata.gz: 6e3ec7032fd9c8368ddfb4bed4e931edc5f9d96c02a69f89f7ee26913f7d8698
+  data.tar.gz: ddb4ef39501440da1869426eda3b4359e37eeef67b464c9e0d660e9f353510f6
 SHA512:
-  metadata.gz: 983b08a4a0977c37dd73b77c5d80d014a05025d7f2841c26788518c82a8e738825ab9fa5fc8a36577e9c6a23fd33cf341c6fefc954630836e213ab40ee12c909
-  data.tar.gz: b091bca286362fb33a31f1b9705840f664ebd0a948c6b2dffbaa2436144c5931a04950080b18e16c1a7d9e4e1b8f517b7ea6c2c133259a3860905928fda32b90
+  metadata.gz: c294de071cad6569f855af1455c9d0281622ca5c9a3df0466baacaca569d8974718eb46d4c06e674f54629a77e2634d69829ee2910612ba146b4aaf786891544
+  data.tar.gz: a7b0c176cec262ad9d89538fe43e6df484f4d79328f85e853dcc9fe6b6ce9a9629f802e7de14659e5c91135a3a4df09a6066011983b1936eff06b17657c24cc5

data/.travis.yml

@@ -12,8 +12,9 @@ before_install:
   - bundle _1.16.1_ install
 
 rvm:
-  - 2.3.0
   - 2.5.0
+  - 2.6.5
+  - 2.7.0
   - jruby-9.1.12.0
 
 services:
@@ -25,7 +26,6 @@ services:
 
 gemfile:
   - gemfiles/norails.gemfile
-  - gemfiles/rails_3.2.gemfile
   - gemfiles/rails_4.2.gemfile
   - gemfiles/rails_4.2_mongoid_5.gemfile
 #  - gemfiles/rails_4.2_nobrainer.gemfile
@@ -46,22 +46,22 @@ script:
 
 matrix:
   exclude:
-    - rvm: 2.3.0
-      gemfile: gemfiles/norails.gemfile
-    - rvm: 2.3.0
-      gemfile: gemfiles/rails_5.0.gemfile
-#    - rvm: 2.3.0
-#      gemfile: gemfiles/rails_5.0_nobrainer.gemfile
-    - rvm: 2.3.0
-      gemfile: gemfiles/rails_5.1.gemfile
-    - rvm: 2.3.0
+    - rvm: 2.7.0
+      gemfile: gemfiles/rails_5.2.gemfile
+    - rvm: 2.6.5
       gemfile: gemfiles/rails_5.2.gemfile
     - rvm: 2.5.0
-      gemfile: gemfiles/rails_3.2.gemfile
-    - rvm: 2.5.0
+      gemfile: gemfiles/rails_4.2.gemfile
+    - rvm: 2.6.5
+      gemfile: gemfiles/rails_4.2.gemfile
+    - rvm: 2.7.0
       gemfile: gemfiles/rails_4.2.gemfile
     - rvm: 2.5.0
       gemfile: gemfiles/rails_4.2_mongoid_5.gemfile
+    - rvm: 2.6.5
+      gemfile: gemfiles/rails_4.2_mongoid_5.gemfile
+    - rvm: 2.7.0
+      gemfile: gemfiles/rails_4.2_mongoid_5.gemfile
 #    - rvm: 2.5.0
 #      gemfile: gemfiles/rails_4.2_nobrainer.gemfile
     - rvm: jruby-9.1.12.0

data/Appraisals

@@ -1,13 +1,3 @@
-appraise 'rails_3.2' do
-  gem 'rails', '~> 3.2.22'
-  gem 'mongoid', '~> 3.1'
-  gem 'sequel'
-  gem 'bson_ext', platforms: :ruby
-  gem 'test-unit', '~> 3.0'
-  gem 'minitest'
-  gem 'activerecord-jdbcsqlite3-adapter', '1.3.24', platforms: :jruby
-end
-
 appraise 'rails_4.2' do
   gem 'nokogiri', '1.6.8.1', platforms: %i[ruby_19]
   gem 'mime-types', '~> 2', platforms: %i[ruby_19 jruby]
@@ -18,6 +8,7 @@ appraise 'rails_4.2' do
   gem 'aws-sdk', '~> 2', platforms: :ruby
   gem 'redis-objects'
   gem 'activerecord-jdbcsqlite3-adapter', '1.3.24', platforms: :jruby
+  gem "after_commit_everywhere", "~> 1.0"
 end
 
 appraise 'rails_4.2_nobrainer' do
@@ -30,6 +21,7 @@ appraise 'rails_4.2_mongoid_5' do
   gem 'rails', '4.2.5'
   gem 'mongoid', '~> 5.0'
   gem 'activerecord-jdbcsqlite3-adapter', '1.3.24', platforms: :jruby
+  gem "after_commit_everywhere", "~> 1.0"
 end
 
 appraise 'rails_5.0' do
@@ -39,6 +31,7 @@ appraise 'rails_5.0' do
   gem 'dynamoid', '~> 1.3', platforms: :ruby
   gem 'aws-sdk', '~> 2', platforms: :ruby
   gem 'redis-objects'
+  gem "after_commit_everywhere", "~> 1.0"
 end
 
 appraise 'rails_5.0_nobrainer' do
@@ -53,6 +46,7 @@ appraise 'rails_5.1' do
   gem 'dynamoid', '~> 1.3', platforms: :ruby
   gem 'aws-sdk', '~>2', platforms: :ruby
   gem 'redis-objects'
+  gem "after_commit_everywhere", "~> 1.0"
 end
 
 appraise 'rails_5.2' do
@@ -62,9 +56,11 @@ appraise 'rails_5.2' do
   gem 'dynamoid', '~>2.2', platforms: :ruby
   gem 'aws-sdk', '~>2', platforms: :ruby
   gem 'redis-objects'
+  gem "after_commit_everywhere", "~> 1.0"
 end
 
 appraise 'norails' do
+  gem 'sqlite3', '~> 1.3', '>= 1.3.5', platforms: :ruby
   gem 'rails', install_if: false
   gem 'sequel'
   gem 'redis-objects'

data/CHANGELOG.md

@@ -1,6 +1,39 @@
 # CHANGELOG
 
 ## unreleased
+## 5.2.0
+
+* fix: timestamp will work with named machine [#739](https://github.com/aasm/aasm/pull/739), thanks to [RolandStuder](https://github.com/RolandStuder)
+* Create namespaced scopes in PR [#735](https://github.com/aasm/aasm/pull/735), thanks to [caiohsramos](https://github.com/caiohsramos)
+* Fix multiple state machines example per class on README in PR [#732](https://github.com/aasm/aasm/pull/732), thanks to [RodrigoVitiello](https://github.com/RodrigoVitiello)
+* Update version in recommendation to add after_commit_everywhere in PR [#729](https://github.com/aasm/aasm/pull/729), thanks to [Envek](https://github.com/Envek)
+* Fix i18n Event translations failing [#721](https://github.com/aasm/aasm/issues/721) in PR [#723](https://github.com/aasm/aasm/pull/723), thanks to [the-spectator](https://github.com/the-spectator)
+* Add documentation to the Readme about how parameters are handled in AASM events in PR [#722](https://github.com/aasm/aasm/pull/722), thanks to [dstuebe](https://github.com/dstuebe)
+* Fix human_state cached across locales [#709](https://github.com/aasm/aasm/issues/709) in PR [716](https://github.com/aasm/aasm/pull/716), thanks to [the-spectator](https://github.com/the-spectator)
+* Relocate DslHelper from root namespace to under AASM namespace in PR [#711](https://github.com/aasm/aasm/pull/711) thank to [yujideveloper ](https://github.com/yujideveloper )
+* Document how to define transitions from any state in in PR [#699](https://github.com/aasm/aasm/pull/699) thanks to [hedgesky](https://github.com/hedgesky)
+* Add simple option for auto-generated timestamps in PR [#677](https://github.com/aasm/aasm/pull/677), thanks to [jaynetics](https://github.com/jaynetics)
+## 5.1.1
+
+* Fix Depreciation message for after_commit_everywhere [#695](https://github.com/aasm/aasm/issues/695) in PR [#696](https://github.com/aasm/aasm/pull/696)
+* Fix human_state to use display option [#684](https://github.com/aasm/aasm/issues/684) in PR [#697](https://github.com/aasm/aasm/pull/697)
+* Remove support for ruby 2.3
+
+## 5.1.0
+
+* Fix after_commit in nested transactions [#536](https://github.com/aasm/aasm/issues/536) without explicit AR dependency in PR [#668](https://github.com/aasm/aasm/pull/668), thanks to [stokarenko](https://github.com/stokarenko)
+* Remove support for Rails 3.2
+
+## 5.0.8
+
+* Revert Fix for :after_commit within nested transaction because it adds after_commit_action dependency which is dependent on many gems.
+
+## 5.0.7
+
+* Fix :after_commit within nested transaction [#666](https://github.com/aasm/aasm/pull/666), thanks to [stokarenko](https://github.com/stokarenko)
+* Add permitted_transitions to group permitted event with state [#664](https://github.com/aasm/aasm/pull/664), thanks to [dnamsons](https://github.com/dnamsons)
+* Add Ruby 2.7.0 & 2.6.5 to Travis CI Test Matrix [#661](https://github.com/aasm/aasm/pull/661), thanks to [the-spectator](https://github.com/the-spectator)
+* Handle InvalidTransition in transition_from matcher [#653](https://github.com/aasm/aasm/pull/653), thanks to [ryanwood](https://github.com/ryanwood)
 
 ## 5.0.6
 

data/Gemfile

@@ -3,4 +3,4 @@ source "https://rubygems.org"
 gemspec
 
 gem 'sqlite3', '~> 1.3.5', :platforms => :ruby
-gem 'rails', '5.1.4'
+gem 'rails', '5.1.4'

data/README.md

@@ -20,6 +20,7 @@
   - [Extending AASM](#extending-aasm)
   - [ActiveRecord](#activerecord)
   - [Bang events](#bang-events)
+  - [Timestamps](#timestamps)
   - [ActiveRecord enums](#activerecord-enums)
   - [Sequel](#sequel)
   - [Dynamoid](#dynamoid)
@@ -212,15 +213,28 @@ class LogRunTime
 end
 ```
 
-Also, you can pass parameters to events:
+#### Parameters
+You can pass parameters to events:
 
 ```ruby
   job = Job.new
   job.run(:defragmentation)
 ```
 
-In this case the `set_process` would be called with `:defragmentation` argument.
+All guards and after callbacks will receive these parameters. In this case `set_process` would be called with 
+`:defragmentation` argument.
 
+If the first argument to the event is a state (e.g. `:running` or `:finished`), the first argument is consumed and 
+the state machine will attempt to transition to that state. Add comma separated parameter for gaurds and callbacks
+
+```ruby
+  job = Job.new
+  job.run(:running, :defragmentation)
+```
+In this case `set_process` won't be called, job will transition to running state and callback will receive 
+:defragmentation as parameter
+
+#### Error Handling
 In case of an error during the event processing the error is rescued and passed to `:error`
 callback, which can handle it or re-raise it for further propagation.
 
@@ -260,8 +274,8 @@ begin
   new_state       enter
   ...update state...
   event           before_success      # if persist successful
-  transition      success             # if persist successful
-  event           success             # if persist successful
+  transition      success             # if persist successful, database update not guaranteed
+  event           success             # if persist successful, database update not guaranteed
   old_state       after_exit
   new_state       after_enter
   event           after
@@ -275,6 +289,8 @@ ensure
 end
 ```
 
+Use event's `after_commit` callback if it should be fired after database update.
+
 #### The current event triggered
 
 While running the callbacks you can easily retrieve the name of the event triggered
@@ -432,16 +448,43 @@ job.stage1_completed
 job.aasm.current_state # stage3
 ```
 
+You can define transition from any defined state by omitting `from`:
+
+```ruby
+event :abort do
+  transitions to: :aborted
+end
+```
+
+### Display name for state
+
+You can define display name for state using :display option
+
+```ruby
+class Job
+  include AASM
+
+  aasm do
+    state :stage1, initial: true, display: 'First Stage'
+    state :stage2
+    state :stage3
+  end
+end
+
+job = Job.new
+job.aasm.human_state
+
+```
 
 ### Multiple state machines per class
 
 Multiple state machines per class are supported. Be aware though that _AASM_ has been
-built with one state machine per class in mind. Nonetheless, here's how to do it:
+built with one state machine per class in mind. Nonetheless, here's how to do it (see below). Please note that you will need to specify database columns for where your pertinent states will be stored - we have specified two columns `move_state` and `work_state` in the example below. See the [Column name & migration](https://github.com/aasm/aasm#column-name--migration) section for further info.
 
 ```ruby
 class SimpleMultipleExample
   include AASM
-  aasm(:move) do
+  aasm(:move, column: 'move_state') do
     state :standing, initial: true
     state :walking
     state :running
@@ -457,7 +500,7 @@ class SimpleMultipleExample
     end
   end
 
-  aasm(:work) do
+  aasm(:work, column: 'work_state') do
     state :sleeping, initial: true
     state :processing
 
@@ -474,13 +517,13 @@ simple = SimpleMultipleExample.new
 
 simple.aasm(:move).current_state
 # => :standing
-simple.aasm(:work).current
+simple.aasm(:work).current_state
 # => :sleeping
 
 simple.start
 simple.aasm(:move).current_state
 # => :standing
-simple.aasm(:work).current
+simple.aasm(:work).current_state
 # => :processing
 
 ```
@@ -677,6 +720,8 @@ end
 AASM comes with support for ActiveRecord and allows automatic persisting of the object's
 state in the database.
 
+Add `gem 'after_commit_everywhere', '~> 1.0'` to your Gemfile.
+
 ```ruby
 class Job < ActiveRecord::Base
   include AASM
@@ -777,6 +822,37 @@ job.aasm_state = :running # => raises AASM::NoDirectAssignmentError
 job.aasm_state # => 'sleeping'
 ```
 
+### Timestamps
+
+You can tell _AASM_ to try to write a timestamp whenever a new state is entered.
+If `timestamps: true` is set, _AASM_ will look for a field named like the new state plus `_at` and try to fill it:
+
+```ruby
+class Job < ActiveRecord::Base
+  include AASM
+
+  aasm timestamps: true do
+    state :sleeping, initial: true
+    state :running
+
+    event :run do
+      transitions from: :sleeping, to: :running
+    end
+  end
+end
+```
+
+resulting in this:
+
+```ruby
+job = Job.create
+job.running_at # => nil
+job.run!
+job.running_at # => 2020-02-20 20:00:00
+```
+
+Missing timestamp fields are silently ignored, so it is not necessary to have setters (such as ActiveRecord columns) for *all* states when using this option.
+
 #### ActiveRecord enums
 
 You can use
@@ -981,6 +1057,12 @@ job.run
 job.save! #notify_about_running_job is not run
 ```
 
+Please note that `:after_commit` AASM callbacks behaves around custom implementation
+of transaction pattern rather than a real-life DB transaction. This fact still causes
+the race conditions and redundant callback calls within nested transaction. In order
+to fix that it's highly recommended to add `gem 'after_commit_everywhere', '~> 1.0'`
+to your `Gemfile`.
+
 If you want to encapsulate state changes within an own transaction, the behavior
 of this nested transaction might be confusing. Take a look at
 [ActiveRecord Nested Transactions](http://api.rubyonrails.org/classes/ActiveRecord/Transactions/ClassMethods.html)
@@ -1065,18 +1147,21 @@ this by defining your favorite column name, using `:column` like this:
 class Job < ActiveRecord::Base
   include AASM
 
-  aasm column: 'my_state' do
+  aasm column: :my_state do
     ...
   end
 
-  aasm :another_state_machine, column: 'second_state' do
+  aasm :another_state_machine, column: :second_state do
     ...
   end
 end
 ```
 
 Whatever column name is used, make sure to add a migration to provide this column
-(of type `string`):
+(of type `string`).
+Do not add default value for column at the database level. If you add default
+value in database then AASM callbacks on the initial state will not be fired upon 
+instantiation of the model.
 
 ```ruby
 class AddJobState < ActiveRecord::Migration
@@ -1092,7 +1177,7 @@ end
 
 ### Log State Changes
 
-Logging state change can be done using [paper_trail](https://github.com/paper-trail-gem/paper_trail) gem 
+Logging state change can be done using [paper_trail](https://github.com/paper-trail-gem/paper_trail) gem
 
 Example of implementation can be found here [https://github.com/nitsujri/aasm-papertrail-example](https://github.com/nitsujri/aasm-papertrail-example)
 
@@ -1141,6 +1226,10 @@ job = Job.new
 job.aasm.states(permitted: true).map(&:name)
 #=> [:running]
 
+# List all the permitted transitions(event and state pairs) from initial state
+job.aasm.permitted_transitions
+#=> [{ :event => :run, :state => :running }]
+
 job.run
 job.aasm.states(permitted: true).map(&:name)
 #=> [:sleeping]

data/aasm.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'generator_spec'
   s.add_development_dependency 'appraisal'
   s.add_development_dependency "simplecov"
-  s.add_development_dependency "codecov", ">= 0.1.10"
+  s.add_development_dependency "codecov", ">= 0.1.21"
 
   # debugging
   # s.add_development_dependency 'debugger'

data/gemfiles/norails.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", "~> 1.3.5", platforms: :ruby
+gem "sqlite3", "~> 1.3", ">= 1.3.5", platforms: :ruby
 gem "rails", install_if: false
 gem "sequel"
 gem "redis-objects"

data/gemfiles/rails_4.2.gemfile

@@ -12,5 +12,6 @@ gem "dynamoid", "~> 1", platforms: :ruby
 gem "aws-sdk", "~> 2", platforms: :ruby
 gem "redis-objects"
 gem "activerecord-jdbcsqlite3-adapter", "1.3.24", platforms: :jruby
+gem "after_commit_everywhere", "~> 1.0"
 
 gemspec path: "../"

data/gemfiles/rails_4.2_mongoid_5.gemfile

@@ -7,5 +7,6 @@ gem "rails", "4.2.5"
 gem "mime-types", "~> 2", platforms: [:ruby_19, :jruby]
 gem "mongoid", "~> 5.0"
 gem "activerecord-jdbcsqlite3-adapter", "1.3.24", platforms: :jruby
+gem "after_commit_everywhere", "~> 1.0"
 
 gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -9,5 +9,6 @@ gem "sequel"
 gem "dynamoid", "~> 1.3", platforms: :ruby
 gem "aws-sdk", "~> 2", platforms: :ruby
 gem "redis-objects"
+gem "after_commit_everywhere", "~> 1.0"
 
 gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -9,5 +9,6 @@ gem "sequel"
 gem "dynamoid", "~> 1.3", platforms: :ruby
 gem "aws-sdk", "~>2", platforms: :ruby
 gem "redis-objects"
+gem "after_commit_everywhere", "~> 1.0"
 
 gemspec path: "../"