simple_state_machine 0.3.3 → 0.3.4

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/examples/user.rb

@@ -11,9 +11,9 @@ class User < ActiveRecord::Base
 
   def invite
     self.activation_code = Digest::SHA1.hexdigest("salt #{Time.now.to_f}")
-    true
+    send_activation_email(self.activation_code)
   end
-  event :invite, :new => :invited, :on_success => :send_activation_email
+  event :invite, :new => :invited
 
   def confirm_invitation activation_code
     if self.activation_code != activation_code
@@ -22,7 +22,15 @@ class User < ActiveRecord::Base
   end
   event :confirm_invitation, :invited => :active
 
-  def send_activation_email    
+  #event :log_send_activation_code_failed, :new => :send_activation_code_failed
+  # 
+  # def reset_password(new_password)
+  #   self.password = new_password
+  # end
+  # # do not change state, but ensure that we are in proper state
+  # event :reset_password, :active => :active
+  
+  def send_activation_email(code)
     true
   end
 

data/lib/simple_state_machine/active_record.rb

@@ -8,6 +8,10 @@ module SimpleStateMachine::ActiveRecord
 
   class Decorator < SimpleStateMachine::Decorator
 
+    # decorates subject with:
+    # * {event_name}_and_save
+    # * {event_name}_and_save!
+    # * {event_name}!
     def decorate transition
       super transition
       event_name = transition.event_name.to_s

data/lib/simple_state_machine/simple_state_machine.rb

@@ -7,6 +7,7 @@ module SimpleStateMachine
   # Adds state machine methods to extended class 
   module StateMachineMixin
 
+    # mark the method as an event and specify how the state should transition 
     def event event_name, state_transitions
       state_transitions.each do |from, to|
         transition = state_machine_definition.add_transition(event_name, from, to)
@@ -59,18 +60,21 @@ module SimpleStateMachine
   end
   
   ##
-  # The state machine used by the instance
+  # Defines the state machine used by the instance
   class StateMachine
 
     def initialize(subject)
       @subject = subject
     end
-  
+
+    # returns the next state for the subject for event_name
     def next_state(event_name)
       transition = transitions.select{|t| t.event_name.to_s == event_name.to_s && @subject.send(state_method).to_s == t.from.to_s}.first
       transition ? transition.to : nil
     end
-  
+
+    # transitions to the next state if next_state exists
+    # calls illegal_event_callback event_name if no next_state is found
     def transition(event_name)
       if to = next_state(event_name)
         result = yield
@@ -105,8 +109,8 @@ module SimpleStateMachine
         state_machine_definition.state_method
       end
 
+      # override with your own implementation, like setting errors in your model
       def illegal_event_callback event_name
-        # override with your own implementation, like setting errors in your model
         raise Error.new("You cannot '#{event_name}' when state is '#{@subject.state}'")
       end
   

data/simple_state_machine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simple_state_machine}
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   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-03}
+  s.date = %q{2010-09-04}
   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 = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simple_state_machine
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Marek de Heus
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-03 00:00:00 +02:00
+date: 2010-09-04 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency