aasm 3.0.15 → 3.0.16

data/.travis.yml

@@ -7,3 +7,4 @@ rvm:
   # - jruby-19mode # JRuby in 1.9 mode
   - rbx-18mode
   - rbx-19mode
+services: mongodb

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 3.0.16
+
+ * added autocreation of state scopes for Mongoid (thanks to [@jonnyshields](https://github.com/johnnyshields))
+
 ## 3.0.15
 
  * added support for localized state names (on a class level, like Record.aasm.states.map(&:localized_name))

data/README.md

@@ -215,6 +215,37 @@ class Job < ActiveRecord::Base
 end
 ```
 
+### Automatic Scopes
+
+AASM will automatically create scope methods for each state in the model.
+
+```ruby
+class Job < ActiveRecord::Base
+  include AASM
+
+  aasm do
+    state :sleeping, :initial => true
+    state :running
+    state :cleaning
+  end
+
+  def sleeping
+    "This method name is in already use"
+  end
+end
+```
+
+```ruby
+class JobsController < ApplicationController
+  def index
+    @running_jobs = jobs.running
+    @recent_cleaning_jobs = jobs.cleaning.where('created_at >=  ?', 3.days.ago)
+
+    # @sleeping_jobs = jobs.sleeping   #=> "This method name is in already use"
+  end
+end
+```
+
 ### Transaction support
 
 Since version *3.0.13* AASM supports ActiveRecord transactions. So whenever a transition

data/aasm.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
   s.licenses    = ["MIT"]
 
   s.add_development_dependency 'activerecord'
+  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.0'

data/lib/aasm/persistence/active_record_persistence.rb

@@ -172,19 +172,3 @@ module AASM
     end
   end
 end
-
-class AASM::Base
-  def state_with_scope(name, *args)
-    state_without_scope(name, *args)
-    if @clazz.ancestors.map {|klass| klass.to_s}.include?("ActiveRecord::Base") && !@clazz.respond_to?(name)
-      # puts "setting scope #{@clazz.name}.#{name}"
-      scope_options = {:conditions => { "#{@clazz.table_name}.#{@clazz.aasm_column}" => name.to_s}}
-      scope_method = ActiveRecord::VERSION::MAJOR >= 3 ? :scope : :named_scope
-      @clazz.send(scope_method, name, scope_options)
-    # else
-    #   puts "not setting scope #{@clazz.name}.#{name}"
-    end
-  end
-  alias_method :state_without_scope, :state
-  alias_method :state, :state_with_scope
-end

data/lib/aasm/persistence/base.rb

@@ -43,4 +43,23 @@ module AASM
 
     end # Base
   end # Persistence
+
+  class Base
+    def state_with_scope(name, *args)
+      state_without_scope(name, *args)
+      unless @clazz.respond_to?(name)
+        if @clazz.ancestors.map {|klass| klass.to_s}.include?("ActiveRecord::Base")
+          scope_options = {:conditions => { "#{@clazz.table_name}.#{@clazz.aasm_column}" => name.to_s}}
+          scope_method = ActiveRecord::VERSION::MAJOR >= 3 ? :scope : :named_scope
+          @clazz.send(scope_method, name, scope_options)
+        elsif @clazz.ancestors.map {|klass| klass.to_s}.include?("Mongoid::Document")
+          scope_options = lambda { @clazz.send(:where, {@clazz.aasm_column.to_sym => name.to_s}) }
+          @clazz.send(:scope, name, scope_options)
+        end
+      end
+    end
+    alias_method :state_without_scope, :state
+    alias_method :state, :state_with_scope
+  end # Base
+
 end # AASM

data/lib/aasm/persistence/mongoid_persistence.rb

@@ -41,25 +41,31 @@ module AASM
         base.send(:include, AASM::Persistence::MongoidPersistence::WriteState) unless base.method_defined?(:aasm_write_state)
         base.send(:include, AASM::Persistence::MongoidPersistence::WriteStateWithoutPersistence) unless base.method_defined?(:aasm_write_state_without_persistence)
 
-        # if base.respond_to?(:named_scope)
-        #   base.extend(AASM::Persistence::MongoidPersistence::NamedScopeMethods)
-        #
-        #   base.class_eval do
-        #     class << self
-        #       unless method_defined?(:aasm_state_without_named_scope)
-        #         alias_method :aasm_state_without_named_scope, :aasm_state
-        #         alias_method :aasm_state, :aasm_state_with_named_scope
-        #       end
-        #     end
-        #   end
-        # end
-
         # Mongoid's Validatable gem dependency goes not have a before_validation_on_xxx hook yet.
         # base.before_validation_on_create :aasm_ensure_initial_state
         base.before_validation :aasm_ensure_initial_state
       end
 
       module ClassMethods
+
+        def find_in_state(number, state, *args)
+          with_state_scope state do
+            find(number, *args)
+          end
+        end
+
+        def count_in_state(state, *args)
+          with_state_scope state do
+            count(*args)
+          end
+        end
+
+        def with_state_scope(state)
+          with_scope where(aasm_column.to_sym => state.to_s) do
+            yield if block_given?
+          end
+        end
+
       end
 
       module InstanceMethods
@@ -155,4 +161,4 @@ module AASM
       end
     end
   end
-end
+end

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "3.0.15"
+  VERSION = "3.0.16"
 end

data/spec/models/mongoid/mongoid_models.rb

@@ -0,0 +1,23 @@
+class SimpleMongoid
+  include Mongoid::Document
+  include AASM
+
+  field :status, type: String
+
+  aasm_column :status
+  aasm_state :unknown_scope
+  aasm_state :new
+end
+
+class SimpleNewDslMongoid
+  include Mongoid::Document
+  include AASM
+
+  field :status, type: String
+
+  aasm :column => :status
+  aasm do
+    state :unknown_scope
+    state :new
+  end
+end

data/spec/unit/persistence/mongoid_persistance_spec.rb

@@ -0,0 +1,126 @@
+describe 'mongoid', :if => Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3') do
+
+  before(:all) do
+    require 'mongoid'
+    require 'logger'
+    require 'spec_helper'
+    require File.dirname(__FILE__) + '/../../models/mongoid/mongoid_models'
+
+    # if you want to see the statements while running the spec enable the following line
+    # Mongoid.logger = Logger.new(STDERR)
+
+    DATABASE_NAME = "mongoid_#{Process.pid}"
+
+    Mongoid.configure do |config|
+      config.connect_to DATABASE_NAME
+    end
+  end
+
+  after do
+    Mongoid.purge!
+  end
+
+  describe "named scopes with the old DSL" do
+
+    context "Does not already respond_to? the scope name" do
+      it "should add a scope" do
+        SimpleMongoid.should respond_to(:unknown_scope)
+        SimpleMongoid.unknown_scope.class.should == Mongoid::Criteria
+      end
+    end
+
+    context "Already respond_to? the scope name" do
+      it "should not add a scope" do
+        SimpleMongoid.should respond_to(:new)
+        SimpleMongoid.new.class.should == SimpleMongoid
+      end
+    end
+
+  end
+
+  describe "named scopes with the new DSL" do
+
+    context "Does not already respond_to? the scope name" do
+      it "should add a scope" do
+        SimpleNewDslMongoid.should respond_to(:unknown_scope)
+        SimpleNewDslMongoid.unknown_scope.class.should == Mongoid::Criteria
+      end
+    end
+
+    context "Already respond_to? the scope name" do
+      it "should not add a scope" do
+        SimpleNewDslMongoid.should respond_to(:new)
+        SimpleNewDslMongoid.new.class.should == SimpleNewDslMongoid
+      end
+    end
+
+  end
+
+  describe "#find_in_state" do
+
+    let!(:model)    { SimpleNewDslMongoid.create!(:status => :unknown_scope) }
+    let!(:model_id) { model._id }
+
+    it "should respond to method" do
+      SimpleNewDslMongoid.should respond_to(:find_in_state)
+    end
+
+    it "should find the model when given the correct scope and model id" do
+      SimpleNewDslMongoid.find_in_state(model_id, 'unknown_scope').class.should == SimpleNewDslMongoid
+      SimpleNewDslMongoid.find_in_state(model_id, 'unknown_scope').should == model
+    end
+
+    it "should raise DocumentNotFound error when given incorrect scope" do
+      expect {SimpleNewDslMongoid.find_in_state(model_id, 'new')}.to raise_error Mongoid::Errors::DocumentNotFound
+    end
+
+    it "should raise DocumentNotFound error when given incorrect model id" do
+      expect {SimpleNewDslMongoid.find_in_state('bad_id', 'unknown_scope')}.to raise_error Mongoid::Errors::DocumentNotFound
+    end
+
+  end
+
+  describe "#count_in_state" do
+
+    before do
+      3.times { SimpleNewDslMongoid.create!(:status => :unknown_scope) }
+    end
+
+    it "should respond to method" do
+      SimpleNewDslMongoid.should respond_to(:count_in_state)
+    end
+
+    it "should return n for a scope with n records persisted" do
+      SimpleNewDslMongoid.count_in_state('unknown_scope').class.should == Fixnum
+      SimpleNewDslMongoid.count_in_state('unknown_scope').should == 3
+    end
+
+    it "should return zero for a scope without records persisted" do
+      SimpleNewDslMongoid.count_in_state('new').class.should == Fixnum
+      SimpleNewDslMongoid.count_in_state('new').should == 0
+    end
+
+  end
+
+  describe "#with_state_scope" do
+
+    before do
+      3.times { SimpleNewDslMongoid.create!(:status => :unknown_scope) }
+      2.times { SimpleNewDslMongoid.create!(:status => :new) }
+    end
+
+    it "should respond to method" do
+      SimpleNewDslMongoid.should respond_to(:with_state_scope)
+    end
+
+    it "should correctly process block" do
+      SimpleNewDslMongoid.with_state_scope('unknown_scope') do
+        SimpleNewDslMongoid.count
+      end.should == 3
+      SimpleNewDslMongoid.with_state_scope('new') do
+        SimpleNewDslMongoid.count
+      end.should == 2
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 3.0.15
+  version: 3.0.16
   prerelease: 
 platform: ruby
 authors:
@@ -12,11 +12,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-27 00:00:00.000000000Z
+date: 2013-01-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70247621982320 !ruby/object:Gem::Requirement
+  requirement: &70169537118900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247621982320
+  version_requirements: *70169537118900
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70247621981900 !ruby/object:Gem::Requirement
+  requirement: &70169537117620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247621981900
+  version_requirements: *70169537117620
 - !ruby/object:Gem::Dependency
   name: sdoc
-  requirement: &70247621981480 !ruby/object:Gem::Requirement
+  requirement: &70169537117180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +46,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247621981480
+  version_requirements: *70169537117180
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70247621980980 !ruby/object:Gem::Requirement
+  requirement: &70169537116680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -57,10 +57,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70247621980980
+  version_requirements: *70169537116680
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70247621980560 !ruby/object:Gem::Requirement
+  requirement: &70169537116260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -68,10 +68,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247621980560
+  version_requirements: *70169537116260
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70247621980100 !ruby/object:Gem::Requirement
+  requirement: &70169537147800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,10 +79,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247621980100
+  version_requirements: *70169537147800
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70247621979680 !ruby/object:Gem::Requirement
+  requirement: &70169537147380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -90,10 +90,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247621979680
+  version_requirements: *70169537147380
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70247621979260 !ruby/object:Gem::Requirement
+  requirement: &70169537146960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,10 +101,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247621979260
+  version_requirements: *70169537146960
 - !ruby/object:Gem::Dependency
   name: ruby-debug-completion
-  requirement: &70247622010320 !ruby/object:Gem::Requirement
+  requirement: &70169537146540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -112,7 +112,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247622010320
+  version_requirements: *70169537146540
 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
@@ -154,6 +154,7 @@ files:
 - spec/models/callback_old_dsl.rb
 - spec/models/conversation.rb
 - spec/models/invalid_persistor.rb
+- spec/models/mongoid/mongoid_models.rb
 - spec/models/not_auto_loaded/process.rb
 - spec/models/parametrised_event.rb
 - spec/models/persistence.rb
@@ -173,6 +174,7 @@ files:
 - spec/unit/memory_leak_spec.rb
 - spec/unit/new_dsl_spec.rb
 - spec/unit/persistence/active_record_persistence_spec.rb
+- spec/unit/persistence/mongoid_persistance_spec.rb
 - spec/unit/simple_example_spec.rb
 - spec/unit/subclassing_spec.rb
 - spec/unit/supporting_classes/event_spec.rb
@@ -214,6 +216,7 @@ test_files:
 - spec/models/callback_old_dsl.rb
 - spec/models/conversation.rb
 - spec/models/invalid_persistor.rb
+- spec/models/mongoid/mongoid_models.rb
 - spec/models/not_auto_loaded/process.rb
 - spec/models/parametrised_event.rb
 - spec/models/persistence.rb
@@ -233,6 +236,7 @@ test_files:
 - spec/unit/memory_leak_spec.rb
 - spec/unit/new_dsl_spec.rb
 - spec/unit/persistence/active_record_persistence_spec.rb
+- spec/unit/persistence/mongoid_persistance_spec.rb
 - spec/unit/simple_example_spec.rb
 - spec/unit/subclassing_spec.rb
 - spec/unit/supporting_classes/event_spec.rb