transitions 0.1.13 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b87d3c72b83d64e0c80f22f8b6984fc897e75725
-  data.tar.gz: c680875bb9ebd5b68fcf0b02943a04a07147121b
+  metadata.gz: 4f76fbe7e05b93bbec46f0faa6723169979ec375
+  data.tar.gz: d968ddb9b44da30cb3b8f34bfa5f536e33d3a6a3
 SHA512:
-  metadata.gz: 400a2ecb0b2c08ae1a29f860607eeddb1c9d0cb4565a2530e90b9d886a88d4c292658097a604e993af2150a8fc90bfacefc030d03a2d76f9d57dede7327de239
-  data.tar.gz: 08d83f73449b3338b4b8a4cbc8ff6f031e9ab61eaa715fdc016f4a3794722e25fb0887ac9326be8195241a76e401d1ed4d93495accdcaec80f6fce3b3145ec43
+  metadata.gz: 39fecff9fec8636c7a99efbac2f32fed979717da83c552e9c73732582ffff3a7e987ef1ce9b1b4032abd6c3491c42f148fa477013c77e18da03e4230e393a3fa
+  data.tar.gz: 7829b0d74c9cb917f4569285eaebb4ed83c4ba73405b3e42e7419f5c2a0d3ead24e4f42bf30ccf5a2a26a61e7524556b45ee290756d2fdbda13e585c2764226a

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.2.0
+
+* (troessner) Fix missing explicit returns in our callback handling
+* (Lee Henson) add can_execute_event? to check against guard clauses
+* (Randy Schmidt / r38y) Make reading state work for non-AR models.
+
 # 0.1.13
 
 * (Nathan Amick and Ryan Long) Allow passing non-Proc callables as guards

data/lib/active_model/transitions.rb

@@ -32,7 +32,7 @@ module ActiveModel
     # 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)
+    def reload(*)
       super.tap do
         sm = self.class.get_state_machine
         remove_instance_variable(sm.current_state_variable) if instance_variable_defined?(sm.current_state_variable)

data/lib/transitions/event.rb

@@ -16,6 +16,13 @@ module Transitions
         machine.klass.send(:define_method, "can_#{name.to_s}?") do |*args|
           machine.events_for(current_state).include?(name.to_sym)
         end
+
+        machine.klass.send(:define_method, "can_execute_#{name.to_s}?") do |*args|
+          event = name.to_sym
+
+          send("can_#{name.to_s}?", *args) &&
+          machine.events[event].can_execute_transition_from_state?(current_state, self, *args)
+        end
       end
       update(options, &block)
     end
@@ -42,6 +49,10 @@ module Transitions
       @transitions.any? { |t| t.from? state }
     end
 
+    def can_execute_transition_from_state?(state, obj, *args)
+      @transitions.select { |t| t.from? state }.any? { |t| t.executable?(obj, *args) }
+    end
+
     def ==(event)
       if event.is_a? Symbol
         name == event

data/lib/transitions/machine.rb

@@ -17,7 +17,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 && ::Transitions.active_record_descendant?(klass)
+      include_scopes if @auto_scopes && ::Transitions.active_model_descendant?(klass)
       self
     end
 
@@ -26,15 +26,18 @@ module Transitions
       handle_state_exit_callback record
       if new_state = transition_to_new_state(record, event, *args)
         handle_state_enter_callback record, new_state
-        handle_event_fired_calllback record, new_state, event
+        handle_event_fired_callback record, new_state, event
         record.update_current_state(new_state, persist)
         handle_event_success_callback record, event
+        return true
       else
         handle_event_failed_callback record, event
+        return false
       end
     rescue => e
       if record.respond_to?(:event_failed)
         record.send(:event_failed, event)
+        return false
       else
         raise e
       end
@@ -64,7 +67,7 @@ module Transitions
       state_index[new_state].call_action(:enter, record)
     end
 
-    def handle_event_fired_calllback(record, new_state, event)
+    def handle_event_fired_callback(record, new_state, event)
       if record.respond_to?(:event_fired, true)
         record.send(:event_fired, record.current_state, new_state, event)
       end

data/lib/transitions/version.rb

@@ -1,3 +1,3 @@
 module Transitions
-  VERSION = '0.1.13'
+  VERSION = '0.2.0'
 end

data/lib/transitions.rb

@@ -44,7 +44,8 @@ module Transitions
   def update_current_state(new_state, persist = false)
     sm   = self.class.get_state_machine
     ivar = sm.current_state_variable
-    if ::Transitions.active_record_descendant?(self.class)
+
+    if Transitions.active_model_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
@@ -73,14 +74,14 @@ module Transitions
     value = instance_variable_get(ivar)
     return value if value
 
-    if ::Transitions.active_record_descendant?(self.class)
+    if Transitions.active_model_descendant?(self.class)
       value = instance_variable_set(ivar, read_state)
     end
 
     !(value.nil? || value.to_s.empty?) ? value : sm.initial_state
   end
 
-  def self.active_record_descendant?(klazz)
-    defined?(ActiveRecord::Base) && klazz < ActiveRecord::Base
+  def self.active_model_descendant?(klazz)
+    defined?(ActiveModel) && klazz.included_modules.include?(ActiveModel::Dirty) # Checking directly for "ActiveModel" wouldn't work so we use some arbitrary module close to it.
   end
 end

data/test/machine/machine_template.rb

@@ -0,0 +1,27 @@
+class MachineTestSubject
+  include Transitions
+
+  state_machine :initial => :open do
+    state :open
+    state :closed
+
+    event :shutdown do
+      transitions :from => :open, :to => :closed
+    end
+
+    event :timeout do
+      transitions :from => :open, :to => :closed
+    end
+
+    event :restart do
+      transitions :from => :closed, to: :open, guard: :restart_allowed?
+    end
+  end
+
+  def restart_allowed?(allowed = true)
+    allowed
+  end
+
+  def event_failed(*)
+  end
+end

data/test/machine/test_fire_event_machine.rb

@@ -0,0 +1,29 @@
+require "helper"
+require_relative "./machine_template"
+
+class TestFireEventMachine < Test::Unit::TestCase
+  def setup
+    @record  = MachineTestSubject.new
+    @machine = MachineTestSubject.get_state_machine
+    @event   = @machine.events_for(@record.current_state).first
+    assert_not_nil @event
+  end
+
+  test "fire_event returns true if state transition was successful" do
+    @machine.stubs(:transition_to_new_state).returns(:closed)
+
+    assert_equal true, @machine.fire_event(@event, @record, false)
+  end
+
+  test "fire_event returns false if state transition was unsuccessful" do
+    @machine.stubs(:transition_to_new_state).returns(false)
+
+    assert_equal false, @machine.fire_event(@event, @record, false)
+  end
+
+  test "fire_event returns false if state transition raises" do
+    @machine.stubs(:transition_to_new_state).raises(StandardError)
+
+    assert_equal false, @machine.fire_event(@event, @record, false)
+  end
+end

data/test/machine/test_machine.rb

@@ -16,9 +16,13 @@ class MachineTestSubject
     end
 
     event :restart do
-      transitions :from => :closed, to: :open
+      transitions :from => :closed, to: :open, guard: :restart_allowed?
     end
   end
+
+  def restart_allowed?(allowed = true)
+    allowed
+  end
 end
 
 class TransitionsMachineTest < Test::Unit::TestCase
@@ -54,7 +58,9 @@ class TransitionsMachineTest < Test::Unit::TestCase
     assert machine.cant_transition?(:shutdown)
   end
 
-  test "test fire_event" do
-    pend "Implement me"
+  test "knows that it can't transition to a state denied by a guard" do
+    machine = MachineTestSubject.new
+    assert machine.can_execute_restart? true
+    refute machine.can_execute_restart? false
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transitions
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.2.0
 platform: ruby
 authors:
 - Jakub Kuzma
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2014-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -153,7 +153,9 @@ files:
 - test/event/test_event_being_fired.rb
 - test/event/test_event_checks.rb
 - test/helper.rb
+- test/machine/machine_template.rb
 - test/machine/test_available_states_listing.rb
+- test/machine/test_fire_event_machine.rb
 - test/machine/test_machine.rb
 - test/state/test_state.rb
 - test/state/test_state_predicate_method.rb