simple_state_machine 0.4.3 → 0.5.0.beta

data/.rspec

@@ -0,0 +1,3 @@
+--color
+#--debugger
+--backtrace

data/Gemfile

@@ -0,0 +1,4 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    simple_state_machine (1.5.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.4.2)
+    activerecord (2.3.10)
+      activesupport (= 2.3.10)
+    activesupport (2.3.10)
+    diff-lcs (1.1.2)
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    sqlite3-ruby (1.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest
+  activerecord (~> 2.3.5)
+  rake
+  rspec
+  simple_state_machine!
+  sqlite3-ruby

data/Rakefile

@@ -1,38 +1,21 @@
-require 'rubygems'
-require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "simple_state_machine"
-    gem.summary = %Q{A statemachine that focuses on events instead of states}
-    gem.description = %Q{A simple DSL to decorate existing methods with logic that guards state transitions.}
-    gem.email = ["FIX@example.com"]
-    gem.homepage = "http://github.com/mdh/ssm"
-    gem.authors = ["Marek de Heus", "Petrik de Heus"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :spec => :check_dependencies
-
-task :default => :spec
+#require 'spec/rake/spectask'
+#Spec::Rake::SpecTask.new(:spec) do |spec|
+#  spec.libs << 'lib' << 'spec'
+#  spec.spec_files = FileList['spec/**/*_spec.rb']
+#end
+#
+#Spec::Rake::SpecTask.new(:rcov) do |spec|
+#  spec.libs << 'lib' << 'spec'
+#  spec.pattern = 'spec/**/*_spec.rb'
+#  spec.rcov = true
+#end
+#
+#task :spec => :check_dependencies
+#
+#task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/lib/simple_state_machine/active_record.rb

@@ -1,10 +1,8 @@
 module SimpleStateMachine::ActiveRecord
 
-  include SimpleStateMachine::StateMachineMixin
-  
-  def state_machine_decorator subject
-    Decorator.new subject
-  end
+  include SimpleStateMachine::Mountable
+  include SimpleStateMachine::Extendable
+  include SimpleStateMachine::Inheritable
 
   class Decorator < SimpleStateMachine::Decorator
 
@@ -60,5 +58,12 @@ module SimpleStateMachine::ActiveRecord
     def define_state_getter_method; end
 
   end
-
+  
+  def state_machine_definition
+    unless @state_machine_definition
+      @state_machine_definition = SimpleStateMachine::StateMachineDefinition.new
+      @state_machine_definition.lazy_decorator = lambda { Decorator.new(self) }
+    end
+    @state_machine_definition
+  end
 end

data/lib/simple_state_machine/simple_state_machine.rb

@@ -1,50 +1,68 @@
 module SimpleStateMachine
+
+  require 'cgi'
   
-  class Error < ::RuntimeError
+  class IllegalStateTransitionError < ::RuntimeError
   end
 
+  ##
+  # Allows class to mount a state_machine
+  module Mountable
+    def state_machine_definition
+      unless @state_machine_definition
+        @state_machine_definition = StateMachineDefinition.new
+        @state_machine_definition.lazy_decorator = lambda { Decorator.new(self) }
+      end
+      @state_machine_definition
+    end
+
+    def state_machine_definition= state_machine_definition
+      @state_machine_definition = state_machine_definition
+      state_machine_definition.transitions.each do |transition|
+        state_machine_definition.decorator.decorate(transition)
+      end
+    end
+  end
+  include Mountable
+
   ##
   # Adds state machine methods to the extended class 
-  module StateMachineMixin
+  module Extendable
 
     # mark the method as an event and specify how the state should transition 
     def event event_name, state_transitions
       state_transitions.each do |froms, to|
         [froms].flatten.each do |from|
-          transition = state_machine_definition.add_transition(event_name, from, to)
-          state_machine_decorator(self).decorate(transition)
+          state_machine_definition.add_transition(event_name, from, to)
         end
       end
     end
 
-    def state_machine_definition
-      @state_machine_definition ||= StateMachineDefinition.new
-    end
-
-    def state_machine_definition= state_machine_definition
-      @state_machine_definition = state_machine_definition
-      state_machine_definition.transitions.each do |transition|
-        state_machine_decorator(self).decorate(transition)
-      end
-    end
-    
-    def state_machine_decorator subject
-      Decorator.new subject
-    end
+  end
+  include Extendable
 
+  ##
+  # Allows subclasses to inherit state machines
+  module Inheritable
     def inherited(subclass)
       subclass.state_machine_definition = state_machine_definition.clone
+      decorator = state_machine_definition.decorator
+      decorator.subject = subclass
+      subclass.state_machine_definition.decorator = decorator
       super
     end
   end
-
-  include StateMachineMixin
+  include Inheritable
   
   ##
   # Defines state machine transitions
   class StateMachineDefinition
 
-    attr_writer :state_method
+    attr_writer :state_method, :decorator, :lazy_decorator
+
+    def decorator
+      @decorator ||= @lazy_decorator.call
+    end
 
     def transitions
       @transitions ||= []
@@ -53,12 +71,28 @@ module SimpleStateMachine
     def add_transition event_name, from, to
       transition = Transition.new(event_name, from, to)
       transitions << transition
-      transition
+      decorator.decorate(transition)
     end
      
     def state_method
       @state_method ||= :state
     end      
+
+    # Human readable format: old_state.event! => new_state 
+    def to_s
+      transitions.map(&:to_s).join("\n")
+    end
+
+    # Graphiz dot format for rendering as a directional graph
+    def to_graphiz_dot
+      transitions.map { |t| t.to_graphiz_dot }.join(";")
+    end
+
+    # Generates a url that renders states and events as a directional graph.
+    # See http://code.google.com/apis/chart/docs/gallery/graphviz.html
+    def google_chart_url
+      "http://chart.googleapis.com/chart?cht=gv&chl=digraph{#{::CGI.escape to_graphiz_dot}}"
+    end
   end
   
   ##
@@ -128,7 +162,7 @@ module SimpleStateMachine
 
       # override with your own implementation, like setting errors in your model
       def illegal_event_callback event_name
-        raise Error.new("You cannot '#{event_name}' when state is '#{@subject.send(state_method)}'")
+        raise IllegalStateTransitionError.new("You cannot '#{event_name}' when state is '#{@subject.send(state_method)}'")
       end
   
   end
@@ -153,6 +187,15 @@ module SimpleStateMachine
       is_same_event?(event_name) && error.class == from
     end
 
+    def to_s
+      "#{from}.#{event_name}! => #{to}"
+    end
+
+    def to_graphiz_dot
+      %("#{from}"->"#{to}"[label=#{event_name}])
+    end
+      
+
     private
 
       def is_same_event?(event_name)
@@ -168,6 +211,7 @@ module SimpleStateMachine
   # Decorates @subject with methods to access the state machine
   class Decorator
 
+    attr_writer :subject
     def initialize(subject)
       @subject = subject
       define_state_machine_method
@@ -191,7 +235,7 @@ module SimpleStateMachine
       end
 
       def define_state_helper_method state
-        unless @subject.method_defined?("#{state.to_s}?")
+        unless any_method_defined?("#{state.to_s}?")
           @subject.send(:define_method, "#{state.to_s}?") do
             self.send(self.class.state_machine_definition.state_method) == state.to_s
           end
@@ -199,7 +243,7 @@ module SimpleStateMachine
       end
 
       def define_event_method event_name
-        unless @subject.method_defined?("#{event_name}")
+        unless any_method_defined?("#{event_name}")
           @subject.send(:define_method, "#{event_name}") {}
         end
       end
@@ -218,7 +262,7 @@ module SimpleStateMachine
       end
 
       def define_state_setter_method
-        unless @subject.method_defined?("#{state_method}=")
+        unless any_method_defined?("#{state_method}=")
           @subject.send(:define_method, "#{state_method}=") do |new_state|
             instance_variable_set(:"@#{self.class.state_machine_definition.state_method}", new_state)
           end
@@ -226,10 +270,16 @@ module SimpleStateMachine
       end
 
       def define_state_getter_method
-        unless @subject.method_defined?(state_method)
+        unless any_method_defined?(state_method)
           @subject.send(:attr_reader, state_method)
         end
       end
+      
+      def any_method_defined?(method)
+        @subject.method_defined?(method) ||
+        @subject.protected_method_defined?(method) ||
+        @subject.private_method_defined?(method)
+      end
 
     protected
 

data/lib/simple_state_machine/version.rb

@@ -0,0 +1,3 @@
+module SimpleStateMachine
+  VERSION = "0.5.0.beta"
+end

data/lib/simple_state_machine.rb

@@ -1,2 +1,2 @@
 require 'simple_state_machine/simple_state_machine'
-require 'simple_state_machine/active_record'
+require 'simple_state_machine/active_record'

data/simple_state_machine.gemspec

@@ -1,72 +1,31 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)  
+require "simple_state_machine/version"   
 
 Gem::Specification.new do |s|
   s.name = %q{simple_state_machine}
-  s.version = "0.4.3"
+  s.version     = SimpleStateMachine::VERSION
+  s.platform    = Gem::Platform::RUBY
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marek de Heus", "Petrik de Heus"]
-  s.date = %q{2010-09-14}
   s.description = %q{A simple DSL to decorate existing methods with logic that guards state transitions.}
   s.email = ["FIX@example.com"]
+  s.homepage = %q{http://github.com/mdh/ssm}
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
   ]
-  s.files = [
-    ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "examples/conversation.rb",
-     "examples/lamp.rb",
-     "examples/relationship.rb",
-     "examples/traffic_light.rb",
-     "examples/user.rb",
-     "lib/simple_state_machine.rb",
-     "lib/simple_state_machine/active_record.rb",
-     "lib/simple_state_machine/simple_state_machine.rb",
-     "simple_state_machine.gemspec",
-     "spec/active_record_spec.rb",
-     "spec/decorator_spec.rb",
-     "spec/examples_spec.rb",
-     "spec/simple_state_machine_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/mdh/ssm}
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{A statemachine that focuses on events instead of states}
-  s.test_files = [
-    "spec/active_record_spec.rb",
-     "spec/decorator_spec.rb",
-     "spec/examples_spec.rb",
-     "spec/simple_state_machine_spec.rb",
-     "spec/spec_helper.rb",
-     "examples/conversation.rb",
-     "examples/lamp.rb",
-     "examples/relationship.rb",
-     "examples/traffic_light.rb",
-     "examples/user.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_development_dependency(%q<rspec>, [">= 1.2.9"])
-    else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
-  end
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.add_development_dependency "rake"
+  s.add_development_dependency "ZenTest"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "activerecord", "~>2.3.5"
+  s.add_development_dependency "sqlite3-ruby"
 end
 

data/spec/active_record_spec.rb

@@ -1,28 +1,29 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-require 'rubygems'
-gem 'activerecord', '~> 2.3.5'
+require "rubygems"
+require "bundler"
+Bundler.require
+#Bundler.setup(:test)#, :activerecord)
 require 'active_record'
 require 'examples/user'
 
-ActiveRecord::Base.logger = Logger.new STDOUT
-ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+ActiveRecord::Base.logger = Logger.new "test.log"
+ActiveRecord::Base.establish_connection(:adapter  => "sqlite3",
+                                        :database => ":memory:")
 
 def setup_db
   ActiveRecord::Schema.define(:version => 1) do    
     create_table :users do |t|
-      t.column :id, :integer
-      t.column :name, :string
-      t.column :state, :string
-      t.column :activation_code, :string
-      t.column :created_at, :datetime
-      t.column :updated_at, :datetime
+      t.column :id,               :integer
+      t.column :name,             :string
+      t.column :state,            :string
+      t.column :activation_code,  :string
+      t.column :created_at,       :datetime
+      t.column :updated_at,       :datetime
     end
-  end
-  ActiveRecord::Schema.define(:version => 1) do    
     create_table :tickets do |t|
-      t.column :id, :integer
-      t.column :ssm_state, :string
+      t.column :id,         :integer
+      t.column :ssm_state,  :string
     end
   end
 end
@@ -87,8 +88,10 @@ describe ActiveRecord do
 
     it "raises an error if an invalid state_transition is called" do
       user = User.create!(:name => 'name')
-      l = lambda { user.confirm_invitation_and_save 'abc' }
-      l.should raise_error(SimpleStateMachine::Error, "You cannot 'confirm_invitation' when state is 'new'")
+      expect { 
+        user.confirm_invitation_and_save 'abc' 
+      }.to raise_error(SimpleStateMachine::IllegalStateTransitionError, 
+                       "You cannot 'confirm_invitation' when state is 'new'")
     end
 
     it "returns false and keeps state if record is invalid" do
@@ -130,16 +133,20 @@ describe ActiveRecord do
 
     it "raises an error if an invalid state_transition is called" do
       user = User.create!(:name => 'name')
-      l = lambda { user.confirm_invitation_and_save! 'abc' }
-      l.should raise_error(SimpleStateMachine::Error, "You cannot 'confirm_invitation' when state is 'new'")
+      expect { 
+        user.confirm_invitation_and_save! 'abc' 
+      }.to raise_error(SimpleStateMachine::IllegalStateTransitionError, 
+                       "You cannot 'confirm_invitation' when state is 'new'")
     end
 
     it "raises a RecordInvalid and keeps state if record is invalid" do
       user = User.new
       user.should be_new
       user.should_not be_valid
-      l = lambda { user.invite_and_save! }
-      l.should raise_error(ActiveRecord::RecordInvalid, "Validation failed: Name can't be blank")
+      expect { 
+        user.invite_and_save! 
+      }.to raise_error(ActiveRecord::RecordInvalid, 
+                       "Validation failed: Name can't be blank")
       user.should be_new
     end
 
@@ -147,13 +154,34 @@ describe ActiveRecord do
       user = User.create!(:name => 'name')
       user.invite_and_save!
       user.should be_invited
-      l = lambda { user.confirm_invitation_and_save!('x') }
-      l.should raise_error(ActiveRecord::RecordInvalid, "Validation failed: Activation code is invalid")
+      expect { 
+        user.confirm_invitation_and_save!('x') 
+      }.to raise_error(ActiveRecord::RecordInvalid, 
+                       "Validation failed: Activation code is invalid")
       user.should be_invited
     end
 
   end
 
+  describe "event" do
+
+    it "does not persist transitions" do
+      user = User.create!(:name => 'name')
+      user.invite.should == true
+      User.find(user.id).should_not be_invited
+      User.find(user.id).activation_code.should be_nil
+    end
+
+    it "returns false and keeps state if record is invalid" do    
+      user = User.new
+      user.should be_new
+      user.should_not be_valid
+      user.invite.should == false
+      user.should be_new
+    end
+
+  end
+
   describe "event!" do
 
     it "persists transitions" do
@@ -167,8 +195,7 @@ describe ActiveRecord do
       user = User.new
       user.should be_new
       user.should_not be_valid
-      l = lambda { user.invite! }
-      l.should raise_error(ActiveRecord::RecordInvalid, "Validation failed: Name can't be blank")
+      expect { user.invite! }.to raise_error(ActiveRecord::RecordInvalid, "Validation failed: Name can't be blank")
       user.should be_new
     end
 
@@ -191,4 +218,6 @@ describe ActiveRecord do
     end
 
   end
+
 end
+