aasm 4.12.3 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 485dd737c1e66c6abf9ad6beec5b88610e282cf5
-  data.tar.gz: dc4e4de44fbb182924bc28b13aff6708766f2cfc
+SHA256:
+  metadata.gz: f2f4099a66f8d753c2bd7c06b3c378dcd37b47acf9b2f7487784e7762742c1c4
+  data.tar.gz: 8971b36f1b066c08d3a4d278a99d7c1e5386be72182da62b51a82db1e60e9e9f
 SHA512:
-  metadata.gz: 8211acf5c307b6c04b04ff0aad09aecece63d8df1fc6dbe3de14e363ab415a1e0291510b2d4783cf9cd22391415a25e4ac72d7f43f35ea612b60f939ab6def2a
-  data.tar.gz: a95bd160171a94dfc8ac1a4de0594372c336cf546f38727cacc95ca73af43369419bc6b3637634faa02b7eae6b8c668d29c5b74a5eb930aba4a03af190f8364a
+  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,23 +2,37 @@ sudo: false
 language: ruby
 cache: bundler
 
+jdk:
+  - openjdk8
+
+before_install:
+  - rvm list
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '1.16.1'
+  - bundle _1.16.1_ install
+
 rvm:
-  - 1.9.3
-  - 2.2.6
-  - 2.3.3
-  - jruby-1.7 # JRuby in 1.9 mode
-  - jruby-9.0.5.0
+  - 2.5.0
+  - 2.6.5
+  - 2.7.0
+  - jruby-9.1.12.0
 
 services:
   - mongodb
   - redis-server
 
+#addons:
+#  rethinkdb: '2.3.4'
+
 gemfile:
-  - gemfiles/rails_3.2.gemfile
-  - gemfiles/rails_4.0.gemfile
+  - gemfiles/norails.gemfile
   - gemfiles/rails_4.2.gemfile
   - gemfiles/rails_4.2_mongoid_5.gemfile
+#  - gemfiles/rails_4.2_nobrainer.gemfile
   - gemfiles/rails_5.0.gemfile
+#  - gemfiles/rails_5.0_nobrainer.gemfile
+  - gemfiles/rails_5.1.gemfile
+  - gemfiles/rails_5.2.gemfile
 
 before_script:
   - mkdir /tmp/dynamodb
@@ -32,20 +46,36 @@ script:
 
 matrix:
   exclude:
-    - rvm: 1.9.3
+    - 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_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: 1.9.3
-      gemfile: gemfiles/rails_5.0.gemfile
-    - rvm: 2.2.6
-      gemfile: gemfiles/rails_3.2.gemfile
-    - rvm: 2.3.3
-      gemfile: gemfiles/rails_3.2.gemfile
-    - rvm: jruby-1.7
+    - rvm: 2.6.5
       gemfile: gemfiles/rails_4.2_mongoid_5.gemfile
-    - rvm: jruby-1.7
-      gemfile: gemfiles/rails_5.0.gemfile
-    - rvm: jruby-9.0.5.0
+    - 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
       gemfile: gemfiles/rails_5.0.gemfile
+    - rvm: jruby-9.1.12.0
+      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
 
 notifications:
   slack:

data/Appraisals

@@ -1,43 +1,67 @@
-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'
-end
-
-appraise 'rails_4.0' do
-  gem 'mime-types', '~> 2',               :platforms => [:ruby_19, :jruby]
-  gem 'rails', '4.0.13'
-  gem 'mongoid', '~>4.0'
+appraise 'rails_4.2' do
+  gem 'nokogiri', '1.6.8.1', platforms: %i[ruby_19]
+  gem 'mime-types', '~> 2', platforms: %i[ruby_19 jruby]
+  gem 'rails', '4.2.5'
+  gem 'mongoid', '~> 4.0'
   gem 'sequel'
-  gem 'dynamoid', '~> 1',                 :platforms => :ruby
-  gem 'aws-sdk', '~>2',                   :platforms => :ruby
+  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", "~> 0.1", ">= 0.1.5"
 end
 
-appraise 'rails_4.2' do
-  gem 'nokogiri', '1.6.8.1',              :platforms => [:ruby_19]
-  gem 'mime-types', '~> 2',               :platforms => [:ruby_19, :jruby]
+appraise 'rails_4.2_nobrainer' do
   gem 'rails', '4.2.5'
-  gem 'mongoid', '~>4.0'
-  gem 'sequel'
-  gem 'dynamoid', '~> 1',                 :platforms => :ruby
-  gem 'aws-sdk', '~>2',                   :platforms => :ruby
-  gem 'redis-objects'
+  gem 'nobrainer', '~> 0.33.0'
 end
 
 appraise 'rails_4.2_mongoid_5' do
-  gem 'mime-types', '~> 2',               :platforms => [:ruby_19, :jruby]
+  gem 'mime-types', '~> 2', platforms: %i[ruby_19 jruby]
   gem 'rails', '4.2.5'
-  gem 'mongoid', '~>5.0'
+  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
   gem 'rails', '5.0.0'
+  gem 'mongoid', '~> 6.0'
+  gem 'sequel'
+  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
+  gem 'rails', '5.0.0'
+  gem 'nobrainer', '~> 0.33.0'
+end
+
+appraise 'rails_5.1' do
+  gem 'rails', '5.1'
+  gem 'mongoid', '~>6.0'
+  gem 'sequel'
+  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
+  gem 'rails', '5.2'
   gem 'mongoid', '~>6.0'
   gem 'sequel'
-  gem 'dynamoid', '~> 1',                 :platforms => :ruby
-  gem 'aws-sdk', '~>2',                   :platforms => :ruby
+  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'
 end

data/CHANGELOG.md

@@ -1,6 +1,78 @@
 # CHANGELOG
 
 ## 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),
+thanks to [tristandruyen](https://github.com/tristandruyen). Fixes [#508](https://github.com/aasm/aasm/issues/508)
+
+## 5.0.4
+
+* Specify dynamoid version for Rails > 5, [#625](https://github.com/aasm/aasm/pull/625),
+thanks to [waghanza](https://github.com/waghanza)
+* Add travis runner for Rails 5.2, [#624](https://github.com/aasm/aasm/pull/624), thanks
+to [waghanza](https://github.com/waghanza)
+* Cleanup Abstract class issue, [#620](https://github.com/aasm/aasm/pull/620), thanks to
+[dennym](https://github.com/dennym)
+
+## 5.0.3
+
+* Fix Abstract class issue, [#619](https://github.com/aasm/aasm/pull/619)
+
+## 5.0.2
+
+* Clear failed callbacks, [#600](https://github.com/aasm/aasm/pull/600), thanks to
+[nedgar](https://github.com/nedgar)
+* README improvements, [#594](https://github.com/aasm/aasm/pull/594),
+[#589](https://github.com/aasm/aasm/pull/589), [#587](https://github.com/aasm/aasm/pull/587),
+[#597](https://github.com/aasm/aasm/pull/597), thanks to [jackscotti](https://github.com/jackscotti), [krmbzds](https://github.com/krmbzds),
+[zegomesjf](https://github.com/zegomesjf), [BKSpurgeon](https://github.com/BKSpurgeon)
+* Update InvalidTransition to include state_machine_name [#592](https://github.com/aasm/aasm/pull/592), thanks to [a14m](https://github.com/a14m)
+* Do not add migration if model and column already exists [#586](https://github.com/aasm/aasm/pull/586), thanks to [KiranJosh](https://github.com/KiranJosh)
+
+## 5.0.1
+
+* Fix failures array in transition not being reset [#383](https://github.com/aasm/aasm/issues/383)
+* Enable AASM scopes to be defined on abstract classes.
+
+## 5.0.0
+
+* Chore(invokers): Refactor callback invokers, add class-callbacks support [#541](https://github.com/aasm/aasm/pull/541), thanks to [pandomic](https://github.com/pandomic)
+* Add docker setup to readme
+* Add support for Nobrainer (RethinkDB) [#522](https://github.com/aasm/aasm/pull/522), thanks to [zedtux](https://github.com/zedtux)
+* Patch `allow_event` to accept event with custom arguments [#419](https://github.com/aasm/aasm/pull/419), thanks to [czhc](https://github.com/czhc)
+
 ## 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)
@@ -14,9 +86,9 @@
 
 ## 4.12.1
 
-* DRY-up Mongoid and ActiveRecord Persistence, Add Sequel transactions and locking [#475](https://github.com/aasm/aasm/pull/475), thanks to [@Aryk] (https://github.com/Aryk)
-* Add aliases for event methods [#476](https://github.com/aasm/aasm/pull/476), thanks to [@Aryk] (https://github.com/Aryk)
-* Support Minitest spec expectations [#387](https://github.com/aasm/aasm/pull/387), thanks to [@faragorn] (https://github.com/faragorn)
+* DRY-up Mongoid and ActiveRecord Persistence, Add Sequel transactions and locking [#475](https://github.com/aasm/aasm/pull/475), thanks to [@Aryk](https://github.com/Aryk)
+* Add aliases for event methods [#476](https://github.com/aasm/aasm/pull/476), thanks to [@Aryk](https://github.com/Aryk)
+* Support Minitest spec expectations [#387](https://github.com/aasm/aasm/pull/387), thanks to [@faragorn](https://github.com/faragorn)
 ## 4.12.0
 
  * Fix thread safe issue with concurrent-ruby gem [see [pull-request #422](https://github.com/aasm/aasm/pull/442), thanks to [@reidmorrison](https://github.com/reidmorrison)

data/Dockerfile

@@ -0,0 +1,44 @@
+FROM ruby:2.3.4-slim
+
+LABEL maintainer="AASM"
+
+ENV DEBIAN_FRONTEND noninteractive
+
+# ~~~~ System locales ~~~~
+RUN apt-get update && apt-get install -y locales && \
+    dpkg-reconfigure locales && \
+    locale-gen C.UTF-8 && \
+    /usr/sbin/update-locale LANG=C.UTF-8 && \
+    echo 'en_US.UTF-8 UTF-8' >> /etc/locale.gen && \
+    locale-gen
+
+# Set default locale for the environment
+ENV LC_ALL C.UTF-8
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US.UTF-8
+ENV APP_HOME /application
+
+# ~~~~ Application dependencies ~~~~
+RUN apt-get update
+RUN apt-get install -y libsqlite3-dev \
+                       build-essential \
+                       git
+
+# ~~~~ Bundler ~~~~
+RUN gem install bundler
+
+WORKDIR $APP_HOME
+RUN mkdir -p $APP_HOME/lib/aasm/
+
+COPY Gemfile* $APP_HOME/
+COPY *.gemspec $APP_HOME/
+COPY lib/aasm/version.rb $APP_HOME/lib/aasm/
+
+ENV BUNDLE_GEMFILE=$APP_HOME/Gemfile \
+  BUNDLE_JOBS=8 \
+  BUNDLE_PATH=/bundle
+
+RUN bundle install
+
+# ~~~~ Import application ~~~~
+COPY . $APP_HOME

data/Gemfile

@@ -2,6 +2,5 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'sqlite3',                          :platforms => :ruby
-gem 'activerecord-jdbcsqlite3-adapter', :platforms => :jruby
-gem 'rails', '5.1.3'
+gem 'sqlite3', '~> 1.3.5', :platforms => :ruby
+gem 'rails', '5.1.4'

data/README.md

@@ -2,8 +2,8 @@
 
 [![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)
-[![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)
+[![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)
@@ -24,11 +24,13 @@
   - [Sequel](#sequel)
   - [Dynamoid](#dynamoid)
   - [Mongoid](#mongoid)
+  - [Nobrainer](#nobrainer)
   - [Redis](#redis)
   - [Automatic Scopes](#automatic-scopes)
   - [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)
@@ -42,6 +44,7 @@
    - [Bundler](#or-if-you-are-using-bundler)
    - [Building your own gems](#building-your-own-gems)
   - [Generators](#generators)
+  - [Test suite with Docker](#docker)
   - [Latest changes](#latest-changes)
   - [Questions?](#questions)
   - [Maintainers](#maintainers)
@@ -52,10 +55,8 @@
 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. It currently provides adapters for
-[ActiveRecord](http://api.rubyonrails.org/classes/ActiveRecord/Base.html),
-and [Mongoid](http://mongoid.org/) but it can be used for any Ruby class, no matter what
-parent class it has (if any).
+that no longer targets only ActiveRecord models. It currently provides adapters for many
+ORMs but it can be used for any Ruby class, no matter what parent class it has (if any).
 
 ## Upgrade from version 3 to 4
 
@@ -71,19 +72,19 @@ class Job
   include AASM
 
   aasm do
-    state :sleeping, :initial => true
+    state :sleeping, initial: true
     state :running, :cleaning
 
     event :run do
-      transitions :from => :sleeping, :to => :running
+      transitions from: :sleeping, to: :running
     end
 
     event :clean do
-      transitions :from => :running, :to => :cleaning
+      transitions from: :running, to: :cleaning
     end
 
     event :sleep do
-      transitions :from => [:running, :cleaning], :to => :sleeping
+      transitions from: [:running, :cleaning], to: :sleeping
     end
   end
 
@@ -109,7 +110,7 @@ AASM not to be *whiny*:
 ```ruby
 class Job
   ...
-  aasm :whiny_transitions => false do
+  aasm whiny_transitions: false do
     ...
   end
 end
@@ -130,27 +131,27 @@ the transition succeeds :
 
 ### Callbacks
 
-You can define a number of callbacks for your transitions. These methods will be
-called, when certain criteria are met, like entering a particular state:
+You can define a number of callbacks for your events, transitions and states. These methods, Procs or classes will be
+called when certain criteria are met, like entering a particular state:
 
 ```ruby
 class Job
   include AASM
 
   aasm do
-    state :sleeping, :initial => true, :before_enter => :do_something
-    state :running
+    state :sleeping, initial: true, before_enter: :do_something
+    state :running, before_enter: Proc.new { do_something && notify_somebody }
     state :finished
 
     after_all_transitions :log_status_change
 
-    event :run, :after => :notify_somebody do
+    event :run, after: :notify_somebody do
       before do
         log('Preparing to run')
       end
 
-      transitions :from => :sleeping, :to => :running, :after => Proc.new {|*args| set_process(*args) }
-      transitions :from => :running, :to => :finished, :after => LogRunTime
+      transitions from: :sleeping, to: :running, after: Proc.new {|*args| set_process(*args) }
+      transitions from: :running, to: :finished, after: LogRunTime
     end
 
     event :sleep do
@@ -160,7 +161,7 @@ class Job
       error do |e|
         ...
       end
-      transitions :from => :running, :to => :sleeping
+      transitions from: :running, to: :sleeping
     end
   end
 
@@ -195,6 +196,8 @@ is finished.
 
 AASM will also initialize `LogRunTime` and run the `call` method for you after the transition from `running` to `finished` in the example above. You can pass arguments to the class by defining an initialize method on it, like this:
 
+Note that Procs are executed in the context of a record, it means that you don't need to expect the record as an argument, just call the methods you need.
+
 ```ruby
 class LogRunTime
   # optional args parameter can be omitted, but if you define initialize
@@ -213,19 +216,17 @@ 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 must 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 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.
 
 Also, you can define a method that will be called if any event fails:
 
-```
+```ruby
 def aasm_event_failed(event_name, old_state_name)
   # use custom exception/messages, report metrics, etc
 end
@@ -259,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
@@ -274,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
@@ -311,24 +314,24 @@ class Cleaner
   include AASM
 
   aasm do
-    state :idle, :initial => true
+    state :idle, initial: true
     state :cleaning
 
     event :clean do
-      transitions :from => :idle, :to => :cleaning, :guard => :cleaning_needed?
+      transitions from: :idle, to: :cleaning, guard: :cleaning_needed?
     end
 
     event :clean_if_needed do
-      transitions :from => :idle, :to => :cleaning do
+      transitions from: :idle, to: :cleaning do
         guard do
           cleaning_needed?
         end
       end
-      transitions :from => :idle, :to => :idle
+      transitions from: :idle, to: :idle
     end
 
     event :clean_if_dirty do
-      transitions :from => :idle, :to => :cleaning, :guard => :if_dirty?
+      transitions from: :idle, to: :cleaning, guard: :if_dirty?
     end
   end
 
@@ -357,16 +360,16 @@ You can even provide a number of guards, which all have to succeed to proceed
     def walked_the_dog?; ...; end
 
     event :sleep do
-      transitions :from => :running, :to => :sleeping, :guards => [:cleaning_needed?, :walked_the_dog?]
+      transitions from: :running, to: :sleeping, guards: [:cleaning_needed?, :walked_the_dog?]
     end
 ```
 
 If you want to provide guards for all transitions within an event, you can use event guards
 
 ```ruby
-    event :sleep, :guards => [:walked_the_dog?] do
-      transitions :from => :running, :to => :sleeping, :guards => [:cleaning_needed?]
-      transitions :from => :cleaning, :to => :sleeping
+    event :sleep, guards: [:walked_the_dog?] do
+      transitions from: :running, to: :sleeping, guards: [:cleaning_needed?]
+      transitions from: :cleaning, to: :sleeping
     end
 ```
 
@@ -374,15 +377,30 @@ If you prefer a more Ruby-like guard syntax, you can use `if` and `unless` as we
 
 ```ruby
     event :clean do
-      transitions :from => :running, :to => :cleaning, :if => :cleaning_needed?
+      transitions from: :running, to: :cleaning, if: :cleaning_needed?
     end
 
     event :sleep do
-      transitions :from => :running, :to => :sleeping, :unless => :cleaning_needed?
+      transitions from: :running, to: :sleeping, unless: :cleaning_needed?
     end
   end
 ```
 
+You can invoke a Class instead a method since this Class responds to `call`
+
+```ruby
+    event :sleep do
+      transitions from: :running, to: :sleeping, guards: Dog
+    end
+```
+```ruby
+  class Dog
+    def call
+      cleaning_needed? && walked?
+    end
+    ...
+  end
+```
 
 ### Transitions
 
@@ -395,7 +413,7 @@ class Job
   include AASM
 
   aasm do
-    state :stage1, :initial => true
+    state :stage1, initial: true
     state :stage2
     state :stage3
     state :completed
@@ -416,40 +434,59 @@ 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
-    state :standing, :initial => true
+  aasm(:move, column: 'move_state') do
+    state :standing, initial: true
     state :walking
     state :running
 
     event :walk do
-      transitions :from => :standing, :to => :walking
+      transitions from: :standing, to: :walking
     end
     event :run do
-      transitions :from => [:standing, :walking], :to => :running
+      transitions from: [:standing, :walking], to: :running
     end
     event :hold do
-      transitions :from => [:walking, :running], :to => :standing
+      transitions from: [:walking, :running], to: :standing
     end
   end
 
-  aasm(:work) do
-    state :sleeping, :initial => true
+  aasm(:work, column: 'work_state') do
+    state :sleeping, initial: true
     state :processing
 
     event :start do
-      transitions :from => :sleeping, :to => :processing
+      transitions from: :sleeping, to: :processing
     end
     event :stop do
-      transitions :from => :processing, :to => :sleeping
+      transitions from: :processing, to: :sleeping
     end
   end
 end
@@ -482,28 +519,28 @@ Alternatively, you can provide a namespace for each state machine:
 class NamespacedMultipleExample
   include AASM
   aasm(:status) do
-    state :unapproved, :initial => true
+    state :unapproved, initial: true
     state :approved
 
     event :approve do
-      transitions :from => :unapproved, :to => :approved
+      transitions from: :unapproved, to: :approved
     end
 
     event :unapprove do
-      transitions :from => :approved, :to => :unapproved
+      transitions from: :approved, to: :unapproved
     end
   end
 
   aasm(:review_status, namespace: :review) do
-    state :unapproved, :initial => true
+    state :unapproved, initial: true
     state :approved
 
     event :approve do
-      transitions :from => :unapproved, :to => :approved
+      transitions from: :unapproved, to: :approved
     end
 
     event :unapprove do
-      transitions :from => :approved, :to => :unapproved
+      transitions from: :approved, to: :unapproved
     end
   end
 end
@@ -523,7 +560,7 @@ All _AASM_ class- and instance-level `aasm` methods accept a state machine selec
 So, for example, to use inspection on a class level, you have to use
 
 ```ruby
-SimpleMultipleExample.aasm(:work).states
+SimpleMultipleExample.aasm(:move).states.map(&:name)
 # => [:standing, :walking, :running]
 ```
 
@@ -535,26 +572,26 @@ class Example
   include AASM
 
   aasm(:work) do
-    state :sleeping, :initial => true
+    state :sleeping, initial: true
     state :processing
 
     event :start do
-      transitions :from => :sleeping, :to => :processing
+      transitions from: :sleeping, to: :processing
     end
     event :stop do
-      transitions :from => :processing, :to => :sleeping
+      transitions from: :processing, to: :sleeping
     end
   end
 
   aasm(:question) do
-    state :answered, :initial => true
+    state :answered, initial: true
     state :asked
 
-    event :ask, :binding_event => :start do
-      transitions :from => :answered, :to => :asked
+    event :ask, binding_event: :start do
+      transitions from: :answered, to: :asked
     end
-    event :answer, :binding_event => :stop do
-      transitions :from => :asked, :to => :answered
+    event :answer, binding_event: :stop do
+      transitions from: :asked, to: :answered
     end
   end
 end
@@ -600,7 +637,7 @@ class CustomAASMBase < AASM::Base
   # A custom transiton that we want available across many AASM models.
   def count_transitions!
     klass.class_eval do
-      aasm :with_klass => CustomAASMBase do
+      aasm with_klass: CustomAASMBase do
         after_all_transitions :increment_transition_count
       end
     end
@@ -630,26 +667,26 @@ class CustomAASMBase < AASM::Base
 end
 ```
 
-When we declare our model that has an AASM state machine, we simply declare the AASM block with a `:with` key to our own class.
+When we declare our model that has an AASM state machine, we simply declare the AASM block with a `:with_klass` key to our own class.
 
 ```ruby
 class SimpleCustomExample
   include AASM
 
   # Let's build an AASM state machine with our custom class.
-  aasm :with_klass => CustomAASMBase do
+  aasm with_klass: CustomAASMBase do
     requires_guards!
     count_transitions!
 
-    state :initialised, :initial => true
+    state :initialised, initial: true
     state :filled_out
     state :authorised
 
     event :fill_out do
-      transitions :from => :initialised, :to => :filled_out, :guard => :fillable?
+      transitions from: :initialised, to: :filled_out, guard: :fillable?
     end
     event :authorise do
-      transitions :from => :filled_out, :to => :authorised, :guard => :authorizable?
+      transitions from: :filled_out, to: :authorised, guard: :authorizable?
     end
   end
 end
@@ -661,20 +698,22 @@ 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
 
   aasm do # default column: aasm_state
-    state :sleeping, :initial => true
+    state :sleeping, initial: true
     state :running
 
     event :run do
-      transitions :from => :sleeping, :to => :running
+      transitions from: :sleeping, to: :running
     end
 
     event :sleep do
-      transitions :from => :running, :to => :sleeping
+      transitions from: :running, to: :sleeping
     end
   end
 
@@ -709,22 +748,30 @@ be updated in the database (just like ActiveRecord `update_column` is working).
 class Job < ActiveRecord::Base
   include AASM
 
-  aasm :skip_validation_on_save => true do
-    state :sleeping, :initial => true
+  aasm skip_validation_on_save: true do
+    state :sleeping, initial: true
     state :running
 
     event :run do
-      transitions :from => :sleeping, :to => :running
+      transitions from: :sleeping, to: :running
     end
 
     event :sleep do
-      transitions :from => :running, :to => :sleeping
+      transitions from: :running, to: :sleeping
     end
   end
 
 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:
 
@@ -732,12 +779,12 @@ configure _AASM_ to not allow direct assignment, like this:
 class Job < ActiveRecord::Base
   include AASM
 
-  aasm :no_direct_assignment => true do
-    state :sleeping, :initial => true
+  aasm no_direct_assignment: true do
+    state :sleeping, initial: true
     state :running
 
     event :run do
-      transitions :from => :sleeping, :to => :running
+      transitions from: :sleeping, to: :running
     end
   end
 
@@ -768,8 +815,8 @@ class Job < ActiveRecord::Base
     running: 99
   }
 
-  aasm :column => :state, :enum => true do
-    state :sleeping, :initial => true
+  aasm column: :state, enum: true do
+    state :sleeping, initial: true
     state :running
   end
 end
@@ -825,6 +872,23 @@ class Job
 end
 ```
 
+### NoBrainer
+
+AASM also supports persistence to [RethinkDB](https://www.rethinkdb.com/)
+if you're using [Nobrainer](http://nobrainer.io/).
+Make sure to include NoBrainer::Document before you include AASM.
+
+```ruby
+class Job
+  include NoBrainer::Document
+  include AASM
+  field :aasm_state
+  aasm do
+    ...
+  end
+end
+```
+
 ### Redis
 
 AASM also supports persistence in Redis via
@@ -851,7 +915,7 @@ class Job < ActiveRecord::Base
   include AASM
 
   aasm do
-    state :sleeping, :initial => true
+    state :sleeping, initial: true
     state :running
     state :cleaning
   end
@@ -880,8 +944,8 @@ defining the `AASM` states, like this:
 class Job < ActiveRecord::Base
   include AASM
 
-  aasm :create_scopes => false do
-    state :sleeping, :initial => true
+  aasm create_scopes: false do
+    state :sleeping, initial: true
     state :running
     state :cleaning
   end
@@ -914,11 +978,11 @@ class Job < ActiveRecord::Base
   include AASM
 
   aasm do
-    state :sleeping, :initial => true
+    state :sleeping, initial: true
     state :running
 
-    event :run, :after_commit => :notify_about_running_job do
-      transitions :from => :sleeping, :to => :running
+    event :run, after_commit: :notify_about_running_job do
+      transitions from: :sleeping, to: :running
     end
   end
 
@@ -940,18 +1004,24 @@ 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)
 if you want to know more about this. Nevertheless, AASM by default requires a new transaction
-`transaction(:requires_new => true)`. You can override this behavior by changing
+`transaction(requires_new: true)`. You can override this behavior by changing
 the configuration
 
 ```ruby
 class Job < ActiveRecord::Base
   include AASM
 
-  aasm :requires_new_transaction => false do
+  aasm requires_new_transaction: false do
     ...
   end
 
@@ -959,7 +1029,7 @@ class Job < ActiveRecord::Base
 end
 ```
 
-which then leads to `transaction(:requires_new => false)`, the Rails default.
+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
@@ -971,7 +1041,7 @@ result of a transaction or callback, even when some error occurs. The
 class Job < ActiveRecord::Base
   include AASM
 
-  aasm :use_transactions => false do
+  aasm use_transactions: false do
     ...
   end
 
@@ -994,7 +1064,7 @@ AASM supports [Active Record pessimistic locking via `with_lock`](http://api.rub
 class Job < ActiveRecord::Base
   include AASM
 
-  aasm :requires_lock => true do
+  aasm requires_lock: true do
     ...
   end
 
@@ -1006,7 +1076,7 @@ end
 class Job < ActiveRecord::Base
   include AASM
 
-  aasm :requires_lock => 'FOR UPDATE NOWAIT' do
+  aasm requires_lock: 'FOR UPDATE NOWAIT' do
     ...
   end
 
@@ -1024,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
@@ -1049,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
@@ -1060,19 +1140,19 @@ class Job
   include AASM
 
   aasm do
-    state :sleeping, :initial => true
+    state :sleeping, initial: true
     state :running, :cleaning
 
     event :run do
-      transitions :from => :sleeping, :to => :running
+      transitions from: :sleeping, to: :running
     end
 
     event :clean do
-      transitions :from => :running, :to => :cleaning, :guard => :cleaning_needed?
+      transitions from: :running, to: :cleaning, guard: :cleaning_needed?
     end
 
     event :sleep do
-      transitions :from => [:running, :cleaning], :to => :sleeping
+      transitions from: [:running, :cleaning], to: :sleeping
     end
   end
 
@@ -1090,15 +1170,19 @@ Job.aasm.states.map(&:name)
 job = Job.new
 
 # show all permitted states (from initial state)
-job.aasm.states(:permitted => true).map(&:name)
+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)
+job.aasm.states(permitted: true).map(&:name)
 #=> [:sleeping]
 
 # show all non permitted states
-job.aasm.states(:permitted => false).map(&:name)
+job.aasm.states(permitted: false).map(&:name)
 #=> [:cleaning]
 
 # show all possible (triggerable) events from the current state
@@ -1106,23 +1190,23 @@ job.aasm.events.map(&:name)
 #=> [:clean, :sleep]
 
 # show all permitted events
-job.aasm.events(:permitted => true).map(&:name)
+job.aasm.events(permitted: true).map(&:name)
 #=> [:sleep]
 
 # show all non permitted events
-job.aasm.events(:permitted => false).map(&:name)
+job.aasm.events(permitted: false).map(&:name)
 #=> [:clean]
 
 # show all possible events except a specific one
-job.aasm.events(:reject => :sleep).map(&:name)
+job.aasm.events(reject: :sleep).map(&:name)
 #=> [:clean]
 
 # list states for select
 Job.aasm.states_for_select
-=> [["Sleeping", "sleeping"], ["Running", "running"], ["Cleaning", "cleaning"]]
+#=> [["Sleeping", "sleeping"], ["Running", "running"], ["Cleaning", "cleaning"]]
 
 # show permitted states with guard parameter
-job.aasm.states({:permitted => true}, guard_parameter).map(&:name)
+job.aasm.states({permitted: true}, guard_parameter).map(&:name)
 ```
 
 
@@ -1135,7 +1219,7 @@ use
 class Job
   include AASM
 
-  aasm :logger => Rails.logger do
+  aasm logger: Rails.logger do
     ...
   end
 end
@@ -1159,7 +1243,15 @@ the 'instance method symbol / string' way whenever possible when defining guardi
 
 #### RSpec
 
-AASM provides some matchers for [RSpec](http://rspec.info): `transition_from`, `have_state`, `allow_event` and `allow_transition_to`. Add `require 'aasm/rspec'` to your `spec_helper.rb` file and use them like this:
+AASM provides some matchers for [RSpec](http://rspec.info):
+* `transition_from`,
+* `have_state`, `allow_event`
+* and `allow_transition_to`.
+
+##### Installation Instructions:
+* Add `require 'aasm/rspec'` to your `spec_helper.rb` file.
+
+##### Examples Of Usage in Rspec:
 
 ```ruby
 # classes with only the default state machine
@@ -1172,7 +1264,7 @@ expect(job).to allow_event :run
 expect(job).to_not allow_event :clean
 expect(job).to allow_transition_to(:running)
 expect(job).to_not allow_transition_to(:cleaning)
-# on_event also accept arguments
+# on_event also accept multiple arguments
 expect(job).to transition_from(:sleeping).to(:running).on_event(:run, :defragmentation)
 
 # classes with multiple state machine
@@ -1193,6 +1285,9 @@ expect(multiple).to allow_event(:start).on(:move)
 expect(multiple).to_not allow_event(:stop).on(:move)
 expect(multiple).to allow_transition_to(:processing).on(:move)
 expect(multiple).to_not allow_transition_to(:sleeping).on(:move)
+# allow_event also accepts arguments
+expect(job).to allow_event(:run).with(:defragmentation)
+
 ```
 
 #### Minitest
@@ -1203,7 +1298,10 @@ AASM provides assertions and rspec-like expectations for [Minitest](https://gith
 
 List of supported assertions: `assert_have_state`, `refute_have_state`, `assert_transitions_from`, `refute_transitions_from`, `assert_event_allowed`, `refute_event_allowed`, `assert_transition_to_allowed`, `refute_transition_to_allowed`.
 
-Add `require 'aasm/minitest' to your `test_helper.rb` file and use them like this:
+
+##### Examples Of Usage (Minitest):
+
+Add `require 'aasm/minitest'` to your `test_helper.rb` file and use them like this:
 
 ```ruby
 # classes with only the default state machine
@@ -1312,6 +1410,14 @@ Replace NAME with the Model name, COLUMN_NAME is optional(default is 'aasm_state
 This will create a model (if one does not exist) and configure it with aasm block.
 For Active record orm a migration file is added to add aasm state column to table.
 
+### Docker
+
+Run test suite easily on docker
+```
+1. docker-compose build aasm
+2. docker-compose run --rm aasm
+```
+
 ## Latest changes ##
 
 Take a look at the [CHANGELOG](https://github.com/aasm/aasm/blob/master/CHANGELOG.md) for details about recent changes to the current version.