simple_state_machine 0.0.0 → 0.1.0

data/README.rdoc

@@ -22,10 +22,10 @@ state transitions.
 
 
 This has a couple of advantages:
+- Encapsulate state transitions (no need for :guards),
 - Arguments can be passed to 'events',
 - 'events' can return a value, remember, it's just a method,
 - Validation errors can be set on the model if you are using ActiveRecord / ActiveModel,
-- Encapsulate state transitions (no need for :guards).
 
 To use the code, you need to do 3 things:
 - extend SimpleStateMachine,
@@ -34,7 +34,7 @@ To use the code, you need to do 3 things:
 
 ==== Example usage
 
-  class Lamp
+  class LampWithHotelSwitch
 
     extend SimpleStateMachine
 
@@ -42,17 +42,17 @@ To use the code, you need to do 3 things:
       self.state = :off
     end
 
-    def push_button1
-      puts "click1: #{state}"
+    def push_switch_1
+      puts 'pushed switch 1 #{state}'
     end
-    event :push_button1, :off => :on,
-                         :on  => :off
+    event :push_switch_1, :off => :on,
+                          :on  => :off
 
-    def push_button2
-      puts "click1: #{state}"
+    def push_switch_2
+      puts 'pushed switch 2 #{state}'
     end
-    event :push_button2, :off => :on,
-                         :on  => :off
+    event :push_switch_2, :off => :on,
+                          :on  => :off
 
   end
 

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/examples/user.rb

@@ -3,7 +3,7 @@ class User < ActiveRecord::Base
   
   validates_presence_of :name
   
-  extend SimpleStateMachine
+  extend SimpleStateMachine::ActiveRecord
 
   def after_initialize
     self.state ||= 'new'
@@ -16,8 +16,8 @@ class User < ActiveRecord::Base
   event :invite, :new => :invited
 
   def confirm_invitation activation_code
-    if activation_code != self.activation_code
-      errors.add(:activation_code, 'Invalid')
+    if self.activation_code != activation_code
+      errors.add 'activation_code', 'is invalid'
     end
   end
   event :confirm_invitation, :invited => :active
@@ -34,4 +34,4 @@ class User < ActiveRecord::Base
     true
   end
 
-end
+end

data/lib/simple_state_machine/active_record.rb

@@ -0,0 +1,51 @@
+module SimpleStateMachine::ActiveRecord
+
+  include SimpleStateMachine::EventMixin
+  
+  def state_machine_decorator subject
+    Decorator.new subject
+  end
+
+  class Decorator < SimpleStateMachine::Decorator
+
+    def decorate event_name, from, to
+      super event_name, from, to
+      unless @subject.method_defined?("#{event_name}_and_save")
+        @subject.send(:define_method, "#{event_name}_and_save") do |*args|
+          old_state = state
+          send "#{event_name}", *args
+          if save
+            return true
+          else
+            self.state = old_state
+            return false
+          end
+        end
+      end
+      unless @subject.method_defined?("#{event_name}_and_save!")
+        @subject.send(:define_method, "#{event_name}_and_save!") do |*args|
+          old_state = state
+          send "#{event_name}", *args
+          if !self.errors.entries.empty?
+            self.state = old_state
+            raise ActiveRecord::RecordInvalid.new(self)
+          end
+          begin
+            save!
+          rescue ActiveRecord::RecordInvalid
+            self.state = old_state
+            raise
+          end
+        end
+      end
+    end
+  
+    private
+
+    def define_state_setter_method; end
+
+    def define_state_getter_method; end
+
+  end
+
+end

data/lib/simple_state_machine/simple_state_machine.rb

@@ -1,209 +1,149 @@
 module SimpleStateMachine
   
-  def event event_name, state_transitions
-    @state_machine_definition ||= StateMachineDefinition.new self
-    @state_machine_definition.define_event event_name, state_transitions
-  end
-  
-  def state_machine_definition
-    @state_machine_definition
-  end
-  
-  class StateMachineDefinition
-    
-    attr_reader :events
+  module EventMixin
 
-    def initialize subject
-      @events = {}
-      @decorator = if inherits_from_active_record_base?(subject)
-        Decorator::ActiveRecord.new(subject)
-      else
-        Decorator::Base.new(subject)
-      end
-    end
-    
-    def define_event event_name, state_transitions
-      @events[event_name.to_s] ||= {}
+    def event event_name, state_transitions
       state_transitions.each do |from, to|
-        @events[event_name.to_s][from.to_s] = to.to_s
-        @decorator.decorate(event_name, from, to)
+        state_machine_definition.add_transition(event_name, from, to)
+        state_machine_decorator(self).decorate( event_name, from, to)
       end
     end
 
-    def inherits_from_active_record_base?(subject)
-      subject.ancestors.map {|klass| klass.to_s}.include?("ActiveRecord::Base")
+    def state_machine_definition
+      @state_machine_definition ||= StateMachineDefinition.new
+    end
+    
+    def state_machine_decorator subject
+      Decorator.new subject
     end
 
   end
+
+  include EventMixin
   
-  module StateMachine
-    
-    class Base
-      def initialize(subject)
-        @subject = subject
-      end
-    
-      def next_state(event_name)
-        @subject.class.state_machine_definition.events[event_name.to_s][@subject.state]
-      end
-    
-      def transition(event_name)
-        if to = next_state(event_name)
-          result = yield
-          @subject.state = to
-          return result
-        else
-          illegal_event_callback event_name
-        end
-      end
-    
-      private
+  class StateMachineDefinition
 
-        def illegal_event_callback event_name
-          # override with your own implementation, like setting errors in your model
-          raise "You cannot '#{event_name}' when state is '#{@subject.state}'"
-        end
+    def transitions
+      @transitions ||= {}
+    end
     
+    def add_transition event_name, from, to
+      transitions[event_name.to_s] ||= {}
+      transitions[event_name.to_s][from.to_s] = to.to_s
     end
 
-    class ActiveRecord < Base
-      
-      def next_state(event_name)
-        if event_name =~ /\!$/
-          event_name = event_name.chop
-        end
-        super event_name
-      end
+  end
+  
+  class StateMachine
 
-      def transition(event_name)
-        if to = next_state(event_name)
-          if with_error_counting { yield } > 0 || @subject.invalid?
-            if event_name =~ /\!$/
-              raise ::ActiveRecord::RecordInvalid.new(@subject)
-            else
-              return false
-            end
-          else
+    def initialize(subject)
+      @subject = subject
+    end
+  
+    def next_state(event_name)
+      transitions[event_name.to_s][@subject.state]
+    end
+  
+    def transition(event_name)
+      if to = next_state(event_name)
+        result = yield
+        # TODO refactor out to AR module
+        if defined?(::ActiveRecord) && @subject.is_a?(::ActiveRecord::Base)
+          if @subject.errors.entries.empty?
             @subject.state = to
-            if event_name =~ /\!$/
-              @subject.save! #TODO maybe save_without_validation!
-            else
-              @subject.save
-            end
+            return true
+          else
+            return false
           end
         else
-          illegal_event_callback event_name
+          @subject.state = to
+          return result
         end
+      else
+        illegal_event_callback event_name
       end
-
-      private
-
-        def with_error_counting
-          original_errors_size =  @subject.errors.size
-          yield
-          @subject.errors.size - original_errors_size
-        end
-
     end
+  
+    private
+    
+      def transitions
+        @subject.class.state_machine_definition.transitions
+      end
 
+      def illegal_event_callback event_name
+        # override with your own implementation, like setting errors in your model
+        raise "You cannot '#{event_name}' when state is '#{@subject.state}'"
+      end
+  
   end
 
-  module Decorator
-    class Base
+  class Decorator
 
-      def initialize(subject)
-        @subject = subject
-        define_state_machine_method
-        define_state_getter_method
-        define_state_setter_method
-      end
-
-      def decorate event_name, from, to
-        define_state_helper_method(from)
-        define_state_helper_method(to)
-        define_event_method(event_name)
-        decorate_event_method(event_name)
-      end
+    def initialize(subject)
+      @subject = subject
+      define_state_machine_method
+      define_state_getter_method
+      define_state_setter_method
+    end
 
-      private
+    def decorate event_name, from, to
+      define_state_helper_method(from)
+      define_state_helper_method(to)
+      define_event_method(event_name)
+      decorate_event_method(event_name)
+    end
 
-        def define_state_machine_method
-          @subject.send(:define_method, "state_machine") do
-            @state_machine ||= StateMachine::Base.new(self)
-          end
-        end
+    private
 
-        def define_state_helper_method state
-          unless @subject.method_defined?("#{state.to_s}?")
-            @subject.send(:define_method, "#{state.to_s}?") do
-              self.state == state.to_s
-            end
-          end
+      def define_state_machine_method
+        @subject.send(:define_method, "state_machine") do
+          @state_machine ||= StateMachine.new(self)
         end
+      end
 
-        def define_event_method event_name
-          unless @subject.method_defined?("#{event_name}")
-            @subject.send(:define_method, "#{event_name}") {}
+      def define_state_helper_method state
+        unless @subject.method_defined?("#{state.to_s}?")
+          @subject.send(:define_method, "#{state.to_s}?") do
+            self.state == state.to_s
           end
         end
+      end
 
-        def decorate_event_method event_name
-          # TODO put in transaction for activeRecord?
-          unless @subject.method_defined?("with_managed_state_#{event_name}")
-            @subject.send(:define_method, "with_managed_state_#{event_name}") do |*args|
-              return state_machine.transition(event_name) do
-                send("without_managed_state_#{event_name}", *args)
-              end
-            end
-            @subject.send :alias_method, "without_managed_state_#{event_name}", event_name
-            @subject.send :alias_method, event_name, "with_managed_state_#{event_name}"
-          end
+      def define_event_method event_name
+        unless @subject.method_defined?("#{event_name}")
+          @subject.send(:define_method, "#{event_name}") {}
         end
+      end
 
-        def define_state_setter_method
-          unless @subject.method_defined?('state=')
-            @subject.send(:define_method, 'state=') do |new_state|
-              @state = new_state.to_s
+      def decorate_event_method event_name
+        # TODO put in transaction for activeRecord?
+        unless @subject.method_defined?("with_managed_state_#{event_name}")
+          @subject.send(:define_method, "with_managed_state_#{event_name}") do |*args|
+            return state_machine.transition(event_name) do
+              send("without_managed_state_#{event_name}", *args)
             end
           end
+          @subject.send :alias_method, "without_managed_state_#{event_name}", event_name
+          @subject.send :alias_method, event_name, "with_managed_state_#{event_name}"
         end
+      end
 
-        def define_state_getter_method
-          unless @subject.method_defined?('state')
-            @subject.send(:define_method, 'state') do
-              @state
-            end
+      def define_state_setter_method
+        unless @subject.method_defined?('state=')
+          @subject.send(:define_method, 'state=') do |new_state|
+            @state = new_state.to_s
           end
         end
+      end
 
-    end
-    
-    class ActiveRecord < Base
-
-      def decorate event_name, from, to
-        super event_name, from, to
-        unless @subject.method_defined?("#{event_name}!")
-          @subject.send(:define_method, "#{event_name}!") do |*args|
-            send "#{event_name}", *args
+      def define_state_getter_method
+        unless @subject.method_defined?('state')
+          @subject.send(:define_method, 'state') do
+            @state
           end
         end
-        decorate_event_method("#{event_name}!")
-      end
-      
-      private
-      
-      def define_state_machine_method
-        @subject.send(:define_method, "state_machine") do
-          @state_machine ||= StateMachine::ActiveRecord.new(self)
-        end
       end
 
-      def define_state_setter_method; end
-
-      def define_state_getter_method; end
-
-    end
-    
   end
 
-end
+end

data/lib/simple_state_machine.rb

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

data/simple_state_machine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simple_state_machine}
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   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-06-28}
+  s.date = %q{2010-08-12}
   s.description = %q{A simple DSL to decorate existing methods with logic that guards state transitions.}
   s.email = ["FIX@example.com"]
   s.extra_rdoc_files = [
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
      "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",

data/spec/active_record_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 require 'rubygems'
-gem 'activerecord', '>= 1.15.4.7794'
+gem 'activerecord', '~> 2.3.5'
 require 'active_record'
 require 'examples/user'
 
@@ -40,44 +40,46 @@ describe User do
     User.new.should be_new
   end
   
+  # TODO needs nesting/grouping, seems to have some duplication
+ 
   describe "events" do
     it "persists transitions" do
       user = User.create!(:name => 'name')
-      user.invite.should == true
+      user.invite_and_save.should == true
       User.find(user.id).should be_invited
       User.find(user.id).activation_code.should_not be_nil
     end
 
     it "persists transitions with !" do
       user = User.create!(:name => 'name')
-      user.invite!.should == true
+      user.invite_and_save!.should == true
       User.find(user.id).should be_invited
       User.find(user.id).activation_code.should_not be_nil
     end
 
     it "raises an error if an invalid state_transition is called" do
       user = User.create!(:name => 'name')
-      l = lambda { user.confirm_invitation 'abc' }
+      l = lambda { user.confirm_invitation_and_save 'abc' }
       l.should raise_error(RuntimeError, "You cannot 'confirm_invitation' when state is 'new'")
     end
 
     it "returns false if event called and record is invalid" do
       user = User.new
       user.should_not be_valid
-      user.invite.should == false
+      user.invite_and_save.should == false
     end
 
     it "keeps state if event called and record is invalid" do
       user = User.new
       user.should_not be_valid
-      user.invite.should == false
+      user.invite_and_save.should == false
       user.should be_new
     end
 
     it "raises a RecordInvalid event if called with ! and record is invalid" do
       user = User.new
       user.should_not be_valid
-      l = lambda { user.invite! }
+      l = lambda { user.invite_and_save! }
       l.should raise_error(ActiveRecord::RecordInvalid, "Validation failed: Name can't be blank")
     end
 
@@ -85,44 +87,43 @@ describe User do
       user = User.new
       user.should_not be_valid
       begin
-        user.invite!
+        user.invite_and_save!
       rescue ActiveRecord::RecordInvalid;end
       user.should be_new
     end
 
-    it "returns falls if record is valid but event adds errors" do
+    it "will inspect errors after event and reset state" do
       user = User.create!(:name => 'name')
-      user.invite!
-      user.should be_valid
-      r = user.confirm_invitation('x').should == false      
+      user.invite_and_save!
+      user.should be_invited
+      user.confirm_invitation('x')
+      user.errors.entries.should == [['activation_code', 'is invalid']]
+      user.should be_invited
     end
 
-    it "keeps state if record is valid but event adds errors" do
+    it "returns false if event adds errors" do
       user = User.create!(:name => 'name')
-      user.invite!
-      user.should be_valid
-      user.confirm_invitation('x')
-      user.should be_invited
+      user.invite_and_save!
+      user.confirm_invitation('x').should == false
     end
 
-    it "raises a RecordInvalid if record is valid but event adds errors" do
+    it "raises a RecordInvalid if 'event'_and_save! is called and event adds errors" do
       user = User.create!(:name => 'name')
-      user.invite!
-      user.should be_valid
-      l = lambda { user.confirm_invitation!('x') }
-      l.should raise_error(ActiveRecord::RecordInvalid, "Validation failed: Activation code Invalid")
+      user.invite_and_save!
+      l = lambda { user.confirm_invitation_and_save!('x') }
+      l.should raise_error(ActiveRecord::RecordInvalid, "Validation failed: Activation code is invalid")
     end
 
     it "keeps state if record is valid but event adds errors" do
       user = User.create!(:name => 'name')
-      user.invite!
-      user.should be_valid
+      user.invite_and_save!
+      user.should be_invited
       begin
-        user.confirm_invitation!('x')
+        user.confirm_invitation_and_save!('x')
       rescue ActiveRecord::RecordInvalid;end
       user.should be_invited
     end
 
   end
 
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simple_state_machine
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 0
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Marek de Heus
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-28 00:00:00 +02:00
+date: 2010-08-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,6 +56,7 @@ files:
 - 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