aasm 4.11.1 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a57dd3feade6d1aea288f5999b4d93c890b11c60
-  data.tar.gz: 8e14ba9da4f262ca2f2ba0a40f633af6234e2075
+  metadata.gz: fedd52d9c93d911e324c5c3594910d7fb7b33db2
+  data.tar.gz: a0334890f17ce24960567a8f95e0cafd03375a9f
 SHA512:
-  metadata.gz: 08b85c55e73ba7b152e7a8344bf706315aa33016047849fee0e64dff8201f2691132d83d1e2c91b7e603b1e5f8e2a23bb8510573b539f142fa38b718c4aa0191
-  data.tar.gz: 2cdd0ef93171f881ef36bd2b1fe0d06d71dce2a73fffee570515c12f69fdc52fb18ea02e29a5b4591498de9526e3fb1bf6039aff8d4ed9af0c8a069f278150cc
+  metadata.gz: 91bec3c1dfd3c450fb0565794026c0dcba137db1c42e5fb79a63544e4071c7ece69e36a2c42b9a5e45cf8790a1fca769c25ce6dc9f9050819a4c7dae7216bb5f
+  data.tar.gz: 20e8f730c627d53ad7558240d808c2ac42e0540b57e0e78814e560668e80af18c0c83014eefb3d335356dd8bb58ff27425f412f0a8054921171e206cff6a88cf

data/.travis.yml

@@ -4,44 +4,43 @@ cache: bundler
 
 rvm:
   - 1.9.3
-  - 2.2.5
-  - 2.3.1
+  - 2.2.6
+  - 2.3.3
   - jruby-1.7 # JRuby in 1.9 mode
   - jruby-9.0.5.0
-  - rbx-2.5.8
 
 services:
   - mongodb
   - redis-server
 
 gemfile:
-  - gemfiles/rails_3.2_stable.gemfile
+  - gemfiles/rails_3.2.gemfile
   - gemfiles/rails_4.0.gemfile
-  - gemfiles/rails_4.0_mongo_mapper.gemfile
   - gemfiles/rails_4.2.gemfile
   - gemfiles/rails_4.2_mongoid_5.gemfile
-  - gemfiles/rails_4.2_mongo_mapper.gemfile
   - gemfiles/rails_5.0.gemfile
 
 before_script:
   - mkdir /tmp/dynamodb
-  - wget -O - http://dynamodb-local.s3-website-us-west-2.amazonaws.com/dynamodb_local_latest | tar xz --directory /tmp/dynamodb
+  - wget -O - http://dynamodb-local.s3-website-us-west-2.amazonaws.com/dynamodb_local_latest.tar.gz | tar xz --directory /tmp/dynamodb
   - java -Djava.library.path=/tmp/dynamodb/DynamoDBLocal_lib -jar /tmp/dynamodb/DynamoDBLocal.jar -inMemory -delayTransientStatuses -port 30180 &
+  - mongod --version
 
 matrix:
-  allow_failures:
-    - rvm: jruby-9.0.5.0
-      gemfile: gemfiles/rails_5.0.gemfile
-    - rvm: rbx-2.5.8
-      gemfile: gemfiles/rails_5.0.gemfile
   exclude:
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails_4.2_mongoid_5.gemfile
     - rvm: 1.9.3
       gemfile: gemfiles/rails_5.0.gemfile
-    - rvm: 2.2.5
-      gemfile: gemfiles/rails_3.2_stable.gemfile
-    - rvm: 2.3.1
-      gemfile: gemfiles/rails_3.2_stable.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
+      gemfile: gemfiles/rails_4.2_mongoid_5.gemfile
+    - rvm: jruby-1.7
+      gemfile: gemfiles/rails_5.0.gemfile
+    - rvm: jruby-9.0.5.0
       gemfile: gemfiles/rails_5.0.gemfile
 
 notifications:

data/Appraisals

@@ -0,0 +1,44 @@
+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'
+  gem 'sequel'
+  gem 'dynamoid', '~> 1',                 :platforms => :ruby
+  gem 'aws-sdk', '~>2',                   :platforms => :ruby
+  gem 'redis-objects'
+end
+
+appraise 'rails_4.2' do
+  gem 'nokogiri', '1.6.8.1',              :platforms => [:ruby_19]
+  gem 'mime-types', '~> 2',               :platforms => [: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
+end
+
+appraise 'rails_4.2_mongoid_5' do
+  gem 'mime-types', '~> 2',               :platforms => [:ruby_19, :jruby]
+  gem 'rails', '4.2.5'
+  gem 'mongoid', '~>5.0'
+end
+
+appraise 'rails_5.0' do
+  gem 'rails', '5.0.0'
+  gem 'mongoid', '~>6.0'
+  gem 'sequel'
+
+  # dynamoid is not yet Rails 5 compatible
+  # gem 'dynamoid', '~> 1',                 :platforms => :ruby
+
+  gem 'aws-sdk', '~>2',                   :platforms => :ruby
+end

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## unreleased
+
+## 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)
+ * Drop Support for Mongo Mapper [see [pull-request #439](https://github.com/aasm/aasm/pull/439)], thanks to [@reidmorrison](https://github.com/reidmorrison)
+ * add :binding_event option to event [see [pull-request #438](https://github.com/aasm/aasm/pull/438)], thanks to [@leanhdaovn](https://github.com/leanhdaovn)
+ * fix: `skip_validation_on_save: true` for default_scope records, [see [pull-request #433](https://github.com/aasm/aasm/pull/433)], thanks to [@larissa](https://github.com/larissa)
+ * Deep clone state machine during inheritance so that state machines in child classes can be modified (see [pull-request #429](https://github.com/aasm/aasm/pull/429)), thanks to [@reidmorrison](https://github.com/reidmorrison) and [@Tybot204](https://github.com/Tybot204)
+ * add before_success callback for event (see [pull-request #422](https://github.com/aasm/aasm/pull/422)), thanks to [@timsly ](https://github.com/timsly)
+ * fix: multiple transitions in a single event with the same to and from states (see [issue #372](https://github.com/aasm/aasm/issues/372) and [issue #362](https://github.com/aasm/aasm/issues/362) for details, fixed with [pull-request #408](https://github.com/aasm/aasm/pull/408), thanks to [@dathanb](https://github.com/dathanb))
+ * fix: passing nil as a argument to callbacks (see [issue #404](https://github.com/aasm/aasm/issues/404) for details, fixed with [pull-request #406](https://github.com/aasm/aasm/pull/406), thanks to [@yogeshjain999](https://github.com/yogeshjain999))
+
+
 ## 4.11.1
 
  * fix: generator file name when using custom column name instead of

data/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+## Contributing ##
+
+While not required to contribute, we recommend [RVM](https://rvm.io/) to manage your rubies.
+
+1. Read the [Contributor Code of Conduct](https://github.com/aasm/aasm/blob/master/CODE_OF_CONDUCT.md)
+2. [Fork it](https://help.github.com/articles/about-forks/)
+3. Clone the project `git clone git@github.com:[YOUR GITHUB USERNAME]/aasm.git`
+4. `cd aasm`
+5. Create your feature branch `git checkout -b my-new-feature`
+6. Write tests for your changes (feature/bug)
+7. Write your (feature/bugfix)
+8. Install the dependencies `appraisal install`
+9. Run the tests `appraisal rspec`
+10. Commit your changes `git commit -am 'Added some feature'`
+11. Push to the branch `git push origin my-new-feature`
+12. Create new [Pull Request](https://help.github.com/articles/creating-a-pull-request/)
+
+There are some option dependencies as well.
+
+- [MongoDB server](https://www.mongodb.com/download-center)
+- [Redis](https://redis.io/topics/quickstart)
+- [DynamoDB (local)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html)
+
+If we've missed something please open an [issue](https://github.com/aasm/aasm/issues/new)

data/Gemfile

@@ -1,24 +1,7 @@
 source "https://rubygems.org"
 
-gem "sqlite3",                          :platforms => :ruby
-gem 'rubysl',                           :platforms => :rbx
-gem "jruby-openssl",                    :platforms => :jruby
-gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
-gem "mime-types", "~> 2" if Gem::Version.create(RUBY_VERSION.dup) <= Gem::Version.create('1.9.3')
-gem "rails", "~>4.2"
-gem 'mongoid', '~>4.0' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
-gem 'sequel'
-
-# testing dynamoid
-# gem 'dynamoid', '~> 1'
-# gem 'aws-sdk', '~>2'
-
-# Since mongoid V4 requires incompatible bson V2, cannot have mongoid (V4 or greater)
-# and mongo_mapper ( or mongo ) in the same application
-# gem 'mongo_mapper', '~> 0.13'
-# gem 'bson_ext',                          :platforms => :ruby
-
-# uncomment if you want to run specs for Redis persistence
-# gem "redis-objects"
-
 gemspec
+
+gem 'sqlite3',                          :platforms => :ruby
+gem 'activerecord-jdbcsqlite3-adapter', :platforms => :jruby
+gem 'rails', '5.0.0'

data/README.md

@@ -10,7 +10,7 @@ This package contains AASM, a library for adding finite state machines to Ruby c
 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),
-[Mongoid](http://mongoid.org/), and [Mongomapper](http://mongomapper.com/) but it can be used for any Ruby class, no matter what
+and [Mongoid](http://mongoid.org/) but it can be used for any Ruby class, no matter what
 parent class it has (if any).
 
 ## Upgrade from version 3 to 4
@@ -180,6 +180,7 @@ begin
   new_state       before_enter
   new_state       enter
   ...update state...
+  event           before_success      # if persist successful
   transition      success             # if persist successful
   event           success             # if persist successful
   old_state       after_exit
@@ -415,6 +416,46 @@ SimpleMultipleExample.aasm(:work).states
 # => [:standing, :walking, :running]
 ```
 
+### Binding event
+
+Allow an event to be bound to another
+```ruby
+class Example
+  include AASM
+
+  aasm(:work) do
+    state :sleeping, :initial => true
+    state :processing
+
+    event :start do
+      transitions :from => :sleeping, :to => :processing
+    end
+    event :stop do
+      transitions :from => :processing, :to => :sleeping
+    end
+  end
+
+  aasm(:question) do
+    state :answered, :initial => true
+    state :asked
+
+    event :ask, :binding_event => :start do
+      transitions :from => :answered, :to => :asked
+    end
+    event :answer, :binding_event => :stop do
+      transitions :from => :asked, :to => :answered
+    end
+  end
+end
+
+example = Example.new
+example.aasm(:work).current_state #=> :sleeping
+example.aasm(:question).current_state #=> :answered
+example.ask
+example.aasm(:work).current_state #=> :processing
+example.aasm(:question).current_state #=> :asked
+```
+
 *Final note*: Support for multiple state machines per class is a pretty new feature
 (since version `4.3`), so please bear with us in case it doesn't work as expected.
 
@@ -532,6 +573,8 @@ class Job < ActiveRecord::Base
 end
 ```
 
+### Bang events
+
 You can tell AASM to auto-save the object or leave it unsaved
 
 ```ruby
@@ -540,8 +583,10 @@ job.run   # not saved
 job.run!  # saved
 ```
 
-Saving includes running all validations on the `Job` class, and returns `true` if
-successful or `false` if errors occur. Exceptions are not raised.
+Saving includes running all validations on the `Job` class. If
+`whiny_persistence` flag is set to `true`, exception is raised in case of
+failure. If `whiny_persistence` flag is set to false, methods with a bang return
+`true` if the state transition is successful or `false` if an error occurs.
 
 If you want make sure the state gets saved without running validations (and
 thereby maybe persisting an invalid object state), simply tell AASM to skip the
@@ -632,7 +677,7 @@ to ```false```.
 
 ### Sequel
 
-AASM also supports [Sequel](http://sequel.jeremyevans.net/) besides _ActiveRecord_, _Mongoid_, and _MongoMapper_.
+AASM also supports [Sequel](http://sequel.jeremyevans.net/) besides _ActiveRecord_, and _Mongoid_.
 
 ```ruby
 class Job < Sequel::Model
@@ -668,23 +713,6 @@ class Job
 end
 ```
 
-### MongoMapper
-
-AASM also supports persistence to Mongodb if you're using MongoMapper. Make sure
-to include MongoMapper::Document before you include AASM.
-
-```ruby
-class Job
-  include MongoMapper::Document
-  include AASM
-
-  key :aasm_state,                   Symbol
-  aasm do
-    ...
-  end
-end
-```
-
 ### Redis
 
 AASM also supports persistence in Redis.
@@ -921,13 +949,13 @@ end
 
 ```ruby
 # show all states
-Job.aasm.states.map(&:name) 
+Job.aasm.states.map(&:name)
 #=> [:sleeping, :running, :cleaning]
 
 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
@@ -935,7 +963,7 @@ 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
@@ -1083,14 +1111,7 @@ Feel free to
 * [Anil Maurya](http://github.com/anilmaurya) (since 2016)
 
 
-## Contributing ##
-
-1. Read the [Contributor Code of Conduct](https://github.com/aasm/aasm/blob/master/CODE_OF_CONDUCT.md)
-2. Fork it
-3. Create your feature branch (git checkout -b my-new-feature)
-4. Commit your changes (git commit -am 'Added some feature')
-5. Push to the branch (git push origin my-new-feature)
-6. Create new Pull Request
+## [Contributing](CONTRIBUTING.md)
 
 ## Warranty ##
 

data/Rakefile

@@ -23,4 +23,9 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-task :default => :spec
+if ENV["APPRAISAL_INITIALIZED"] || ENV["TRAVIS"]
+  task :default => :spec
+else
+  require 'appraisal'
+  task :default => :appraisal
+end

data/TESTING.md

@@ -0,0 +1,25 @@
+## Install dependency matrix
+
+    appraisal install
+
+This will re-generate Gemfiles in `gemfile` folder
+
+Use rvm gemsets or similar to avoid global gem pollution
+
+## Run specs
+
+For all supported Rails/ORM combinations:
+
+    appraisal rspec
+
+Or for specific one:
+
+    appraisal rails_4.2 rspec
+
+Or for one particular test file
+
+    appraisal rails_4.2_mongoid_5 rspec spec/unit/persistence/mongoid_persistence_multiple_spec.rb
+
+Or down to one test case
+
+    appraisal rails_4.2_mongoid_5 rspec spec/unit/persistence/mongoid_persistence_multiple_spec.rb:92

data/aasm.gemspec

@@ -16,10 +16,13 @@ Gem::Specification.new do |s|
   s.platform              = Gem::Platform::RUBY
   s.required_ruby_version = '>= 1.9.3'
 
+  s.add_dependency 'concurrent-ruby', '~> 1.0'
+
   s.add_development_dependency 'rake'
   s.add_development_dependency 'sdoc'
   s.add_development_dependency 'rspec', ">= 3"
   s.add_development_dependency 'generator_spec'
+  s.add_development_dependency 'appraisal'
 
   # debugging
   # s.add_development_dependency 'debugger'

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", :platforms => :ruby
+gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
+gem "rails", "~>3.2.22"
+gem "mongoid", "~>3.1"
+gem "sequel"
+gem "bson_ext", :platforms => :ruby
+gem "test-unit", "~> 3.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.0.gemfile

@@ -1,16 +1,15 @@
+# This file was generated by Appraisal
+
 source "https://rubygems.org"
 
-gem "sqlite3",                          :platforms => :ruby
-gem 'rubysl',                           :platforms => :rbx
-gem 'rubinius-developer_tools',         :platforms => :rbx
-gem "jruby-openssl",                    :platforms => :jruby
+gem "sqlite3", :platforms => :ruby
 gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
-gem "mime-types", "~> 2" if Gem::Version.create(RUBY_VERSION.dup) <= Gem::Version.create('1.9.3')
 gem "rails", "4.0.13"
-gem 'mongoid', '~>4.0' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
-gem 'sequel'
-gem 'dynamoid', '~> 1',                 :platforms => :ruby
-gem 'aws-sdk', '~>2',                   :platforms => :ruby
+gem "mime-types", "~> 2", :platforms => [:ruby_19, :jruby]
+gem "mongoid", "~>4.0"
+gem "sequel"
+gem "dynamoid", "~> 1", :platforms => :ruby
+gem "aws-sdk", "~>2", :platforms => :ruby
 gem "redis-objects"
 
 gemspec :path => "../"

data/gemfiles/rails_4.2.gemfile

@@ -1,15 +1,15 @@
+# This file was generated by Appraisal
+
 source "https://rubygems.org"
 
-gem "sqlite3",                          :platforms => :ruby
-gem 'rubysl',                           :platforms => :rbx
-gem 'rubinius-developer_tools',         :platforms => :rbx
-gem "jruby-openssl",                    :platforms => :jruby
+gem "sqlite3", :platforms => :ruby
 gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
-gem "mime-types", "~> 2" if Gem::Version.create(RUBY_VERSION.dup) <= Gem::Version.create('1.9.3')
 gem "rails", "4.2.5"
-gem 'mongoid', '~>4.0' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
-gem 'sequel'
-gem 'dynamoid', '~> 1',                 :platforms => :ruby
-gem 'aws-sdk', '~>2',                   :platforms => :ruby
+gem "nokogiri", "1.6.8.1", :platforms => [:ruby_19]
+gem "mime-types", "~> 2", :platforms => [:ruby_19, :jruby]
+gem "mongoid", "~>4.0"
+gem "sequel"
+gem "dynamoid", "~> 1", :platforms => :ruby
+gem "aws-sdk", "~>2", :platforms => :ruby
 
 gemspec :path => "../"