aasm 3.0.24 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a95f430c49bb639c7f0df66dc4ce2998636ef6a
-  data.tar.gz: 67293708b7b6fbaae038e97d229367d0ca074aa8
+  metadata.gz: 90aa17e423f74f9397944f3e941fc539833f4a86
+  data.tar.gz: c18f24941a1ed1c7880140decfe262a88b37f3aa
 SHA512:
-  metadata.gz: 90707f9d64e5e03e9b58acde6081c9fe5239ff5599ece71a1909abad871dfdb99dfe8d1d63fae89a94d6f5a908754649387cb792f150d09a94f3a3acab2f2714
-  data.tar.gz: 20f34ec847d1fe22c59a7e077c5ccdd54f5ab6483dbab086544c7f7995f8df408a018344248ed9017ce9f8ed23f5d64dfe549855700d68c8797911edae9ceafc
+  metadata.gz: de15b7a7878ba85fe1da7f7e55bb418b499a31c3a7f3556bd66be0667e077a7c69ca2f02ce8f5066b5274a98639ca4c101f94c28c9bc113a5ba14a70876bb4eb
+  data.tar.gz: 9d3fd63e5bec19aae9234bf8a13a889934fd97202e4c30cdf85bd518176034c95c81a8bbd623298d728d706c46c51086375f162a1364f6c69de90ce8642af5e0

data/.gitignore

@@ -6,8 +6,14 @@ coverage
 pkg
 rdoc
 Gemfile.lock
+gemfiles/*.lock
 spec/debug.log
 spec/*.db
 TODO
 .rvmrc
+.ruby-version
+.ruby-gemset
 alto
+.rspec
+.bundle
+

data/.travis.yml

@@ -1,11 +1,36 @@
 language: ruby
+
 rvm:
-  - 1.8.7
+  # - 1.8.7
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1
   # - jruby-18mode # JRuby in 1.8 mode
-  # - jruby-19mode # JRuby in 1.9 mode
-  - rbx-18mode
-  - rbx-19mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-2.2.1
+
 services: mongodb
+
+gemfile:
+  - gemfiles/rails_3.2.gemfile
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile
+
+matrix:
+  allow_failures:
+    - rvm: rbx-2.2.1
+    - rvm: jruby-19mode
+  exclude:
+    - rvm: 1.8.7
+      gemfile: gemfiles/rails_4.0.gemfile
+    - rvm: 1.8.7
+      gemfile: gemfiles/rails_4.1.gemfile
+    - rvm: 1.9.2
+      gemfile: gemfiles/rails_4.0.gemfile
+    - rvm: 1.9.2
+      gemfile: gemfiles/rails_4.1.gemfile
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails_4.1.gemfile
+    - rvm: jruby-19mode
+      gemfile: gemfiles/rails_4.1.gemfile

data/CHANGELOG.md

@@ -1,5 +1,61 @@
 # CHANGELOG
 
+## 3.9.0 (not yet released)
+
+ * deprecated old aasm_* class methods (old-style DSL), in preparation for AASM v4.0.0
+
+## 3.4.0
+
+ * allow retrieving the current event (`aasm.current_event`) (see [issue #159](https://github.com/aasm/aasm/issues/159) and [issue #168](https://github.com/aasm/aasm/issues/168))
+
+## 3.3.3
+
+ * bugfix: support reloading development environment in Rails (see [issue #148](https://github.com/aasm/aasm/issues/148))
+
+## 3.3.2
+
+ * bugfix: avoid conflicts with `failed` and `fired` event names (see [issue #157](https://github.com/aasm/aasm/issues/157)), thanks to [@MichaelXavier](https://github.com/MichaelXavier)
+ * bugfix: not using transactions unless saving to the database (see [issue #162](https://github.com/aasm/aasm/issues/162) and [issue #164](https://github.com/aasm/aasm/issues/164)), thanks to [@roberthoner](https://github.com/roberthoner)
+ * bugfix: `after_commit` should only run if saving to the database (see [issue #151](https://github.com/aasm/aasm/issues/151)), thanks to [@ivantsepp](https://github.com/ivantsepp)
+
+## 3.3.1
+
+ * bugfix: permissible events will respect given `guards` (see [issue #150](https://github.com/aasm/aasm/issues/150))
+
+## 3.3.0
+
+ * support for Rails 4.1 enum fields (see [issue #124](https://github.com/aasm/aasm/issues/124), thanks to [@bkon](https://github.com/bkon))
+ * bugfix: allow lazy-evaluation for Rails 3 scopes (see [issue #144](https://github.com/aasm/aasm/issues/144), thanks to [@laurens](https://github.com/laurens))
+
+## 3.2.1
+
+ * bugfix: permissible_events and events did not contain events with an empty "from" transition (see [issue #140](https://github.com/aasm/aasm/issues/140) and [issue #141](https://github.com/aasm/aasm/issues/141), thanks to [@daniel-rikowski](https://github.com/daniel-rikowski))
+
+## 3.2.0
+
+ * support [Sequel](http://sequel.jeremyevans.net/) (see [issue #119](https://github.com/aasm/aasm/issues/119), thanks to [@godfat](https://github.com/godfat))
+ * may not fire an unknown event (see [issue #128](https://github.com/aasm/aasm/issues/128)
+
+## 3.1.1
+
+ * bugfix: don't require ActiveRecord for localizing AASM event and state name (see [issue #113](https://github.com/aasm/aasm/issues/113), thanks to [@silentshade](https://github.com/silentshade))
+
+## 3.1.0
+
+ * validating the current state (see [issue #95](https://github.com/aasm/aasm/issues/95), thanks to [@ivantsepp](https://github.com/ivantsepp))
+ * allow configuring behavior of nested transactions (see [issue #107](https://github.com/aasm/aasm/issues/107))
+ * support multiple guards per transition
+ * support event guards (see [issue #85](https://github.com/aasm/aasm/issues/85))
+ * support reading from- and to-state during on_transition callback (see [issue #100](https://github.com/aasm/aasm/issues/100))
+
+## 3.0.26
+
+ * support state.human_name (aliased to state.localized_name) (see [issue #105](https://github.com/aasm/aasm/issues/105))
+
+## 3.0.25
+
+ * initialize the state even if validation is skipped (for ActiveRecord and Mongoid persistence) (see [issue #103](https://github.com/aasm/aasm/issues/103), thanks to [@vfonic](https://github.com/vfonic) and [@aaronklaassen](https://github.com/aaronklaassen))
+
 ## 3.0.24
 
  * added support for event blocks (thanks to [@Intrepidd](https://github.com/Intrepidd))

data/Gemfile

@@ -1,3 +1,12 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
+
+gem "sqlite3",                          :platforms => :ruby
+gem "coveralls",                        :platforms => :ruby
+gem 'rubysl',                           :platforms => :rbx
+gem "jruby-openssl",                    :platforms => :jruby
+gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
+gem "rails", "3.2.18"
+gem 'mongoid' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
+gem 'sequel'
 
 gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2012 Scott Barron
+Copyright (c) 2006-2014 Scott Barron
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,6 +1,9 @@
 # AASM - Ruby state machines
 
-[![Gem Version](https://badge.fury.io/rb/aasm.png)](http://badge.fury.io/rb/aasm) [![Build Status](https://secure.travis-ci.org/aasm/aasm.png?branch=master)](http://travis-ci.org/aasm/aasm) [![Code Climate](https://codeclimate.com/github/aasm/aasm.png)](https://codeclimate.com/github/aasm/aasm) [![Coverage Status](https://coveralls.io/repos/aasm/aasm/badge.png?branch=master)](https://coveralls.io/r/aasm/aasm)
+<a href="http://badge.fury.io/rb/aasm"><img src="https://badge.fury.io/rb/aasm@2x.png" alt="Gem Version" height="18"></a>
+[![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.png)](https://codeclimate.com/github/aasm/aasm)
+[![Coverage Status](https://coveralls.io/repos/aasm/aasm/badge.png?branch=master)](https://coveralls.io/r/aasm/aasm)
 
 This package contains AASM, a library for adding finite state machines to Ruby classes.
 
@@ -91,7 +94,7 @@ class Job
     state :sleeping, :initial => true, :before_enter => :do_something
     state :running
 
-    event :run, :after => Proc.new { |user| notify_somebody(user) } do
+    event :run, :after => Proc.new { do_afterwards } do
       transitions :from => :sleeping, :to => :running, :on_transition => Proc.new {|obj, *args| obj.set_process(*args) }
     end
 
@@ -114,7 +117,7 @@ class Job
     ...
   end
 
-  def notify_somebody(user)
+  def do_afterwards
     ...
   end
 
@@ -122,7 +125,7 @@ end
 ```
 
 In this case `do_something` is called before actually entering the state `sleeping`,
-while `notify_somebody` is called after the transition `run` (from `sleeping` to `running`)
+while `do_afterwards` is called after the transition `run` (from `sleeping` to `running`)
 is finished.
 
 Here you can see a list of all possible callbacks, together with their order of calling:
@@ -144,11 +147,47 @@ Also, you can pass parameters to events:
   job.run(:running, :defragmentation)
 ```
 
-In this case the `set_process` would be called with `:defagmentation` argument.
+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.
 
+During the `:on_transition` callback (and reliably only then) you can access the
+originating state (the from-state) and the target state (the to state), like this:
+
+```ruby
+  def set_process(name)
+    logger.info "from #{aasm.from_state} to #{aasm.to_state}"
+  end
+```
+
+#### The current event triggered
+
+While running the callbacks you can easily retrieve the name of the event triggered
+by using `aasm.current_event`:
+
+```ruby
+  # taken the example callback from above
+  def do_something
+    puts "triggered #{aasm.current_event}"
+  end
+```
+
+and then
+
+```ruby
+  job = Job.new
+
+  # without bang
+  job.sleep # => triggered :sleep
+
+  # with bang
+  job.sleep! # => triggered :sleep!
+```
+
+
 ### Guards
 
 Let's assume you want to allow particular transitions only if a defined condition is
@@ -190,6 +229,24 @@ job.may_sleep?  # => false
 job.sleep       # => raises AASM::InvalidTransition
 ```
 
+You can even provide a number of guards, which all have to succeed to proceed
+
+```ruby
+    def walked_the_dog?; ...; end
+
+    event :sleep do
+      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
+    end
+```
 
 ### ActiveRecord
 
@@ -248,6 +305,57 @@ class Job < ActiveRecord::Base
 end
 ```
 
+#### ActiveRecord enums
+
+You can use
+[enumerations](http://edgeapi.rubyonrails.org/classes/ActiveRecord/Enum.html)
+in Rails 4.1+ for your state column:
+
+```ruby
+class Job < ActiveRecord::Base
+  include AASM
+
+  enum state: {
+    sleeping: 5,
+    running: 99
+  }
+
+  aasm :column => :state, :enum => true do
+    state :sleeping, :initial => true
+    state :running
+  end
+end
+```
+
+You can explicitly pass the name of the method which provides access
+to the enumeration mapping as a value of ```enum```, or you can simply
+set it to ```true```. In the latter case AASM will try to use
+pluralized column name to access possible enum states.
+
+Furthermore, if your column has integer type (which is normally the
+case when you're working with Rails enums), you can omit ```:enum```
+setting --- AASM auto-detects this situation and enabled enum
+support. If anything goes wrong, you can disable enum functionality
+and fall back to the default behavior by setting ```:enum```
+to ```false```.
+
+### Sequel
+
+AASM also supports [Sequel](http://sequel.jeremyevans.net/) besides _ActiveRecord_ and _Mongoid_.
+
+```ruby
+class Job < Sequel::Model
+  include AASM
+
+  aasm do # default column: aasm_state
+    ...
+  end
+end
+```
+
+However it's not yet as feature complete as _ActiveRecord_. For example, there are
+scopes defined yet. See [Automatic Scopes](#automatic-scopes).
+
 ### Mongoid
 
 AASM also supports persistence to Mongodb if you're using Mongoid. Make sure
@@ -257,6 +365,7 @@ to include Mongoid::Document before you include AASM.
 class Job
   include Mongoid::Document
   include AASM
+  field :aasm_state
   aasm do
     ...
   end
@@ -277,7 +386,7 @@ class Job < ActiveRecord::Base
     state :cleaning
   end
 
-  def sleeping
+  def self.sleeping
     "This method name is in already use"
   end
 end
@@ -286,10 +395,10 @@ end
 ```ruby
 class JobsController < ApplicationController
   def index
-    @running_jobs = jobs.running
-    @recent_cleaning_jobs = jobs.cleaning.where('created_at >=  ?', 3.days.ago)
+    @running_jobs = Job.running
+    @recent_cleaning_jobs = Job.cleaning.where('created_at >=  ?', 3.days.ago)
 
-    # @sleeping_jobs = jobs.sleeping   #=> "This method name is in already use"
+    # @sleeping_jobs = Job.sleeping   #=> "This method name is in already use"
   end
 end
 ```
@@ -325,9 +434,9 @@ class Job < ActiveRecord::Base
 
   aasm do
     state :sleeping, :initial => true
-    state :running
+    state :running, :after_commit => :notify_about_running_job
 
-    event :run, :after_commit => :notify_about_running_job do
+    event :run do
       transitions :from => :sleeping, :to => :running
     end
   end
@@ -338,6 +447,28 @@ class Job < ActiveRecord::Base
 end
 ```
 
+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
+the configuration
+
+```ruby
+class Job < ActiveRecord::Base
+  include AASM
+
+  aasm :requires_new_transaction => false do
+    ...
+  end
+
+  ...
+end
+```
+
+which then leads to `transaction(:requires_new => false)`, the Rails default.
+
+
 ### Column name & migration
 
 As a default AASM uses the column `aasm_state` to store the states. You can override
@@ -378,13 +509,13 @@ Given the `Job` class from above:
 ```ruby
 job = Job.new
 
-job.aasm.states
+job.aasm.states.map(&:name)
 => [:sleeping, :running, :cleaning]
 
-job.aasm.states(:permissible => true)
+job.aasm.states(:permissible => true).map(&:name)
 => [:running]
 job.run
-job.aasm.states(:permissible => true)
+job.aasm.states(:permissible => true).map(&:name)
 => [:cleaning, :sleeping]
 
 job.aasm.events
@@ -417,7 +548,7 @@ gem 'aasm'
 
 ## Latest changes ##
 
-Look at the [CHANGELOG](https://github.com/aasm/aasm/blob/master/CHANGELOG.md) for details.
+Take a look at the [CHANGELOG](https://github.com/aasm/aasm/blob/master/CHANGELOG.md) for details about recent changes to the current version.
 
 ## Questions? ##
 
@@ -427,11 +558,11 @@ Feel free to
 * [ask a question on StackOverflow](http://stackoverflow.com) (tag with `aasm`)
 * send us a tweet [@aasm](http://twitter.com/aasm)
 
-## Authors ##
+## Maintainers ##
 
-* [Scott Barron](https://github.com/rubyist)
-* [Travis Tilley](https://github.com/ttilley)
-* [Thorsten Böttger](http://github.com/alto)
+* [Scott Barron](https://github.com/rubyist) (2006–2009, original author)
+* [Travis Tilley](https://github.com/ttilley) (2009–2011)
+* [Thorsten Böttger](http://github.com/alto) (since 2011)
 
 
 ## Warranty ##
@@ -443,7 +574,7 @@ purpose.
 
 ## License ##
 
-Copyright (c) 2006-2012 Scott Barron
+Copyright (c) 2006-2014 Scott Barron
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/aasm.gemspec

@@ -5,7 +5,7 @@ require "aasm/version"
 Gem::Specification.new do |s|
   s.name        = "aasm"
   s.version     = AASM::VERSION
-  s.authors     = ["Scott Barron", "Scott Petersen", "Travis Tilley", "Thorsten Boettger"]
+  s.authors     = ["Scott Barron", "Travis Tilley", "Thorsten Boettger"]
   s.email       = %q{scott@elitists.net, ttilley@gmail.com, aasm@mt7.de}
   s.homepage    = %q{https://github.com/aasm/aasm}
   s.summary     = %q{State machine mixin for Ruby objects}
@@ -13,22 +13,21 @@ Gem::Specification.new do |s|
   s.date        = Time.now
   s.licenses    = ["MIT"]
 
-  s.add_development_dependency 'activerecord', '3.2.15'
+  # s.add_development_dependency 'activerecord', '3.2.15'
   # s.add_development_dependency 'activerecord', '4.0.1'
 
-  s.add_development_dependency 'mongoid' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
+  # s.add_development_dependency 'mongoid' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
   s.add_development_dependency 'rake'
   s.add_development_dependency 'sdoc'
   s.add_development_dependency 'rspec', '~> 2.14'
   s.add_development_dependency 'rr'
-  s.add_development_dependency 'sqlite3'
+  # s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'minitest'
   # s.add_development_dependency 'debugger'
   # s.add_development_dependency 'pry'
-  s.add_development_dependency 'ruby-debug-completion'
 
   s.add_development_dependency 'mime-types', '~> 1.25' # needed by coveralls (>= 2.0 needs Ruby >=1.9.2)
-  s.add_development_dependency 'coveralls'
+  # s.add_development_dependency 'coveralls'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+gem "sqlite3",                          :platforms => :ruby
+gem "coveralls"
+gem 'rubysl',                           :platforms => :rbx
+gem 'rubinius-developer_tools',         :platforms => :rbx
+gem "jruby-openssl",                    :platforms => :jruby
+gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
+gem "rails", "3.2.18"
+gem 'mongoid' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
+gem 'sequel'
+
+gemspec :path => "../"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+gem "sqlite3",                          :platforms => :ruby
+gem "coveralls"
+gem 'rubysl',                           :platforms => :rbx
+gem 'rubinius-developer_tools',         :platforms => :rbx
+gem "jruby-openssl",                    :platforms => :jruby
+gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
+gem "rails", "4.0.5"
+
+# mongoid is not yet compatible with Rails >= 4
+# gem 'mongoid' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
+
+gem 'sequel'
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+gem "sqlite3",                          :platforms => :ruby
+gem "coveralls"
+gem 'rubysl',                           :platforms => :rbx
+gem 'rubinius-developer_tools',         :platforms => :rbx
+gem "jruby-openssl",                    :platforms => :jruby
+gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
+gem "rails", "4.1.1"
+
+# mongoid is not yet compatible with Rails >= 4
+# gem 'mongoid' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
+
+gem 'sequel'
+
+gemspec :path => "../"