alter-ego-mongoid 0.1.2

data/Manifest

@@ -0,0 +1,9 @@
+Manifest
+README.rdoc
+Rakefile
+alter-ego-mongoid.gemspec
+init.rb
+lib/alter_ego/mongoid_adapter.rb
+test/adapter_test.rb
+test/helper.rb
+test/traffic_signal.rb

data/README.rdoc

@@ -0,0 +1,37 @@
+= AlterEgo-Mongoid
+
+== Motivation
+AlterEgo is my favorite Ruby state machine for the following reasons:
+  1. It's not dependent on Mongoid - 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 Mongoid because it 
+stores state in <tt>@state</tt>, whereas Mongoid::Document
+persists with setter methods.
+
+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
+=== As a Ruby Gem 
+  gem install alter-ego-mongoid
+=== OR as a Rails plugin
+  script/plugin install git://github.com/wink/alter-ego-mongoid.git
+
+== Usage
+This plugin automatically adds a string field to your model called "state".
+
+  # you'll only need the following two lines if you're NOT using
+  # alter-ego-mongoid as a plugin
+  gem 'alter-ego-mongoid'
+  require 'alter_ego/mongoid_adapter'
+
+  class Example
+    include Mongoid::Document
+    include AlterEgo # include this first
+    include AlterEgo::MongoidAdapter
+
+    # Your code here
+  end

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('alter-ego-mongoid', '0.1.2') do |p|
+  p.description = "Adapter to allow Mongoid to persist and restore state of objects using the AlterEgo state machine, ported from the alter-ego-activerecord gem by Paul Hieromnimon"
+  p.author = "Micah Winkelspecht"
+  p.email = "winkelspecht@gmail.com"
+  p.url = "http://github.com/wink/alter-ego-mongoid"
+  p.runtime_dependencies = ["mongoid >=2.0.0.rc.6", "bson_ext ~>1.2", "alter-ego >=1.0.1" ]
+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-mongoid.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{alter-ego-mongoid}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Micah Winkelspecht"]
+  s.date = %q{2011-01-30}
+  s.description = %q{Adapter to allow Mongoid to persist and restore state of objects using the AlterEgo state machine, ported from the alter-ego-activerecord gem by Paul Hieromnimon}
+  s.email = %q{winkelspecht@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/alter_ego/mongoid_adapter.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "alter-ego-mongoid.gemspec", "init.rb", "lib/alter_ego/mongoid_adapter.rb", "test/adapter_test.rb", "test/helper.rb", "test/traffic_signal.rb"]
+  s.homepage = %q{http://github.com/wink/alter-ego-mongoid}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Alter-ego-mongoid", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{alter-ego-mongoid}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Adapter to allow Mongoid to persist and restore state of objects using the AlterEgo state machine, ported from the alter-ego-activerecord gem by Paul Hieromnimon}
+  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<mongoid>, [">= 2.0.0.rc.6"])
+      s.add_runtime_dependency(%q<bson_ext>, ["~> 1.2"])
+      s.add_runtime_dependency(%q<alter-ego>, [">= 1.0.1"])
+    else
+      s.add_dependency(%q<mongoid>, [">= 2.0.0.rc.6"])
+      s.add_dependency(%q<bson_ext>, ["~> 1.2"])
+      s.add_dependency(%q<alter-ego>, [">= 1.0.1"])
+    end
+  else
+    s.add_dependency(%q<mongoid>, [">= 2.0.0.rc.6"])
+    s.add_dependency(%q<bson_ext>, ["~> 1.2"])
+    s.add_dependency(%q<alter-ego>, [">= 1.0.1"])
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'alter_ego/mongoid_adapter'

data/lib/alter_ego/mongoid_adapter.rb

@@ -0,0 +1,31 @@
+module AlterEgo
+  module MongoidAdapter
+
+    def self.included klass
+      klass.field :state
+      klass.after_initialize do |r|
+        r.state = r.state
+      end
+    end
+
+    # # rails needs this method to be defined for the
+    # # class method after_initialize 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
+      self[:state] = identifier.to_s unless identifier.nil?
+    end
+
+    def state
+      result = self[: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,70 @@
+require 'helper'
+
+class AdapterTest < Test::Unit::TestCase
+    
+  def test_state_stored_in_attributes
+    t = TrafficSignal.new
+    assert_not_nil t.state
+    t.state = :caution
+    assert_equal :caution, t.state
+  end
+
+  def test_state_stored_as_string
+    t = TrafficSignal.new
+    assert_equal String, t[: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[: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
+
+end

data/test/helper.rb

@@ -0,0 +1,16 @@
+require 'test/unit'
+require 'rubygems'
+gem 'mongoid'
+gem 'bson_ext'
+require 'mongoid'
+gem 'alter-ego'
+require 'alter_ego'
+require 'alter_ego/mongoid_adapter'
+require 'traffic_signal'
+
+Mongoid.configure do |config|
+  name = "alter-ego-mongoid-test"
+  host = "localhost"
+  config.master = Mongo::Connection.new.db(name)
+  config.persist_in_safe_mode = false
+end

data/test/traffic_signal.rb

@@ -0,0 +1,30 @@
+class TrafficSignal
+  include Mongoid::Document
+  
+  field :state
+  
+  include AlterEgo
+  include AlterEgo::MongoidAdapter
+  
+  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,130 @@
+--- !ruby/object:Gem::Specification 
+name: alter-ego-mongoid
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Micah Winkelspecht
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-30 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15424089
+        segments: 
+        - 2
+        - 0
+        - 0
+        - rc
+        - 6
+        version: 2.0.0.rc.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: alter-ego
+  prerelease: false
+  requirement: &id003 !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: *id003
+description: Adapter to allow Mongoid to persist and restore state of objects using the AlterEgo state machine, ported from the alter-ego-activerecord gem by Paul Hieromnimon
+email: winkelspecht@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/alter_ego/mongoid_adapter.rb
+files: 
+- Manifest
+- README.rdoc
+- Rakefile
+- alter-ego-mongoid.gemspec
+- init.rb
+- lib/alter_ego/mongoid_adapter.rb
+- test/adapter_test.rb
+- test/helper.rb
+- test/traffic_signal.rb
+has_rdoc: true
+homepage: http://github.com/wink/alter-ego-mongoid
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Alter-ego-mongoid
+- --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-mongoid
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Adapter to allow Mongoid to persist and restore state of objects using the AlterEgo state machine, ported from the alter-ego-activerecord gem by Paul Hieromnimon
+test_files: 
+- test/adapter_test.rb