aasm 3.0.19 → 3.0.20

data/CHANGELOG.md

@@ -1,17 +1,21 @@
 # CHANGELOG
 
+## 3.0.20
+
+ * added configuration option to disable automatic scope creation
+
 ## 3.0.19
 
- * fixed deprecation warning with Rails 4 (Relation#update_all with conditions is deprecated)
- * fixing issue #69 (ActiveRecord scopes are not chainable)
+ * fixed deprecation warning with *Rails 4* (`Relation#update_all` with conditions is deprecated)
+ * fixing [issue #69](https://github.com/aasm/aasm/issues/69) ( *ActiveRecord* scopes are not chainable)
 
 ## 3.0.18
 
- * fixing issue #66 (state methods not reflecting the current state)
+ * fixing [issue #66](https://github.com/aasm/aasm/issues/66) (state methods not reflecting the current state)
 
 ## 3.0.17
 
- * supporting instance level inspection for states (including permissible state, see issue #54)
+ * supporting instance level inspection for states (including permissible state, see [issue #54](https://github.com/aasm/aasm/issues/54))
  * added autocreation of constants for each state ([@jherdman](https://github.com/jherdman))
 
 ## 3.0.16
@@ -20,7 +24,7 @@
 
 ## 3.0.15
 
- * added support for localized state names (on a class level, like Record.aasm.states.map(&:localized_name))
+ * added support for localized state names (on a class level, like `Record.aasm.states.map(&:localized_name)`)
 
 ## 3.0.14
 
@@ -40,7 +44,7 @@
 
 ## 3.0.10
 
- * added support for transitions from all other states (thanks to *Stefan 'swrobel' Wrobel*)
+ * added support for transitions from all other states (thanks to [@swrobel](https://github.com/swrobel))
 
 ## 3.0.9
 
@@ -52,7 +56,7 @@
 
 ## 3.0.7
 
- * removed deprecation warning when localizing aasm state names (look at https://github.com/rubyist/aasm/issues/38 for details)
+ * removed deprecation warning when localizing aasm state names (look at [issue #38](https://github.com/rubyist/aasm/issues/38) for details)
 
 ## 3.0.6
 

data/README.md

@@ -268,6 +268,22 @@ class JobsController < ApplicationController
 end
 ```
 
+If you don't need scopes (or simply don't want them), disable their creation when
+defining the `AASM` states, like this:
+
+```ruby
+class Job < ActiveRecord::Base
+  include AASM
+
+  aasm :create_scopes => false do
+    state :sleeping, :initial => true
+    state :running
+    state :cleaning
+  end
+end
+```
+
+
 ### Transaction support
 
 Since version *3.0.13* AASM supports ActiveRecord transactions. So whenever a transition
@@ -313,16 +329,16 @@ Given the `Job` class from above:
 ```ruby
 job = Job.new
 
-job.states
+job.aasm.states
 => [:sleeping, :running, :cleaning]
 
-job.states(:permissible => true)
+job.aasm.states(:permissible => true)
 => [:running]
 job.run
-job.states(:permissible => true)
+job.aasm.states(:permissible => true)
 => [:cleaning, :sleeping]
 
-job.events
+job.aasm.events
 => [:run, :clean, :sleep]
 ```
 

data/lib/aasm/aasm.rb

@@ -2,7 +2,11 @@ module AASM
 
   def self.included(base) #:nodoc:
     base.extend AASM::ClassMethods
+
+    # do not overwrite existing state machines, which could have been created by
+    # inheritance, see class method inherited
     AASM::StateMachine[base] ||= AASM::StateMachine.new('')
+
     AASM::Persistence.load_persistence(base)
     super
   end

data/lib/aasm/base.rb

@@ -12,6 +12,12 @@ module AASM
         @state_machine.config.whiny_transitions = true # this is the default, so let's cry
       end
 
+      if options.key?(:create_scopes)
+        @state_machine.config.create_scopes = options[:create_scopes]
+      elsif @state_machine.config.create_scopes.nil?
+        @state_machine.config.create_scopes = true # this is the default, so let's create scopes
+      end
+
       if options.key?(:skip_validation_on_save)
         @state_machine.config.skip_validation_on_save = options[:skip_validation_on_save]
       elsif @state_machine.config.skip_validation_on_save.nil?

data/lib/aasm/event.rb

@@ -64,16 +64,16 @@ module AASM
       self
     end
 
-    # Execute if test? == false, otherwise return true/false depending on whether it would fire
+    # Execute if test == false, otherwise return true/false depending on whether it would fire
     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 }
-        return nil if transitions.size == 0
+        return result if transitions.size == 0
       else
         transitions = @transitions
       end
 
-      result = test ? false : nil
       transitions.each do |transition|
         next if to_state and !Array(transition.to).include?(to_state)
         if transition.perform(obj, *args)

data/lib/aasm/persistence/base.rb

@@ -87,7 +87,7 @@ module AASM
     # make sure to create a (named) scope for each state
     def state_with_scope(name, *args)
       state_without_scope(name, *args)
-      unless @clazz.respond_to?(name)
+      if AASM::StateMachine[@clazz].config.create_scopes && !@clazz.respond_to?(name)
         if @clazz.ancestors.map {|klass| klass.to_s}.include?("ActiveRecord::Base")
 
           conditions = {"#{@clazz.table_name}.#{@clazz.aasm_column}" => name.to_s}

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "3.0.19"
+  VERSION = "3.0.20"
 end

data/spec/models/mongoid/no_scope_mongoid.rb

@@ -0,0 +1,10 @@
+class NoScopeMongoid
+  include Mongoid::Document
+  include AASM
+
+  field :status, type: String
+
+  aasm :create_scopes => false, :column => :status do
+    state :ignored_scope
+  end
+end

data/spec/models/persistence.rb

@@ -52,6 +52,13 @@ class SimpleNewDsl < ActiveRecord::Base
   end
 end
 
+class NoScope < ActiveRecord::Base
+  include AASM
+  aasm :create_scopes => false do
+    state :ignored_scope
+  end
+end
+
 class Derivate < Simple
 end
 

data/spec/schema.rb

@@ -1,6 +1,6 @@
 ActiveRecord::Schema.define(:version => 0) do
 
-  %w{gates readers writers transients simples simple_new_dsls thieves localizer_test_models persisted_states provided_and_persisted_states}.each do |table_name|
+  %w{gates readers writers transients simples simple_new_dsls no_scopes thieves localizer_test_models persisted_states provided_and_persisted_states}.each do |table_name|
     create_table table_name, :force => true do |t|
       t.string "aasm_state"
     end

data/spec/unit/persistence/active_record_persistence_spec.rb

@@ -110,6 +110,10 @@ describe "named scopes with the new DSL" do
     end
   end
 
+  it "does not create scopes if requested" do
+    NoScope.should_not respond_to(:ignored_scope)
+  end
+
 end
 
 describe 'initial states' do

data/spec/unit/persistence/mongoid_persistance_spec.rb

@@ -55,6 +55,10 @@ describe 'mongoid', :if => Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version
       end
     end
 
+    it "does not create scopes if requested" do
+      NoScopeMongoid.should_not respond_to(:ignored_scope)
+    end
+
   end
 
   describe "#find_in_state" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 3.0.19
+  version: 3.0.20
   prerelease: 
 platform: ruby
 authors:
@@ -12,22 +12,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-29 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70095838288580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 3.2.12
   type: :development
   prerelease: false
-  version_requirements: *70095838288580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.12
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70095838287920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +40,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70095838287920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70095838287460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +56,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70095838287460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sdoc
-  requirement: &70095838287040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +72,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70095838287040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70095838286540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +88,15 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70095838286540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70095838286120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,10 +104,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70095838286120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70095838285660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -90,10 +120,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70095838285660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70095838285240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,10 +136,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70095838285240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-debug-completion
-  requirement: &70095838284820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -112,10 +152,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70095838284820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
-  requirement: &70095838284400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -123,7 +168,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70095838284400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: AASM is a continuation of the acts as state machine rails plugin, built
   for plain Ruby objects.
 email: scott@elitists.net, ttilley@gmail.com, aasm@mt7.de
@@ -171,6 +221,7 @@ files:
 - spec/models/father.rb
 - spec/models/foo.rb
 - spec/models/invalid_persistor.rb
+- spec/models/mongoid/no_scope_mongoid.rb
 - spec/models/mongoid/simple_mongoid.rb
 - spec/models/mongoid/simple_new_dsl_mongoid.rb
 - spec/models/not_auto_loaded/process.rb
@@ -222,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: State machine mixin for Ruby objects
@@ -240,6 +291,7 @@ test_files:
 - spec/models/father.rb
 - spec/models/foo.rb
 - spec/models/invalid_persistor.rb
+- spec/models/mongoid/no_scope_mongoid.rb
 - spec/models/mongoid/simple_mongoid.rb
 - spec/models/mongoid/simple_new_dsl_mongoid.rb
 - spec/models/not_auto_loaded/process.rb