aasm 4.10.0 → 4.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a36f037200d0d9577fe0164fdd7a66e23db9156
-  data.tar.gz: 253250812a0f774df4e1d0c5111bf6c273ccd76d
+  metadata.gz: f62dfd355dcd559e5f9b2d00afc1d858c2b9a1f8
+  data.tar.gz: 168ae1576773a1e9e56444818704cfa74284f226
 SHA512:
-  metadata.gz: b41ce1fa467ee74ec16d1e3260506adfbda581d13078f2548120e4322c6a1582fb93aae9c84b451e834cd621ce115a3bb6f75c57a7b09be598fc93d2a348f919
-  data.tar.gz: c43910a1666f9011dfe6b604f6626931c821f5a2e5d9f641194e1837a5eb0b3a000f5d85cfca24af60635dec36074f3df9c83bbcd552b4e7da0da6b00d323e9d
+  metadata.gz: a93b62dad3157b2b731859ba126b427d0cc6401e30d215a73dcd6182fd9126b5f0fc183cc467108937c4ff9be2d60147074f017c88b5044f2e5e80959444547a
+  data.tar.gz: 91014f1d7a04436d98121a506ce34a3ed6777fe382dba29978f36257b17481d3d909b04562fcd747fe1e9498d2665850408da8ef8e195cba126719df5f659135

data/.travis.yml

@@ -4,12 +4,10 @@ cache: bundler
 
 rvm:
   - 1.9.3
-  - 2.0.0
-  - 2.1
-  - 2.2
-  - 2.3
+  - 2.2.5
+  - 2.3.1
   - jruby-1.7 # JRuby in 1.9 mode
-  - jruby-9.0.4.0
+  - jruby-9.0.5.0
   - rbx-2.5.8
 
 services:
@@ -20,11 +18,10 @@ gemfile:
   - gemfiles/rails_3.2_stable.gemfile
   - gemfiles/rails_4.0.gemfile
   - gemfiles/rails_4.0_mongo_mapper.gemfile
-  - gemfiles/rails_4.1.gemfile
-  - gemfiles/rails_4.1_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
@@ -33,15 +30,16 @@ before_script:
 
 matrix:
   allow_failures:
-    - rvm: rbx-2.2.1
-    - rvm: jruby-1.7
-    - rvm: 2.3
+    - 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.1.gemfile
-    - rvm: 2.2
+      gemfile: gemfiles/rails_5.0.gemfile
+    - rvm: 2.2.5
       gemfile: gemfiles/rails_3.2_stable.gemfile
-    - rvm: 2.3
+    - rvm: 2.3.1
       gemfile: gemfiles/rails_3.2_stable.gemfile
-    - rvm: jruby-19mode
-      gemfile: gemfiles/rails_4.1.gemfile
+    - rvm: jruby-1.7
+      gemfile: gemfiles/rails_5.0.gemfile

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 4.10.1
+
+ * fix: suppress warnings when using ActiveRecord enums feature (see [issue #346](https://github.com/aasm/aasm/pull/346) for details, thanks to [@110y](https://github.com/110y), and [issue #353](https://github.com/aasm/aasm/pull/353) for details, thanks to [@nathanstitt](https://github.com/nathanstitt))
+ * fix: handle array of success callbacks for transitions properly (see [issue #363](https://github.com/aasm/aasm/pull/363) for details, thanks to [@shunichi](https://github.com/shunichi))
+ * support `permitted: false` for states and events query/inspection methods (see [issue #364](https://github.com/aasm/aasm/pull/364) for details, thanks to [@hspazio](https://github.com/hspazio))
+
 ## 4.10.0
 
  * fix: some issues with RubyMotion (see [issue #320](https://github.com/aasm/aasm/pull/320) and [issue #343](https://github.com/aasm/aasm/pull/343) for details, thanks to [@Infotaku](https://github.com/Infotaku))

data/Gemfile

@@ -4,6 +4,7 @@ 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'

data/README.md

@@ -151,7 +151,7 @@ is finished.
 
 AASM will also initialize `LogRunTime` and run the `call` method for you after the transition from `running` to `finished` in the example above. You can pass arguments to the class by defining an initialize method on it, like this:
 
-```
+```ruby
 class LogRunTime
   # optional args parameter can be omitted, but if you define initialize
   # you must accept the model instance as the first parameter to it.
@@ -524,7 +524,7 @@ successful or `false` if errors occur. Exceptions are not raised.
 If you want make sure the state gets saved without running validations (and
 thereby maybe persisting aninvalid 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).
+be updated in the database (just like ActiveRecord `update_column` is working).
 
 ```ruby
 class Job < ActiveRecord::Base
@@ -866,29 +866,70 @@ end
 
 ### Inspection
 
-AASM supports a couple of methods to find out which states or events are provided or permitted.
+AASM supports query methods for states and events
+
+Given the following `Job` class:
+```ruby
+class Job
+  include AASM
+
+  aasm do
+    state :sleeping, :initial => true
+    state :running, :cleaning
+
+    event :run do
+      transitions :from => :sleeping, :to => :running
+    end
+
+    event :clean do
+      transitions :from => :running, :to => :cleaning, :guard => :cleaning_needed?
+    end
 
-Given this `Job` class:
+    event :sleep do
+      transitions :from => [:running, :cleaning], :to => :sleeping
+    end
+  end
+  
+  def cleaning_needed?
+    false
+  end
+end
+```
 
 ```ruby
 # show all states
-Job.aasm.states.map(&:name)
-=> [:sleeping, :running, :cleaning]
+Job.aasm.states.map(&:name) 
+#=> [:sleeping, :running, :cleaning]
 
 job = Job.new
 
-# show all permitted (reachable / possible) states
-job.aasm.states(:permitted => true).map(&:name)
-=> [:running]
+# show all permitted states (from initial state)
+job.aasm.states(:permitted => true).map(&:name) 
+#=> [:running]
+
 job.run
 job.aasm.states(:permitted => true).map(&:name)
-=> [:cleaning, :sleeping]
+#=> [:sleeping]
 
-# show all possible (triggerable) events (allowed by transitions)
+# show all non permitted states
+job.aasm.states(:permitted => false).map(&:name) 
+#=> [:cleaning]
+
+# show all possible (triggerable) events from the current state
 job.aasm.events.map(&:name)
-=> [:sleep]
+#=> [:clean, :sleep]
+
+# show all permitted events
+job.aasm.events(:permitted => true).map(&:name)
+#=> [:sleep]
+
+# show all non permitted events
+job.aasm.events(:permitted => false).map(&:name)
+#=> [:clean]
+
+# show all possible events except a specific one
 job.aasm.events(:reject => :sleep).map(&:name)
-=> []
+#=> [:clean]
 
 # list states for select
 Job.aasm.states_for_select

data/gemfiles/rails_4.0.gemfile

@@ -5,6 +5,7 @@ gem 'rubysl',                           :platforms => :rbx
 gem 'rubinius-developer_tools',         :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.0.13"
 gem 'mongoid', '~>4.0' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
 gem 'sequel'

data/gemfiles/rails_4.0_mongo_mapper.gemfile

@@ -6,6 +6,7 @@ gem 'rubysl',                           :platforms => :rbx
 gem 'rubinius-developer_tools',         :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.0.13"
 gem 'sequel'
 gem 'mongo_mapper', '~>0.13'

data/gemfiles/rails_4.2.gemfile

@@ -5,6 +5,7 @@ gem 'rubysl',                           :platforms => :rbx
 gem 'rubinius-developer_tools',         :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.5"
 gem 'mongoid', '~>4.0' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
 gem 'sequel'

data/gemfiles/rails_4.2_mongo_mapper.gemfile

@@ -6,6 +6,7 @@ gem 'rubysl',                           :platforms => :rbx
 gem 'rubinius-developer_tools',         :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.5"
 gem 'sequel'
 gem 'mongo_mapper'

data/gemfiles/rails_4.2_mongoid_5.gemfile

@@ -5,6 +5,7 @@ gem 'rubysl',                           :platforms => :rbx
 gem 'rubinius-developer_tools',         :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.5"
 gem 'mongoid', '~>5.0' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
 gem 'sequel'

data/gemfiles/{rails_4.1.gemfile → rails_5.0.gemfile}

@@ -5,11 +5,17 @@ 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.14"
-gem 'mongoid', '~>4.0' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
+
+gem "rails", "5.0.0.beta4"
+
+# mongoid is not yet Rails 5 compatible
+# gem 'mongoid', '~>4.0' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
+
 gem 'sequel'
-gem 'dynamoid', '~> 1',                 :platforms => :ruby
+
+# dynamoid is not yet Rails 5 compatible
+# gem 'dynamoid', '~> 1',                 :platforms => :ruby
+
 gem 'aws-sdk', '~>2',                   :platforms => :ruby
-gem "redis-objects"
 
 gemspec :path => "../"

data/lib/aasm/base.rb

@@ -193,7 +193,13 @@ module AASM
     end
 
     def safely_define_method(klass, method_name, method_definition)
-      if klass.instance_methods.include?(method_name.to_sym)
+      # Warn if method exists and it did not originate from an enum
+      if klass.method_defined?(method_name) &&
+         ! ( @state_machine.config.enum &&
+             klass.respond_to?(:defined_enums) &&
+             klass.defined_enums.values.any?{ |methods|
+                 methods.keys{| enum | enum + '?' == method_name }
+             })
         warn "#{klass.name}: overriding method '#{method_name}'!"
       end
 

data/lib/aasm/core/transition.rb

@@ -125,7 +125,7 @@ module AASM::Core
         when Proc
           code.arity == 0 ? record.instance_exec(&code) : record.instance_exec(*args, &code)
         when Array
-          @success.map {|a| _fire_callbacks(a, obj, args)}
+          code.map {|a| _fire_callbacks(a, record, args)}
         else
           true
       end

data/lib/aasm/instance_base.rb

@@ -34,19 +34,22 @@ module AASM
     end
 
     def states(options={})
-      if options[:permitted]
-        permitted_events = events(:permitted => true)
-
+      if options.has_key?(:permitted)
+        selected_events = events(:permitted => options[:permitted])
         # An array of arrays. Each inner array represents the transitions that
         # transition from the current state for an event
-        event_transitions = permitted_events.map {|e| e.transitions_from_state(current_state) }
+        event_transitions = selected_events.map {|e| e.transitions_from_state(current_state) }
 
-        # An array of symbols that are possible :to transition states
+        # An array of :to transition states
         to_state_names = event_transitions.map do |transitions|
           return nil if transitions.empty?
 
-          # Return the :to state of the first transition that is allowed or nil
-          transition = transitions.find { |t| t.allowed?(@instance) }
+          # Return the :to state of the first transition that is allowed (or not) or nil
+          if options[:permitted] 
+            transition = transitions.find { |t| t.allowed?(@instance) }
+          else
+            transition = transitions.find { |t| !t.allowed?(@instance) }
+          end
           transition ? transition.to : nil
         end.flatten.compact.uniq
 
@@ -64,10 +67,14 @@ module AASM
       options[:reject] = Array(options[:reject])
       events.reject! { |e| options[:reject].include?(e.name) }
 
-      if options[:permitted]
+      if options.has_key?(:permitted)
         # filters the results of events_for_current_state so that only those that
         # are really currently possible (given transition guards) are shown.
-        events.select! { |e| @instance.send("may_#{e.name}?") }
+        if options[:permitted]
+          events.select! { |e| @instance.send("may_#{e.name}?") }
+        else
+          events.select! { |e| !@instance.send("may_#{e.name}?") }
+        end
       end
 
       events

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "4.10.0"
+  VERSION = "4.10.1"
 end

data/spec/unit/inspection_spec.rb

@@ -25,10 +25,15 @@ describe 'inspection for common cases' do
       expect(states).to include(:closed)
       expect(states).to include(:final)
 
-      states = foo.aasm.states(:permitted => true)
-      expect(states).to include(:closed)
-      expect(states).not_to include(:open)
-      expect(states).not_to include(:final)
+      permitted_states = foo.aasm.states(:permitted => true)
+      expect(permitted_states).to include(:closed)
+      expect(permitted_states).not_to include(:open)
+      expect(permitted_states).not_to include(:final)
+
+      blocked_states = foo.aasm.states(:permitted => false)
+      expect(blocked_states).to include(:closed)
+      expect(blocked_states).not_to include(:open)
+      expect(blocked_states).to include(:final)
 
       foo.close
       expect(foo.aasm.states(:permitted => true)).to be_empty
@@ -124,3 +129,16 @@ describe 'permitted events' do
     expect(foo.aasm.events(:permitted => true, reject: [:close])).not_to include(:close)
   end
 end
+
+describe 'not permitted events' do
+  let(:foo) {Foo.new}
+
+  it 'work' do
+    expect(foo.aasm.events(:permitted => false)).to include(:null)
+    expect(foo.aasm.events(:permitted => false)).not_to include(:close)
+  end
+
+  it 'should not include events in the reject option' do
+    expect(foo.aasm.events(:permitted => false, reject: :null)).to eq([])
+  end
+end

data/spec/unit/override_warning_spec.rb

@@ -12,6 +12,21 @@ describe 'warns when overrides a method' do
     end
   end
 
+  module WithEnumBase
+    def self.included base
+      base.send :include, AASM
+      base.instance_eval do
+        def defined_enums
+          { 'state' => { 'valid' => 0, 'invalid' => 1 } }
+        end
+      end
+      base.aasm enum: true do
+        state :valid
+        event(:save) { }
+      end
+    end
+  end
+
   describe 'state' do
     class Base
       def valid?; end
@@ -22,6 +37,16 @@ describe 'warns when overrides a method' do
     end
   end
 
+  describe 'enum' do
+    class EnumBase
+      def valid?; end
+    end
+    it "dosn't warn when overriding an enum" do
+      expect { EnumBase.send :include, WithEnumBase }.
+        not_to output(/EnumBase: overriding method 'valid\?'!/).to_stderr
+    end
+  end
+
   describe 'event' do
     context 'may?' do
       class Base
@@ -40,4 +65,5 @@ describe 'warns when overrides a method' do
       end
     end
   end
+
 end

data/spec/unit/transition_spec.rb

@@ -392,6 +392,18 @@ describe AASM::Core::Transition, '- when invoking the transition :success method
     st.invoke_success_callbacks(obj, args)
   end
 
+  it 'should accept a Array for the method name' do
+    opts = {:from => 'foo', :to => 'bar', :success => [:test1, :test2]}
+    st = AASM::Core::Transition.new(event, opts)
+    args = {:arg1 => '1', :arg2 => '2'}
+    obj = double('object', :aasm => 'aasm')
+
+    expect(obj).to receive(:test1)
+    expect(obj).to receive(:test2)
+
+    st.invoke_success_callbacks(obj, args)
+  end
+
   it 'should pass args if the target method accepts them' do
     opts = {:from => 'foo', :to => 'bar', :success => :test}
     st = AASM::Core::Transition.new(event, opts)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 4.10.0
+  version: 4.10.1
 platform: ruby
 authors:
 - Scott Barron
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-31 00:00:00.000000000 Z
+date: 2016-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -107,11 +107,10 @@ files:
 - gemfiles/rails_3.2_stable.gemfile
 - gemfiles/rails_4.0.gemfile
 - gemfiles/rails_4.0_mongo_mapper.gemfile
-- gemfiles/rails_4.1.gemfile
-- gemfiles/rails_4.1_mongo_mapper.gemfile
 - gemfiles/rails_4.2.gemfile
 - gemfiles/rails_4.2_mongo_mapper.gemfile
 - gemfiles/rails_4.2_mongoid_5.gemfile
+- gemfiles/rails_5.0.gemfile
 - lib/aasm.rb
 - lib/aasm/aasm.rb
 - lib/aasm/base.rb
@@ -300,7 +299,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

data/gemfiles/rails_4.1_mongo_mapper.gemfile

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