aasm 3.0.24 → 3.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a95f430c49bb639c7f0df66dc4ce2998636ef6a
-  data.tar.gz: 67293708b7b6fbaae038e97d229367d0ca074aa8
+  metadata.gz: 2d749826eeac0c51c3ee50f09e7acee8f67db5bf
+  data.tar.gz: 7c96c771d9470db46c96c0ca1af339afd037feb1
 SHA512:
-  metadata.gz: 90707f9d64e5e03e9b58acde6081c9fe5239ff5599ece71a1909abad871dfdb99dfe8d1d63fae89a94d6f5a908754649387cb792f150d09a94f3a3acab2f2714
-  data.tar.gz: 20f34ec847d1fe22c59a7e077c5ccdd54f5ab6483dbab086544c7f7995f8df408a018344248ed9017ce9f8ed23f5d64dfe549855700d68c8797911edae9ceafc
+  metadata.gz: ff4157e4b1824c00a0201d249bd2e3d97f899c172c2209765ce786d0974836291c532a5d8c6ff54d92e999d322a545db3156331b9f69d9ab7ec60b2b94a35eec
+  data.tar.gz: e96dffe3354bbe7b9d9a38e0b5f7f1c447effd552e6a98b84bfbcea0ad4fe13299b99f8cffd99bdec42d87b56f3e8940b80744d889d1bb1d84862b133fc633de

data/.travis.yml

@@ -1,11 +1,29 @@
 language: ruby
+
 rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
   - 2.0.0
   # - 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
+
+matrix:
+  allow_failures:
+    - rvm: rbx-2.2.1
+    - rvm: jruby-19mode
+  exclude:
+    - { rvm: 1.8.7, gemfile: gemfiles/rails_4.0.gemfile }
+    - { rvm: 1.9.2, gemfile: gemfiles/rails_4.0.gemfile }
+    - { rvm: 1.9.3, gemfile: gemfiles/rails_4.0.gemfile }
+    - { rvm: jruby-19mode, gemfile: gemfiles/rails_3.2.gemfile }
+    - { rvm: jruby-19mode, gemfile: gemfiles/rails_4.0.gemfile }
+    - { rvm: rbx-2.2.1, gemfile: gemfiles/rails_3.2.gemfile }
+    - { rvm: rbx-2.2.1, gemfile: gemfiles/rails_4.0.gemfile }

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 3.1.0 (not yet released)
+
+ * deprecated old aasm_* class methods (old-style DSL), in preparation for AASM v4.0.0
+
+## 3.0.25
+
+ * initialize the state even if validation is skipped (for ActiveRecord and Mongoid persistence) (see issue #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,11 @@
-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.15"
+gem 'mongoid' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
 
 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

@@ -257,6 +257,7 @@ to include Mongoid::Document before you include AASM.
 class Job
   include Mongoid::Document
   include AASM
+  field :aasm_state
   aasm do
     ...
   end
@@ -325,9 +326,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
@@ -417,7 +418,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 +428,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 +444,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

@@ -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,11 @@
+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.15"
+gem 'mongoid' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
+
+gemspec :path => "../"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,10 @@
+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.0.1"
+
+gemspec :path => "../"

data/lib/aasm.rb

@@ -13,6 +13,3 @@ require 'ostruct'
     persistence
     aasm
   ).each { |file| require File.join(File.dirname(__FILE__), 'aasm', file) }
-
-# load the deprecated methods and modules
-Dir[File.join(File.dirname(__FILE__), 'aasm', 'deprecated', '*.rb')].sort.each { |f| require File.expand_path(f) }

data/lib/aasm/aasm.rb

@@ -26,52 +26,56 @@ module AASM
       @aasm
     end
 
-    # TODO: maybe better: aasm.initial_state
+    # TODO remove this method in v4.0.0
     def aasm_initial_state(set_state=nil)
       if set_state
-        # deprecated way to set the value
+        warn ".aasm_initial_state(:name) is deprecated and will be removed in version 4.0.0; please use .aasm.initial_state = :name instead!"
         AASM::StateMachine[self].initial_state = set_state
       else
+        warn ".aasm_initial_state is deprecated and will be removed in version 4.0.0; please use .aasm.initial_state instead!"
         AASM::StateMachine[self].initial_state
       end
     end
 
-    # is this better?: aasm.states.name.from_states
+    # TODO remove this method in v4.0.0
     def aasm_from_states_for_state(state, options={})
-      if options[:transition]
-        aasm.events[options[:transition]].transitions_to_state(state).flatten.map(&:from).flatten
-      else
-        aasm.events.map {|k,v| v.transitions_to_state(state)}.flatten.map(&:from).flatten
-      end
+      warn ".aasm_from_states_for_state is deprecated and will be removed in version 4.0.0; please use .aasm.from_states_for_state instead!"
+      aasm.from_states_for_state(state, options)
     end
 
-    # deprecated
+    # TODO remove this method in v4.0.0
     def aasm_initial_state=(state)
+      warn ".aasm_initial_state= is deprecated and will be removed in version 4.0.0"
       AASM::StateMachine[self].initial_state = state
     end
 
-    # deprecated
+    # TODO remove this method in v4.0.0
     def aasm_state(name, options={})
+      warn ".aasm_state is deprecated and will be removed in version 4.0.0; please use .aasm.state instead!"
       aasm.state(name, options)
     end
 
-    # deprecated
+    # TODO remove this method in v4.0.0
     def aasm_event(name, options = {}, &block)
+      warn ".aasm_event is deprecated and will be removed in version 4.0.0; please use .aasm.event instead!"
       aasm.event(name, options, &block)
     end
 
-    # deprecated
+    # TODO remove this method in v4.0.0
     def aasm_states
+      warn ".aasm_states is deprecated and will be removed in version 4.0.0; please use .aasm.states instead!"
       aasm.states
     end
 
-    # deprecated
+    # TODO remove this method in v4.0.0
     def aasm_events
+      warn ".aasm_events is deprecated and will be removed in version 4.0.0; please use .aasm.events instead!"
       aasm.events
     end
 
-    # deprecated
+    # TODO remove this method in v4.0.0
     def aasm_states_for_select
+      warn ".aasm_states_for_select is deprecated and will be removed in version 4.0.0; please use .aasm.states_for_select instead!"
       aasm.states_for_select
     end
 
@@ -103,46 +107,46 @@ module AASM
     true
   end
 
-  # deprecated
+    # TODO remove this method in v4.0.0
   def aasm_current_state
-    # warn "#aasm_current_state is deprecated and will be removed in version 3.2.0; please use #aasm.state instead!"
+    warn "#aasm_current_state is deprecated and will be removed in version 4.0.0; please use #aasm.current_state instead!"
     aasm.current_state
   end
 
-  # deprecated
+    # TODO remove this method in v4.0.0
   def aasm_enter_initial_state
-    # warn "#aasm_enter_initial_state is deprecated and will be removed in version 3.2.0; please use #aasm.enter_initial_state instead!"
+    warn "#aasm_enter_initial_state is deprecated and will be removed in version 4.0.0; please use #aasm.enter_initial_state instead!"
     aasm.enter_initial_state
   end
 
-  # deprecated
+    # TODO remove this method in v4.0.0
   def aasm_events_for_current_state
-    # warn "#aasm_events_for_current_state is deprecated and will be removed in version 3.2.0; please use #aasm.events instead!"
+    warn "#aasm_events_for_current_state is deprecated and will be removed in version 4.0.0; please use #aasm.events(aasm.current_state) instead!"
     aasm.events(aasm.current_state)
   end
 
-  # deprecated
+    # TODO remove this method in v4.0.0
   def aasm_permissible_events_for_current_state
-    # warn "#aasm_permissible_events_for_current_state is deprecated and will be removed in version 3.2.0; please use #aasm.permissible_events instead!"
+    warn "#aasm_permissible_events_for_current_state is deprecated and will be removed in version 4.0.0; please use #aasm.permissible_events instead!"
     aasm.permissible_events
   end
 
-  # deprecated
+    # TODO remove this method in v4.0.0
   def aasm_events_for_state(state_name)
-    # warn "#aasm_events_for_state(state_name) is deprecated and will be removed in version 3.2.0; please use #aasm.events(state_name) instead!"
+    warn "#aasm_events_for_state(state_name) is deprecated and will be removed in version 4.0.0; please use #aasm.events(state_name) instead!"
     aasm.events(state_name)
   end
 
-  # deprecated
+    # TODO remove this method in v4.0.0
   def aasm_human_state
-    # warn "#aasm_human_state is deprecated and will be removed in version 3.2.0; please use #aasm.human_state instead!"
+    warn "#aasm_human_state is deprecated and will be removed in version 4.0.0; please use #aasm.human_state instead!"
     aasm.human_state
   end
 
 private
 
   def aasm_fire_event(event_name, options, *args, &block)
-    event = self.class.aasm_events[event_name]
+    event = self.class.aasm.events[event_name]
     begin
       old_state = aasm.state_object_for_name(aasm.current_state)
       old_state.fire_callbacks(:exit, self)

data/lib/aasm/base.rb

@@ -25,13 +25,16 @@ module AASM
       end
     end
 
-    def initial_state
-      @state_machine.initial_state
+    def initial_state(new_initial_state=nil)
+      if new_initial_state
+        @state_machine.initial_state = new_initial_state
+      else
+        @state_machine.initial_state
+      end
     end
 
     # define a state
     def state(name, options={})
-      # @clazz.aasm_state(name, options)
       @state_machine.add_state(name, @clazz, options)
       @state_machine.initial_state = name if options[:initial] || !@state_machine.initial_state
 
@@ -46,8 +49,6 @@ module AASM
 
     # define an event
     def event(name, options={}, &block)
-      # @clazz.aasm_event(name, options, &block)
-
       @state_machine.events[name] = AASM::Event.new(name, options, &block)
 
       # an addition over standard aasm so that, before firing an event, you can ask
@@ -78,5 +79,13 @@ module AASM
       states.map { |state| state.for_select }
     end
 
+    def from_states_for_state(state, options={})
+      if options[:transition]
+        events[options[:transition]].transitions_to_state(state).flatten.map(&:from).flatten
+      else
+        events.map {|k,v| v.transitions_to_state(state)}.flatten.map(&:from).flatten
+      end
+    end
+
   end
 end

data/lib/aasm/event.rb

@@ -36,9 +36,9 @@ module AASM
       @transitions.select { |t| t.to == state }
     end
 
-    # deprecated
+    # TODO remove this method in v4.0.0
     def all_transitions
-      # warn "Event#all_transitions is deprecated and will be removed in version 3.2.0; please use Event#transitions instead!"
+      warn "Event#all_transitions is deprecated and will be removed in version 4.0.0; please use Event#transitions instead!"
       transitions
     end
 
@@ -54,6 +54,19 @@ module AASM
       end
     end
 
+    ## DSL interface
+    def transitions(definitions=nil)
+      if definitions # define new transitions
+        # Create a separate transition for each from state to the given state
+        Array(definitions[:from]).each do |s|
+          @transitions << AASM::Transition.new(definitions.merge({:from => s.to_sym}))
+        end
+        # Create a transition if to is specified without from (transitions from ANY state)
+        @transitions << AASM::Transition.new(definitions) if @transitions.empty? && definitions[:to]
+      end
+      @transitions
+    end
+
   private
 
     def update(options = {}, &block)
@@ -68,7 +81,7 @@ module AASM
     def _fire(obj, test, to_state=nil, *args)
       result = test ? false : nil
       if @transitions.map(&:from).any?
-        transitions = @transitions.select { |t| t.from == obj.aasm_current_state }
+        transitions = @transitions.select { |t| t.from == obj.aasm.current_state }
         return result if transitions.size == 0
       else
         transitions = @transitions
@@ -106,19 +119,6 @@ module AASM
       end
     end
 
-    ## DSL interface
-    def transitions(trans_opts=nil)
-      if trans_opts # define new transitions
-        # Create a separate transition for each from state to the given state
-        Array(trans_opts[:from]).each do |s|
-          @transitions << AASM::Transition.new(trans_opts.merge({:from => s.to_sym}))
-        end
-        # Create a transition if to is specified without from (transitions from ANY state)
-        @transitions << AASM::Transition.new(trans_opts) if @transitions.empty? && trans_opts[:to]
-      end
-      @transitions
-    end
-
     [:after, :before, :error, :success].each do |callback_name|
       define_method callback_name do |*args, &block|
         options[callback_name] = Array(options[callback_name])

data/lib/aasm/instance_base.rb

@@ -15,7 +15,7 @@ module AASM
     end
 
     def enter_initial_state
-      state_name = determine_state_name(@instance.class.aasm_initial_state)
+      state_name = determine_state_name(@instance.class.aasm.initial_state)
       state_object = state_object_for_name(state_name)
 
       state_object.fire_callbacks(:before_enter, @instance)

data/lib/aasm/persistence/active_record_persistence.rb

@@ -36,6 +36,8 @@ module AASM
         else
           base.before_validation_on_create(:aasm_ensure_initial_state)
         end
+        # ensure initial aasm state even when validations are skipped
+        base.before_create(:aasm_ensure_initial_state)
       end
 
       module ClassMethods
@@ -71,10 +73,10 @@ module AASM
         # Writes <tt>state</tt> to the state column and persists it to the database
         #
         #   foo = Foo.find(1)
-        #   foo.aasm_current_state # => :opened
+        #   foo.aasm.current_state # => :opened
         #   foo.close!
-        #   foo.aasm_current_state # => :closed
-        #   Foo.find(1).aasm_current_state # => :closed
+        #   foo.aasm.current_state # => :closed
+        #   Foo.find(1).aasm.current_state # => :closed
         #
         # NOTE: intended to be called from an event
         def aasm_write_state(state)
@@ -97,13 +99,13 @@ module AASM
         # Writes <tt>state</tt> to the state column, but does not persist it to the database
         #
         #   foo = Foo.find(1)
-        #   foo.aasm_current_state # => :opened
+        #   foo.aasm.current_state # => :opened
         #   foo.close
-        #   foo.aasm_current_state # => :closed
-        #   Foo.find(1).aasm_current_state # => :opened
+        #   foo.aasm.current_state # => :closed
+        #   Foo.find(1).aasm.current_state # => :opened
         #   foo.save
-        #   foo.aasm_current_state # => :closed
-        #   Foo.find(1).aasm_current_state # => :closed
+        #   foo.aasm.current_state # => :closed
+        #   Foo.find(1).aasm.current_state # => :closed
         #
         # NOTE: intended to be called from an event
         def aasm_write_state_without_persistence(state)