aasm 5.0.1 → 5.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea455b8d666bb3c526bec4b9be0736719a3b38a5
-  data.tar.gz: 3987011c8c53b930f369f76399b37194966bd170
+  metadata.gz: 51dfd1ad2a78034c409ddc556625e765260dd067
+  data.tar.gz: f934e43d4a35fc75a06d161190a8794e36066c02
 SHA512:
-  metadata.gz: b35a314d950405db70775b44f8cb06617d5b4987d1f07e586069e19dcab525e761d71551019c53340b622733a8600de5ce238a44cf685854801696203cdda4d0
-  data.tar.gz: 3852368590562313ea46427efb3c41d1f414c9a379e522880d7af472807014350a109ab65c2ebe445dbbd6132cee531375e20bb0fd36a83eea425d4cf054d377
+  metadata.gz: 983b08a4a0977c37dd73b77c5d80d014a05025d7f2841c26788518c82a8e738825ab9fa5fc8a36577e9c6a23fd33cf341c6fefc954630836e213ab40ee12c909
+  data.tar.gz: b091bca286362fb33a31f1b9705840f664ebd0a948c6b2dffbaa2436144c5931a04950080b18e16c1a7d9e4e1b8f517b7ea6c2c133259a3860905928fda32b90

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,27 +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:
-  - 2.2.6
-  - 2.3.3
+  - 2.3.0
+  - 2.5.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.0.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
 
 before_script:
   - mkdir /tmp/dynamodb
@@ -36,18 +46,36 @@ script:
 
 matrix:
   exclude:
-    - rvm: 2.2.6
-      gemfile: gemfiles/rails_3.2.gemfile
-    - rvm: 2.3.3
+    - 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
+      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.5.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_4.2_nobrainer.gemfile
-    - rvm: jruby-9.1.12.0
-      gemfile: gemfiles/rails_5.0_nobrainer.gemfile
+      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

@@ -4,17 +4,7 @@ appraise 'rails_3.2' do
   gem 'sequel'
   gem 'bson_ext', platforms: :ruby
   gem 'test-unit', '~> 3.0'
-  gem 'activerecord-jdbcsqlite3-adapter', '1.3.24', platforms: :jruby
-end
-
-appraise 'rails_4.0' do
-  gem 'mime-types', '~> 2', platforms: %i[ruby_19 jruby]
-  gem 'rails', '4.0.13'
-  gem 'mongoid', '~> 4.0'
-  gem 'sequel'
-  gem 'dynamoid', '~> 1', platforms: :ruby
-  gem 'aws-sdk', '~> 2', platforms: :ruby
-  gem 'redis-objects'
+  gem 'minitest'
   gem 'activerecord-jdbcsqlite3-adapter', '1.3.24', platforms: :jruby
 end
 
@@ -46,7 +36,7 @@ appraise 'rails_5.0' do
   gem 'rails', '5.0.0'
   gem 'mongoid', '~> 6.0'
   gem 'sequel'
-  gem 'dynamoid', '~> 1', platforms: :ruby
+  gem 'dynamoid', '~> 1.3', platforms: :ruby
   gem 'aws-sdk', '~> 2', platforms: :ruby
   gem 'redis-objects'
 end
@@ -60,7 +50,22 @@ appraise 'rails_5.1' do
   gem 'rails', '5.1'
   gem 'mongoid', '~>6.0'
   gem 'sequel'
-  gem 'dynamoid', '~> 1', platforms: :ruby
+  gem 'dynamoid', '~> 1.3', platforms: :ruby
   gem 'aws-sdk', '~>2', platforms: :ruby
   gem 'redis-objects'
 end
+
+appraise 'rails_5.2' do
+  gem 'rails', '5.2'
+  gem 'mongoid', '~>6.0'
+  gem 'sequel'
+  gem 'dynamoid', '~>2.2', platforms: :ruby
+  gem 'aws-sdk', '~>2', platforms: :ruby
+  gem 'redis-objects'
+end
+
+appraise 'norails' do
+  gem 'rails', install_if: false
+  gem 'sequel'
+  gem 'redis-objects'
+end

data/CHANGELOG.md

@@ -2,6 +2,43 @@
 
 ## unreleased
 
+## 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)

data/Gemfile

@@ -2,5 +2,5 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'sqlite3',                          :platforms => :ruby
+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)
@@ -30,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)
@@ -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
@@ -138,19 +139,19 @@ class Job
   include AASM
 
   aasm do
-    state :sleeping, :initial => true, :before_enter => :do_something
+    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
 
@@ -215,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 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.
 
@@ -313,24 +312,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
 
@@ -359,16 +358,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
 ```
 
@@ -376,15 +375,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
 
@@ -397,7 +411,7 @@ class Job
   include AASM
 
   aasm do
-    state :stage1, :initial => true
+    state :stage1, initial: true
     state :stage2
     state :stage3
     state :completed
@@ -428,30 +442,30 @@ built with one state machine per class in mind. Nonetheless, here's how to do it
 class SimpleMultipleExample
   include AASM
   aasm(:move) do
-    state :standing, :initial => true
+    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
+    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
@@ -484,28 +498,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
@@ -537,26 +551,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
@@ -602,7 +616,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
@@ -639,19 +653,19 @@ 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
@@ -668,15 +682,15 @@ 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
 
@@ -711,22 +725,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:
 
@@ -734,12 +756,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
 
@@ -770,8 +792,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
@@ -870,7 +892,7 @@ class Job < ActiveRecord::Base
   include AASM
 
   aasm do
-    state :sleeping, :initial => true
+    state :sleeping, initial: true
     state :running
     state :cleaning
   end
@@ -899,8 +921,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
@@ -933,11 +955,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
 
@@ -963,14 +985,14 @@ 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
 
@@ -978,7 +1000,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
@@ -990,7 +1012,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
 
@@ -1013,7 +1035,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
 
@@ -1025,7 +1047,7 @@ end
 class Job < ActiveRecord::Base
   include AASM
 
-  aasm :requires_lock => 'FOR UPDATE NOWAIT' do
+  aasm requires_lock: 'FOR UPDATE NOWAIT' do
     ...
   end
 
@@ -1043,7 +1065,7 @@ 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
 
@@ -1068,6 +1090,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
@@ -1079,19 +1108,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
 
@@ -1109,15 +1138,15 @@ 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]
 
 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
@@ -1125,23 +1154,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)
 ```
 
 
@@ -1154,7 +1183,7 @@ use
 class Job
   include AASM
 
-  aasm :logger => Rails.logger do
+  aasm logger: Rails.logger do
     ...
   end
 end
@@ -1178,7 +1207,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
@@ -1191,7 +1228,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
@@ -1225,6 +1262,9 @@ 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`.
 
+
+##### Examples Of Usage (Minitest):
+
 Add `require 'aasm/minitest'` to your `test_helper.rb` file and use them like this:
 
 ```ruby