enum_state_machine 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5660c6ced26751d7ebd07759021f013bd931e97
-  data.tar.gz: 0737ed7e96f4fc0f3d97241a0464e519bc24c12e
+  metadata.gz: 71e6b42441dcc75052d13fa17238af8ae8528e88
+  data.tar.gz: bb40a059b58ce675d7e5e51cd1885a73f3d43780
 SHA512:
-  metadata.gz: a7cf04a5fee94ca45e3cc371558ddd8be3a4f5e1c9c0b4c14ca866e854bd3f2c243b827de3f0efcaa7920811c253fde221dc32fd8f3c106c55b9ffcd707c8e93
-  data.tar.gz: bcb2635a67328258a1ef41c5a9372a254c5c7ee8abdef7c8e8ab43582ad20246c754f29a85a2023813de1ced74a191f9cf38363711c1d7e089ecae69a60ec9ab
+  metadata.gz: 6ca5e94e9e546fd839512dfe2f539a87b89ef06bfd0bb1302ce096a60b4ac468a47514d0c704b497d852b19ebcbbc94d497b0aebb6ceb31d6cebb169481eb9bf
+  data.tar.gz: a77f9f4cf047ec6646e171580200fc66590f4592333b1a5c4c0b735fae1737ee7249f0b6b7694ff0e05d9d40d9e758bb7a0a86f002c9746353c89da97023cc1d

data/enum_state_machine.gemspec

@@ -17,19 +17,17 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files  = %w(README.md CHANGELOG.md LICENSE)
   s.license           = 'MIT'
 
-  s.add_dependency "rails", "~> 4.0.13"
+  s.add_dependency "rails", "~> 4.0", "< 4.2"
 
-  s.add_dependency "activemodel", "~> 4.0.5"
-  s.add_dependency "activerecord", "~> 4.0.5"
   s.add_dependency "activerecord-deprecated_finders", "~> 1.0.3"
   s.add_dependency "protected_attributes", "~> 1.0.7"
-  s.add_dependency "rails-observers", "~> 0.1.2"
+  #s.add_dependency "rails-observers", "~> 0.1.2"
   s.add_dependency "power_enum", "~> 2.7"
 
   s.add_development_dependency "rake"
-  s.add_development_dependency "minitest", "~> 4.7.5"
+  s.add_development_dependency "minitest", "~> 5.1"
   s.add_development_dependency "simplecov"
   s.add_development_dependency "yard"
   s.add_development_dependency "sqlite3", "~> 1.3.9"
-  s.add_development_dependency "ruby-graphviz", "~> 1.0.9"
+  s.add_development_dependency "ruby-graphviz"
 end

data/lib/enum_state_machine/integrations/active_model.rb

@@ -386,16 +386,21 @@ module EnumStateMachine
         end
       end
       
-      # Describes the current validation errors on the given object.  If none
+      # Describe the current validation errors on the given object.  If none
       # are specific, then the default error is interpeted as a "halt".
       def errors_for(object)
         object.errors.empty? ? 'Transition halted' : object.errors.full_messages * ', '
       end
       
-      # Resets any errors previously added when invalidating the given object
+      # Reset any errors previously added when invalidating the given object.
       def reset(object)
         object.errors.clear if supports_validations?
       end
+
+      # Run state events around the object's validation process.
+      def around_validation(object)
+        object.class.state_machines.transitions(object, action, :after => false).perform { yield }
+      end
       
       protected
         # Whether observers are supported in the integration.  Only true if
@@ -417,23 +422,22 @@ module EnumStateMachine
           false
         end
         
-        # Gets the terminator to use for callbacks
+        # Get the terminator to use for callbacks.
         def callback_terminator
           @terminator ||= lambda {|result| result == false}
         end
         
-        # Determines the base scope to use when looking up translations
+        # Determine the base scope to use when looking up translations.
         def i18n_scope(klass)
           klass.i18n_scope
         end
         
-        # The default options to use when generating messages for validation
-        # errors
+        # The default options to use when generating messages for validation errors.
         def default_error_message_options(object, attribute, message)
           {:message => @messages[message]}
         end
         
-        # Translates the given key / value combo.  Translation keys are looked
+        # Translate the given key / value combo.  Translation keys are looked
         # up in the following order:
         # * <tt>#{i18n_scope}.state_machines.#{model_name}.#{machine_name}.#{plural_key}.#{value}</tt>
         # * <tt>#{i18n_scope}.state_machines.#{model_name}.#{plural_key}.#{value}</tt>
@@ -459,7 +463,7 @@ module EnumStateMachine
           klass.lookup_ancestors
         end
         
-        # Initializes class-level extensions and defaults for this machine
+        # Initialize class-level extensions and defaults for this machine.
         def after_initialize
           super
           load_locale
@@ -467,18 +471,18 @@ module EnumStateMachine
           add_default_callbacks
         end
         
-        # Loads any locale files needed for translating validation errors
+        # Load any locale files needed for translating validation errors.
         def load_locale
           I18n.load_path.unshift(@integration.locale_path) unless I18n.load_path.include?(@integration.locale_path)
         end
         
-        # Loads extensions to ActiveModel's Observers
+        # Load extensions to ActiveModel's Observers.
         def load_observer_extensions
           require 'enum_state_machine/integrations/active_model/observer'
           require 'enum_state_machine/integrations/active_model/observer_update'
         end
         
-        # Adds a set of default callbacks that utilize the Observer extensions
+        # Add a set of default callbacks that utilize the Observer extensions.
         def add_default_callbacks
           if supports_observers?
             callbacks[:before] << Callback.new(:before) {|object, transition| notify(:before, object, transition)}
@@ -487,7 +491,7 @@ module EnumStateMachine
           end
         end
         
-        # Skips defining reader/writer methods since this is done automatically
+        # Skip defining reader/writer methods since this is done automatically.
         def define_state_accessor
           name = self.name
           
@@ -497,24 +501,19 @@ module EnumStateMachine
           end if supports_validations?
         end
         
-        # Adds hooks into validation for automatically firing events
+        # Add hooks into validation for automatically firing events.
         def define_action_helpers
           super
           define_validation_hook if runs_validations_on_action?
         end
         
-        # Hooks into validations by defining around callbacks for the
-        # :validation event
+        # Hook into validations by defining around callbacks for the
+        # :validation event.
         def define_validation_hook
           owner_class.set_callback(:validation, :around, self, :prepend => true)
         end
         
-        # Runs state events around the object's validation process
-        def around_validation(object)
-          object.class.state_machines.transitions(object, action, :after => false).perform { yield }
-        end
-        
-        # Creates a new callback in the callback chain, always inserting it
+        # Create a new callback in the callback chain, always inserting it
         # before the default Observer callbacks that were created after
         # initialization.
         def add_callback(type, options, &block)
@@ -529,21 +528,21 @@ module EnumStateMachine
           end
         end
         
-        # Configures new states with the built-in humanize scheme
+        # Configure new states with the built-in humanize scheme.
         def add_states(new_states)
           super.each do |new_state|
             new_state.human_name = lambda {|state, klass| translate(klass, :state, state.name)}
           end
         end
         
-        # Configures new event with the built-in humanize scheme
+        # Configure new events with the built-in humanize scheme.
         def add_events(new_events)
           super.each do |new_event|
             new_event.human_name = lambda {|event, klass| translate(klass, :event, event.name)}
           end
         end
         
-        # Notifies observers on the given object that a callback occurred
+        # Notify observers on the given object that a callback occurred
         # involving the given transition.  This will attempt to call the
         # following methods on observers:
         # * <tt>#{type}_#{qualified_event}_from_#{from}_to_#{to}</tt>

data/lib/enum_state_machine/version.rb

@@ -1,3 +1,3 @@
 module EnumStateMachine
-  VERSION = '0.1.1'
+  VERSION = "0.2.0"
 end

data/test/functional/state_machine_test.rb

@@ -241,7 +241,7 @@ class TrafficLight
   end
 end
 
-class VehicleTest < Test::Unit::TestCase
+class VehicleTest < MiniTest::Test
   def setup
     @vehicle = Vehicle.new
   end
@@ -259,7 +259,7 @@ class VehicleTest < Test::Unit::TestCase
   end
 end
 
-class VehicleUnsavedTest < Test::Unit::TestCase
+class VehicleUnsavedTest < MiniTest::Test
   def setup
     @vehicle = Vehicle.new
   end
@@ -269,12 +269,12 @@ class VehicleUnsavedTest < Test::Unit::TestCase
   end
   
   def test_should_raise_exception_if_checking_invalid_state
-    assert_raise(IndexError) { @vehicle.state?(:invalid) }
+    assert_raises(IndexError) { @vehicle.state?(:invalid) }
   end
   
   def test_should_raise_exception_if_getting_name_of_invalid_state
     @vehicle.state = 'invalid'
-    assert_raise(ArgumentError) { @vehicle.state_name }
+    assert_raises(ArgumentError) { @vehicle.state_name }
   end
   
   def test_should_be_parked
@@ -318,7 +318,7 @@ class VehicleUnsavedTest < Test::Unit::TestCase
   
   def test_should_have_a_transition_for_ignite
     transition = @vehicle.ignite_transition
-    assert_not_nil transition
+    refute_nil transition
     assert_equal 'parked', transition.from
     assert_equal 'idling', transition.to
     assert_equal :ignite, transition.event
@@ -357,7 +357,7 @@ class VehicleUnsavedTest < Test::Unit::TestCase
   end
   
   def test_should_raise_error_with_invalid_event_through_generic_event_runer
-    assert_raise(IndexError) { @vehicle.fire_state_event(:invalid) }
+    assert_raises(IndexError) { @vehicle.fire_state_event(:invalid) }
   end
   
   def test_should_allow_ignite
@@ -438,7 +438,7 @@ class VehicleUnsavedTest < Test::Unit::TestCase
   end
 end
 
-class VehicleParkedTest < Test::Unit::TestCase
+class VehicleParkedTest < MiniTest::Test
   def setup
     @vehicle = Vehicle.new
   end
@@ -481,7 +481,7 @@ class VehicleParkedTest < Test::Unit::TestCase
   end
   
   def test_should_raise_exception_if_repair_not_allowed!
-    exception = assert_raise(EnumStateMachine::InvalidTransition) {@vehicle.repair!}
+    exception = assert_raises(EnumStateMachine::InvalidTransition) {@vehicle.repair!}
     assert_equal @vehicle, exception.object
     assert_equal Vehicle.state_machine(:state), exception.machine
     assert_equal :repair, exception.event
@@ -489,7 +489,7 @@ class VehicleParkedTest < Test::Unit::TestCase
   end
 end
 
-class VehicleIdlingTest < Test::Unit::TestCase
+class VehicleIdlingTest < MiniTest::Test
   def setup
     @vehicle = Vehicle.new
     @vehicle.ignite
@@ -508,7 +508,7 @@ class VehicleIdlingTest < Test::Unit::TestCase
   end
   
   def test_should_track_time_elapsed
-    assert_not_nil @vehicle.time_elapsed
+    refute_nil @vehicle.time_elapsed
   end
   
   def test_should_allow_park
@@ -546,7 +546,7 @@ class VehicleIdlingTest < Test::Unit::TestCase
   end
 end
 
-class VehicleFirstGearTest < Test::Unit::TestCase
+class VehicleFirstGearTest < MiniTest::Test
   def setup
     @vehicle = Vehicle.new
     @vehicle.ignite
@@ -586,7 +586,7 @@ class VehicleFirstGearTest < Test::Unit::TestCase
   end
 end
 
-class VehicleSecondGearTest < Test::Unit::TestCase
+class VehicleSecondGearTest < MiniTest::Test
   def setup
     @vehicle = Vehicle.new
     @vehicle.ignite
@@ -626,7 +626,7 @@ class VehicleSecondGearTest < Test::Unit::TestCase
   end
 end
 
-class VehicleThirdGearTest < Test::Unit::TestCase
+class VehicleThirdGearTest < MiniTest::Test
   def setup
     @vehicle = Vehicle.new
     @vehicle.ignite
@@ -666,7 +666,7 @@ class VehicleThirdGearTest < Test::Unit::TestCase
   end
 end
 
-class VehicleStalledTest < Test::Unit::TestCase
+class VehicleStalledTest < MiniTest::Test
   def setup
     @vehicle = Vehicle.new
     @vehicle.ignite
@@ -729,7 +729,7 @@ class VehicleStalledTest < Test::Unit::TestCase
   end
 end
 
-class VehicleRepairedTest < Test::Unit::TestCase
+class VehicleRepairedTest < MiniTest::Test
   def setup
     @vehicle = Vehicle.new
     @vehicle.ignite
@@ -747,7 +747,7 @@ class VehicleRepairedTest < Test::Unit::TestCase
   end
 end
 
-class VehicleLockedTest < Test::Unit::TestCase
+class VehicleLockedTest < MiniTest::Test
   def setup
     @vehicle = Vehicle.new
     @vehicle.state = 'locked'
@@ -774,7 +774,7 @@ class VehicleLockedTest < Test::Unit::TestCase
   end
 end
 
-class VehicleWithParallelEventsTest < Test::Unit::TestCase
+class VehicleWithParallelEventsTest < MiniTest::Test
   def setup
     @vehicle = Vehicle.new
   end
@@ -793,7 +793,9 @@ class VehicleWithParallelEventsTest < Test::Unit::TestCase
   end
   
   def test_should_raise_exception_if_any_event_cannot_transition_on_bang
-    exception = assert_raise(EnumStateMachine::InvalidParallelTransition) { @vehicle.fire_events!(:ignite, :cancel_insurance) }
+    exception = assert_raises(EnumStateMachine::InvalidParallelTransition) {
+      @vehicle.fire_events!(:ignite, :cancel_insurance)
+    }
     assert_equal @vehicle, exception.object
     assert_equal [:ignite, :cancel_insurance], exception.events
   end
@@ -808,7 +810,7 @@ class VehicleWithParallelEventsTest < Test::Unit::TestCase
   end
 end
 
-class VehicleWithEventAttributesTest < Test::Unit::TestCase
+class VehicleWithEventAttributesTest < MiniTest::Test
   def setup
     @vehicle = Vehicle.new
     @vehicle.state_event = 'ignite'
@@ -836,7 +838,7 @@ class VehicleWithEventAttributesTest < Test::Unit::TestCase
   end
 end
 
-class MotorcycleTest < Test::Unit::TestCase
+class MotorcycleTest < MiniTest::Test
   def setup
     @motorcycle = Motorcycle.new
   end
@@ -880,7 +882,7 @@ class MotorcycleTest < Test::Unit::TestCase
   end
 end
 
-class CarTest < Test::Unit::TestCase
+class CarTest < MiniTest::Test
   def setup
     @car = Car.new
   end
@@ -927,7 +929,7 @@ class CarTest < Test::Unit::TestCase
   end
 end
 
-class CarBackingUpTest < Test::Unit::TestCase
+class CarBackingUpTest < MiniTest::Test
   def setup
     @car = Car.new
     @car.reverse
@@ -970,7 +972,7 @@ class CarBackingUpTest < Test::Unit::TestCase
   end
 end
 
-class AutoShopAvailableTest < Test::Unit::TestCase
+class AutoShopAvailableTest < MiniTest::Test
   def setup
     @auto_shop = AutoShop.new
   end
@@ -988,7 +990,7 @@ class AutoShopAvailableTest < Test::Unit::TestCase
   end
 end
 
-class AutoShopBusyTest < Test::Unit::TestCase
+class AutoShopBusyTest < MiniTest::Test
   def setup
     @auto_shop = AutoShop.new
     @auto_shop.tow_vehicle
@@ -1011,7 +1013,7 @@ class AutoShopBusyTest < Test::Unit::TestCase
   end
 end
 
-class TrafficLightStopTest < Test::Unit::TestCase
+class TrafficLightStopTest < MiniTest::Test
   def setup
     @light = TrafficLight.new
     @light.state = 'stop'
@@ -1035,7 +1037,7 @@ class TrafficLightStopTest < Test::Unit::TestCase
   end
 end
 
-class TrafficLightProceedTest < Test::Unit::TestCase
+class TrafficLightProceedTest < MiniTest::Test
   def setup
     @light = TrafficLight.new
     @light.state = 'proceed'
@@ -1050,7 +1052,7 @@ class TrafficLightProceedTest < Test::Unit::TestCase
   end
 end
 
-class TrafficLightCautionTest < Test::Unit::TestCase
+class TrafficLightCautionTest < MiniTest::Test
   def setup
     @light = TrafficLight.new
     @light.state = 'caution'

data/test/test_helper.rb

@@ -3,5 +3,17 @@ if ENV['COVERAGE']
   SimpleCov.start { add_filter '/test/' }
 end
 
-require 'test/unit'
+#require 'test/unit'
+require 'minitest'
+require "minitest/autorun"
 require 'enum_state_machine'
+
+class MiniTest::Test
+  def assert_nothing_raised
+    yield
+  rescue => ex
+    assert_nil ex
+  end
+
+  alias_method :assert_nothing_thrown, :assert_nothing_raised
+end

data/test/unit/assertions_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 
-class AssertionsBaseTest < Test::Unit::TestCase
+class AssertionsBaseTest < MiniTest::Test
   include EnumStateMachine::Assertions
   
   def default_test
@@ -13,7 +13,9 @@ class AssertValidKeysTest < AssertionsBaseTest
   end
   
   def test_should_raise_exception_if_key_is_invalid
-    exception = assert_raise(ArgumentError) { assert_valid_keys({:name => 'foo', :value => 'bar', :invalid => true}, :name, :value, :force) }
+    exception = assert_raises(ArgumentError) {
+      assert_valid_keys({:name => 'foo', :value => 'bar', :invalid => true}, :name, :value, :force)
+    }
     assert_equal 'Invalid key(s): invalid', exception.message
   end
 end
@@ -29,12 +31,16 @@ class AssertExclusiveKeysTest < AssertionsBaseTest
   end
   
   def test_should_raise_exception_if_two_keys_found
-    exception = assert_raise(ArgumentError) { assert_exclusive_keys({:only => :parked, :except => :parked}, :only, :except) }
+    exception = assert_raises(ArgumentError) {
+      assert_exclusive_keys({:only => :parked, :except => :parked}, :only, :except)
+    }
     assert_equal 'Conflicting keys: only, except', exception.message
   end
   
   def test_should_raise_exception_if_multiple_keys_found
-    exception = assert_raise(ArgumentError) { assert_exclusive_keys({:only => :parked, :except => :parked, :on => :park}, :only, :except, :with) }
+    exception = assert_raises(ArgumentError) {
+      assert_exclusive_keys({:only => :parked, :except => :parked, :on => :park}, :only, :except, :with)
+    }
     assert_equal 'Conflicting keys: only, except', exception.message
   end
 end