alter-ego-activerecord 0.1.0

data/Manifest

@@ -0,0 +1,9 @@
+Manifest
+README.rdoc
+Rakefile
+alter-ego-activerecord.gemspec
+lib/alter_ego/active_record_adapter.rb
+test/adapter_test.rb
+test/create_traffic_signals.rb
+test/helper.rb
+test/traffic_signal.rb

data/README.rdoc

@@ -0,0 +1,28 @@
+= AlterEgo-ActiveRecord
+
+== Motivation
+AlterEgo is my favorite Ruby state machine for the following reasons:
+  1. It's not dependent on ActiveRecord - it can be used on plain Ruby objects.
+  2. It most closely follows the GOF State Pattern because it allows for 
+     polymorphic behavior based on state.
+
+Out of the box, AlterEgo doesn't play nicely with ActiveRecord because it 
+stores state in <tt>@state</tt>, whereas subclasses of ActiveRecord::Base
+persist their <tt>attributes</tt> hash.
+
+This mixin overrides the AlterEgo's accessor methods for state to allow it 
+to be properly persisted to a database, as well as serialized/unserialized as
+json, yml, and xml.
+
+== Installation
+  gem install alter-ego-activerecord
+
+== Usage
+  Make sure the table your class maps to has a <tt>state</tt> column.
+ 
+  class Example < ActiveRecord::Base
+    include AlterEgo # include this first
+    include AlterEgo::ActiveRecordAdapter
+    
+    # Your code here
+  end

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('alter-ego-activerecord', '0.1.0') do |p|
+  p.description = "Adapter to allow ActiveRecord to persist and restore state of objects using the AlterEgo state machine"
+  p.author = "Paul Hieromnimon"
+  p.email = "paul.hieromnimon@gmail.com"
+  p.url = "http://github.com/pavlos/alter-ego-active-record"
+  p.runtime_dependencies = ["activerecord >=2.3.5", "alter-ego >=1.0.1" ]
+  p.ignore_pattern = ["*.sqlite"]
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test' 
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/alter-ego-activerecord.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{alter-ego-activerecord}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Hieromnimon"]
+  s.date = %q{2010-08-13}
+  s.description = %q{Adapter to allow ActiveRecord to persist and restore state of objects using the AlterEgo state machine}
+  s.email = %q{paul.hieromnimon@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/alter_ego/active_record_adapter.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "alter-ego-activerecord.gemspec", "lib/alter_ego/active_record_adapter.rb", "test/adapter_test.rb", "test/create_traffic_signals.rb", "test/helper.rb", "test/traffic_signal.rb"]
+  s.homepage = %q{http://github.com/pavlos/alter-ego-active-record}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Alter-ego-activerecord", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{alter-ego-activerecord}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Adapter to allow ActiveRecord to persist and restore state of objects using the AlterEgo state machine}
+  s.test_files = ["test/adapter_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.3.5"])
+      s.add_runtime_dependency(%q<alter-ego>, [">= 1.0.1"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+      s.add_dependency(%q<alter-ego>, [">= 1.0.1"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+    s.add_dependency(%q<alter-ego>, [">= 1.0.1"])
+  end
+end

data/lib/alter_ego/active_record_adapter.rb

@@ -0,0 +1,30 @@
+module AlterEgo
+  module ActiveRecordAdapter
+
+    def self.included klass
+      klass.after_initialize do |r|
+        r.state = r.state
+      end
+    end
+
+    # rails needs this method to be defined for the
+    # class method after_find to be able to take a block
+    # this is because of some performance optimization
+    def after_initialize; end
+
+    # Override methods from AlterEgo to store state
+    # in @attributes["state"] instead of @state
+    def state=(identifier)
+      # state needs to always be stored as a string - symbol serialization is strange
+      @attributes["state"] = identifier.to_s unless identifier.nil?
+    end
+
+    def state
+      result = ( @attributes["state"] || self.class.default_state)
+      result = result.to_sym unless result.nil?
+      assert(result.nil? || self.class.states.keys.include?(result))
+      result
+    end
+
+  end
+end

data/test/adapter_test.rb

@@ -0,0 +1,77 @@
+require 'helper'
+
+class AdapterTest < Test::Unit::TestCase
+
+  def setup
+    CreateTrafficSignals.up
+  end
+    
+  def test_state_stored_in_attributes
+    t = TrafficSignal.new
+    assert_not_nil t.attributes["state"]
+    t.state = :caution
+    assert_equal "caution", t.attributes["state"]
+  end
+
+  def test_state_stored_as_string
+    t = TrafficSignal.new
+    assert_equal String, t.attributes["state"].class
+  end
+
+  def test_state_returned_as_symbol
+    t = TrafficSignal.new
+    assert_equal Symbol, t.state.class
+  end
+  
+  def test_state_is_persisted_and_restored
+    t = TrafficSignal.new
+    old_state = t.state
+    t.cycle!
+    new_state = t.state
+
+    #sanity check
+    assert_not_equal old_state, new_state
+
+    t.save!
+    t = t.reload
+
+    assert_equal t.state, new_state
+  end
+
+  def test_new_object_has_default_state
+    t=TrafficSignal.new
+    assert_equal t.state, TrafficSignal.default_state
+    assert_equal t.attributes["state"].to_sym, TrafficSignal.default_state
+  end
+
+  def test_yaml
+    require 'yaml'
+    t= TrafficSignal.new
+    t.cycle!
+    yaml = YAML::dump t
+    t2 = YAML::load yaml
+    assert_equal t.state, t2.state    
+  end
+
+  def test_json
+    t = TrafficSignal.new
+    t.cycle!
+    json = t.to_json
+    t2 = TrafficSignal.new
+    t2.from_json json
+    assert_equal t.state, t2.state
+  end
+
+  def test_xml
+    t = TrafficSignal.new
+    t.cycle!
+    xml = t.to_xml
+    t2 = TrafficSignal.new
+    t2.from_xml xml
+    assert_equal t.state, t2.state
+  end
+  
+  def teardown
+    CreateTrafficSignals.down
+  end
+end

data/test/create_traffic_signals.rb

@@ -0,0 +1,19 @@
+class CreateTrafficSignals < ActiveRecord::Migration
+
+  def self.up
+    create_table :traffic_signals do |t|
+      t.string :state
+    end
+  end
+
+  def self.down
+    drop_table :traffic_signals
+  end
+
+  # redirect output so running tests doesn't display a bunch of migration info
+  def self.puts *args
+    log = File.new "test/migrations.log", 'a+'
+    args.each {|a| log << a.to_s; log << "\n"}
+    log.close
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'test/unit'
+require 'rubygems'
+gem 'activerecord'
+require 'active_record'
+ActiveRecord::Base.establish_connection(:adapter=>'sqlite3', :database=>'test/testdb.sqlite')
+gem 'alter-ego'
+require 'alter_ego'
+require 'alter_ego/active_record_adapter'
+require 'create_traffic_signals'
+require 'traffic_signal'

data/test/traffic_signal.rb

@@ -0,0 +1,27 @@
+class TrafficSignal < ActiveRecord::Base
+  include AlterEgo
+  include AlterEgo::ActiveRecordAdapter
+
+
+  state :proceed, :default=>true do
+    handle :color do
+  "green"
+    end
+    transition :to => :caution, :on => :cycle!
+  end
+
+  state :caution do
+    handle :color do
+  "yellow"
+    end
+    transition :to => :stop, :on => :cycle!
+  end
+
+  state :stop do
+    handle :color do
+  "red"
+    end
+    transition :to => :proceed, :on => :cycle!
+  end
+
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: alter-ego-activerecord
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Paul Hieromnimon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: alter-ego
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id002
+description: Adapter to allow ActiveRecord to persist and restore state of objects using the AlterEgo state machine
+email: paul.hieromnimon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/alter_ego/active_record_adapter.rb
+files: 
+- Manifest
+- README.rdoc
+- Rakefile
+- alter-ego-activerecord.gemspec
+- lib/alter_ego/active_record_adapter.rb
+- test/adapter_test.rb
+- test/create_traffic_signals.rb
+- test/helper.rb
+- test/traffic_signal.rb
+has_rdoc: true
+homepage: http://github.com/pavlos/alter-ego-active-record
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Alter-ego-activerecord
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: alter-ego-activerecord
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Adapter to allow ActiveRecord to persist and restore state of objects using the AlterEgo state machine
+test_files: 
+- test/adapter_test.rb