stateflow 0.4.2 → 0.5.0.beta

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    stateflow (0.4.1)
+    stateflow (0.4.2)
+      activesupport
 
 GEM
   remote: http://rubygems.org/

data/Manifest

@@ -5,6 +5,7 @@ LICENCE
 Manifest
 README.rdoc
 Rakefile
+benchmark/compare_state_machines.rb
 examples/robot.rb
 examples/test.rb
 init.rb
@@ -17,10 +18,10 @@ lib/stateflow/persistence/active_record.rb
 lib/stateflow/persistence/mongo_mapper.rb
 lib/stateflow/persistence/mongoid.rb
 lib/stateflow/persistence/none.rb
+lib/stateflow/railtie.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,12 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('stateflow', '0.4.2') do |p|
+Echoe.new('stateflow', '0.5.0.beta') 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.dependencies = ["activesupport"]
   p.development_dependencies = ["rspec >=2.0.0", "activerecord", "mongoid >=2.0.0.beta.20", "sqlite3-ruby"]
 end

data/benchmark/compare_state_machines.rb

@@ -0,0 +1,88 @@
+require 'benchmark'
+require 'active_record'
+require 'stateflow'
+require 'aasm'
+
+# change this if sqlite is unavailable
+dbconfig = {
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+}
+
+ActiveRecord::Base.establish_connection(dbconfig)
+ActiveRecord::Migration.verbose = false
+
+
+class TestMigration < ActiveRecord::Migration
+  STATE_MACHINES = ['stateflow', 'aasm']
+
+  def self.up
+    STATE_MACHINES.each do |name|
+      create_table "#{name}_tests", :force => true do |t|
+        t.column :state, :string
+      end
+    end
+  end
+
+  def self.down
+    STATE_MACHINES.each do |name|
+      drop_table "#{name}_tests"
+    end
+  end
+end
+
+Stateflow.persistence = :active_record
+
+class StateflowTest < ActiveRecord::Base
+  include Stateflow
+
+  stateflow do
+    initial :green
+
+    state :green, :yellow, :red
+
+    event :change_color do
+      transitions :from => :green, :to => :yellow
+      transitions :from => :yellow, :to => :red
+      transitions :from => :red, :to => :green
+    end
+  end
+end
+
+class AasmTest < ActiveRecord::Base
+  include AASM
+
+  aasm_column :state # defaults to aasm_state
+
+  aasm_initial_state :green
+
+  aasm_state :green
+  aasm_state :yellow
+  aasm_state :red
+
+  aasm_event :change_color do
+    transitions :from => :green, :to => :yellow
+    transitions :from => :yellow, :to => :red
+    transitions :from => :red, :to => :green
+  end
+end
+
+n = 1000
+TestMigration.up
+
+Benchmark.bm(7) do |x|
+  x.report('stateflow') do
+    n.times do
+      stateflow = StateflowTest.new
+      3.times { stateflow.change_color! }
+    end
+  end
+  x.report('aasm') do
+    n.times do
+      aasm = AasmTest.new
+      3.times { aasm.change_color! }
+    end
+  end
+end
+
+TestMigration.down

data/lib/stateflow.rb

@@ -1,12 +1,14 @@
+require 'active_support'
+
 module Stateflow
-  def self.included(base)
-    base.send :include, InstanceMethods
-    base.extend ClassMethods
-    Stateflow::Persistence.set(base)
+  extend ActiveSupport::Concern
+  
+  included do |base|
+    Stateflow::Persistence.load!(base)
   end
   
   def self.persistence
-    @@persistence ||= :active_record
+    @@persistence ||= nil
   end
   
   def self.persistence=(persistence)
@@ -69,3 +71,5 @@ module Stateflow
   autoload :Persistence, 'stateflow/persistence'
   autoload :Exception, 'stateflow/exception'
 end
+
+require 'stateflow/railtie' if defined?(Rails)

data/lib/stateflow/persistence.rb

@@ -1,21 +1,29 @@
 module Stateflow
   module Persistence
-    def self.set(base)
-      case Stateflow.persistence
-        when :mongo_mapper
-          Stateflow::Persistence::MongoMapper.install(base)
-        when :active_record
-          Stateflow::Persistence::ActiveRecord.install(base)
-        when :mongoid
-          Stateflow::Persistence::Mongoid.install(base)
-        when :none
-          Stateflow::Persistence::None.install(base)
+    def self.active
+      persistences = Array.new
+      
+      Dir[File.dirname(__FILE__) + '/persistence/*.rb'].each do |file|
+        persistences << File.basename(file, File.extname(file)).underscore.to_sym
       end
+      
+      persistences
     end
     
-    autoload :MongoMapper, 'stateflow/persistence/mongo_mapper'
-    autoload :ActiveRecord, 'stateflow/persistence/active_record'
-    autoload :Mongoid, 'stateflow/persistence/mongoid'
-    autoload :None, 'stateflow/persistence/none'
+    def self.load!(base)
+      begin
+        base.send :include, "Stateflow::Persistence::#{Stateflow.persistence.to_s.camelize}".constantize
+      rescue NameError
+        puts "[Stateflow] The ORM you are using does not have a Persistence layer. Defaulting to ActiveRecord."
+        puts "[Stateflow] You can overwrite the persistence with Stateflow.persistence = :new_persistence_layer"
+
+        Stateflow.persistence = :active_record 
+        base.send :include, "Stateflow::Persistence::ActiveRecord".constantize
+      end
+    end
+    
+    Stateflow::Persistence.active.each do |p|
+      autoload p.to_s.camelize.to_sym, "stateflow/persistence/#{p.to_s}"
+    end
   end
 end

data/lib/stateflow/persistence/active_record.rb

@@ -1,11 +1,10 @@
 module Stateflow
   module Persistence
     module ActiveRecord
-      def self.install(base)
-        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
+      extend ActiveSupport::Concern
+      
+      included do |base|
+        base.before_validation(:ensure_initial_state, :on => :create)
       end
       
       module InstanceMethods

data/lib/stateflow/persistence/mongo_mapper.rb

@@ -1,11 +1,10 @@
 module Stateflow
   module Persistence
     module MongoMapper
-      def self.install(base)
-        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
+      extend ActiveSupport::Concern
+      
+      included do |base|
+        base.before_validation(:ensure_initial_state, :on => :create)
       end
       
       module InstanceMethods

data/lib/stateflow/persistence/mongoid.rb

@@ -1,13 +1,12 @@
 module Stateflow
   module Persistence
     module Mongoid
-      def self.install(base)
-        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
+      extend ActiveSupport::Concern
+      
+      included do |base|
+        base.before_validation(:ensure_initial_state, :on => :create)
       end
-
+      
       module InstanceMethods
         def load_from_persistence
           send machine.state_column.to_sym

data/lib/stateflow/persistence/none.rb

@@ -1,10 +1,8 @@
 module Stateflow
   module Persistence
     module None
-      def self.install(base)
-        base.send :include, InstanceMethods
-      end
-      
+      extend ActiveSupport::Concern
+
       module InstanceMethods
         attr_accessor :state
         

data/lib/stateflow/railtie.rb

@@ -0,0 +1,12 @@
+module Stateflow
+  class Railtie < Rails::Railtie
+    def default_orm
+      generators = config.respond_to?(:app_generators) ? :app_generators : :generators
+      config.send(generators).options[:rails][:orm]
+    end
+    
+    initializer "stateflow.set_persistence" do
+      Stateflow.persistence = default_orm if Stateflow.persistence.blank?
+    end
+  end
+end

data/spec/stateflow_spec.rb

@@ -136,6 +136,10 @@ describe Stateflow do
     it "should respond to the machine attr accessor" do
       Robot.should respond_to(:machine)
     end
+    
+    it "should return all active persistence layers" do
+      Stateflow::Persistence.active.should == [:active_record, :mongo_mapper, :mongoid, :none]
+    end
   end
 
   describe "instance methods" do

data/stateflow.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stateflow}
-  s.version = "0.4.2"
+  s.version = "0.5.0.beta"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Oberholzer"]
-  s.date = %q{2011-04-07}
+  s.date = %q{2011-04-08}
   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", "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.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/railtie.rb", "lib/stateflow/state.rb", "lib/stateflow/transition.rb"]
+  s.files = ["CHANGELOG.rdoc", "Gemfile", "Gemfile.lock", "LICENCE", "Manifest", "README.rdoc", "Rakefile", "benchmark/compare_state_machines.rb", "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/railtie.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"]
@@ -22,17 +22,20 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 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<activesupport>, [">= 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<activesupport>, [">= 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"])

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: stateflow
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.4.2
+  prerelease: 6
+  version: 0.5.0.beta
 platform: ruby
 authors: 
 - Ryan Oberholzer
@@ -10,53 +10,64 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-07 00:00:00 +02:00
+date: 2011-04-08 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: activesupport
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: 2.0.0
   type: :development
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: activerecord
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: mongoid
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: 2.0.0.beta.20
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: sqlite3-ruby
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 description: State machine that allows dynamic transitions for business workflows
 email: ryan@platform45.com
 executables: []
@@ -75,6 +86,7 @@ extra_rdoc_files:
 - lib/stateflow/persistence/mongo_mapper.rb
 - lib/stateflow/persistence/mongoid.rb
 - lib/stateflow/persistence/none.rb
+- lib/stateflow/railtie.rb
 - lib/stateflow/state.rb
 - lib/stateflow/transition.rb
 files: 
@@ -85,6 +97,7 @@ files:
 - Manifest
 - README.rdoc
 - Rakefile
+- benchmark/compare_state_machines.rb
 - examples/robot.rb
 - examples/test.rb
 - init.rb
@@ -97,6 +110,7 @@ files:
 - lib/stateflow/persistence/mongo_mapper.rb
 - lib/stateflow/persistence/mongoid.rb
 - lib/stateflow/persistence/none.rb
+- lib/stateflow/railtie.rb
 - lib/stateflow/state.rb
 - lib/stateflow/transition.rb
 - spec/orm/activerecord_spec.rb