transitions 0.0.13 → 0.0.14

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.14 (2012-04-16):
+
+* (troessner) Improve error messages for invalid transitions.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    transitions (0.0.13)
+    transitions (0.0.14)
 
 GEM
   remote: http://rubygems.org/

data/README.rdoc

@@ -12,11 +12,11 @@
 
 This goes into your Gemfile:
 
- gem "transitions", :require => ["transitions", "active_record/transitions"]
+ gem "transitions", :require => ["transitions", "active_model/transitions"]
 
-… and this into your AR model:
+… and this into your ORM model:
 
- include ActiveRecord::Transitions
+ include ActiveModel::Transitions
 
 == Standalone
 
@@ -62,7 +62,7 @@ bang(!)-version will call <tt>write_state</tt>.
 Given a model like this:
 
   class Order < ActiveRecord::Base
-    include ActiveRecord::Transitions
+    include ActiveModel::Transitions
     state_machine :auto_scopes => true do
       state :pick_line_items
       state :picking_line_items
@@ -117,7 +117,7 @@ the name of the timestamp column.
 
   # This will look for an attribute named repaired_on to update upon save
   event :rebuild, :timestamp => :repaired_on do
-    transiions :from => :exploded, :to => :rebuilt
+    transitions :from => :exploded, :to => :rebuilt
   end
 
 == Listing all the available states

data/lib/active_model/transitions.rb

@@ -0,0 +1,74 @@
+# Copyright (c) 2009 Rick Olson
+
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation files
+# (the "Software"), to deal in the Software without restriction,
+# including without limitation the rights to use, copy, modify, merge,
+# publish, distribute, sublicense, and/or sell copies of the Software,
+# and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+module ActiveModel
+  module Transitions
+    extend ActiveSupport::Concern
+
+    included do
+      include ::Transitions
+      after_initialize :set_initial_state
+      validates_presence_of :state
+      validate :state_inclusion
+    end
+    
+    # The optional options argument is passed to find when reloading so you may
+    # do e.g. record.reload(:lock => true) to reload the same record with an
+    # exclusive row lock. 
+    def reload(options = nil)
+      super.tap do
+        self.class.state_machines.values.each do |sm|
+          remove_instance_variable(sm.current_state_variable) if instance_variable_defined?(sm.current_state_variable)
+        end
+      end
+    end
+
+    protected
+
+    def write_state(state_machine, state)
+      ivar = state_machine.current_state_variable
+      prev_state = current_state(state_machine.name)
+      instance_variable_set(ivar, state)
+      self.state = state.to_s
+      save!
+    rescue ActiveRecord::RecordInvalid
+      self.state = prev_state.to_s
+      instance_variable_set(ivar, prev_state)
+      raise
+    end
+
+    def read_state(state_machine)
+      self.state && self.state.to_sym
+    end
+
+    def set_initial_state
+      self.state ||= self.class.state_machine.initial_state.to_s if self.has_attribute?(:state)
+    end
+
+    def state_inclusion
+      unless self.class.state_machine.states.map{|s| s.name.to_s }.include?(self.state.to_s)
+        self.errors.add(:state, :inclusion, :value => self.state)
+      end
+    end
+  end
+end
+

data/lib/active_record/transitions.rb

@@ -1,74 +1,5 @@
-# Copyright (c) 2009 Rick Olson
-
-# Permission is hereby granted, free of charge, to any person
-# obtaining a copy of this software and associated documentation files
-# (the "Software"), to deal in the Software without restriction,
-# including without limitation the rights to use, copy, modify, merge,
-# publish, distribute, sublicense, and/or sell copies of the Software,
-# and to permit persons to whom the Software is furnished to do so,
-# subject to the following conditions:
-
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
-# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
-# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
+require_relative '../active_model/transitions'
 
 module ActiveRecord
-  module Transitions
-    extend ActiveSupport::Concern
-
-    included do
-      include ::Transitions
-      after_initialize :set_initial_state
-      validates_presence_of :state
-      validate :state_inclusion
-    end
-    
-    # The optional options argument is passed to find when reloading so you may
-    # do e.g. record.reload(:lock => true) to reload the same record with an
-    # exclusive row lock. 
-    def reload(options = nil)
-      super.tap do
-        self.class.state_machines.values.each do |sm|
-          remove_instance_variable(sm.current_state_variable) if instance_variable_defined?(sm.current_state_variable)
-        end
-      end
-    end
-
-    protected
-
-    def write_state(state_machine, state)
-      ivar = state_machine.current_state_variable
-      prev_state = current_state(state_machine.name)
-      instance_variable_set(ivar, state)
-      self.state = state.to_s
-      save!
-    rescue ActiveRecord::RecordInvalid
-      self.state = prev_state.to_s
-      instance_variable_set(ivar, prev_state)
-      raise
-    end
-
-    def read_state(state_machine)
-      self.state && self.state.to_sym
-    end
-
-    def set_initial_state
-      self.state ||= self.class.state_machine.initial_state.to_s if self.has_attribute?(:state)
-    end
-
-    def state_inclusion
-      unless self.class.state_machine.states.map{|s| s.name.to_s }.include?(self.state.to_s)
-        self.errors.add(:state, :inclusion, :value => self.state)
-      end
-    end
-  end
-end
-
+  Transitions = ActiveModel::Transitions
+end

data/lib/transitions/event.rb

@@ -40,7 +40,7 @@ module Transitions
 
     def fire(obj, to_state = nil, *args)
       transitions = @transitions.select { |t| t.from == obj.current_state(@machine ? @machine.name : nil) }
-      raise InvalidTransition if transitions.size == 0
+      raise InvalidTransition, error_message_for_invalid_transitions(obj) if transitions.size == 0
 
       next_state = nil
       transitions.each do |transition|
@@ -133,5 +133,9 @@ module Transitions
         lambda { |record| record.send(callback_symbol_or_proc) }
       end
     end
+
+    def error_message_for_invalid_transitions(obj)
+      "No transitions present for `#{obj.class.name}` #{obj.class < ActiveRecord::Base && obj.persisted? ? "with ID #{obj.id} " : nil}with current state `#{obj.current_state}`"
+    end
   end
 end

data/lib/transitions/version.rb

@@ -1,3 +1,3 @@
 module Transitions
-  VERSION = "0.0.13"
+  VERSION = "0.0.14"
 end

data/test/helper.rb

@@ -9,7 +9,7 @@ require "ruby-debug"
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require "transitions"
-require "active_record/transitions"
+require "active_model/transitions"
 
 class Test::Unit::TestCase
 

data/test/test_active_record.rb

@@ -33,7 +33,7 @@ CreateLightBulbs.migrate(:up)
 CreateLights.migrate(:up)
 
 class TrafficLight < ActiveRecord::Base
-  include ActiveRecord::Transitions
+  include ActiveModel::Transitions
 
   state_machine :auto_scopes => true do
     state :off
@@ -73,7 +73,7 @@ class ConditionalValidatingTrafficLight < TrafficLight
 end
 
 class LightBulb < ActiveRecord::Base
-  include ActiveRecord::Transitions
+  include ActiveModel::Transitions
 
   state_machine do
     state :off
@@ -203,7 +203,7 @@ class TestScopes < Test::Unit::TestCase
   test 'scope generation raises an exception if we try to overwrite an existing method' do
     assert_raise(Transitions::InvalidMethodOverride) {
       class Light < ActiveRecord::Base
-        include ActiveRecord::Transitions
+        include ActiveModel::Transitions
 
         state_machine :auto_scopes => true do
           state :new

data/test/test_active_record_timestamps.rb

@@ -4,7 +4,7 @@ require 'active_support/core_ext/module/aliasing'
 create_database
 
 class Order < ActiveRecord::Base
-  include ActiveRecord::Transitions
+  include ActiveModel::Transitions
 
   state_machine do
     state :opened
@@ -104,7 +104,7 @@ class TestActiveRecordTimestamps < Test::Unit::TestCase
   test "passing an invalid value to timestamp options should raise an exception" do
     assert_raise(ArgumentError) do
       class Order < ActiveRecord::Base
-        include ActiveRecord::Transitions
+        include ActiveModel::Transitions
         state_machine do
           event :replace, timestamp: 1 do
             transitions :from => :prepared, :to => :placed

data/test/test_event_being_fired.rb

@@ -3,10 +3,14 @@ require "helper"
 class TestEventBeingFired < Test::Unit::TestCase
   test "should raise an Transitions::InvalidTransition error if the transitions are empty" do
     event = Transitions::Event.new(nil, :event)
+    class AnotherDummy; end
+    obj = AnotherDummy.new
+    obj.stubs(:current_state).returns(:running)
 
-    assert_raise Transitions::InvalidTransition do
-      event.fire(nil)
+    exception = assert_raise Transitions::InvalidTransition do
+      event.fire(obj)
     end
+    assert_match /No transitions present for `TestEventBeingFired::AnotherDummy` with current state `running`/, exception.message
   end
 
   test "should return the state of the first matching transition it finds" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transitions
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-20 00:00:00.000000000Z
+date: 2012-04-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &77702010 !ruby/object:Gem::Requirement
+  requirement: &74398430 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '1'
   type: :development
   prerelease: false
-  version_requirements: *77702010
+  version_requirements: *74398430
 - !ruby/object:Gem::Dependency
   name: test-unit
-  requirement: &77701310 !ruby/object:Gem::Requirement
+  requirement: &74398010 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '2.2'
   type: :development
   prerelease: false
-  version_requirements: *77701310
+  version_requirements: *74398010
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &77700870 !ruby/object:Gem::Requirement
+  requirement: &74397730 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *77700870
+  version_requirements: *74397730
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
-  requirement: &77700370 !ruby/object:Gem::Requirement
+  requirement: &74397410 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *77700370
+  version_requirements: *74397410
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &77699800 !ruby/object:Gem::Requirement
+  requirement: &74396940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: '3'
   type: :development
   prerelease: false
-  version_requirements: *77699800
+  version_requirements: *74396940
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &77698980 !ruby/object:Gem::Requirement
+  requirement: &74396440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *77698980
+  version_requirements: *74396440
 description: Lightweight state machine extracted from ActiveModel
 email: timo.roessner@googlemail.com
 executables: []
@@ -87,11 +87,13 @@ files:
 - .gitignore
 - .rvmrc
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
+- lib/active_model/transitions.rb
 - lib/active_record/transitions.rb
 - lib/transitions.rb
 - lib/transitions/event.rb
@@ -128,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 819396333
+      hash: 950488929
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: