aasm 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b51607dcaee12f000a23ee83033925bf03dcee7
-  data.tar.gz: c367dd718de8264432f332ff626fc8aff05581e3
+  metadata.gz: 7796dc2427b68fdbe78f6a79597c483b04f0cf70
+  data.tar.gz: 5b787a0ef49492a02f6beb7e5fffe6ab44c7724d
 SHA512:
-  metadata.gz: 4a3750ab5b7758679ed9ca66fc35f04cf69347a09bc03070fd514ccbd3c111f129f907e6c4e387cf253441daf7e8e79a1045ea64da43296803434711c56a2b84
-  data.tar.gz: d82ff5d11b0ebae4112277283706e3bd9774517e6f4a7bece806360deda054c811ccebccfefd59c05244dd05e5351f21672932ba8071a8c2626077ba76bc585d
+  metadata.gz: 2d429dd03690c213d5fed037d1d65b5fcc31f6ef83ff6a54ddd6092f46958f5bebe753d429bd8ecbd70e83ba210265895e83028fdbb5e5b8aab9031cea532a4f
+  data.tar.gz: 0b9fe7da0c4755fabb564fc05beb553d8fd666d6cc885079bef5eb6c97f2a08e81b8721bdac39b0453118b3a7835387eb2c4881855a19c9e72310b241d680c76

data/.travis.yml

@@ -18,11 +18,12 @@ services: mongodb
 gemfile:
   - gemfiles/rails_3.2.gemfile
   - gemfiles/rails_4.0.gemfile
-  - gemfiles/rails_4.0_bson1.gemfile
+  - gemfiles/rails_4.0_mongo_mapper.gemfile
   - gemfiles/rails_4.1.gemfile
-  - gemfiles/rails_4.1_bson1.gemfile
+  - gemfiles/rails_4.1_mongo_mapper.gemfile
   - gemfiles/rails_4.2.gemfile
-  - gemfiles/rails_4.2_bson1.gemfile
+  - gemfiles/rails_4.2_mongoid_5.gemfile
+  - gemfiles/rails_4.2_mongo_mapper.gemfile
 
 matrix:
   allow_failures:

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 4.4.0
+
+ * add support global transation callbacks (see [issue #221](https://github.com/aasm/aasm/issues/221) and [issue #253](https://github.com/aasm/aasm/issues/253) for details)
+ * add support (bugfix) for Mongoid >= 5.0 (see [issue #277](https://github.com/aasm/aasm/issues/277) and [issue #278](https://github.com/aasm/aasm/issues/278) for details)
+
 ## 4.3.0
 
  * add support for multiple state machines per class (see [issue #158](https://github.com/aasm/aasm/issues/158) and [issue #240](https://github.com/aasm/aasm/issues/240) for details)

data/PLANNED_CHANGES.md

@@ -4,24 +4,8 @@
 
    * drop support for aasm_column ?
 
+
 # Currently working on
 
 
 # Changes so far
-
-## version 4.3
-
- * add support for multiple state machines per class
-   * class- and instance-level `aasm` methods accept a state machine selector
-     (aka the state machine _name_)
-     * if no selector/name is provided, `:default` will be used
-   * duplicate definitions of states and events will issue warnings
-   * check all tests
-     * _ActiveRecord_
-     * _Mongoid_
-     * _MongoMapper_
-     * _Sequel_
-   * what happen's if someone accesses `aasm`, but has defined a
-     state machine for `aasm(:my_name)`?
-   * documentation
- * drop support for find_in_state, count_in_state, calculate_in_state, with_state_scope

data/README.md

@@ -98,6 +98,8 @@ class Job
     state :sleeping, :initial => true, :before_enter => :do_something
     state :running
 
+    after_all_transitions :log_status_change
+
     event :run, :after => :notify_somebody do
       before do
         log('Preparing to run')
@@ -117,6 +119,10 @@ class Job
     end
   end
 
+  def log_status_change
+    puts "changing from #{aasm.from_state} to #{aasm.to_state} (event: #{aasm.current_event})"
+  end
+
   def set_process(name)
     ...
   end
@@ -145,6 +151,7 @@ begin
   transition      guards
   old_state       before_exit
   old_state       exit
+                  after_all_transitions
   transition      after
   new_state       before_enter
   new_state       enter
@@ -172,8 +179,9 @@ Note that when passing arguments to a state transition, the first argument must
 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 transition's `:after` callback (and reliably only then) you can access the
-originating state (the from-state) and the target state (the to state), like this:
+During the transition's `:after` callback (and reliably only then, or in the global
+`after_all_transitions` callback) you can access the originating state (the from-state)
+and the target state (the to state), like this:
 
 ```ruby
   def set_process(name)
@@ -313,9 +321,9 @@ job.aasm.current_state # stage3
 ```
 
 
-### Multiple state machine per class
+### Multiple state machines per class
 
-Multiple state machines per class are supported. Be aware though, that _AASM_ has been
+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:
 
 ```ruby
@@ -365,9 +373,9 @@ simple.aasm(:work).current
 
 ```
 
-_AASM_ doesn't prohibit to define the same event in both state machines. The
-latest definition "wins" and overrides previous definitions. A warning is issued:
-`SimpleMultipleExample: The event name run is already used!`.
+_AASM_ doesn't prohibit to define the same event in more than one state machine. The
+latest definition "wins" and overrides previous definitions. Nonetheless, a warning is issued:
+`SimpleMultipleExample: The aasm event name run is already used!`.
 
 All _AASM_ class- and instance-level `aasm` methods accept a state machine selector.
 So, for example, to use inspection on a class level, you have to use
@@ -378,7 +386,7 @@ SimpleMultipleExample.aasm(:work).states
 ```
 
 *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 as expected.
+(since version `4.3`), so please bear with us in case it doesn't work as expected.
 
 
 
@@ -417,7 +425,7 @@ job.run!  # saved
 
 Saving includes running all validations on the `Job` class. 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 validations. Be aware, that
+invalid object state), simply tell AASM to skip the validations. Be aware that
 when skipping validations, only the state column will be updated in the database
 (just like ActiveRecord `change_column` is working).
 
@@ -704,6 +712,10 @@ job.aasm.states(:permitted => true).map(&:name)
 # show all possible (triggerable) events (allowed by transitions)
 job.aasm.events.map(&:name)
 => [:sleep]
+
+# list states for select
+Job.aasm.states_for_select
+=> [["Sleeping", "sleeping"], ["Running", "running"], ["Cleaning", "cleaning"]]
 ```
 
 

data/gemfiles/rails_4.2_mongoid_5.gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+gem "sqlite3",                          :platforms => :ruby
+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 'mongoid', '~>5.0' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
+gem 'sequel'
+
+gemspec :path => "../"

data/lib/aasm/base.rb

@@ -67,7 +67,7 @@ module AASM
       @state_machine.add_state(name, @klass, options)
 
       if @klass.instance_methods.include?("#{name}?")
-        warn "#{@klass.name}: The state name #{name} is already used!"
+        warn "#{@klass.name}: The aasm state name #{name} is already used!"
       end
 
       @klass.class_eval <<-EORUBY, __FILE__, __LINE__ + 1
@@ -86,7 +86,7 @@ module AASM
       @state_machine.add_event(name, options, &block)
 
       if @klass.instance_methods.include?("may_#{name}?".to_sym)
-        warn "#{@klass.name}: The event name #{name} is already used!"
+        warn "#{@klass.name}: The aasm event name #{name} is already used!"
       end
 
       # an addition over standard aasm so that, before firing an event, you can ask
@@ -109,6 +109,10 @@ module AASM
       EORUBY
     end
 
+    def after_all_transitions(*callbacks, &block)
+      @state_machine.add_global_callbacks(:after_all_transitions, *callbacks, &block)
+    end
+
     def states
       @state_machine.states
     end

data/lib/aasm/core/transition.rb

@@ -30,6 +30,7 @@ module AASM::Core
     end
 
     def execute(obj, *args)
+      invoke_callbacks_compatible_with_guard(event.state_machine.global_callbacks[:after_all_transitions], obj, args)
       invoke_callbacks_compatible_with_guard(@after, obj, args)
     end
 

data/lib/aasm/instance_base.rb

@@ -59,7 +59,7 @@ module AASM
     end
 
     def state_object_for_name(name)
-      obj = @instance.class.aasm(@name).states.find {|s| s == name}
+      obj = @instance.class.aasm(@name).states.find {|s| s.name == name}
       raise AASM::UndefinedState, "State :#{name} doesn't exist" if obj.nil?
       obj
     end

data/lib/aasm/persistence/base.rb

@@ -56,8 +56,8 @@ module AASM
     def state_with_scope(name, *args)
       state_without_scope(name, *args)
       if @state_machine.config.create_scopes && !@klass.respond_to?(name)
-        if @klass.ancestors.map {|klass| klass.to_s}.include?("ActiveRecord::Base")
 
+        if @klass.ancestors.map {|klass| klass.to_s}.include?("ActiveRecord::Base")
           conditions = {"#{@klass.table_name}.#{@klass.aasm(@name).attribute_name}" => name.to_s}
           if ActiveRecord::VERSION::MAJOR >= 3
             @klass.class_eval do
@@ -69,12 +69,17 @@ module AASM
             end
           end
         elsif @klass.ancestors.map {|klass| klass.to_s}.include?("Mongoid::Document")
-          scope_options = lambda { @klass.send(:where, {@klass.aasm(@name).attribute_name.to_sym => name.to_s}) }
+          klass = @klass
+          state_machine_name = @name
+          scope_options = lambda {
+            klass.send(:where, {klass.aasm(state_machine_name).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(@name).attribute_name.to_sym => name.to_s }
           @klass.scope(name, lambda { @klass.where(conditions) })
         end
+
       end
     end
     alias_method :state_without_scope, :state

data/lib/aasm/state_machine.rb

@@ -10,12 +10,13 @@ module AASM
       (@machines ||= {})[klass.to_s] = machine
     end
 
-    attr_accessor :states, :events, :initial_state, :config, :name
+    attr_accessor :states, :events, :initial_state, :config, :name, :global_callbacks
 
     def initialize(name)
       @initial_state = nil
       @states = []
       @events = {}
+      @global_callbacks = {}
       @config = AASM::Configuration.new
       @name = name
     end
@@ -40,6 +41,14 @@ module AASM
       @events[name] = AASM::Core::Event.new(name, self, options, &block)
     end
 
+    def add_global_callbacks(name, *callbacks, &block)
+      @global_callbacks[name] ||= []
+      callbacks.each do |callback|
+        @global_callbacks[name] << callback
+      end
+      @global_callbacks[name] << block if block
+    end
+
     private
 
     def set_initial_state(name, options)

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "4.3.0"
+  VERSION = "4.4.0"
 end

data/spec/database.rb

@@ -1,5 +1,5 @@
 ActiveRecord::Migration.suppress_messages do
-  %w{gates multiple_gates readers writers transients simples no_scopes multiple_no_scopes no_direct_assignments multiple_no_direct_assignments thieves multiple_thieves localizer_test_models persisted_states provided_and_persisted_states with_enums with_true_enums with_false_enums false_states multiple_with_enums multiple_with_true_enums multiple_with_false_enums multiple_false_states}.each do |table_name|
+  %w{gates multiple_gates readers writers transients simples no_scopes multiple_no_scopes no_direct_assignments multiple_no_direct_assignments thieves multiple_thieves localizer_test_models persisted_states provided_and_persisted_states with_enums with_true_enums with_false_enums false_states multiple_with_enums multiple_with_true_enums multiple_with_false_enums multiple_false_states readme_jobs}.each do |table_name|
     ActiveRecord::Migration.create_table table_name, :force => true do |t|
       t.string "aasm_state"
     end

data/spec/models/active_record/readme_job.rb

@@ -0,0 +1,21 @@
+class ReadmeJob < ActiveRecord::Base
+  include AASM
+
+  aasm do
+    state :sleeping, :initial => true
+    state :running
+    state :cleaning
+
+    event :run do
+      transitions :from => :sleeping, :to => :running
+    end
+
+    event :clean do
+      transitions :from => :running, :to => :cleaning
+    end
+
+    event :sleep do
+      transitions :from => [:running, :cleaning], :to => :sleeping
+    end
+  end
+end

data/spec/models/callbacks/basic.rb

@@ -18,6 +18,8 @@ module Callbacks
     end
 
     aasm do
+      after_all_transitions :after_all_transitions
+
       state :open, :initial => true,
         :before_enter => :before_enter_open,
         :enter        => :enter_open,
@@ -68,6 +70,7 @@ module Callbacks
     def transition_guard;     log('transition_guard');    !@fail_transition_guard; end
 
     def after_transition;     log('after_transition');    end
+    def after_all_transitions;log('after_all_transitions');end
 
     def before_event;         log('before_event');        end
     def after_event;          log('after_event');         end

data/spec/models/callbacks/with_state_arg.rb

@@ -4,7 +4,7 @@ module Callbacks
     include AASM
 
     aasm do
-      state :open, :inital => true
+      state :open, :initial => true
       state :closed
       state :out_to_lunch
 

data/spec/models/callbacks/with_state_arg_multiple.rb

@@ -4,7 +4,7 @@ module Callbacks
     include AASM
 
     aasm(:left) do
-      state :open, :inital => true
+      state :open, :initial => true
       state :closed
       state :out_to_lunch
 

data/spec/unit/callbacks_spec.rb

@@ -17,6 +17,7 @@ describe 'callbacks for the new DSL' do
       expect(callback).to receive(:exit_open).once.ordered
       # expect(callback).to receive(:event_guard).once.ordered.and_return(true)
       # expect(callback).to receive(:transition_guard).once.ordered.and_return(true)
+      expect(callback).to receive(:after_all_transitions).once.ordered
       expect(callback).to receive(:after_transition).once.ordered
       expect(callback).to receive(:before_enter_closed).once.ordered
       expect(callback).to receive(:enter_closed).once.ordered

data/spec/unit/persistence/active_record_persistence_spec.rb

@@ -521,3 +521,20 @@ describe 'basic example with two state machines' do
     expect(example.aasm(:sync).current_state).to eql :unsynced
   end
 end
+
+describe 'testing the README examples' do
+  it 'Usage' do
+    job = ReadmeJob.new
+
+    expect(job.sleeping?).to eql true
+    expect(job.may_run?).to eql true
+
+    job.run
+
+    expect(job.running?).to eql true
+    expect(job.sleeping?).to eql false
+    expect(job.may_run?).to eql false
+
+    expect { job.run }.to raise_error(AASM::InvalidTransition)
+  end
+end

data/spec/unit/readme_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe 'testing the README examples' do
+
+  it 'Usage' do
+    class Job
+      include AASM
+
+      aasm do
+        state :sleeping, :initial => true
+        state :running
+        state :cleaning
+
+        event :run do
+          transitions :from => :sleeping, :to => :running
+        end
+
+        event :clean do
+          transitions :from => :running, :to => :cleaning
+        end
+
+        event :sleep do
+          transitions :from => [:running, :cleaning], :to => :sleeping
+        end
+      end
+    end
+
+    job = Job.new
+
+    expect(job.sleeping?).to eql true
+    expect(job.may_run?).to eql true
+
+    job.run
+
+    expect(job.running?).to eql true
+    expect(job.sleeping?).to eql false
+    expect(job.may_run?).to eql false
+
+    expect { job.run }.to raise_error(AASM::InvalidTransition)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Scott Barron
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-10 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -92,11 +92,12 @@ files:
 - callbacks.txt
 - gemfiles/rails_3.2.gemfile
 - gemfiles/rails_4.0.gemfile
-- gemfiles/rails_4.0_bson1.gemfile
+- gemfiles/rails_4.0_mongo_mapper.gemfile
 - gemfiles/rails_4.1.gemfile
-- gemfiles/rails_4.1_bson1.gemfile
+- gemfiles/rails_4.1_mongo_mapper.gemfile
 - gemfiles/rails_4.2.gemfile
-- gemfiles/rails_4.2_bson1.gemfile
+- gemfiles/rails_4.2_mongo_mapper.gemfile
+- gemfiles/rails_4.2_mongoid_5.gemfile
 - lib/aasm.rb
 - lib/aasm/aasm.rb
 - lib/aasm/base.rb
@@ -132,6 +133,7 @@ files:
 - spec/models/active_record/persisted_state.rb
 - spec/models/active_record/provided_and_persisted_state.rb
 - spec/models/active_record/reader.rb
+- spec/models/active_record/readme_job.rb
 - spec/models/active_record/simple_new_dsl.rb
 - spec/models/active_record/thief.rb
 - spec/models/active_record/transient.rb
@@ -220,6 +222,7 @@ files:
 - spec/unit/persistence/mongoid_persistence_spec.rb
 - spec/unit/persistence/sequel_persistence_multiple_spec.rb
 - spec/unit/persistence/sequel_persistence_spec.rb
+- spec/unit/readme_spec.rb
 - spec/unit/reloading_spec.rb
 - spec/unit/simple_example_spec.rb
 - spec/unit/simple_multiple_example_spec.rb
@@ -247,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: State machine mixin for Ruby objects
@@ -267,6 +270,7 @@ test_files:
 - spec/models/active_record/persisted_state.rb
 - spec/models/active_record/provided_and_persisted_state.rb
 - spec/models/active_record/reader.rb
+- spec/models/active_record/readme_job.rb
 - spec/models/active_record/simple_new_dsl.rb
 - spec/models/active_record/thief.rb
 - spec/models/active_record/transient.rb
@@ -355,6 +359,7 @@ test_files:
 - spec/unit/persistence/mongoid_persistence_spec.rb
 - spec/unit/persistence/sequel_persistence_multiple_spec.rb
 - spec/unit/persistence/sequel_persistence_spec.rb
+- spec/unit/readme_spec.rb
 - spec/unit/reloading_spec.rb
 - spec/unit/simple_example_spec.rb
 - spec/unit/simple_multiple_example_spec.rb