state_objects 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## v0.0.3
+* Ported tests from gem selection_options_for
+
+## v0.0.2
+
+* initial release as a rubygem

data/README.md

@@ -8,6 +8,11 @@ State transitions are the responsibility of the state classes.
 
 Since this was extracted from an application, the specs are currently still in the main application.  I will move the specs to this gem as soon as possible.
 
+## Focus
+Many state machines focus on events and state transitions.
+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.
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -52,7 +57,7 @@ Or install it yourself as:
       state_objects :color_state,
          LightGreenState,
          LightRedState 
-      state_object_events :change
+      state_object_events :color_state, :change
                                                                                        
       scope :red,   where("color_state = #{LightRedState.db_value}" )    
       scope :green, where("color_state = #{LightGreenState.db_value}" )    
@@ -76,14 +81,11 @@ TODO: there may be typos in the following.  It should be cleared up when I move
      <%= select :walk_light, :color_state, WalkLight.color_states %>
      <%= select :walk_light, :color_state,  [['','']] + WalkLight.color_states %>
     
-     assert_equal  ['Walk', 'Dont Walk'],   WalkLight.color_state_hash.values
      assert_equal "['Walk', 'Dont Walk']",  WalkLight.color_state_js_list
     
-    color_state_symbols  #  returns hash of symbols
 
 adds the following INSTANCE METHODS to WalkLight
 
-    color_state_hash
     color_state #  returns the single character value as in the db    
     color_state_label  # returns the current values label    
     color_state_symbol  # returns the current values symbol
@@ -107,8 +109,6 @@ adds the following INSTANCE METHODS to WalkLight
     assert_equal "Dont Walk",        walk_light.color_state_label
     
     assert_equal [["Walk", "G"], ["Dont Walk", "R"]], WalkLight.color_states
-    assert_equal({"G"=>"Walk", "R"=>"Dont Walk",},    WalkLight.color_state_hash) 
-    assert_equals({'G'=>:green, 'R'=>:red },          WalkLight.color_state_symbols) 
     
 ### Example #2: Selection list
 

data/lib/state_objects/base.rb

@@ -13,6 +13,9 @@ module StateObjects
         def self.db_value
           '#{opts[1]}'
         end
+        def self.where
+          "(status_option ='#{opts[1]}')"
+        end
         def self.label
           '#{opts[2]}'
         end

data/lib/state_objects/model_additions.rb

@@ -24,6 +24,8 @@ module StateObjects
         EOF1
       end 
     end # state_object_events
+    alias state_object_accessors state_object_events 
+    alias state_object_mutators  state_object_events 
   
     def state_objects(id, *opts)  # :nodoc:
       id = id.to_s

data/lib/state_objects/version.rb

@@ -1,3 +1,3 @@
 module StateObjects
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/state_objects.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]            
   
   # gem.add_development_dependency "supermodel" # TODO  
-  gem.add_development_dependency "activerecord"
+  # gem.add_development_dependency "activerecord"
+  gem.add_development_dependency "supermodel"
   gem.add_development_dependency "rspec-given"
   gem.add_runtime_dependency     "activerecord"
   

data/test/state_objects_exeptions_test.rb

@@ -0,0 +1,41 @@
+## ruby -Itest -Ilib test/state_objects_exceptions_test.rb
+require 'test_helper'
+
+#
+# test bad data and exceptions
+#
+                            
+class LightGreenState  < StateObjects::Base
+  state_object_values :green, 'G', 'Walk' 
+end        
+
+class ModelUnderTest < SuperModel::Base
+  extend StateObjects::ModelAdditions
+  state_objects :color_state,
+     LightGreenState
+
+  begin 
+    state_object_events :color_state, :missing_event
+                                                                                   
+  rescue RuntimeError => ex
+    @@exception_missing_event = ex
+  end
+
+  def self.exception_missing_event
+    @@exception_missing_event
+  end
+
+end
+
+class TranslateOptionsForExTest < Test::Unit::TestCase
+  def setup
+    @model  = ModelUnderTest
+  end
+
+  def test_exception_missing_event
+    assert_equal RuntimeError, ModelUnderTest.exception_missing_event.class
+    assert_equal "Invalid state class LightGreenState must implement #missing_event",
+                  ModelUnderTest.exception_missing_event.message
+  end 
+
+end

data/test/state_objects_methods_test.rb

@@ -0,0 +1,102 @@
+## ruby -Itest -Ilib test/state_objects_methods_test.rb
+require 'test_helper'
+
+#
+# setup three classes for these tests
+#
+# 1. ModelUnderTest  -- declare selection_options_for to be tested
+# 2. SiblingOfModelUnderTest -- make sure that no meta-level leaks occur
+# 3. SubClassOfModel -- should have it's own copy of class variables
+#
+
+class SiblingOfModelUnderTest < SuperModel::Base
+  extend StateObjects::ModelAdditions
+end
+
+class LightRedState  < StateObjects::Base
+  state_object_values :red, 'R', "Dont Walk" 
+  def change
+    model.color_state_green!
+    model.save!    
+  end  
+end        
+
+class LightGreenState  < StateObjects::Base
+  state_object_values :green, 'G', 'Walk' 
+  def change
+    model.color_state_red!
+    model.save!    
+  end  
+end        
+
+class ModelUnderTest < SuperModel::Base
+  extend StateObjects::ModelAdditions
+  state_objects :color_state,
+     LightGreenState,
+     LightRedState 
+  state_object_events :color_state, :change
+                                                                                   
+end
+
+# class SubClassOfModel < ModelUnderTest
+#   selection_options_for :payment_method_option,
+#             [:advanced, 'A', 'Advanced'],
+#             [:ecash,    'E', 'ECash Account']
+# end
+
+class StateObjectsTest < Test::Unit::TestCase
+  def setup
+    @model  = ModelUnderTest
+  end  
+
+  def test_should_provide_symbol
+    target =  @model.new
+    target.color_state_red!
+    assert_equal :red, target.color_state_symbol
+  end
+    
+  def test_symbol_generation
+    target =  @model.new
+    # green
+    target.color_state_green!
+    assert target.color_state_green?
+    assert !target.color_state_red?
+    # red
+    target.color_state_red!
+    assert !target.color_state_green?
+    assert target.color_state_red?
+  end
+
+  def test_sibling_of_target_not_effected_by_class_methods
+      SiblingOfModelUnderTest.payment_method_options
+      flunk "Should throw Exception" 
+      rescue NoMethodError => ex
+         assert true
+      rescue
+        flunk "wrong exception thrown"
+  end
+
+  # def test_each_subclass_has_own_symbols    
+  #   assert_equal [["Advanced", "A"], ["ECash Account", "E"]] ,
+  #                 SubClassOfModel.color_payment_method_options.sort 
+  # end
+
+  def test_default_status
+    target =  @model.new
+    target.color_state_red!
+    assert_equal 'Dont Walk', target.color_state_label
+    target.color_state = 'G'
+    assert_equal 'Walk', target.color_state_label
+  end
+
+  def test_color_state_array    
+    assert_equal [["Dont Walk", 'R'], ["Walk", "G"]].sort,  
+                  @model.color_states.sort    
+  end
+
+  def test_color_state_js_list
+    assert_equal "['Walk', 'Dont Walk']",
+                 @model.color_state_js_list
+  end
+    
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'test/unit'
+require 'supermodel'
+require File.dirname(__FILE__) +  '/../lib/state_objects'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_objects
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-25 00:00:00.000000000 Z
+date: 2012-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: supermodel
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -67,6 +67,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -76,6 +77,9 @@ files:
 - lib/state_objects/model_additions.rb
 - lib/state_objects/version.rb
 - state_objects.gemspec
+- test/state_objects_exeptions_test.rb
+- test/state_objects_methods_test.rb
+- test/test_helper.rb
 homepage: https://github.com/mwindholtz/state_objects
 licenses: []
 post_install_message: 
@@ -100,4 +104,7 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: ! '''State'' Design Pattern from the Gang of Four book'
-test_files: []
+test_files:
+- test/state_objects_exeptions_test.rb
+- test/state_objects_methods_test.rb
+- test/test_helper.rb