state_shifter 0.7.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "yard", "~> 0.7"
+  gem 'redcarpet' 
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.1.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,41 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redcarpet (2.1.1)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    yard (0.8.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.0)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  redcarpet
+  rspec (~> 2.8.0)
+  simplecov
+  yard (~> 0.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Bruno Antunes
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,22 @@
+state\_shifter
+==============
+
+Description goes here.
+
+Contributing to state\_shifter
+------------------------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2012 Bruno Antunes. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "state_shifter"
+  gem.homepage = "http://github.com/sardaukar/state_shifter"
+  gem.license = "MIT"
+  gem.summary = %Q{state_shifter is a gem that adds state machine behavior to a class}
+  gem.description = %Q{state_shifter is a gem that adds state machine behavior to a class}
+  gem.email = "sardaukar.siet@gmail.com"
+  gem.authors = ["Bruno Antunes"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  ENV['COVERAGE'] = 'true'
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :rcov
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.7.0

data/examples/advanced.rb

@@ -0,0 +1,95 @@
+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
+
+  ###
+
+  def entries_deadline_reached?
+    true
+  end
+
+  def running_entry previous_state, trigger_event
+    #
+  end
+
+  def benchmark from, to, trigger_event, duration
+    #
+  end
+
+end

data/examples/malformed_events.rb

@@ -0,0 +1,33 @@
+class MalformedEvents
+  include StateShifter::Definition
+
+  state_machine do 
+
+    # first state to be defined is the initial one
+    state :new do
+      event :submit => :awaiting_review
+    end
+
+    state :awaiting_review do
+      event :submit => :being_reviewed
+    end
+
+    state :being_reviewed do
+      event :accept => :accepted, :if => :cool_article?
+      event :reject => :rejected, :if => :bad_article?
+    end
+
+    state :accepted
+    state :rejected
+
+  end
+
+  def cool_article?
+    true
+  end
+
+  def bad_article?
+    false
+  end
+
+end

data/examples/malformed_states.rb

@@ -0,0 +1,33 @@
+class MalformedStates
+  include StateShifter::Definition
+
+  state_machine do 
+
+    # first state to be defined is the initial one
+    state :new do
+      event :submit => :awaiting_review
+    end
+
+    state :new do
+      event :review => :being_reviewed
+    end
+
+    state :being_reviewed do
+      event :accept => :accepted, :if => :cool_article?
+      event :reject => :rejected, :if => :bad_article?
+    end
+
+    state :accepted
+    state :rejected
+
+  end
+
+  def cool_article?
+    true
+  end
+
+  def bad_article?
+    false
+  end
+
+end

data/examples/mounted.rb

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

data/examples/simple.rb

@@ -0,0 +1,33 @@
+class Simple
+  include StateShifter::Definition
+
+  state_machine do 
+
+    # first state to be defined is the initial one
+    state :new do
+      event :submit => :awaiting_review
+    end
+
+    state :awaiting_review do
+      event :review => :being_reviewed
+    end
+
+    state :being_reviewed do
+      event :accept => :accepted, :if => :cool_article?
+      event :reject => :rejected, :if => :bad_article?
+    end
+
+    state :accepted
+    state :rejected
+
+  end
+
+  def cool_article?
+    true
+  end
+
+  def bad_article?
+    false
+  end
+
+end

data/lib/state_shifter/definition/class_methods.rb

@@ -0,0 +1,84 @@
+module StateShifter
+  module Definition
+    module ClassMethods
+
+      attr_accessor :state_machine_definition
+
+      def state_machine &definition
+        @state_machine_definition = Contents.new(&definition)
+        add_methods
+      end
+
+      def add_methods
+        @state_machine_definition.states.each do |state_name, state_definition|
+          
+          module_eval do
+
+            define_method "_next_states" do |from_state, *options|
+              options = options.first || {}
+              next_states_hash   = {}
+              check_guards  = options.has_key?(:check_guards)
+
+              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)
+                end
+
+                next_states_hash.merge!( event_def.to.nil? ? { from_state.to_sym => event_name } : { event_def.to => event_def.name } )
+              end
+
+              next_states_hash.keys.uniq.sort
+            end
+
+            define_method "#{state_name}?" do
+              current_state == state_name
+            end
+
+            state_machine_definition.events.each do |event_name, event_definition|
+
+              define_method "can_#{event_name}?" do
+              
+                this_event = state_machine_definition.get(:event, event_name)
+                
+                current_state == this_event.from && !check_guards(event_name).is_a?(Array) 
+              
+              end
+
+              define_method "#{event_name}!" do
+
+                self.send event_name.to_sym, true
+              
+              end
+
+              define_method "#{event_name}" do |bang=false|
+
+                if current_state != event_definition.from
+                  if bang  
+                    halt("you cannot transition from #{current_state} via #{event_name}")
+                  else
+                    return false
+                  end
+                end
+                
+                if (failed_guards = check_guards(event_name)).is_a?(Array)
+                  if bang
+                    failed_guards.delete_at(0)
+                    raise ::StateShifter::GuardNotSatisfied, "#{failed_guards.join}"
+                  else 
+                    return false
+                  end
+                end
+
+                transition :to => ( event_definition.to.nil? ? current_state : event_definition.to ), :trigger => ( bang ? "#{event_name}!" : event_name )
+               
+              end
+
+            end
+
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/state_shifter/definition/contents.rb

@@ -0,0 +1,85 @@
+module StateShifter
+
+  module Definition
+
+    class Contents
+
+      attr_accessor :states, :initial_state, :events, :on_transition_proc
+
+      def initialize &definition
+        @states = {}
+        @events = {}
+        instance_eval &definition if block_given?
+      end
+
+      def state name, &events_and_stuff
+        this_state = State.new(name)
+        @initial_state = this_state if @states.empty? # first state declared is the initial one
+        
+        raise ::StateShifter::RedifiningState, this_state.name if @states.has_key?(this_state.name.to_sym)
+        
+        @states[this_state.name.to_sym] = this_state
+        @current_state = this_state
+        instance_eval &events_and_stuff if events_and_stuff
+      end
+
+      def event hash_or_sym, hash=nil
+        this_event =
+          if hash.nil?
+            if hash_or_sym.is_a?(Symbol)
+              # looping event
+              event_name = hash_or_sym
+              
+              Event.new @current_state.name.to_sym, event_name
+            else
+              # normal event
+              event_guards = hash_or_sym.delete(:if)
+              event_name = hash_or_sym.keys.first
+              event_next_state = hash_or_sym[event_name.to_sym]
+        
+              Event.new @current_state.name.to_sym, event_name, event_next_state, event_guards
+            end
+          else
+            event_guards = hash.delete(:if)
+            event_name = hash_or_sym
+            event_callback = hash.delete(:call)
+            
+            Event.new @current_state.name.to_sym, event_name, @current_state.name.to_sym, event_guards, event_callback
+          end
+
+        raise ::StateShifter::RedifiningEvent, this_event.name if @events.has_key?(this_event.name.to_sym)        
+        
+        @events[this_event.name.to_sym] = this_event
+        @current_state.events[event_name.to_sym] = this_event
+      end
+
+      def on_entry event_name=nil, &proc_contents
+        if event_name.nil?
+          @current_state.entry_callback = proc_contents
+        else
+          @current_state.entry_callback = event_name
+        end
+      end
+
+      def get key, what
+        case key
+        when :event
+          @events[what.to_sym] || @events[what.to_s.gsub('!','').to_sym]
+        when :state
+          @states[what.to_sym] || @states[what.to_s.gsub('!','').to_sym]
+        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

@@ -0,0 +1,109 @@
+module StateShifter
+
+  module Definition
+
+    module InstanceMethods
+
+      attr_accessor :current_state, :state_machine_definition
+
+      def initialize
+        @current_state = state_machine_definition.initial_state.name.to_sym
+        @subject = self
+      end
+
+      def state_machine_definition
+        self.class.state_machine_definition
+      end
+
+      def next_states
+        _next_states current_state
+      end
+
+      def transitionable_states
+        _next_states current_state, {:check_guards => true}
+      end
+
+      def state_names
+        names_for :states
+      end
+
+      def event_names
+        names_for :events
+      end
+
+      def initial_state
+        state_machine_definition.initial_state.name
+      end
+
+      def names_for what
+        state_machine_definition.send(what).collect {|name, definition| name }
+      end
+
+      def check_event_callbacks event_name
+        event_def = state_machine_definition.get(:event, event_name)
+        begin
+          @subject.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)
+      end
+
+      def call_state_entry_callback trigger, old_state
+        proc_or_method_name = current_state_def.entry_callback
+
+        if proc_or_method_name.is_a?(Symbol)
+          begin
+            @subject.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)
+        end        
+      end
+
+      def transition args
+        _start = Time.now
+
+        # BOOP!
+        old_state = @current_state
+        @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?
+        true
+      end
+
+      def halt message
+        raise ::StateShifter::TransitionHalted, message
+      end
+
+      def check_guards event_name
+        event = state_machine_definition.get(:event, event_name)
+
+        if event.has_guards?
+          event.guards.each do |guard|
+            begin
+              return false, guard unless self.send(guard.to_sym)
+            rescue NoMethodError
+              raise ::StateShifter::GuardMethodUndefined, guard
+            end
+          end
+          true
+        else
+          true
+        end
+      end
+
+    end
+  end
+
+end

data/lib/state_shifter/definition.rb

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

data/lib/state_shifter/event.rb

@@ -0,0 +1,22 @@
+module StateShifter
+  class Event
+    attr_reader :name, :from, :to, :guards, :callback
+
+    def initialize from, name, to=nil, guards=nil, callback=nil
+      @name = name
+      @from = from
+      @to = to
+      @guards = [guards].flatten.compact
+      @callback = callback
+    end
+
+    def has_guards?
+      !@guards.nil?
+    end
+
+    def has_callback?
+      !@callback.nil?
+    end
+
+  end
+end

data/lib/state_shifter/mountable/class_methods.rb

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,20 @@
+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

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

data/lib/state_shifter/state.rb

@@ -0,0 +1,20 @@
+module StateShifter
+
+  class State
+  
+    attr_reader :name, :events
+    attr_accessor :entry_callback
+
+    def initialize name
+      @name = name
+      @events = {}
+      @entry_callback = nil
+    end
+
+    def has_entry_callback?
+      !@entry_callback.nil?
+    end
+
+  end
+
+end

data/lib/state_shifter.rb

@@ -0,0 +1,17 @@
+require 'state_shifter/state'
+require 'state_shifter/event'
+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
+class ::StateShifter::GuardNotSatisfied < Exception ; end
+class ::StateShifter::CallbackMethodNotDefined < Exception ; end
+class ::StateShifter::RedifiningEvent < Exception ; end
+class ::StateShifter::RedifiningState < Exception ; end
+

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'state_shifter'
+require 'simplecov'
+
+if ENV['COVERAGE']
+  SimpleCov.start do
+    add_filter 'spec'
+  end
+end
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/state_shifter_spec.rb

@@ -0,0 +1,162 @@
+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
+  
+  before(:each) do
+    @state_machine = described_class.new
+  end
+
+  it 'should have all states and events defined' do
+    @state_machine.state_names.should == [:new, :awaiting_review, :being_reviewed, :accepted, :rejected]
+    @state_machine.event_names.should == [:submit, :review, :accept, :reject]
+  end
+
+  it 'should have the proper initial state set' do
+    @state_machine.initial_state.should == :new
+    @state_machine.current_state.should == :new
+
+    @state_machine.submit
+    @state_machine.initial_state.should == :new
+  end
+
+  it 'should transit between states properly' do
+    @state_machine.submit
+    @state_machine.current_state.should == :awaiting_review
+
+    @state_machine.review!
+    @state_machine.current_state.should == :being_reviewed
+  end
+
+  it 'should know the current state' do
+    @state_machine.current_state.should == :new
+
+    @state_machine.new?.should be_true
+    @state_machine.accepted?.should be_false
+
+    @state_machine.submit
+
+    @state_machine.awaiting_review?.should be_true
+    @state_machine.new?.should be_false
+  end
+
+  it 'should respect guard statements' do
+    @state_machine.submit
+    @state_machine.review
+
+    @state_machine.reject.should_not be_true
+    lambda { @state_machine.reject!}.should raise_error(StateShifter::GuardNotSatisfied, 'bad_article?')
+
+    @state_machine.accept.should be_true
+    @state_machine.current_state.should == :accepted
+  end
+
+  it 'should know if a transition is possible' do
+    @state_machine.can_submit?.should be_true
+
+    @state_machine.submit
+
+    @state_machine.can_review?.should be_true
+
+    @state_machine.review
+
+    @state_machine.can_accept?.should be_true
+    @state_machine.can_reject?.should be_false
+  end
+
+  it 'should properly indicate next states' do
+    @state_machine.next_states.should == [:awaiting_review]
+    @state_machine.transitionable_states.should == [:awaiting_review]
+
+    @state_machine.submit!
+    @state_machine.next_states.should == [:being_reviewed]
+    @state_machine.transitionable_states.should == [:being_reviewed]
+
+    @state_machine.review!
+    @state_machine.next_states.should == [:accepted, :rejected]
+    @state_machine.transitionable_states.should == [:accepted]
+
+    @state_machine.accept
+    @state_machine.next_states.should == []
+    @state_machine.transitionable_states.should == []
+  end
+
+  it 'should respect proper transition precedence' do
+    @state_machine.current_state.should == :new
+    lambda { @state_machine.review! }.should raise_error(StateShifter::TransitionHalted, 'you cannot transition from new via review')
+  end
+
+end
+
+describe Simple do
+   
+  it_should_behave_like 'a simple state machine'
+
+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
+    lambda { require_relative '../examples/malformed_states' }.should raise_error(StateShifter::RedifiningState, 'new')
+  end
+
+  it 'should complain about redifining events' do
+    lambda { require_relative '../examples/malformed_events' }.should raise_error(StateShifter::RedifiningEvent, 'submit')
+  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?')
+  end
+
+  it 'should complain about undefined callbacks on state entry' do
+    advanced = Advanced.new
+    advanced.forced_start!
+    
+    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
+
+  it 'should call looping event callbacks' do
+    @advanced.stub!(:handle_start_date_changed)
+    
+    @advanced.should_receive(:handle_start_date_changed)
+    @advanced.start_date_changed
+  end
+
+  it 'state on_entry callbacks should work' do
+    # block
+    @advanced.should_receive(:running_entry).with(:initialized, :forced_start).and_return(nil)
+    @advanced.forced_start
+
+    # method name only
+    @advanced.should_receive(:send_notification_to_organizers)
+    @advanced.deadline_reached!
+  end
+
+  it 'the on_transition callback should work' do
+    @advanced.should_receive(:benchmark).with(:initialized, :running, :forced_start!, an_instance_of(Float)).and_return(nil)
+    @advanced.forced_start!
+  end
+
+end
+

data/state_shifter.gemspec

@@ -0,0 +1,83 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "state_shifter"
+  s.version = "0.7.0"
+
+  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.description = "state_shifter is a gem that adds state machine behavior to a class"
+  s.email = "sardaukar.siet@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "examples/advanced.rb",
+    "examples/malformed_events.rb",
+    "examples/malformed_states.rb",
+    "examples/mounted.rb",
+    "examples/simple.rb",
+    "lib/state_shifter.rb",
+    "lib/state_shifter/definition.rb",
+    "lib/state_shifter/definition/class_methods.rb",
+    "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",
+    "state_shifter.gemspec"
+  ]
+  s.homepage = "http://github.com/sardaukar/state_shifter"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "state_shifter is a gem that adds state machine behavior to a class"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<redcarpet>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: state_shifter
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+  prerelease: 
+platform: ruby
+authors:
+- Bruno Antunes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: state_shifter is a gem that adds state machine behavior to a class
+email: sardaukar.siet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- examples/advanced.rb
+- examples/malformed_events.rb
+- examples/malformed_states.rb
+- examples/mounted.rb
+- examples/simple.rb
+- lib/state_shifter.rb
+- lib/state_shifter/definition.rb
+- lib/state_shifter/definition/class_methods.rb
+- 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
+- state_shifter.gemspec
+homepage: http://github.com/sardaukar/state_shifter
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4081808216781371275
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: state_shifter is a gem that adds state machine behavior to a class
+test_files: []