stateflow 0.4.0 → 0.4.1

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+= Version 0.4.1
+	* Removed the depreciation warnings - FINALLY :)
+
 = Version 0.4.0
 * Changed the order of the hooks, now runs in the following order:
 	- Exit on previous state

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    stateflow (0.4.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.3)
+    arel (2.0.6)
+    bson (1.1.4)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    i18n (0.5.0)
+    mongo (1.1.4)
+      bson (>= 1.1.1)
+    mongoid (2.0.0.beta.20)
+      activemodel (~> 3.0)
+      mongo (~> 1.1)
+      tzinfo (~> 0.3.22)
+      will_paginate (~> 3.0.pre)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    tzinfo (0.3.23)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  mongoid (>= 2.0.0.beta.20)
+  rspec (>= 2.0.0)
+  sqlite3-ruby
+  stateflow!

data/Manifest

@@ -1,4 +1,6 @@
 CHANGELOG.rdoc
+Gemfile
+Gemfile.lock
 LICENCE
 Manifest
 README.rdoc
@@ -17,6 +19,8 @@ lib/stateflow/persistence/mongoid.rb
 lib/stateflow/persistence/none.rb
 lib/stateflow/state.rb
 lib/stateflow/transition.rb
+spec/orm/activerecord_spec.rb
+spec/orm/mongoid_spec.rb
 spec/spec_helper.rb
 spec/stateflow_spec.rb
 stateflow.gemspec

data/Rakefile

@@ -2,11 +2,11 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('stateflow', '0.4.0') do |p|
+Echoe.new('stateflow', '0.4.1') do |p|
   p.description    = "State machine that allows dynamic transitions for business workflows"
   p.url            = "http://github.com/ryanza/stateflow"
   p.author         = "Ryan Oberholzer"
   p.email          = "ryan@platform45.com"
   p.ignore_pattern = ["tmp/*", "script/*"]
-  p.development_dependencies = ["rspec", "activerecord", "mongoid >=2.0.0.beta.20", "sqlite3-ruby"]
+  p.development_dependencies = ["rspec >=2.0.0", "activerecord", "mongoid >=2.0.0.beta.20", "sqlite3-ruby"]
 end

data/lib/stateflow.rb

@@ -45,7 +45,7 @@ module Stateflow
       @current_state ||= load_from_persistence.nil? ? machine.initial_state : machine.states[load_from_persistence.to_sym]
     end
     
-    def set_current_state(new_state, options)
+    def set_current_state(new_state, options = {})
       save_to_persistence(new_state.name.to_s, options)
       @current_state = new_state
     end

data/lib/stateflow/persistence/mongo_mapper.rb

@@ -2,8 +2,10 @@ module Stateflow
   module Persistence
     module MongoMapper
       def self.install(base)
-        base.before_validation_on_create :ensure_initial_state
-        base.send :include, InstanceMethods
+        ActiveSupport::Deprecation.silence do
+          base.respond_to?(:before_validation_on_create) ? base.before_validation_on_create(:ensure_initial_state) : base.before_validation(:ensure_initial_state, :on => :create)
+          base.send :include, InstanceMethods
+        end
       end
       
       module InstanceMethods

data/lib/stateflow/persistence/mongoid.rb

@@ -2,8 +2,10 @@ module Stateflow
   module Persistence
     module Mongoid
       def self.install(base)
-        base.respond_to?(:before_validation_on_create) ? base.before_validation_on_create(:ensure_initial_state) : base.before_validation(:ensure_initial_state, :on => :create)
-        base.send :include, InstanceMethods
+        ActiveSupport::Deprecation.silence do
+          base.respond_to?(:before_validation_on_create) ? base.before_validation_on_create(:ensure_initial_state) : base.before_validation(:ensure_initial_state, :on => :create)
+          base.send :include, InstanceMethods
+        end
       end
 
       module InstanceMethods

data/spec/orm/activerecord_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+require 'active_record'
+
+Stateflow.persistence = :active_record
+
+# change this if sqlite is unavailable
+dbconfig = {
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+}
+
+ActiveRecord::Base.establish_connection(dbconfig)
+ActiveRecord::Migration.verbose = false
+
+class TestMigration < ActiveRecord::Migration
+  def self.up
+    create_table :active_record_robots, :force => true do |t|
+      t.column :state, :string
+      t.column :name, :string
+    end
+
+    create_table :active_record_protected_robots, :force => true do |t|
+      t.column :state, :string
+      t.column :name, :string
+    end
+
+  end
+
+  def self.down
+    drop_table :active_record_robots
+    drop_table :active_record_protected_robots
+  end
+end
+
+class ActiveRecordRobot < ActiveRecord::Base
+  include Stateflow
+  
+  stateflow do
+    initial :red
+
+    state :red, :green
+
+    event :change do
+      transitions :from => :red, :to => :green
+    end
+  end
+end
+
+class ActiveRecordProtectedRobot < ActiveRecord::Base
+  include Stateflow
+  
+  attr_protected :state
+
+  stateflow do
+    initial :red
+
+    state :red, :green
+
+    event :change do
+      transitions :from => :red, :to => :green
+    end
+  end
+end
+
+describe Stateflow::Persistence::ActiveRecord do
+  before(:all) { TestMigration.up }
+  after(:all) { TestMigration.down }
+  after { ActiveRecordRobot.delete_all; ActiveRecordProtectedRobot.delete_all }
+
+  let(:robot) { ActiveRecordRobot.new }
+  let(:protected_robot) { ActiveRecordProtectedRobot.new }
+
+  describe "includes" do
+    it "should include current_state" do
+      robot.respond_to?(:current_state).should be_true
+    end
+
+    it "should include current_state=" do
+      robot.respond_to?(:set_current_state).should be_true
+    end
+
+    it "should include save_to_persistence" do
+      robot.respond_to?(:save_to_persistence).should be_true
+    end
+
+    it "should include load_from_persistence" do
+      robot.respond_to?(:load_from_persistence).should be_true
+    end
+  end
+
+  describe "bang method" do
+    before do
+      @robot = robot
+      @robot.state = "red"
+    end
+
+    it "should call the set_current_state with save being true" do
+      @robot.should_receive(:set_current_state).with(@robot.machine.states[:green], {:save=>true})
+      @robot.change!
+    end
+
+    it "should call the setter method for the state column" do
+      @robot.should_receive(:state=).with("green")
+      @robot.change!
+    end
+
+    it "should call save after setting the state column" do
+      @robot.should_receive(:save)
+      @robot.change!
+    end
+
+    it "should save the record" do
+      @robot.new_record?.should be_true
+      @robot.change!
+      @robot.new_record?.should be_false
+      @robot.reload.state.should == "green"
+    end
+
+    it "should save the protected method" do
+      @protected_robot = protected_robot
+      @protected_robot.new_record?.should be_true
+      @protected_robot.change!
+      @protected_robot.new_record?.should be_false
+      @protected_robot.reload.state.should == "green"
+    end
+  end
+
+    describe "non bang method" do
+    before do
+      @robot = robot
+      @robot.state = "red"
+    end
+
+    it "should call the set_current_state with save being false" do
+      @robot.should_receive(:set_current_state).with(@robot.machine.states[:green], {:save=>false})
+      @robot.change
+    end
+
+    it "should call the setter method for the state column" do
+      @robot.should_receive(:state=).with("green")
+      @robot.change
+    end
+
+    it "should call save after setting the state column" do
+      @robot.should_not_receive(:save)
+      @robot.change
+    end
+
+    it "should not save the record" do
+      @robot.new_record?.should be_true
+      @robot.change
+      @robot.new_record?.should be_true
+      @robot.state.should == "green"
+    end
+  end
+
+  it "Make sure stateflow saves the initial state if no state is set" do
+    @robot3 = robot
+
+    @robot3.save
+    @robot3.reload
+
+    @robot3.state.should == "red"
+  end
+
+  describe "load from persistence" do
+    before do
+      @robot = robot
+      @robot.state = "green"
+      @robot.name = "Bottie"
+      @robot.save
+    end
+
+    it "should call the load_from_persistence method" do
+     @robot.reload
+     @robot.should_receive(:load_from_persistence)
+
+     @robot.current_state
+    end
+  end
+end
+

data/spec/orm/mongoid_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+require 'mongoid'
+
+Stateflow.persistence = :mongoid
+
+connection = Mongo::Connection.new
+Mongoid.database = connection.db("stateflow_test")
+
+class MongoRobot
+  include Mongoid::Document
+  include Stateflow
+
+  field :state
+  field :name
+
+  stateflow do
+    initial :red
+
+    state :red, :green
+
+    event :change do
+      transitions :from => :red, :to => :green
+    end
+  end
+end
+
+describe Stateflow::Persistence::Mongoid do
+  after { MongoRobot.collection.drop }
+  
+  let(:robot) { MongoRobot.new }
+  
+  describe "includes" do
+    it "should include current_state" do
+      robot.respond_to?(:current_state).should be_true
+    end
+
+    it "should include current_state=" do
+      robot.respond_to?(:set_current_state).should be_true
+    end
+
+    it "should include save_to_persistence" do
+      robot.respond_to?(:save_to_persistence).should be_true
+    end
+
+    it "should include load_from_persistence" do
+      robot.respond_to?(:load_from_persistence).should be_true
+    end
+  end
+  
+  describe "bang method" do
+    before do
+      @robot = robot
+      @robot.state = "red"
+    end
+
+    it "should call the set_current_state with save being true" do
+      @robot.should_receive(:set_current_state).with(@robot.machine.states[:green], {:save=>true})
+      @robot.change!
+    end
+
+    it "should call the setter method for the state column" do
+      @robot.should_receive(:state=).with("green")
+      @robot.change!
+    end
+
+    it "should call save after setting the state column" do
+      @robot.should_receive(:save)
+      @robot.change!
+    end
+
+    it "should save the record" do
+      @robot.new_record?.should be_true
+      @robot.change!
+      @robot.new_record?.should be_false
+      @robot.reload.state.should == "green"
+    end
+  end
+
+    describe "non bang method" do
+    before do
+      @robot = robot
+      @robot.state = "red"
+    end
+
+    it "should call the set_current_state with save being false" do
+      @robot.should_receive(:set_current_state).with(@robot.machine.states[:green], {:save=>false})
+      @robot.change
+    end
+
+    it "should call the setter method for the state column" do
+      @robot.should_receive(:state=).with("green")
+      @robot.change
+    end
+
+    it "should call save after setting the state column" do
+      @robot.should_not_receive(:save)
+      @robot.change
+    end
+
+    it "should not save the record" do
+      @robot.new_record?.should be_true
+      @robot.change
+      @robot.new_record?.should be_true
+      @robot.state.should == "green"
+    end
+  end
+
+  it "Make sure stateflow saves the initial state if no state is set" do
+    @robot = robot
+
+    @robot.save
+    @robot.reload
+
+    @robot.state.should == "red"
+  end
+  
+  describe "load from persistence" do
+    before do
+      @robot = robot
+      @robot.state = "green"
+      @robot.name = "Bottie"
+      @robot.save
+    end
+    
+    it "should call the load_from_persistence method" do
+     @robot.reload
+     @robot.should_receive(:load_from_persistence)
+
+     @robot.current_state
+    end
+  end
+end
+

data/stateflow.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stateflow}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Oberholzer"]
-  s.date = %q{2010-12-09}
+  s.date = %q{2011-02-13}
   s.description = %q{State machine that allows dynamic transitions for business workflows}
   s.email = %q{ryan@platform45.com}
   s.extra_rdoc_files = ["CHANGELOG.rdoc", "README.rdoc", "lib/stateflow.rb", "lib/stateflow/event.rb", "lib/stateflow/exception.rb", "lib/stateflow/machine.rb", "lib/stateflow/persistence.rb", "lib/stateflow/persistence/active_record.rb", "lib/stateflow/persistence/mongo_mapper.rb", "lib/stateflow/persistence/mongoid.rb", "lib/stateflow/persistence/none.rb", "lib/stateflow/state.rb", "lib/stateflow/transition.rb"]
-  s.files = ["CHANGELOG.rdoc", "LICENCE", "Manifest", "README.rdoc", "Rakefile", "examples/robot.rb", "examples/test.rb", "init.rb", "lib/stateflow.rb", "lib/stateflow/event.rb", "lib/stateflow/exception.rb", "lib/stateflow/machine.rb", "lib/stateflow/persistence.rb", "lib/stateflow/persistence/active_record.rb", "lib/stateflow/persistence/mongo_mapper.rb", "lib/stateflow/persistence/mongoid.rb", "lib/stateflow/persistence/none.rb", "lib/stateflow/state.rb", "lib/stateflow/transition.rb", "spec/spec_helper.rb", "spec/stateflow_spec.rb", "stateflow.gemspec"]
+  s.files = ["CHANGELOG.rdoc", "Gemfile", "Gemfile.lock", "LICENCE", "Manifest", "README.rdoc", "Rakefile", "examples/robot.rb", "examples/test.rb", "init.rb", "lib/stateflow.rb", "lib/stateflow/event.rb", "lib/stateflow/exception.rb", "lib/stateflow/machine.rb", "lib/stateflow/persistence.rb", "lib/stateflow/persistence/active_record.rb", "lib/stateflow/persistence/mongo_mapper.rb", "lib/stateflow/persistence/mongoid.rb", "lib/stateflow/persistence/none.rb", "lib/stateflow/state.rb", "lib/stateflow/transition.rb", "spec/orm/activerecord_spec.rb", "spec/orm/mongoid_spec.rb", "spec/spec_helper.rb", "spec/stateflow_spec.rb", "stateflow.gemspec"]
   s.homepage = %q{http://github.com/ryanza/stateflow}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Stateflow", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
@@ -23,18 +23,18 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0"])
       s.add_development_dependency(%q<activerecord>, [">= 0"])
       s.add_development_dependency(%q<mongoid>, [">= 2.0.0.beta.20"])
       s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
     else
-      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0"])
       s.add_dependency(%q<activerecord>, [">= 0"])
       s.add_dependency(%q<mongoid>, [">= 2.0.0.beta.20"])
       s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0"])
     s.add_dependency(%q<activerecord>, [">= 0"])
     s.add_dependency(%q<mongoid>, [">= 2.0.0.beta.20"])
     s.add_dependency(%q<sqlite3-ruby>, [">= 0"])

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: stateflow
 version: !ruby/object:Gem::Version 
-  hash: 15
   prerelease: false
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Ryan Oberholzer
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-09 00:00:00 +02:00
+date: 2011-02-13 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,10 +25,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
+        - 2
         - 0
-        version: "0"
+        - 0
+        version: 2.0.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -40,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -54,7 +53,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 62196427
         segments: 
         - 2
         - 0
@@ -72,7 +70,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -100,6 +97,8 @@ extra_rdoc_files:
 - lib/stateflow/transition.rb
 files: 
 - CHANGELOG.rdoc
+- Gemfile
+- Gemfile.lock
 - LICENCE
 - Manifest
 - README.rdoc
@@ -118,6 +117,8 @@ files:
 - lib/stateflow/persistence/none.rb
 - lib/stateflow/state.rb
 - lib/stateflow/transition.rb
+- spec/orm/activerecord_spec.rb
+- spec/orm/mongoid_spec.rb
 - spec/spec_helper.rb
 - spec/stateflow_spec.rb
 - stateflow.gemspec
@@ -140,7 +141,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -149,7 +149,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 11
       segments: 
       - 1
       - 2