aasm 4.0.8 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9602429239af9631275cb2f9c1b3c175177aea51
-  data.tar.gz: 1dc343974f7348d43882b5f15908440012dcd6e5
+  metadata.gz: cd80c470206244734a77fe540848e299e87dab9f
+  data.tar.gz: 28b464e9012345a46ddc5595d29541d52a358bf4
 SHA512:
-  metadata.gz: c0c7e3300ea262db0385d2f4f403a227968ecc42cd99c0cc13eba81b2f356881b9a42b24a33191b286e1573233ca5ff8a9abdacffd51874d763494e66caabb08
-  data.tar.gz: f3ec766f78f6dd8bd9a781220764e35e28dbe0cd8217763a960675202e4001e3a647bb22db7be930a2079d0d832933bc4fc68da5aaa722a130369a2e12579942
+  metadata.gz: 46d54cc3e2e66387916f7f1edfe03f3de9cb09578a8b485ea084bd68ba854f9003d1fd00de18a6d7c40984a0b0d2fe1b2d7bc4b3610e7d421c724e2f5af7a9f1
+  data.tar.gz: cb2506c237a22fc3dc04869791d15f85614ac33096ccff60fa5a6dd40830d2325375ed13cdc3abf2adc02c958a336362027393c6ee0351bc463cf47cb0b9020f

data/.travis.yml

@@ -10,7 +10,7 @@ rvm:
   - 2.1
   - 2.2
   # - jruby-18mode # JRuby in 1.8 mode
-  - jruby-19mode # JRuby in 1.9 mode
+  - jruby-1.7 # JRuby in 1.9 mode
   - rbx-2.2.1
 
 services: mongodb
@@ -18,13 +18,16 @@ services: mongodb
 gemfile:
   - gemfiles/rails_3.2.gemfile
   - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.0_bson1.gemfile
   - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_4.1_bson1.gemfile
   - gemfiles/rails_4.2.gemfile
+  - gemfiles/rails_4.2_bson1.gemfile
 
 matrix:
   allow_failures:
     - rvm: rbx-2.2.1
-    - rvm: jruby-19mode
+    - rvm: jruby-1.7
   exclude:
     - rvm: 1.9.3
       gemfile: gemfiles/rails_4.1.gemfile

data/CHANGELOG.md

@@ -1,13 +1,29 @@
 # CHANGELOG
 
-## 4.1.0 (not yet released)
+## 4.3.0 (not yet released)
 
+## 4.2.0
+
+ * support turning off and on the configuration option for `no_direct_assignment` (see [issue #223](https://github.com/aasm/aasm/issues/223) for details)
+ * event arguments are now passed to `:after_commit` callbacks as well (see [issue #238](https://github.com/aasm/aasm/pull/238), thanks to [@kuinak](https://github.com/kuinak))
+
+## 4.1.1
+
+ * support block notation for `:after_commit` event callbacks (see [issue #224](https://github.com/aasm/aasm/issues/224) for details)
+ * event arguments are now passed to state callbacks as well (not only to event callbacks) (see [issue #219](https://github.com/aasm/aasm/issues/219), thanks to [@tobithiel](https://github.com/tobithiel))
+ * `AASM::InvalidTransition` now references the current object (with the state machine) and the _AASM_ event name (see [issue #217](https://github.com/aasm/aasm/issues/217), thanks to [@awsmsrc](https://github.com/awsmsrc))
+ * bugfix: do not update unloaded state for [Sequel](http://sequel.jeremyevans.net/) (see [issue #218](https://github.com/aasm/aasm/issues/218), thanks to [@godfat](https://github.com/godfat))
+
+## 4.1.0
+
+ * bugfix: initialize the aasm state column after initialization of the _Mongoid_ instance (see [issue #206](https://github.com/aasm/aasm/issues/206), thanks to [@Shwetakale ](https://github.com/Shwetakale ))
+ * added support for mongomapper ORM (see [issue #203](https://github.com/aasm/aasm/issues/203), thanks to [@reidmorrison ](https://github.com/reidmorrison ))
  * `aasm_column` has been removed. Use `aasm.attribute_name` instead
  * `aasm_human_event_name` has been removed. Use `aasm.human_event_name` instead
 
 ## 4.0.8
 
- * bugfix: may_<event>? should return true or false only (see [issue #200](https://github.com/aasm/aasm/issues/200) for details)
+ * bugfix: may_event_name? should return true or false only (see [issue #200](https://github.com/aasm/aasm/issues/200) for details)
 
 ## 4.0.7
 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -1,12 +1,15 @@
 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", "~>4.1"
-gem 'mongoid' 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'
+# 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
 
 gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2014 Scott Barron
+Copyright (c) 2006-2015 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

@@ -2,15 +2,15 @@
 
 [![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)
-[![Coverage Status](https://img.shields.io/coveralls/aasm/aasm.svg)](https://coveralls.io/r/aasm/aasm?branch=master)
 
 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
+[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
 parent class it has (if any).
 
 ## Upgrade from version 3 to 4
@@ -435,7 +435,7 @@ to ```false```.
 
 ### Sequel
 
-AASM also supports [Sequel](http://sequel.jeremyevans.net/) besides _ActiveRecord_ and _Mongoid_.
+AASM also supports [Sequel](http://sequel.jeremyevans.net/) besides _ActiveRecord_, _Mongoid_, and _MongoMapper_.
 
 ```ruby
 class Job < Sequel::Model
@@ -466,6 +466,23 @@ 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
+```
+
 ### Automatic Scopes
 
 AASM will automatically create scope methods for each state in the model.
@@ -662,6 +679,15 @@ Feel free to
 * [Thorsten Böttger](http://github.com/alto) (since 2011)
 
 
+## 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
+
 ## Warranty ##
 
 This software is provided "as is" and without any express or
@@ -671,7 +697,7 @@ purpose.
 
 ## License ##
 
-Copyright (c) 2006-2014 Scott Barron
+Copyright (c) 2006-2015 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

@@ -18,16 +18,12 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'sdoc'
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec', ">= 3"
 
   # debugging
   # s.add_development_dependency 'debugger'
   s.add_development_dependency 'pry'
 
-  # test coverage
-  # s.add_development_dependency 'mime-types', '~> 1.25' # needed by coveralls (>= 2.0 needs Ruby >=1.9.2)
-  # s.add_development_dependency 'coveralls'
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/gemfiles/rails_3.2.gemfile

@@ -1,13 +1,14 @@
 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.21"
-gem 'mongoid' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
+gem 'mongoid', '~>3.1' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
 gem 'sequel'
+gem 'mongo_mapper', '~>0.13'
+gem 'bson_ext',                          :platforms => :ruby
 
 gemspec :path => "../"

data/gemfiles/rails_4.0.gemfile

@@ -1,16 +1,12 @@
 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.12"
-
-# mongoid is not yet compatible with Rails >= 4
-# gem 'mongoid' 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'
 
 gemspec :path => "../"

data/gemfiles/rails_4.0_bson1.gemfile

@@ -0,0 +1,14 @@
+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.13"
+gem 'sequel'
+gem 'mongo_mapper', '~>0.13'
+gem 'bson_ext',                          :platforms => :ruby
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -1,16 +1,12 @@
 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.8"
-
-# mongoid is not yet compatible with Rails >= 4
-# gem 'mongoid' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
-
+gem "rails", "4.1.9"
+gem 'mongoid', '~>4.0' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
 gem 'sequel'
 
 gemspec :path => "../"

data/gemfiles/rails_4.1_bson1.gemfile

@@ -0,0 +1,14 @@
+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.9"
+gem 'sequel'
+gem 'mongo_mapper', '~> 0.13'
+gem 'bson_ext',                          :platforms => :ruby
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.gemfile

@@ -1,16 +1,12 @@
 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.2.0"
-
-# mongoid is not yet compatible with Rails >= 4
-# gem 'mongoid' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
-
+gem 'mongoid', '~>4.0' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
 gem 'sequel'
 
 gemspec :path => "../"

data/gemfiles/rails_4.2_bson1.gemfile

@@ -0,0 +1,14 @@
+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.2.0"
+gem 'sequel'
+gem 'mongo_mapper'
+gem 'bson_ext',                          :platforms => :ruby
+
+gemspec :path => "../"

data/lib/aasm/aasm.rb

@@ -69,8 +69,10 @@ private
       )
 
       if may_fire_to = event.may_fire?(self, *args)
-        old_state.fire_callbacks(:before_exit, self)
-        old_state.fire_callbacks(:exit, self) # TODO: remove for AASM 4?
+        old_state.fire_callbacks(:before_exit, self,
+          *process_args(event, aasm.current_state, *args))
+        old_state.fire_callbacks(:exit, self,
+          *process_args(event, aasm.current_state, *args)) # TODO: remove for AASM 4?
 
         if new_state_name = event.fire(self, {:may_fire => may_fire_to}, *args)
           aasm_fired(event, old_state, new_state_name, options, *args, &block)
@@ -90,9 +92,11 @@ private
 
     new_state = aasm.state_object_for_name(new_state_name)
 
-    new_state.fire_callbacks(:before_enter, self)
+    new_state.fire_callbacks(:before_enter, self,
+      *process_args(event, aasm.current_state, *args))
 
-    new_state.fire_callbacks(:enter, self) # TODO: remove for AASM 4?
+    new_state.fire_callbacks(:enter, self,
+      *process_args(event, aasm.current_state, *args)) # TODO: remove for AASM 4?
 
     persist_successful = true
     if persist
@@ -107,8 +111,10 @@ private
     end
 
     if persist_successful
-      old_state.fire_callbacks(:after_exit, self)
-      new_state.fire_callbacks(:after_enter, self)
+      old_state.fire_callbacks(:after_exit, self,
+        *process_args(event, aasm.current_state, *args))
+      new_state.fire_callbacks(:after_enter, self,
+        *process_args(event, aasm.current_state, *args))
       event.fire_callbacks(
         :after,
         self,
@@ -129,7 +135,7 @@ private
     end
 
     if AASM::StateMachine[self.class].config.whiny_transitions
-      raise AASM::InvalidTransition, "Event '#{event_name}' cannot transition from '#{aasm.current_state}'"
+      raise AASM::InvalidTransition.new(self, event_name) 
     else
       false
     end

data/lib/aasm/base.rb

@@ -27,11 +27,19 @@ module AASM
 
       configure :enum, nil
 
-      if @state_machine.config.no_direct_assignment
-        @klass.send(:define_method, "#{@state_machine.config.column}=") do |state_name|
-          raise AASM::NoDirectAssignmentError.new('direct assignment of AASM column has been disabled (see AASM configuration for this class)')
+      # make sure to raise an error if no_direct_assignment is enabled
+      # and attribute is directly assigned though
+      @klass.class_eval %Q(
+        def #{@state_machine.config.column}=(state_name)
+          if self.class.aasm.state_machine.config.no_direct_assignment
+            raise AASM::NoDirectAssignmentError.new(
+              'direct assignment of AASM column has been disabled (see AASM configuration for this class)'
+            )
+          else
+            super
+          end
         end
-      end
+      )
     end
 
     # This method is both a getter and a setter

data/lib/aasm/core/event.rb

@@ -12,7 +12,7 @@ module AASM::Core
 
       # from aasm4
       @options = options # QUESTION: .dup ?
-      add_options_from_dsl(@options, [:after, :before, :error, :success], &block) if block
+      add_options_from_dsl(@options, [:after, :before, :error, :success, :after_commit], &block) if block
     end
 
     # a neutered version of fire - it doesn't actually fire the event, it just

data/lib/aasm/core/state.rb

@@ -28,12 +28,12 @@ module AASM::Core
       name.to_s
     end
 
-    def fire_callbacks(action, record)
+    def fire_callbacks(action, record, *args)
       action = @options[action]
       catch :halt_aasm_chain do
         action.is_a?(Array) ?
-                action.each {|a| _fire_callbacks(a, record)} :
-                _fire_callbacks(action, record)
+                action.each {|a| _fire_callbacks(a, record, args)} :
+                _fire_callbacks(action, record, args)
       end
     end
 
@@ -66,12 +66,14 @@ module AASM::Core
       self
     end
 
-    def _fire_callbacks(action, record)
+    def _fire_callbacks(action, record, args)
       case action
         when Symbol, String
-          record.send(action)
+          arity = record.send(:method, action.to_sym).arity
+          record.send(action, *(arity < 0 ? args : args[0...arity]))
         when Proc
-          action.call(record)
+          arity = action.arity
+          action.call(record, *(arity < 0 ? args : args[0...arity]))
       end
     end
 

data/lib/aasm/errors.rb

@@ -1,5 +1,16 @@
 module AASM
-  class InvalidTransition < RuntimeError; end
+
+  class InvalidTransition < RuntimeError
+    attr_reader :object, :event_name
+    def initialize(object, event_name)
+      @object, @event_name = object, event_name
+    end
+
+    def message
+      "Event '#{event_name}' cannot transition from '#{object.aasm.current_state}'"
+    end
+  end
+
   class UndefinedState < RuntimeError; end
   class NoDirectAssignmentError < RuntimeError; end
 end

data/lib/aasm/persistence/active_record_persistence.rb

@@ -10,7 +10,7 @@ module AASM
       #
       # Adds
       #
-      #   before_validation :aasm_ensure_initial_state, :on => :create
+      #   after_initialize :aasm_ensure_initial_state
       #
       # As a result, it doesn't matter when you define your methods - the following 2 are equivalent
       #
@@ -166,7 +166,7 @@ module AASM
         def aasm_ensure_initial_state
           # checking via respond_to? does not work in Rails <= 3
           # if respond_to?(self.class.aasm.attribute_name) && send(self.class.aasm.attribute_name).blank? # Rails 4
-          if attributes.key?(self.class.aasm.attribute_name.to_s) && send(self.class.aasm.attribute_name).blank?
+          if attribute_names.include?(self.class.aasm.attribute_name.to_s) && send(self.class.aasm.attribute_name).blank?
             aasm.enter_initial_state
           end
         end
@@ -176,7 +176,7 @@ module AASM
 
           if success && options[:persist]
             event = self.class.aasm.state_machine.events[name]
-            event.fire_callbacks(:after_commit, self)
+            event.fire_callbacks(:after_commit, self, *args)
           end
 
           success
@@ -187,7 +187,7 @@ module AASM
         end
 
         def aasm_validate_states
-          unless AASM::StateMachine[self.class].config.skip_validation_on_save
+          unless aasm_skipping_validations
             if aasm.current_state && !aasm.states.include?(aasm.current_state)
               self.errors.add(AASM::StateMachine[self.class].config.column , "is invalid")
             end

data/lib/aasm/persistence/base.rb

@@ -71,6 +71,9 @@ module AASM
         elsif @klass.ancestors.map {|klass| klass.to_s}.include?("Mongoid::Document")
           scope_options = lambda { @klass.send(:where, {@klass.aasm.attribute_name.to_sym => name.to_s}) }
           @klass.send(:scope, name, scope_options)
+        elsif @klass.ancestors.map {|klass| klass.to_s}.include?("MongoMapper::Document")
+          conditions = { @klass.aasm.attribute_name.to_sym => name.to_s }
+          @klass.scope(name, lambda { @klass.where(conditions) })
         end
       end
     end