state_shifter 0.7.1 → 0.7.2

data/Gemfile

@@ -6,6 +6,7 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
+  gem 'activerecord', '~> 3.2.x'
   gem "rspec", "~> 2.8.0"
   gem "yard", "~> 0.7"
   gem 'redcarpet' 

data/Gemfile.lock

@@ -1,8 +1,22 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
     diff-lcs (1.1.3)
     git (1.2.5)
+    i18n (0.6.0)
     jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
@@ -26,12 +40,14 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
+    tzinfo (0.3.33)
     yard (0.8.2.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord (~> 3.2.x)
   bundler (~> 1.1.0)
   jeweler (~> 1.8.4)
   rdoc (~> 3.12)

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.7.2

data/examples/malformed_persistence.rb

@@ -0,0 +1,97 @@
+class Advanced
+  include StateShifter::Definition
+
+  ### 
+
+  state_machine do
+
+    state :initialized do
+
+      event :start_date_changed, :call => :handle_start_date_changed
+      event :forced_start => :running
+      event :start_date_reached => :running, :if => :start_date_reached?
+      event :abort_initialized_contest => :finalized
+    end
+
+    state :running do
+
+      on_entry do |previous_state, trigger_event|
+        running_entry previous_state, trigger_event
+      end
+
+      event :abort_running_contest => :notify_stakeholders 
+      event :changed_properties
+      event :keep_users_engaged
+      event :deadline_reached => :notify_organizers, :if => :entries_deadline_reached?
+      event :spots_filled  => :notify_organizers, :if => :spots_filled?
+      event :deadline_reached_without_approvals  => :notify_pending_users, :if => :entries_deadline_reached_without_approvals?
+      event :deadline_reached_without_entries => :finalized, :if => :entries_deadline_reached_without_entries?
+    end
+
+    state :notify_organizers do
+      on_entry :send_notification_to_organizers
+      event :organizers_notified => :awaiting_organizer_reply
+    end
+
+    state :awaiting_organizer_reply do
+      event :organizer_confirmation_missing => :notify_stakeholders, :if => :organizer_confirmation_deadline_reached?
+      event :keep_organizers_engaged
+      event :organizer_confirmation_received => :notify_approved_users
+      event :organizer_has_more_tickets  => :running
+    end
+
+    state :notify_stakeholders do
+      on_entry :send_notification_to_stakeholders
+      event :stakeholders_notified => :cancelled
+    end
+
+    state :cancelled
+
+    state :notify_pending_users do
+      on_entry :send_notification_to_pending_users
+      event :pending_users_notified => :finalized
+    end
+
+    state :notify_approved_users do
+      on_entry :send_notification_to_approved_users
+      event :approved_users_notified => :send_list_to_organizers
+     end
+
+    state :send_list_to_organizers do
+      on_entry :send_guestlist_to_organizers
+      event :list_sent_to_organizers => :awaiting_attendance
+    end
+
+    state :awaiting_attendance do
+      event :remind_to_fill_in_report => :create_report_filling_requests
+    end
+
+    state :create_report_filling_requests do
+      on_entry :send_report_filling_requests
+      event :finalize => :finalized
+    end
+
+    state :finalized
+
+    on_transition do |from,to,trigger_event, duration|
+      benchmark from, to, trigger_event, duration
+    end
+  end
+
+  persist_attribute :lollies
+
+  ###
+
+  def entries_deadline_reached?
+    true
+  end
+
+  def running_entry previous_state, trigger_event
+    #
+  end
+
+  def benchmark from, to, trigger_event, duration
+    #
+  end
+
+end

data/lib/state_shifter/definition/class_methods.rb

@@ -2,9 +2,15 @@ module StateShifter
   module Definition
     module ClassMethods
 
-      attr_accessor :state_machine_definition
+      attr_accessor :state_machine_definition, :persist_attr_name
+
+      def persist_attribute attr_name
+        raise ::StateShifter::PersistenceAttributeAlreadyDefined if @persist_attr_name
+        @persist_attr_name = attr_name.to_sym
+      end
 
       def state_machine &definition
+        @persist_attr_name ||= :current_state
         @state_machine_definition = Contents.new(&definition)
         
         @state_machine_definition.states.each do |state_name, state_definition|
@@ -18,7 +24,7 @@ module StateShifter
 
               state_machine_definition.get(:state, from_state).events.each do |event_name, event_def|
                 if event_def.has_guards? && check_guards
-                  next if @subject.send(:check_guards, event_name).is_a?(Array)
+                  next if self.send(:check_guards, event_name).is_a?(Array)
                 end
 
                 next_states_hash.merge!( event_def.to.nil? ? { from_state.to_sym => event_name } : { event_def.to => event_def.name } )

data/lib/state_shifter/definition/contents.rb

@@ -1,7 +1,5 @@
 module StateShifter
-
   module Definition
-
     class Contents
 
       attr_accessor :states, :initial_state, :events, :on_transition_proc
@@ -61,6 +59,12 @@ module StateShifter
         end
       end
 
+      def on_transition &proc_contents
+        @on_transition_proc = proc_contents
+      end
+
+      ### end of DSL methods
+
       def get key, what
         case key
         when :event
@@ -70,16 +74,10 @@ module StateShifter
         end
       end
 
-      def on_transition &proc_contents
-        @on_transition_proc = proc_contents
-      end
-
       def has_on_transition_proc?
         !@on_transition_proc.nil?
       end
 
     end
-
   end
-
 end

data/lib/state_shifter/definition/instance_methods.rb

@@ -1,14 +1,17 @@
 module StateShifter
-
   module Definition
-
     module InstanceMethods
 
-      attr_accessor :current_state, :state_machine_definition
+      def current_state
+        @current_state ||=  get_current_state
+      end
 
-      def initialize
-        @current_state = state_machine_definition.initial_state.name.to_sym
-        @subject = self
+      def get_current_state
+        instance_variable_defined?(:@current_state) ? @current_state : state_machine_definition.initial_state.name.to_sym
+      end
+
+      def set_current_state value
+        @current_state = value
       end
 
       def state_machine_definition
@@ -42,14 +45,14 @@ module StateShifter
       def check_event_callbacks event_name
         event_def = state_machine_definition.get(:event, event_name)
         begin
-          @subject.send event_def.callback
+          self.send event_def.callback
         rescue NoMethodError
           raise ::StateShifter::CallbackMethodNotDefined, event_def.callback
         end
       end
 
       def current_state_def
-        state_machine_definition.get(:state, @current_state)
+        state_machine_definition.get(:state, current_state)
       end
 
       def call_state_entry_callback trigger, old_state
@@ -57,12 +60,12 @@ module StateShifter
 
         if proc_or_method_name.is_a?(Symbol)
           begin
-            @subject.send proc_or_method_name  
+            self.send proc_or_method_name  
           rescue NoMethodError
             raise ::StateShifter::CallbackMethodNotDefined, proc_or_method_name
           end
         else
-          @subject.instance_exec(old_state, trigger.to_sym, &proc_or_method_name)
+          self.instance_exec(old_state, trigger.to_sym, &proc_or_method_name)
         end        
       end
 
@@ -70,15 +73,16 @@ module StateShifter
         _start = Time.now
 
         # BOOP!
-        old_state = @current_state
-        @current_state = args[:to].to_sym
+        old_state = current_state
+        set_current_state args[:to].to_sym
         #
 
         check_event_callbacks(args[:trigger]) if state_machine_definition.get(:event, args[:trigger]).has_callback?
 
         call_state_entry_callback(args[:trigger], old_state) if current_state_def.has_entry_callback?
         
-        @subject.instance_exec(old_state, @current_state, args[:trigger].to_sym, (Time.now - _start), &state_machine_definition.on_transition_proc) if state_machine_definition.has_on_transition_proc?
+        self.instance_exec(old_state, current_state, args[:trigger].to_sym, (Time.now - _start), &state_machine_definition.on_transition_proc) if state_machine_definition.has_on_transition_proc?
+
         true
       end
 
@@ -105,5 +109,4 @@ module StateShifter
 
     end
   end
-
 end

data/lib/state_shifter.rb

@@ -4,9 +4,6 @@ require 'state_shifter/definition'
 require 'state_shifter/definition/contents'
 require 'state_shifter/definition/class_methods'
 require 'state_shifter/definition/instance_methods'
-require 'state_shifter/mountable'
-require 'state_shifter/mountable/class_methods'
-require 'state_shifter/mountable/instance_methods'
 
 class ::StateShifter::TransitionHalted < Exception ; end
 class ::StateShifter::GuardMethodUndefined < Exception ; end
@@ -14,4 +11,5 @@ class ::StateShifter::GuardNotSatisfied < Exception ; end
 class ::StateShifter::CallbackMethodNotDefined < Exception ; end
 class ::StateShifter::RedifiningEvent < Exception ; end
 class ::StateShifter::RedifiningState < Exception ; end
+class ::StateShifter::PersistenceAttributeAlreadyDefined < Exception ; end
 

data/spec/spec_helper.rb

@@ -1,10 +1,14 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+
 require 'rspec'
+require 'active_record'
+
 require 'state_shifter'
-require 'simplecov'
 
 if ENV['COVERAGE']
+  require 'simplecov'
+  
   SimpleCov.start do
     add_filter 'spec'
   end

data/spec/state_shifter_spec.rb

@@ -1,7 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require_relative '../examples/simple'
 require_relative '../examples/advanced'
-require_relative '../examples/mounted'
 
 shared_examples_for 'a simple state machine' do
   
@@ -101,12 +100,6 @@ describe Simple do
 
 end
 
-describe Mounted do
-
-  it_should_behave_like 'a simple state machine'
-
-end
-
 describe 'Malformed state machines' do
 
   it 'should complain about redifining states' do
@@ -117,6 +110,18 @@ describe 'Malformed state machines' do
     lambda { require_relative '../examples/malformed_events' }.should raise_error(StateShifter::RedifiningEvent, 'submit')
   end
 
+  it 'should complain when the persistence attribute is set after the state machine definition' do
+    lambda { require_relative '../examples/malformed_persistence' }.should raise_error(StateShifter::PersistenceAttributeAlreadyDefined)
+  end
+
+end
+
+describe 'Advanced state machine functionality' do
+
+  before(:each) do
+    @advanced = Advanced.new
+  end
+
   it 'should complain about undefined guards' do
     advanced = Advanced.new
     lambda { advanced.can_start_date_reached?}.should raise_error(StateShifter::GuardMethodUndefined, 'start_date_reached?')
@@ -129,14 +134,6 @@ describe 'Malformed state machines' do
     lambda { advanced.deadline_reached }.should raise_error(StateShifter::CallbackMethodNotDefined, 'send_notification_to_organizers')
   end
 
-end
-
-describe 'Advanced state machine functionality' do
-
-  before(:each) do
-    @advanced = Advanced.new
-  end
-
   it 'should complain about looping event callbacks not being defined' do
     lambda { @advanced.start_date_changed }.should raise_error(StateShifter::CallbackMethodNotDefined, 'handle_start_date_changed')
   end

data/state_shifter.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "state_shifter"
-  s.version = "0.7.1"
+  s.version = "0.7.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bruno Antunes"]
-  s.date = "2012-08-24"
+  s.date = "2012-08-27"
   s.description = "state_shifter is a gem that adds state machine behavior to a class"
   s.email = "sardaukar.siet@gmail.com"
   s.extra_rdoc_files = [
@@ -27,8 +27,8 @@ Gem::Specification.new do |s|
     "VERSION",
     "examples/advanced.rb",
     "examples/malformed_events.rb",
+    "examples/malformed_persistence.rb",
     "examples/malformed_states.rb",
-    "examples/mounted.rb",
     "examples/simple.rb",
     "lib/state_shifter.rb",
     "lib/state_shifter/definition.rb",
@@ -36,9 +36,6 @@ Gem::Specification.new do |s|
     "lib/state_shifter/definition/contents.rb",
     "lib/state_shifter/definition/instance_methods.rb",
     "lib/state_shifter/event.rb",
-    "lib/state_shifter/mountable.rb",
-    "lib/state_shifter/mountable/class_methods.rb",
-    "lib/state_shifter/mountable/instance_methods.rb",
     "lib/state_shifter/state.rb",
     "spec/spec_helper.rb",
     "spec/state_shifter_spec.rb",
@@ -54,6 +51,7 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<activerecord>, ["~> 3.2.x"])
       s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_development_dependency(%q<yard>, ["~> 0.7"])
       s.add_development_dependency(%q<redcarpet>, [">= 0"])
@@ -62,6 +60,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
     else
+      s.add_dependency(%q<activerecord>, ["~> 3.2.x"])
       s.add_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_dependency(%q<yard>, ["~> 0.7"])
       s.add_dependency(%q<redcarpet>, [">= 0"])
@@ -71,6 +70,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<simplecov>, [">= 0"])
     end
   else
+    s.add_dependency(%q<activerecord>, ["~> 3.2.x"])
     s.add_dependency(%q<rspec>, ["~> 2.8.0"])
     s.add_dependency(%q<yard>, ["~> 0.7"])
     s.add_dependency(%q<redcarpet>, [">= 0"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_shifter
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-24 00:00:00.000000000 Z
+date: 2012-08-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.x
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.x
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -141,8 +157,8 @@ files:
 - VERSION
 - examples/advanced.rb
 - examples/malformed_events.rb
+- examples/malformed_persistence.rb
 - examples/malformed_states.rb
-- examples/mounted.rb
 - examples/simple.rb
 - lib/state_shifter.rb
 - lib/state_shifter/definition.rb
@@ -150,9 +166,6 @@ files:
 - lib/state_shifter/definition/contents.rb
 - lib/state_shifter/definition/instance_methods.rb
 - lib/state_shifter/event.rb
-- lib/state_shifter/mountable.rb
-- lib/state_shifter/mountable/class_methods.rb
-- lib/state_shifter/mountable/instance_methods.rb
 - lib/state_shifter/state.rb
 - spec/spec_helper.rb
 - spec/state_shifter_spec.rb
@@ -172,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1507395421623075771
+      hash: -2788732275758639550
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/examples/mounted.rb

@@ -1,8 +0,0 @@
-require_relative 'simple'
-
-class Mounted
-  include StateShifter::Mountable
-
-  mount_state_machine Simple
-
-end

data/lib/state_shifter/mountable/class_methods.rb

@@ -1,13 +0,0 @@
-module StateShifter
-  module Mountable
-    module ClassMethods
-
-      attr_accessor :mountable_class_name
-
-      def mount_state_machine mountable_class_name
-        self.mountable_class_name = mountable_class_name
-      end
-
-     end
-  end
-end

data/lib/state_shifter/mountable/instance_methods.rb

@@ -1,20 +0,0 @@
-module StateShifter
-  module Mountable
-    module InstanceMethods
-
-      attr_accessor :state_machine_definition
-
-      def initialize
-        @state_machine_definition = self.class.mountable_class_name.new
-        @state_machine_definition.instance_variable_set(:@subject,self)
-
-        ( @state_machine_definition.methods - Object.methods).sort.each do |meth|
-          self.class.send :define_method, meth, &@state_machine_definition.method(meth)
-        end
-
-        super
-      end
-
-    end
-  end
-end

data/lib/state_shifter/mountable.rb

@@ -1,10 +0,0 @@
-module StateShifter
-  module Mountable
-
-    def self.included klass
-      klass.send :include, InstanceMethods
-      klass.extend ClassMethods
-    end
-
-  end
-end