state_objects 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in state_objects.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Windholtz
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,136 @@
+# StateObjects
+
+This is a State Machine implementation based on the http://en.wikipedia.org/wiki/State_pattern
+From the classic book http://en.wikipedia.org/wiki/Design_Patterns
+Each state is a separate class.
+You can add methods to the state classes, but each state class must have implement the same list of methods.
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'state_objects'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install state_objects
+
+## Usage
+
+    class WalkLights < ActiveRecord::Migration
+      def self.change
+        create_table :walk_lights do |t|
+          t.string :color_state, :default => LightRedState.db_value
+        end
+    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 WalkLight < ActiveRecord::Base
+      extend StateObjects::ModelAdditions
+      state_objects :color_state,
+         LightGreenState,
+         LightRedState 
+      state_object_events :change
+                                                                                       
+      scope :red,   where("color_state = #{LightRedState.db_value}" )    
+      scope :green, where("color_state = #{LightGreenState.db_value}" )    
+    end
+
+    # now lets use it 
+    north_south_elm_300_block = WalkLight.create(color_state: LightRedState.db_value)
+    while (true)
+      pause rand(200)  # keep the pedestrians guessing :-)
+      north_south_elm_300_block.change
+    end
+
+### adds the following CLASS METHODS to WalkLight
+
+TODO: there may be typos in the following.  It should be cleared up when I move the specs into the gem.
+
+* color_states
+  returns a array of 2-value arrays suitable to fill a select tag
+  The second example shows how to start the selection on a blank
+    
+     <%= 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
+
+* methods ending in '?' return boolean if the value is set
+* methods ending in '!' set the value ( this does NOT save the model)
+  
+    color_state_red?  
+    color_state_red! 
+    
+    color_state_green?
+    color_state_green!
+    
+### example #1: Selection list
+
+    walk_light = WalkLight.build(color_state: LightGreenState.db_value)
+    walk_light.color_state_red!
+    assert_equal 'R',                walk_light.color_state
+    assert_equal :red,               walk_light.color_state_symbol
+    assert_equal true,               walk_light.color_state_red?
+    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
+
+    <%=  select :walk_light, :color_state, WalkLight.color_states %> 
+    
+
+### Example #3: Radio button labels
+
+    <% WalkLight.color_state_hash.each do | key, value | %>
+        <%=  radio_button :walk_light, :color_state, key %> <%= value %><br />
+    <% end %>
+    
+
+### Example #4 in a java_script list
+
+    color_state_js_list
+
+    
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/state_objects/base.rb

@@ -0,0 +1,28 @@
+module StateObjects
+  class Base
+
+    def initialize(model)
+      @model = model
+    end
+
+    def self.state_object_values(*opts)  # :nodoc:
+      class_eval <<-EOF
+        def self.symbol
+          '#{opts[0]}'.to_sym
+        end
+        def self.db_value
+          '#{opts[1]}'
+        end
+        def self.label
+          '#{opts[2]}'
+        end
+      EOF
+    end
+
+    protected 
+      def model
+        @model
+      end
+
+  end
+end

data/lib/state_objects/model_additions.rb

@@ -0,0 +1,93 @@
+module StateObjects
+  module ModelAdditions  
+    
+    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"
+      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}"
+          end                     
+        end
+      end
+      
+      id = id.to_s  
+      methods.each do |method|
+        module_eval <<-EOF1
+          def #{method}(*args)
+            #{id}_state.#{method}(*args)
+          end
+        EOF1
+      end 
+    end # state_object_events
+  
+    def state_objects(id, *opts)  # :nodoc:
+      id = id.to_s
+      id_klasses = id + '_klasses'
+      class_eval <<-EOF
+        class_attribute "#{id_klasses}".to_sym
+        send("#{id_klasses}=".to_sym, {})             
+
+        def self.#{id}_states 
+          #{id_klasses}.values
+        end
+
+        def self.#{id}s   
+          #{id_klasses}.map { |key, klass| [klass.label, key] }
+        end
+
+        def self.#{id}_js_list
+          result = '['
+          self.#{id}_states.each{ |klass| result = result + "'"+ klass.label + "', "}
+          result.chop!.chop! if result.size > 2
+          result + ']'
+        end
+
+        def #{id}_state_klass
+          self.#{id_klasses}[self.#{id}]
+        end            
+
+        def #{id}_state
+          #{id}_state_klass.new(self)
+        end            
+        
+        def #{id}_label
+          #{id}_state_klass.label
+        end                                                   
+        
+        def #{id}_symbol
+          #{id}_state_klass.symbol
+        end
+      EOF
+      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}.  I suggest using #state_object_values"
+          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: " + 
+                 letter + ' for text: ' + display_text
+        end
+        send(id_klasses)[letter] = option_klass
+        module_eval <<-EOF2
+          def #{id}_#{option_klass.symbol}?
+            self.#{id} == '#{letter}'
+          end
+          def #{id}_#{option_klass.symbol}!
+            self.#{id} = '#{letter}'
+          end
+        EOF2
+      end # opts.each
+    end # state_objects
+  end  # ModelAdditions
+end # StateObjects
+
+

data/lib/state_objects/version.rb

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

data/lib/state_objects.rb

@@ -0,0 +1,3 @@
+require "state_objects/version"
+require "state_objects/model_additions"
+require "state_objects/base"

data/state_objects.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'state_objects/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "state_objects"
+  gem.version       = StateObjects::VERSION
+  gem.authors       = ["Mark Windholtz"]
+  gem.email         = ["windholtz@gmail.com"]
+  gem.homepage      = "https://github.com/mwindholtz/state_objects"
+  gem.summary       = %q{ 'State' Design Pattern from the Gang of Four book }
+  gem.description   = %q{ 'State' Design Pattern from the Gang of Four book }
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]            
+  
+  # gem.add_development_dependency "supermodel" # TODO  
+  gem.add_development_dependency "activerecord"
+  gem.add_development_dependency "rspec-given"
+  gem.add_runtime_dependency     "activerecord"
+  
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: state_objects
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Mark Windholtz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' ''State'' Design Pattern from the Gang of Four book '
+email:
+- windholtz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/state_objects.rb
+- lib/state_objects/base.rb
+- lib/state_objects/model_additions.rb
+- lib/state_objects/version.rb
+- state_objects.gemspec
+homepage: https://github.com/mwindholtz/state_objects
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ! '''State'' Design Pattern from the Gang of Four book'
+test_files: []