aasm 5.0.5 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6e702f783991a9de8f199c63ef2872f9929cde73
-  data.tar.gz: 9a1339c1f9e22d9bd7f00f6aabb493e303b1549e
+SHA256:
+  metadata.gz: f2f4099a66f8d753c2bd7c06b3c378dcd37b47acf9b2f7487784e7762742c1c4
+  data.tar.gz: 8971b36f1b066c08d3a4d278a99d7c1e5386be72182da62b51a82db1e60e9e9f
 SHA512:
-  metadata.gz: 7b34c93b3e939d6803fb3f7987ba2510fb33be577ac786140474d36305441829ea4b8318ee034dea4a005ed365d4d4930d6d9f3d4847902fdb77a1e85d5210e7
-  data.tar.gz: 801b5dee037527de96cbf156eeebe6e92e216ce9bea97c9edf2bdd6e52790c66ff0e7186839afcb6d6a91ee3992028206f0b94089753380ba3d5701f68cb7312
+  metadata.gz: c24e544b82cfc4616f3e3ff033b7a5ab68bff7bd834b115797e9127ca361effe241ffb1adaedcdb595711a6757f2e0a8e0a8d606a9bc812c28707a1ee845ef40
+  data.tar.gz: 421636d1e59e52b8d6b4ddff7dd373fecd9a19ef67b90935e856b1ee980bae9a5a4a8526e62238de9ecc84a7783362e8d5b2005c53b9c7754368be79724c6255

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.travis.yml

@@ -2,6 +2,9 @@ sudo: false
 language: ruby
 cache: bundler
 
+jdk:
+  - openjdk8
+
 before_install:
   - rvm list
   - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
@@ -9,25 +12,25 @@ 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:
   - mongodb
   - redis-server
 
-addons:
-  rethinkdb: '2.3.6'
+#addons:
+#  rethinkdb: '2.3.4'
 
 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
+#  - gemfiles/rails_4.2_nobrainer.gemfile
   - gemfiles/rails_5.0.gemfile
-  - gemfiles/rails_5.0_nobrainer.gemfile
+#  - gemfiles/rails_5.0_nobrainer.gemfile
   - gemfiles/rails_5.1.gemfile
   - gemfiles/rails_5.2.gemfile
 
@@ -43,24 +46,24 @@ 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.5.0
-      gemfile: gemfiles/rails_4.2_nobrainer.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
       gemfile: gemfiles/norails.gemfile
     - rvm: jruby-9.1.12.0
@@ -69,10 +72,10 @@ matrix:
       gemfile: gemfiles/rails_5.1.gemfile
     - rvm: jruby-9.1.12.0
       gemfile: gemfiles/rails_5.2.gemfile
-    - rvm: jruby-9.1.12.0
-      gemfile: gemfiles/rails_4.2_nobrainer.gemfile
-    - rvm: jruby-9.1.12.0
-      gemfile: gemfiles/rails_5.0_nobrainer.gemfile
+#    - rvm: jruby-9.1.12.0
+#      gemfile: gemfiles/rails_4.2_nobrainer.gemfile
+#    - rvm: jruby-9.1.12.0
+#      gemfile: gemfiles/rails_5.0_nobrainer.gemfile
 
 notifications:
   slack:

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", "~> 0.1", ">= 0.1.5"
 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", "~> 0.1", ">= 0.1.5"
 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", "~> 0.1", ">= 0.1.5"
 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", "~> 0.1", ">= 0.1.5"
 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", "~> 0.1", ">= 0.1.5"
 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

@@ -2,6 +2,36 @@
 
 ## unreleased
 
+## 5.1.0
+
+* 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
+
+* Fix no_direct_assignment, couldn't be turned off pragmatically [#636](https://github.com/aasm/aasm/issues/636)
+* Add instance level validation skip option [#644](https://github.com/aasm/aasm/pull/644), thanks to [Nitin-Salunke](https://github.com/Nitin-Salunke)
+* Fixed aasm.current_event incorrectly yields nil when calling aasm.fire!(:event) [#551](https://github.com/aasm/aasm/issues/551) in [#638](https://github.com/aasm/aasm/pull/638), thanks to [DoubleJarvis](https://github.com/DoubleJarvis)
+* Code Refactor [#634](https://github.com/aasm/aasm/pull/634) , thanks to [rahulknojha](https://github.com/rahulknojha)
+* Fixed callback argument for :before_success & :success callback, [#630](https://github.com/aasm/aasm/pull/630)
+
 ## 5.0.5
 
 * Independent of ActiveSupport methods, [#627](https://github.com/aasm/aasm/pull/627),

data/Dockerfile

@@ -1,9 +1,4 @@
-ARG RVM_RUBY_VERSIONS="2.4.0 2.5.0"
-ARG RVM_RUBY_DEFAULT="2.4.0"
-FROM msati/docker-rvm
-
-# After Ruby versions are installed we continue as non-root rvm user
-USER ${RVM_USER}
+FROM ruby:2.3.4-slim
 
 LABEL maintainer="AASM"
 

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

@@ -3,6 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/aasm.svg)](http://badge.fury.io/rb/aasm)
 [![Build Status](https://travis-ci.org/aasm/aasm.svg?branch=master)](https://travis-ci.org/aasm/aasm)
 [![Code Climate](https://codeclimate.com/github/aasm/aasm/badges/gpa.svg)](https://codeclimate.com/github/aasm/aasm)
+[![codecov](https://codecov.io/gh/aasm/aasm/branch/master/graph/badge.svg)](https://codecov.io/gh/aasm/aasm)
 
 ## Index
 - [Upgrade from version 3 to 4](#upgrade-from-version-3-to-4)
@@ -29,6 +30,7 @@
   - [Transaction support](#transaction-support)
   - [Pessimistic Locking](#pessimistic-locking)
   - [Column name & migration](#column-name--migration)
+  - [Log State Changes](#log-state-changes)
   - [Inspection](#inspection)
   - [Warning output](#warning-output)
   - [RubyMotion support](#rubymotion-support)
@@ -214,13 +216,11 @@ Also, you can pass parameters to events:
 
 ```ruby
   job = Job.new
-  job.run(:running, :defragmentation)
+  job.run(:defragmentation)
 ```
 
 In this case the `set_process` would be called with `:defragmentation` argument.
 
-Note that when passing arguments to a state transition, the first argument should be the desired end state. In the above example, we wish to transition to `:running` state and run the callback with `:defragmentation` argument. You can also omit or pass in `nil` as the desired end state, and AASM will try to transition to the first end state defined for that event.
-
 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 +260,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 +275,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 +434,35 @@ job.stage1_completed
 job.aasm.current_state # stage3
 ```
 
+### 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 +478,7 @@ class SimpleMultipleExample
     end
   end
 
-  aasm(:work) do
+  aasm(:work, column: 'work_state') do
     state :sleeping, initial: true
     state :processing
 
@@ -677,6 +698,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', '~> 0.1', '>= 0.1.5'` to your Gemfile 
+
 ```ruby
 class Job < ActiveRecord::Base
   include AASM
@@ -741,6 +764,14 @@ class Job < ActiveRecord::Base
 end
 ```
 
+Also You can skip the validation at instance level with `some_event_name_without_validation!` method.
+With this you have the flexibility of having validation for all your transitions by default and then skip it wherever required.
+Please note that only state column will be updated as mentioned in the above example.
+
+```ruby
+job.run_without_validation!
+```
+
 If you want to make sure that the _AASM_ column for storing the state is not directly assigned,
 configure _AASM_ to not allow direct assignment, like this:
 
@@ -973,6 +1004,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', '~> 0.1', '>= 0.1.5'`
+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)
@@ -1057,18 +1094,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
@@ -1082,6 +1122,13 @@ class AddJobState < ActiveRecord::Migration
 end
 ```
 
+### Log State Changes
+
+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)
+
+
 ### Inspection
 
 AASM supports query methods for states and events
@@ -1126,6 +1173,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]
@@ -1193,7 +1244,7 @@ the 'instance method symbol / string' way whenever possible when defining guardi
 #### RSpec
 
 AASM provides some matchers for [RSpec](http://rspec.info):
-*`transition_from`,
+* `transition_from`,
 * `have_state`, `allow_event`
 * and `allow_transition_to`.