simple_state_machine 0.4.0 → 0.4.1

data/.gitignore

@@ -0,0 +1 @@
+*.swp

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/lib/simple_state_machine/simple_state_machine.rb

@@ -4,7 +4,7 @@ module SimpleStateMachine
   end
 
   ##
-  # Adds state machine methods to extended class 
+  # Adds state machine methods to the extended class 
   module StateMachineMixin
 
     # mark the method as an event and specify how the state should transition 
@@ -53,7 +53,7 @@ module SimpleStateMachine
       transitions << transition
       transition
     end
-    
+     
     def state_method
       @state_method ||= :state
     end      
@@ -126,11 +126,13 @@ 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.state}'")
+        raise Error.new("You cannot '#{event_name}' when state is '#{@subject.send(state_method)}'")
       end
   
   end
 
+  ##
+  # Defines transitions for events
   class Transition 
     attr_reader :event_name, :from, :to
     def initialize(event_name, from, to)
@@ -139,17 +141,19 @@ module SimpleStateMachine
       @to         = to.to_s
     end
 
+    # returns true if it's a transition for event_name
     def is_transition_for?(event_name)
       self.event_name == event_name.to_s
     end
 
+    # returns true if it's a error transition for event_name and error
     def is_error_transition_for?(event_name, error)
       is_transition_for?(event_name) && error.class == from
     end
   end
 
   ##
-  # Decorates the extended class with methods to access the state machine
+  # Decorates @subject with methods to access the state machine
   class Decorator
 
     def initialize(subject)

data/simple_state_machine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simple_state_machine}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   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-06}
+  s.date = %q{2010-09-10}
   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 = [
@@ -17,7 +17,8 @@ Gem::Specification.new do |s|
      "README.rdoc"
   ]
   s.files = [
-    "LICENSE",
+    ".gitignore",
+     "LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",

data/spec/simple_state_machine_spec.rb

@@ -14,6 +14,17 @@ class SimpleExample
   event :event2, :state2 => :state3
 end
 
+class SimpleExampleWithCustomStateMethod
+  extend SimpleStateMachine
+  state_machine_definition.state_method = :ssm_state
+
+  def initialize(state = 'state1')
+    @ssm_state = state
+  end
+  event :event1, :state1 => :state2
+  event :event2, :state2 => :state3
+end
+
 describe SimpleStateMachine do
  
   it "has an error that extends RuntimeError" do
@@ -76,6 +87,15 @@ describe SimpleStateMachine do
 
   end
 
+  describe 'custom state method' do
+    
+    it "raise an error if an invalid state_transition is called" do
+      example = SimpleExampleWithCustomStateMethod.new
+      lambda { example.event2 }.should raise_error(SimpleStateMachine::Error, "You cannot 'event2' when state is 'state1'")
+    end
+
+  end
+
   describe "state_machine_definition" do
     it "is inherited by subclasses" do
       example = Class.new(SimpleExample).new

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simple_state_machine
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Marek de Heus
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-06 00:00:00 +02:00
+date: 2010-09-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,6 +46,7 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
+- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile