state_objects 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e44cb2199c32773f02d840fbeeb51ddc379419de
-  data.tar.gz: bbc333440089a4bcd8e4738fe6fc1fbd552bc810
+  metadata.gz: 938432a87a9eb1b7b7ce8899f3420232932c3a88
+  data.tar.gz: c763fe9fd28af4114e6c8a831405dbb9ef962047
 SHA512:
-  metadata.gz: 2c58b74d0827f6a4a15ebff03a6b3e7210ccae65ce94ff1fa28e199be481fb43209f14e19ba2a068dbd2bb1ca7c9fdae7d0b4b72625082345f4d24ec1401e675
-  data.tar.gz: 59112ed15ebd555c6163c61d680e04195b68fc551dfdb2cf0fc87c0a5e362c6c134e263bd27f66174c12bf8a2904deacbc7b8d2400f8de1514c79c9b8974b1dc
+  metadata.gz: 82bf299546f3e69835fd79f06b9f0dbde29688a46018c32c0090fa412384b65817384756c85e9ffabecc4f9a1d57b8e5d73cec788885456fab16908e60fea3fa
+  data.tar.gz: 2b6b1f4ec19e52378462de6ee60067f017f62b31a44df07c81c43dfde1b4bffb8ec6cf8531c87ba6d60598d13bbbe2e63f5658bb285f77fa5e00d8285b60087e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.9.2
+* changed library to raise StateObjects::Error instead of RuntimeError
+* Documentation update
+
 ## 0.9.1
 * Fixed typos in the example code. 
 

data/README.md

@@ -11,6 +11,7 @@ Many other state machines focus on events and state transitions.
 This state machine focuses on behavior.
 The main benefit of this gem is to reduce conditional logic by removing #if checks in the model and moving the logic into the state objects. Using Composition in this way can go a long way to simplify Rails models.
 
+This gem works well with ActiveRecord classes, however ActiveRecord is not required.  It can manage the state of regular Ruby objects as well.
 
 ## Installation
 
@@ -133,4 +134,4 @@ It's now easy to add scopes with using _occurs, which will generate your where s
 5. Create new Pull Request
 
 ## Thanks To
-* Scott Baron - for helping with the unit tests.
+* Scott Baron (https://github.com/rubyist) - for helping with the unit tests.

data/lib/state_objects/base.rb

@@ -1,4 +1,8 @@
 module StateObjects
+  
+  class Error < RuntimeError
+  end
+  
   class Base
 
     def initialize(model)
@@ -7,7 +11,7 @@ module StateObjects
 
     def self.state_object_values(*opts)  # :nodoc:          
       unless opts.size == 3
-        raise @model.to_s + "#state_object_values Must have 3 arguments: symbol, db_value, label.  For Example: state_object_values :red,'R','Dont Walk'"
+        raise StateObjects::Error.new @model.to_s + "#state_object_values Must have 3 arguments: symbol, db_value, label.  For Example: state_object_values :red,'R','Dont Walk'"
       end
       
       class_eval <<-EOF

data/lib/state_objects/model_additions.rb

@@ -3,14 +3,14 @@ module StateObjects
     
     def state_object_events(id,*methods)  # :nodoc:
       unless self.respond_to?("#{id}_klasses")
-        raise "Invalid call sequence. #state_objects must be defined before #state_object_events"
+        raise StateObjects::Error.new "Invalid call sequence. #state_objects must be defined before #state_object_events"
       end                     
 
       # check methods on State classes      
       self.send("#{id}_states").each do |klass|
         methods.each do |method|
           unless klass.new(nil).respond_to?(method)
-            raise "Invalid state class #{klass} must implement ##{method}"
+            raise StateObjects::Error.new "Invalid state class #{klass} must implement ##{method}"
           end                     
         end
       end
@@ -51,7 +51,7 @@ module StateObjects
 
         def #{id}_state_klass
           unless result = self.#{id_klasses}[self.#{id}]
-            raise #{id} + " was not a valid state in: " +  self.#{id_klasses}.keys.join(', ') 
+            raise StateObjects::Error.new #{id} + " was not a valid state in: " +  self.#{id_klasses}.keys.join(', ') 
           end  
           result
         end            
@@ -72,14 +72,14 @@ module StateObjects
       opts.each do |option_klass|
         [:symbol, :label, :db_value].each do |required_method|
           unless option_klass.respond_to?(required_method) 
-            raise "Invalid State class ["+ option_klass.to_s + "]. Must implement a class method named: ##{required_method}.  Use #state_object_values to setup StateObject"
+            raise StateObjects::Error.new "Invalid State class ["+ option_klass.to_s + "]. Must implement a class method named: ##{required_method}.  Use #state_object_values to setup StateObject"
           end          
         end
         
         letter       = option_klass.db_value
         display_text = option_klass.label
         if(send(id_klasses).has_key?(letter))
-          raise "Duplicate key during state_objects :" + id + ".  key: " + 
+          raise StateObjects::Error.new "Duplicate key during state_objects :" + id + ".  key: " + 
                  letter + ' for text: ' + display_text
         end
         send(id_klasses)[letter] = option_klass

data/lib/state_objects/version.rb

@@ -1,3 +1,3 @@
 module StateObjects
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 end

data/test/missing_event_ex_test.rb

@@ -17,7 +17,7 @@ class MissingEventExModelUnderTest < SuperModel::Base
   begin 
     state_object_events :color_state, :missing_event
                                                                                    
-  rescue RuntimeError => ex
+  rescue StateObjects::Error => ex
     @@exception_missing_event = ex
   end
 
@@ -33,7 +33,7 @@ class MissingEventExTest < Test::Unit::TestCase
   end
 
   def test_exception_missing_event
-    assert_equal RuntimeError, MissingEventExModelUnderTest.exception_missing_event.class
+    assert_equal StateObjects::Error, MissingEventExModelUnderTest.exception_missing_event.class
     assert_equal "Invalid state class LightGreenState must implement #missing_event",
                   MissingEventExModelUnderTest.exception_missing_event.message
   end 

data/test/state_object_values_class_test.rb

@@ -5,7 +5,7 @@ class StateObjectUnderTest < StateObjects::Base
     
   begin 
     state_object_values :green, 'G'
-  rescue RuntimeError => ex
+  rescue StateObjects::Error => ex
     @@ex_incomplete_values = ex
   end
 
@@ -21,7 +21,7 @@ class StateObjectValuesClassTest < Test::Unit::TestCase
   end
 
   def test_ex_incomplete_values
-    assert_equal RuntimeError, StateObjectUnderTest.ex_incomplete_values.class
+    assert_equal StateObjects::Error, StateObjectUnderTest.ex_incomplete_values.class
     assert_equal "#state_object_values Must have 3 arguments: symbol, db_value, label.  For Example: state_object_values :red,'R','Dont Walk'",
                   StateObjectUnderTest.ex_incomplete_values.message
   end

data/test/state_object_values_test.rb

@@ -14,7 +14,7 @@ class ModelUnderTest < SuperModel::Base
   begin                                             
     state_objects :no_state,
        NoStateObjectValues    
-  rescue RuntimeError => ex
+  rescue StateObjects::Error => ex
     @@ex_no_state_values = ex
   end
 
@@ -30,7 +30,7 @@ class StateObjectValuesTest < Test::Unit::TestCase
   end
 
   def test_no_state_values
-    assert_equal RuntimeError, ModelUnderTest.ex_no_state_values.class
+    assert_equal StateObjects::Error, ModelUnderTest.ex_no_state_values.class
     assert_equal "Invalid State class [NoStateObjectValues]. Must implement a class method named: #symbol.  Use #state_object_values to setup StateObject",
                   ModelUnderTest.ex_no_state_values.message
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: state_objects
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Mark Windholtz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-17 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: supermodel
@@ -97,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: "'State' Design Pattern from the Gang of Four book"