transitions 0.1.1 → 0.1.2

data/.travis.yml

@@ -1 +1 @@
-rvm: 1.9.2
+rvm: 1.9.3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.2
+
+(troessner) Slightly improved handling of current states.
+
 # 1.0.1
 
 * (troessner) Remove feature:

data/README.rdoc

@@ -51,7 +51,11 @@ If this is not the case for you you have to add
 
 whereever you load your dependencies in your application.
 
-<b>A word of warning:</b> Use symbols, not strings for declaring the state machine. Using strings is *not* supported as is using whitespace in names (because `transitions` possibly generates methods out of this).
+<b>Know limitations:</b> 
+
+* You can only use one state machine per model. While in theory you can define two or more, this won't work as you would expect. Not supporting this was intentional, if you're interested in the ratione look up version 1.0.0 in the CHANGELOG.
+
+* Use symbols, not strings for declaring the state machine. Using strings is *not* supported as is using whitespace in names (because `transitions` possibly generates methods out of this).
 
 === Features
 
@@ -105,7 +109,7 @@ In case you need to trigger a method call after a successful transition you can
 In addition to just specify the method name on the record as a symbol you can pass a lambda to
 perfom some more complex success callbacks:
 
-  event :discontinue, :success => lambda { |order) AdminNotifier.notify_about_discontinued_order(order) } do
+  event :discontinue, :success => lambda { |order| AdminNotifier.notify_about_discontinued_order(order) } do
     transitions :to => :discontinued, :from => [:available, :out_of_stock]
   end
 

data/lib/transitions.rb

@@ -57,30 +57,32 @@ module Transitions
     base.extend(ClassMethods)
   end
 
-  # TODO Do we need this method really? Also, it's not a beauty, refactor at least.
-  def current_state(new_state = nil, persist = false)
+  def update_current_state(new_state, persist = false)
     sm   = self.class.get_state_machine
     ivar = sm.current_state_variable
-    if new_state
-      if persist && respond_to?(:write_state)
-        write_state(new_state)
-      end
-
-      if respond_to?(:write_state_without_persistence)
-        write_state_without_persistence(new_state)
-      end
-
-      instance_variable_set(ivar, new_state)
-    else
-      instance_variable_set(ivar, nil) unless instance_variable_defined?(ivar)
-      value = instance_variable_get(ivar)
-      return value if value
-
-      if respond_to?(:read_state)
-        value = instance_variable_set(ivar, read_state)
-      end
-
-      value || sm.initial_state
+    if ::Transitions.active_record_descendant?(self.class)
+      write_state(new_state) if persist
+      write_state_without_persistence(new_state) # TODO This seems like a duplicate, `write_new` already calls `write_state_without_persistence`.
     end
+
+    instance_variable_set(ivar, new_state)
+  end
+
+  def current_state
+    sm   = self.class.get_state_machine
+    ivar = sm.current_state_variable
+
+    value = instance_variable_get(ivar)
+    return value if value
+
+    if ::Transitions.active_record_descendant?(self.class)
+      value = instance_variable_set(ivar, read_state)
+    end
+
+    !(value.nil? || value.empty?) ? value : sm.initial_state
+  end
+
+  def self.active_record_descendant?(klazz)
+    defined?(ActiveRecord::Base) && klazz < ActiveRecord::Base
   end
 end

data/lib/transitions/machine.rb

@@ -39,7 +39,7 @@ module Transitions
       @initial_state = options[:initial] if options.key?(:initial)
       @auto_scopes = options[:auto_scopes]
       instance_eval(&block) if block
-      include_scopes if @auto_scopes && defined?(ActiveRecord::Base) && @klass < ActiveRecord::Base
+      include_scopes if @auto_scopes && ::Transitions.active_record_descendant?(klass)
       self
     end
 
@@ -54,7 +54,7 @@ module Transitions
             record.send(:event_fired, record.current_state, new_state, event)
           end
 
-          record.current_state(new_state, persist)
+          record.update_current_state(new_state, persist)
           @events[event].success.call(record) if @events[event].success
           return true
         else

data/lib/transitions/version.rb

@@ -1,3 +1,3 @@
 module Transitions
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/test/state_transition/test_state_transition_on_transition_callback.rb

@@ -1,7 +1,12 @@
 require 'helper'
 
-class Car
+class Truck
   include Transitions
+  attr_reader :test_recorder
+
+  def initialize
+    @test_recorder = []
+  end
 
   state_machine do
     state :parked
@@ -18,26 +23,26 @@ class Car
   end
 
   %w!start_engine loosen_handbrake push_gas_pedal!.each do |m|
-    define_method(m){}
+    define_method(m){ @test_recorder << m }
   end
 end
 
 class TestStateTransitionCallbacks < Test::Unit::TestCase
-  def setup
-    @car = Car.new
-  end
-
   test "should execute callback defined via 'on_transition'" do
-    @car.expects(:start_engine)
-    @car.turn_key!
+    truck = Truck.new
+    truck.expects(:start_engine)
+    truck.turn_key!
   end
 
   test "should execute multiple callbacks defined via 'on_transition' in the same order they were defined" do
-    on_transition_sequence = sequence('on_transition_sequence')
+    # This test requires some explanation: We started out with something like this:
+    #   truck.expects(:start_engine).in_sequence(on_transition_sequence)
+    # Which, after a while (don't ask me why) caused some weird problems and seemed to fail randomly.
+    # Hence the workaround below.
+
+    truck = Truck.new
 
-    @car.expects(:start_engine).in_sequence(on_transition_sequence)
-    @car.expects(:loosen_handbrake).in_sequence(on_transition_sequence)
-    @car.expects(:push_gas_pedal).in_sequence(on_transition_sequence)
-    @car.start_driving!
+    truck.start_driving!
+    assert_equal truck.test_recorder, [:start_engine, :loosen_handbrake, :push_gas_pedal].map(&:to_s)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transitions
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-06 00:00:00.000000000 Z
+date: 2012-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -179,7 +179,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -930958051
+      hash: -696557581
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: