transitions 0.0.11 → 0.0.12

data/.gitignore

@@ -1,4 +1,4 @@
 pkg
 *.gem
 .bundle
-.rvmrc
+.idea/

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.2-p290@transitions

data/.travis.yml

@@ -0,0 +1 @@
+rvm: 1.9.2

data/Gemfile.lock

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

data/README.rdoc

@@ -1,11 +1,11 @@
+== Travis Build Status {<img src="https://secure.travis-ci.org/troessner/transitions.png"/>}[http://travis-ci.org/troessner/transitions]
+
 = What is transitions?
 
 transitions is a ruby state machine implementation based on Rick Olson’s
 ActiveModel::StateMachine. It was extracted from ActiveModel and turned
 into a gem when it got the axe in commit {db49c706b}[http://github.com/rails/rails/commit/db49c706b62e7ea2ab93f05399dbfddf5087ee0c].
 
-I really encourage you to try {state_machine}[https://github.com/pluginaweek/state_machine] before using this gem. Currently I have no time to maintain the gem, if you want to add some new features - contact with me.
-
 == Quick Example
 
  require 'transitions'
@@ -32,13 +32,13 @@ I really encourage you to try {state_machine}[https://github.com/pluginaweek/sta
 
 == Automatic scope generation
 
-`transitions` will automatically generate scopes for you if you are using AR:
+`transitions` will automatically generate scopes for you if you are using ActiveRecord and tell it to do so via the `auto_scopes` option:
 
 Given a model like this:
 
   class Order < ActiveRecord::Base
     include ActiveRecord::Transitions
-    state_machine do
+    state_machine :auto_scopes => true do
       state :pick_line_items
       state :picking_line_items
     end
@@ -53,7 +53,7 @@ you can use this feature a la:
   >> Order.pick_line_items
   => [#<Order id: 3, state: "pick_line_items", description: nil, created_at: "2011-08-23 15:48:46", updated_at: "2011-08-23 15:48:46">]
 
-== Using on_transition
+== Using `on_transition`
 
 Each event definition takes an optional "on_transition" argument, which allows you to execute methods on transition.
 You can pass in a Symbol, a String, a Proc or an Array containing method names as Symbol or String like this:
@@ -62,6 +62,15 @@ You can pass in a Symbol, a String, a Proc or an Array containing method names a
     transitions :to => :discontinued, :from => [:available, :out_of_stock], :on_transition => [:do_discontinue, :notify_clerk]
   end
 
+== Using `success`
+
+In case you need to trigger a method call after a successful transition you can use `success`:
+
+  event :discontinue, :success => :notfiy_admin do
+    transitions :to => :discontinued, :from => [:available, :out_of_stock]
+  end
+
+
 == Timestamps
 
 If you'd like to note the time of a state change, Transitions comes with timestamps free!
@@ -121,7 +130,7 @@ bang(!)-version will call <tt>write_state</tt>.
 
 == Documentation, Guides & Examples
 
-- {Online API Documentation}[http://rdoc.info/github/qoobaa/transitions/master/Transitions]
+- {Online API Documentation}[http://rdoc.info/github/troessner/transitions/master/Transitions]
 - Krzysiek Heród (aka {Netizer}[http://github.com/netizer]) wrote a nice
   {blog post}[http://dev.netizer.pl/transitions-state-machine-for-rails-3.html]
   about using Transitions in ActiveRecord.

data/lib/transitions.rb

@@ -27,9 +27,8 @@ require "transitions/state_transition"
 require "transitions/version"
 
 module Transitions
-  class InvalidTransition < StandardError
-
-  end
+  class InvalidTransition     < StandardError; end
+  class InvalidMethodOverride < StandardError; end
 
   module ClassMethods
     def inherited(klass)

data/lib/transitions/machine.rb

@@ -24,7 +24,7 @@ module Transitions
   class Machine
     attr_writer :initial_state
     attr_accessor :states, :events, :state_index
-    attr_reader :klass, :name
+    attr_reader :klass, :name, :auto_scopes
 
     def initialize(klass, name, options = {}, &block)
       @klass, @name, @states, @state_index, @events = klass, name, [], {}, {}
@@ -37,8 +37,9 @@ module Transitions
 
     def update(options = {}, &block)
       @initial_state = options[:initial] if options.key?(:initial)
+      @auto_scopes = options[:auto_scopes]
       instance_eval(&block) if block
-      include_scopes if defined?(ActiveRecord::Base) && @klass < ActiveRecord::Base
+      include_scopes if @auto_scopes && defined?(ActiveRecord::Base) && @klass < ActiveRecord::Base
       self
     end
 
@@ -48,7 +49,7 @@ module Transitions
         state_index[new_state].call_action(:enter, record)
 
         if record.respond_to?(event_fired_callback)
-          record.send(event_fired_callback, record.current_state, new_state)
+          record.send(event_fired_callback, record.current_state, new_state, event)
         end
 
         record.current_state(@name, new_state, persist)
@@ -96,7 +97,9 @@ module Transitions
 
     def include_scopes
       @states.each do |state|
-        @klass.scope state.name.to_sym, @klass.where(:state => state.name.to_s)
+        state_name = state.name.to_s
+        raise InvalidMethodOverride if @klass.respond_to?(state_name)
+        @klass.scope state_name, @klass.where(:state => state_name)
       end
     end
   end

data/lib/transitions/version.rb

@@ -1,3 +1,3 @@
 module Transitions
-  VERSION = "0.0.11"
+  VERSION = "0.0.12"
 end

data/test/test_scopes.rb

@@ -12,10 +12,30 @@ class CreateTrafficLights < ActiveRecord::Migration
   end
 end
 
+class CreateLightBulbs < ActiveRecord::Migration
+  def self.up
+    create_table(:light_bulbs) do |t|
+      t.string :state
+    end
+  end
+end
+
+class CreateLights < ActiveRecord::Migration
+  def self.up
+    create_table(:lights) do |t|
+      t.string :state
+    end
+  end
+end
+
+CreateTrafficLights.migrate(:up)
+CreateLightBulbs.migrate(:up)
+CreateLights.migrate(:up)
+
 class TrafficLight < ActiveRecord::Base
   include ActiveRecord::Transitions
 
-  state_machine do
+  state_machine :auto_scopes => true do
     state :off
 
     state :red
@@ -40,16 +60,18 @@ class TrafficLight < ActiveRecord::Base
   end
 end
 
-class TestScopes < Test::Unit::TestCase
-  def setup
-    ActiveRecord::Base.establish_connection(:adapter  => "sqlite3", :database => ":memory:")
-    ActiveRecord::Migration.verbose = false
-    CreateTrafficLights.migrate(:up)
+class LightBulb < ActiveRecord::Base
+  include ActiveRecord::Transitions
 
-    @light = TrafficLight.create!
+  state_machine do
+    state :off
+    state :on
   end
+end
 
+class TestScopes < Test::Unit::TestCase
   test "scope returns correct object" do
+    @light = TrafficLight.create!
     assert TrafficLight.respond_to? :off
     assert_equal TrafficLight.off.first, @light
     assert TrafficLight.red.empty?
@@ -61,4 +83,22 @@ class TestScopes < Test::Unit::TestCase
     assert TrafficLight.respond_to? :green
     assert TrafficLight.respond_to? :yellow
   end
+
+  test 'scopes are only generated if we explicitly say so' do
+    assert !LightBulb.respond_to?(:off)
+    assert !LightBulb.respond_to?(:on)
+  end
+
+  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
+
+        state_machine :auto_scopes => true do
+          state :new
+          state :broken
+        end
+      end
+    }
+  end
 end

data/test/test_state_transition_callbacks.rb

@@ -17,6 +17,9 @@ class Car
     end
   end
 
+  def event_fired(current_state, new_state, event)
+  end
+
   %w!start_engine loosen_handbrake push_gas_pedal!.each do |m|
     define_method(m){}
   end
@@ -40,4 +43,9 @@ class TestStateTransitionCallbacks < Test::Unit::TestCase
     @car.expects(:push_gas_pedal).in_sequence(on_transition_sequence)
     @car.start_driving!
   end
+
+  test "should pass event when calling event_fired_callback" do
+    @car.expects(:event_fired).with(:parked, :driving, :start_driving)
+    @car.start_driving!
+  end
 end

data/transitions.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Jakub Kuźma", "Timo Rößner"]
   s.email       = "timo.roessner@googlemail.com"
-  s.homepage    = "http://github.com/qoobaa/transitions"
+  s.homepage    = "http://github.com/troessner/transitions"
   s.summary     = "State machine extracted from ActiveModel"
   s.description = "Lightweight state machine extracted from ActiveModel"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transitions
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-12 00:00:00.000000000Z
+date: 2011-11-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &69475640 !ruby/object:Gem::Requirement
+  requirement: &74700350 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '1'
   type: :development
   prerelease: false
-  version_requirements: *69475640
+  version_requirements: *74700350
 - !ruby/object:Gem::Dependency
   name: test-unit
-  requirement: &69470060 !ruby/object:Gem::Requirement
+  requirement: &74700040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *69470060
+  version_requirements: *74700040
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &69469200 !ruby/object:Gem::Requirement
+  requirement: &74699680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *69469200
+  version_requirements: *74699680
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
-  requirement: &69468690 !ruby/object:Gem::Requirement
+  requirement: &74699290 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *69468690
+  version_requirements: *74699290
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &69467660 !ruby/object:Gem::Requirement
+  requirement: &74698870 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,7 +66,7 @@ dependencies:
         version: '3'
   type: :development
   prerelease: false
-  version_requirements: *69467660
+  version_requirements: *74698870
 description: Lightweight state machine extracted from ActiveModel
 email: timo.roessner@googlemail.com
 executables: []
@@ -74,6 +74,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rvmrc
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -100,7 +102,7 @@ files:
 - test/test_state_transition_callbacks.rb
 - test/test_state_transition_guard_check.rb
 - transitions.gemspec
-homepage: http://github.com/qoobaa/transitions
+homepage: http://github.com/troessner/transitions
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -114,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 59531697
+      hash: -171038385
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -123,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: transitions
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: State machine extracted from ActiveModel