transitions 0.0.4

data/.document

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

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## GEM
+*.gem
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jakub Kuźma
+
+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.rdoc

@@ -0,0 +1,27 @@
+= state_machine
+
+The gem is based on Rick Olson's code of ActiveModel::StateMachine,
+axed from ActiveModel in {this
+commit}[http://github.com/rails/rails/commit/db49c706b62e7ea2ab93f05399dbfddf5087ee0c].
+
+== Installation
+
+Currently there's no gem released on gemcutter (we need a different
+name). However it's fully usable in bundler, you can just paste the
+following line into the Gemfile:
+
+  gem "state_machine", :git => "git://github.com/qoobaa/state_machine.git"
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jakub Kuźma. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+
+require "rubygems"
+require "rake"
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gem|
+    gem.name = "transitions"
+    gem.summary = %Q{State machine extracted from ActiveModel}
+    # gem.description = %Q{TODO: longer description of your gem}
+    gem.email = "qoobaa@gmail.com"
+    gem.homepage = "http://github.com/qoobaa/transitions"
+    gem.authors = ["Jakub Kuźma"]
+    gem.add_development_dependency "test-unit", ">= 2"
+    gem.add_development_dependency "mocha"
+    gem.add_development_dependency "sqlite3-ruby"
+    gem.add_development_dependency "activerecord"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/test_*.rb"
+  test.verbose = true
+end
+
+begin
+  require "rcov/rcovtask"
+  Rcov::RcovTask.new do |test|
+    test.libs << "test"
+    test.pattern = "test/**/test_*.rb"
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require "rake/rdoctask"
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?("VERSION") ? File.read("VERSION") : ""
+
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "state_machine #{version}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/lib/active_record/state_machine.rb

@@ -0,0 +1,47 @@
+# Copyright (c) 2009 Rick Olson
+
+# 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.
+
+module ActiveRecord
+  module StateMachine
+    extend ActiveSupport::Concern
+
+    included do
+      include ::StateMachine
+      before_validation :set_initial_state
+      validates_presence_of :state
+    end
+
+    protected
+
+    def write_state(state_machine, state)
+      update_attributes! :state => state.to_s
+    end
+
+    def read_state(state_machine)
+      self.state.to_sym
+    end
+
+    def set_initial_state
+      self.state ||= self.class.state_machine.initial_state.to_s
+    end
+  end
+end

data/lib/state_machine.rb

@@ -0,0 +1,93 @@
+# Copyright (c) 2009 Rick Olson
+
+# 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.
+
+require "state_machine/event"
+require "state_machine/machine"
+require "state_machine/state"
+require "state_machine/state_transition"
+
+module StateMachine
+  class InvalidTransition < Exception
+
+  end
+
+  module ClassMethods
+    def inherited(klass)
+      super
+      klass.state_machines = state_machines
+    end
+
+    def state_machines
+      @state_machines ||= {}
+    end
+
+    def state_machines=(value)
+      @state_machines = value ? value.dup : nil
+    end
+
+    def state_machine(name = nil, options = {}, &block)
+      if name.is_a?(Hash)
+        options = name
+        name    = nil
+      end
+      name ||= :default
+      state_machines[name] ||= Machine.new(self, name)
+      block ? state_machines[name].update(options, &block) : state_machines[name]
+    end
+
+    def define_state_query_method(state_name)
+      name = "#{state_name}?"
+      undef_method(name) if method_defined?(name)
+      class_eval "def #{name}; current_state.to_s == %(#{state_name}) end"
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def current_state(name = nil, new_state = nil, persist = false)
+    sm   = self.class.state_machine(name)
+    ivar = sm.current_state_variable
+    if name && new_state
+      if persist && respond_to?(:write_state)
+        write_state(sm, new_state)
+      end
+
+      if respond_to?(:write_state_without_persistence)
+        write_state_without_persistence(sm, new_state)
+      end
+
+      instance_variable_set(ivar, new_state)
+    else
+      instance_variable_set(ivar, nil) unless instance_variable_defined?(ivar)
+      value = instance_variable_get(ivar)
+      return value if value
+
+      if respond_to?(:read_state)
+        value = instance_variable_set(ivar, read_state(sm))
+      end
+
+      value || sm.initial_state
+    end
+  end
+end

data/lib/state_machine/event.rb

@@ -0,0 +1,83 @@
+# Copyright (c) 2009 Rick Olson
+
+# 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.
+
+module StateMachine
+  class Event
+    attr_reader :name, :success
+
+    def initialize(machine, name, options = {}, &block)
+      @machine, @name, @transitions = machine, name, []
+      if machine
+        machine.klass.send(:define_method, "#{name}!") do |*args|
+          machine.fire_event(name, self, true, *args)
+        end
+
+        machine.klass.send(:define_method, name.to_s) do |*args|
+          machine.fire_event(name, self, false, *args)
+        end
+      end
+      update(options, &block)
+    end
+
+    def fire(obj, to_state = nil, *args)
+      transitions = @transitions.select { |t| t.from == obj.current_state(@machine ? @machine.name : nil) }
+      raise InvalidTransition if transitions.size == 0
+
+      next_state = nil
+      transitions.each do |transition|
+        next if to_state && !Array(transition.to).include?(to_state)
+        if transition.perform(obj)
+          next_state = to_state || Array(transition.to).first
+          transition.execute(obj, *args)
+          break
+        end
+      end
+      next_state
+    end
+
+    def transitions_from_state?(state)
+      @transitions.any? { |t| t.from? state }
+    end
+
+    def ==(event)
+      if event.is_a? Symbol
+        name == event
+      else
+        name == event.name
+      end
+    end
+
+    def update(options = {}, &block)
+      @success = options[:success] if options.key?(:success)
+      instance_eval(&block) if block
+      self
+    end
+
+    private
+
+    def transitions(trans_opts)
+      Array(trans_opts[:from]).each do |s|
+        @transitions << StateTransition.new(trans_opts.merge({:from => s.to_sym}))
+      end
+    end
+  end
+end

data/lib/state_machine/machine.rb

@@ -0,0 +1,97 @@
+# Copyright (c) 2009 Rick Olson
+
+# 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.
+
+module StateMachine
+  class Machine
+    attr_writer :initial_state
+    attr_accessor :states, :events, :state_index
+    attr_reader :klass, :name
+
+    def initialize(klass, name, options = {}, &block)
+      @klass, @name, @states, @state_index, @events = klass, name, [], {}, {}
+      update(options, &block)
+    end
+
+    def initial_state
+      @initial_state ||= (states.first ? states.first.name : nil)
+    end
+
+    def update(options = {}, &block)
+      @initial_state = options[:initial] if options.key?(:initial)
+      instance_eval(&block) if block
+      self
+    end
+
+    def fire_event(event, record, persist, *args)
+      state_index[record.current_state(@name)].call_action(:exit, record)
+      if new_state = @events[event].fire(record, nil, *args)
+        state_index[new_state].call_action(:enter, record)
+
+        if record.respond_to?(event_fired_callback)
+          record.send(event_fired_callback, record.current_state, new_state)
+        end
+
+        record.current_state(@name, new_state, persist)
+        record.send(@events[event].success) if @events[event].success
+        true
+      else
+        if record.respond_to?(event_failed_callback)
+          record.send(event_failed_callback, event)
+        end
+
+        false
+      end
+    end
+
+    def states_for_select
+      states.map { |st| [st.display_name, st.name.to_s] }
+    end
+
+    def events_for(state)
+      events = @events.values.select { |event| event.transitions_from_state?(state) }
+      events.map! { |event| event.name }
+    end
+
+    def current_state_variable
+      "@#{@name}_current_state"
+    end
+
+    private
+
+    def state(name, options = {})
+      @states << (state_index[name] ||= State.new(name, :machine => self)).update(options)
+    end
+
+    def event(name, options = {}, &block)
+      (@events[name] ||= Event.new(self, name)).update(options, &block)
+    end
+
+    def event_fired_callback
+      @event_fired_callback ||= (@name == :default ? '' : "#{@name}_") + 'event_fired'
+    end
+
+    def event_failed_callback
+      @event_failed_callback ||= (@name == :default ? '' : "#{@name}_") + 'event_failed'
+    end
+  end
+end
+

data/lib/state_machine/state.rb

@@ -0,0 +1,67 @@
+# Copyright (c) 2009 Rick Olson
+
+# 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.
+
+module StateMachine
+  class State
+    attr_reader :name, :options
+
+    def initialize(name, options = {})
+      @name = name
+      if machine = options.delete(:machine)
+        machine.klass.define_state_query_method(name)
+      end
+      update(options)
+    end
+
+    def ==(state)
+      if state.is_a? Symbol
+        name == state
+      else
+        name == state.name
+      end
+    end
+
+    def call_action(action, record)
+      action = @options[action]
+      case action
+      when Symbol, String
+        record.send(action)
+      when Proc
+        action.call(record)
+      end
+    end
+
+    def display_name
+      @display_name ||= name.to_s.gsub(/_/, ' ').capitalize
+    end
+
+    def for_select
+      [display_name, name.to_s]
+    end
+
+    def update(options = {})
+      @display_name = options.delete(:display) if options.key?(:display)
+      @options = options
+      self
+    end
+  end
+end

data/lib/state_machine/state_transition.rb

@@ -0,0 +1,60 @@
+# Copyright (c) 2009 Rick Olson
+
+# 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.
+
+module StateMachine
+  class StateTransition
+    attr_reader :from, :to, :options
+
+    def initialize(opts)
+      @from, @to, @guard, @on_transition = opts[:from], opts[:to], opts[:guard], opts[:on_transition]
+      @options = opts
+    end
+
+    def perform(obj)
+      case @guard
+      when Symbol, String
+        obj.send(@guard)
+      when Proc
+        @guard.call(obj)
+      else
+        true
+      end
+    end
+
+    def execute(obj, *args)
+      case @on_transition
+      when Symbol, String
+        obj.send(@on_transition, *args)
+      when Proc
+        @on_transition.call(obj, *args)
+      end
+    end
+
+    def ==(obj)
+      @from == obj.from && @to == obj.to
+    end
+
+    def from?(value)
+      @from == value
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,14 @@
+require "rubygems"
+gem "test-unit" # enforce gem usage on 1.8.x
+require "test/unit"
+require "active_record"
+require "mocha"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "state_machine"
+require "active_record/state_machine"
+
+class Test::Unit::TestCase
+
+end

data/test/test_active_record.rb

@@ -0,0 +1,79 @@
+require "helper"
+
+class CreateTrafficLights < ActiveRecord::Migration
+  def self.up
+    create_table(:traffic_lights) { |t| t.string :state }
+  end
+end
+
+class TrafficLight < ActiveRecord::Base
+  include ActiveRecord::StateMachine
+
+  state_machine do
+    state :off
+
+    state :red
+    state :green
+    state :yellow
+
+    event :red_on do
+      transitions :to => :red, :from => [:yellow]
+    end
+
+    event :green_on do
+      transitions :to => :green, :from => [:red]
+    end
+
+    event :yellow_on do
+      transitions :to => :yellow, :from => [:green]
+    end
+
+    event :reset do
+      transitions :to => :red, :from => [:off]
+    end
+  end
+end
+
+class TestActiveRecord < Test::Unit::TestCase
+  def setup
+    ActiveRecord::Base.establish_connection(:adapter  => "sqlite3", :database => ":memory:")
+    ActiveRecord::Migration.verbose = false
+    CreateTrafficLights.migrate(:up)
+
+    @light = TrafficLight.create!
+  end
+
+  test "states initial state" do
+    assert @light.off?
+    assert_equal :off, @light.current_state
+  end
+
+  test "transition to a valid state" do
+    @light.reset
+    assert @light.red?
+    assert_equal :red, @light.current_state
+
+    @light.green_on
+    assert @light.green?
+    assert_equal :green, @light.current_state
+  end
+
+  test "transition does not persist state" do
+    @light.reset
+    assert_equal :red, @light.current_state
+    @light.reload
+    assert_equal "off", @light.state
+  end
+
+  test "transition does persists state" do
+    @light.reset!
+    assert_equal :red, @light.current_state
+    @light.reload
+    assert_equal "red", @light.state
+  end
+
+  test "transition to an invalid state" do
+    assert_raise(StateMachine::InvalidTransition) { @light.yellow_on }
+    assert_equal :off, @light.current_state
+  end
+end

data/test/test_event.rb

@@ -0,0 +1,28 @@
+require "helper"
+
+class TestEvent < Test::Unit::TestCase
+  def setup
+    @state_name = :close_order
+    @success = :success_callback
+  end
+
+  def new_event
+    @event = StateMachine::Event.new(nil, @state_name, {:success => @success}) do
+      transitions :to => :closed, :from => [:open, :received]
+    end
+  end
+
+  test "should set the name" do
+    assert_equal @state_name, new_event.name
+  end
+
+  test "should set the success option" do
+    assert_equal @success, new_event.success
+  end
+
+  test "should create StateTransitions" do
+    StateMachine::StateTransition.expects(:new).with(:to => :closed, :from => :open)
+    StateMachine::StateTransition.expects(:new).with(:to => :closed, :from => :received)
+    new_event
+  end
+end

data/test/test_event_arguments.rb

@@ -0,0 +1,30 @@
+require "helper"
+
+class ArgumentsTestSubject
+  include StateMachine
+  attr_accessor :date
+
+  state_machine do
+    state :initial
+    state :opened
+
+    event :open do
+      transitions :from => :initial, :to => :opened, :on_transition => :update_date
+    end
+  end
+
+  def update_date(date = Date.today)
+    self.date = date
+  end
+end
+
+class StateMachineMachineTest < Test::Unit::TestCase
+  test "pass arguments to transition method" do
+    subject = ArgumentsTestSubject.new
+    assert_equal :initial, subject.current_state
+    subject.open!(Date.yesterday)
+    assert_equal :opened, subject.current_state
+    assert_equal Date.yesterday, subject.date
+  end
+end
+

data/test/test_event_being_fired.rb

@@ -0,0 +1,22 @@
+require "helper"
+
+class TestEventBeingFired < Test::Unit::TestCase
+  test "should raise an StateMachine::InvalidTransition error if the transitions are empty" do
+    event = StateMachine::Event.new(nil, :event)
+
+    assert_raise StateMachine::InvalidTransition do
+      event.fire(nil)
+    end
+  end
+
+  test "should return the state of the first matching transition it finds" do
+    event = StateMachine::Event.new(nil, :event) do
+      transitions :to => :closed, :from => [:open, :received]
+    end
+
+    obj = stub
+    obj.stubs(:current_state).returns(:open)
+
+    assert_equal :closed, event.fire(obj)
+  end
+end

data/test/test_machine.rb

@@ -0,0 +1,43 @@
+require "helper"
+
+class MachineTestSubject
+  include StateMachine
+
+  state_machine do
+    state :open
+    state :closed
+  end
+
+  state_machine :initial => :foo do
+    event :shutdown do
+      transitions :from => :open, :to => :closed
+    end
+
+    event :timeout do
+      transitions :from => :open, :to => :closed
+    end
+  end
+
+  state_machine :extra, :initial => :bar do
+  end
+end
+
+class StateMachineMachineTest < Test::Unit::TestCase
+  test "allows reuse of existing machines" do
+    assert_equal 2, MachineTestSubject.state_machines.size
+  end
+
+  test "sets #initial_state from :initial option" do
+    assert_equal :bar, MachineTestSubject.state_machine(:extra).initial_state
+  end
+
+  test "accesses non-default state machine" do
+    assert_kind_of StateMachine::Machine, MachineTestSubject.state_machine(:extra)
+  end
+
+  test "finds events for given state" do
+    events = MachineTestSubject.state_machine.events_for(:open)
+    assert events.include?(:shutdown)
+    assert events.include?(:timeout)
+  end
+end

data/test/test_state.rb

@@ -0,0 +1,72 @@
+require "helper"
+
+class StateTestSubject
+  include StateMachine
+
+  state_machine do
+  end
+end
+
+class TestState < Test::Unit::TestCase
+  def setup
+    @state_name = :astate
+    @machine = StateTestSubject.state_machine
+    @options = { :crazy_custom_key => "key", :machine => @machine }
+  end
+
+  def new_state(options={})
+    StateMachine::State.new(@state_name, @options.merge(options))
+  end
+
+  test "sets the name" do
+    assert_equal :astate, new_state.name
+  end
+
+  test "sets the display_name from name" do
+    assert_equal "Astate", new_state.display_name
+  end
+
+  test "sets the display_name from options" do
+    assert_equal "A State", new_state(:display => "A State").display_name
+  end
+
+  test "sets the options and expose them as options" do
+    @options.delete(:machine)
+    assert_equal @options, new_state.options
+  end
+
+  test "equals a symbol of the same name" do
+    assert_equal new_state, :astate
+  end
+
+  test "equals a State of the same name" do
+    assert_equal new_state, new_state
+  end
+
+  test "should send a message to the record for an action if the action is present as a symbol" do
+    state = new_state(:entering => :foo)
+
+    record = stub
+    record.expects(:foo)
+
+    state.call_action(:entering, record)
+  end
+
+  test "should send a message to the record for an action if the action is present as a string" do
+    state = new_state(:entering => "foo")
+
+    record = stub
+    record.expects(:foo)
+
+    state.call_action(:entering, record)
+  end
+
+  test "should call a proc, passing in the record for an action if the action is present" do
+    state = new_state(:entering => Proc.new {|r| r.foobar})
+
+    record = stub
+    record.expects(:foobar)
+
+    state.call_action(:entering, record)
+  end
+end

data/test/test_state_transition.rb

@@ -0,0 +1,45 @@
+require "helper"
+
+class TestStateTransition < Test::Unit::TestCase
+  test "should set from, to, and opts attr readers" do
+    opts = {:from => "foo", :to => "bar", :guard => "g"}
+    st = StateMachine::StateTransition.new(opts)
+
+    assert_equal opts[:from], st.from
+    assert_equal opts[:to],   st.to
+    assert_equal opts,        st.options
+  end
+
+  test "should pass equality check if from and to are the same" do
+    opts = {:from => "foo", :to => "bar", :guard => "g"}
+    st = StateMachine::StateTransition.new(opts)
+
+    obj = stub
+    obj.stubs(:from).returns(opts[:from])
+    obj.stubs(:to).returns(opts[:to])
+
+    assert_equal st, obj
+  end
+
+  test "should fail equality check if from are not the same" do
+    opts = {:from => "foo", :to => "bar", :guard => "g"}
+    st = StateMachine::StateTransition.new(opts)
+
+    obj = stub
+    obj.stubs(:from).returns("blah")
+    obj.stubs(:to).returns(opts[:to])
+
+    assert_not_equal st, obj
+  end
+
+  test "should fail equality check if to are not the same" do
+    opts = {:from => "foo", :to => "bar", :guard => "g"}
+    st = StateMachine::StateTransition.new(opts)
+
+    obj = stub
+    obj.stubs(:from).returns(opts[:from])
+    obj.stubs(:to).returns("blah")
+
+    assert_not_equal st, obj
+  end
+end

data/test/test_state_transition_guard_check.rb

@@ -0,0 +1,40 @@
+require "helper"
+
+class TestStateTransitionGuardCheck < Test::Unit::TestCase
+  test "should return true of there is no guard" do
+    opts = {:from => "foo", :to => "bar"}
+      st = StateMachine::StateTransition.new(opts)
+
+    assert st.perform(nil)
+  end
+
+  test "should call the method on the object if guard is a symbol" do
+    opts = {:from => "foo", :to => "bar", :guard => :test_guard}
+    st = StateMachine::StateTransition.new(opts)
+
+    obj = stub
+    obj.expects(:test_guard)
+
+    st.perform(obj)
+  end
+
+  test "should call the method on the object if guard is a string" do
+    opts = {:from => "foo", :to => "bar", :guard => "test_guard"}
+    st = StateMachine::StateTransition.new(opts)
+
+    obj = stub
+    obj.expects(:test_guard)
+
+    st.perform(obj)
+  end
+
+  test "should call the proc passing the object if the guard is a proc" do
+    opts = {:from => "foo", :to => "bar", :guard => Proc.new {|o| o.test_guard}}
+    st = StateMachine::StateTransition.new(opts)
+
+    obj = stub
+    obj.expects(:test_guard)
+
+    st.perform(obj)
+  end
+end

data/transitions.gemspec

@@ -0,0 +1,81 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{transitions}
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jakub Kuźma"]
+  s.date = %q{2010-03-14}
+  s.email = %q{qoobaa@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/active_record/state_machine.rb",
+     "lib/state_machine.rb",
+     "lib/state_machine/event.rb",
+     "lib/state_machine/machine.rb",
+     "lib/state_machine/state.rb",
+     "lib/state_machine/state_transition.rb",
+     "test/helper.rb",
+     "test/test_active_record.rb",
+     "test/test_event.rb",
+     "test/test_event_arguments.rb",
+     "test/test_event_being_fired.rb",
+     "test/test_machine.rb",
+     "test/test_state.rb",
+     "test/test_state_transition.rb",
+     "test/test_state_transition_guard_check.rb",
+     "transitions.gemspec"
+  ]
+  s.homepage = %q{http://github.com/qoobaa/transitions}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{State machine extracted from ActiveModel}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_state_transition_guard_check.rb",
+     "test/test_active_record.rb",
+     "test/test_machine.rb",
+     "test/test_state_transition.rb",
+     "test/test_event_arguments.rb",
+     "test/test_state.rb",
+     "test/test_event_being_fired.rb",
+     "test/test_event.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<test-unit>, [">= 2"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_development_dependency(%q<activerecord>, [">= 0"])
+    else
+      s.add_dependency(%q<test-unit>, [">= 2"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<test-unit>, [">= 2"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: transitions
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- "Jakub Ku\xC5\xBAma"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-14 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        version: "2"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: 
+email: qoobaa@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/active_record/state_machine.rb
+- lib/state_machine.rb
+- lib/state_machine/event.rb
+- lib/state_machine/machine.rb
+- lib/state_machine/state.rb
+- lib/state_machine/state_transition.rb
+- test/helper.rb
+- test/test_active_record.rb
+- test/test_event.rb
+- test/test_event_arguments.rb
+- test/test_event_being_fired.rb
+- test/test_machine.rb
+- test/test_state.rb
+- test/test_state_transition.rb
+- test/test_state_transition_guard_check.rb
+- transitions.gemspec
+has_rdoc: true
+homepage: http://github.com/qoobaa/transitions
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: State machine extracted from ActiveModel
+test_files: 
+- test/helper.rb
+- test/test_state_transition_guard_check.rb
+- test/test_active_record.rb
+- test/test_machine.rb
+- test/test_state_transition.rb
+- test/test_event_arguments.rb
+- test/test_state.rb
+- test/test_event_being_fired.rb
+- test/test_event.rb