transitions 0.0.8 → 0.0.9

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    transitions (0.0.9)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    i18n (0.4.1)
+    mocha (0.9.8)
+      rake
+    rake (0.8.7)
+    sqlite3-ruby (1.3.1)
+    test-unit (2.1.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3)
+  bundler (~> 1)
+  mocha
+  sqlite3-ruby
+  test-unit (~> 2)
+  transitions!

data/README.rdoc

@@ -10,16 +10,16 @@ If you're using Rails + ActiveRecord + Bundler
 
   # in your Gemfile
   gem "transitions", :require => ["transitions", "active_record/transitions"]
-  
+
   # in your AR models that will use the state machine
   include ::Transitions
   include ActiveRecord::Transitions
-  
+
   state_machine do
     state :available # first one is initial state
     state :out_of_stock
     state :discontinue
-    
+
     event :discontinue do
       transitions :to => :discontinue, :from => [:available, :out_of_stock], :on_transition => :do_discontinue
     end
@@ -31,6 +31,12 @@ If you're using Rails + ActiveRecord + Bundler
     end
   end
 
+== Usage
+
+Krzysiek Heród (aka {Netizer}[http://github.com/netizer]) wrote a nice {blog
+post}[http://dev.netizer.pl/transitions-state-machine-for-rails-3.html]
+about using Transitions in ActiveRecord.
+
 == Copyright
 
 Copyright (c) 2010 Jakub Kuźma. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+Bundler.setup
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/test_*.rb"
+  test.verbose = true
+end
+
+task :default => :test

data/lib/transitions/version.rb

@@ -1,3 +1,3 @@
 module Transitions
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/test/helper.rb

@@ -0,0 +1,14 @@
+Bundler.require
+require "test/unit"
+require "active_support/all"
+require "active_record"
+require "mocha"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "transitions"
+require "active_record/transitions"
+
+class Test::Unit::TestCase
+
+end

data/test/test_active_record.rb

@@ -0,0 +1,112 @@
+require "helper"
+require 'active_support/core_ext/module/aliasing'
+
+class CreateTrafficLights < ActiveRecord::Migration
+  def self.up
+    create_table(:traffic_lights) { |t| t.string :state }
+  end
+end
+
+class TrafficLight < ActiveRecord::Base
+  include ActiveRecord::Transitions
+
+  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 ProtectedTrafficLight < TrafficLight
+  attr_protected :state
+end
+
+class ValidatingTrafficLight < TrafficLight
+  validate {|t| errors.add(:base, 'This TrafficLight will never validate after creation') unless t.new_record? }
+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(Transitions::InvalidTransition) { @light.yellow_on }
+    assert_equal :off, @light.current_state
+  end
+
+  test "transition does persists state when state is protected" do
+    protected_light = ProtectedTrafficLight.create!
+    protected_light.reset!
+    assert_equal :red, protected_light.current_state
+    protected_light.reload
+    assert_equal "red", protected_light.state
+  end
+
+  test "transition with wrong state will not validate" do
+    for s in @light.class.state_machine.states
+      @light.state = s.name
+      assert @light.valid?
+    end
+    @light.state = "invalid_one"
+    assert_false @light.valid?
+  end
+
+  test "transition raises exception when model validation fails" do
+    validating_light = ValidatingTrafficLight.create!
+    assert_raise(ActiveRecord::RecordInvalid) do
+      validating_light.reset!
+    end
+  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 = Transitions::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
+    Transitions::StateTransition.expects(:new).with(:to => :closed, :from => :open)
+    Transitions::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 Transitions
+  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 Transitions::InvalidTransition error if the transitions are empty" do
+    event = Transitions::Event.new(nil, :event)
+
+    assert_raise Transitions::InvalidTransition do
+      event.fire(nil)
+    end
+  end
+
+  test "should return the state of the first matching transition it finds" do
+    event = Transitions::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 Transitions
+
+  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 TransitionsMachineTest < 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 Transitions::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 Transitions
+
+  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={})
+    Transitions::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 = Transitions::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 = Transitions::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 = Transitions::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 = Transitions::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 = Transitions::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 = Transitions::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 = Transitions::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 = Transitions::StateTransition.new(opts)
+
+    obj = stub
+    obj.expects(:test_guard)
+
+    st.perform(obj)
+  end
+end

data/transitions.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/transitions/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "transitions"
+  s.version     = Transitions::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jakub Kuźma"]
+  s.email       = "qoobaa@gmail.com"
+  s.homepage    = "http://github.com/qoobaa/transitions"
+  s.summary     = "State machine extracted from ActiveModel"
+  s.description = "Lightweight state machine extracted from ActiveModel"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "transitions"
+
+  s.add_development_dependency "bundler", "~> 1"
+  s.add_development_dependency "test-unit", "~> 2"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "sqlite3-ruby"
+  s.add_development_dependency "activerecord", "~> 3"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: transitions
 version: !ruby/object:Gem::Version 
-  hash: 15
   prerelease: false
   segments: 
   - 0
   - 0
-  - 8
-  version: 0.0.8
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - "Jakub Ku\xC5\xBAma"
@@ -15,66 +14,74 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-12 00:00:00 +02:00
+date: 2010-09-21 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: test-unit
-  prerelease: false
+  name: bundler
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
-        - 2
-        - 0
-        version: "2.0"
+        - 1
+        version: "1"
   type: :development
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: mocha
-  prerelease: false
+  name: test-unit
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
-        - 0
-        version: "0"
+        - 2
+        version: "2"
   type: :development
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: sqlite3-ruby
-  prerelease: false
+  name: mocha
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: activerecord
-  prerelease: false
+  name: sqlite3-ruby
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        version: "3"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
 description: Lightweight state machine extracted from ActiveModel
 email: qoobaa@gmail.com
 executables: []
@@ -84,15 +91,29 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/active_record/transitions.rb
 - lib/transitions.rb
-- lib/transitions/state_transition.rb
-- lib/transitions/state.rb
 - lib/transitions/event.rb
-- lib/transitions/version.rb
 - lib/transitions/machine.rb
-- lib/active_record/transitions.rb
-- LICENSE
-- README.rdoc
+- lib/transitions/state.rb
+- lib/transitions/state_transition.rb
+- lib/transitions/version.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: []
@@ -107,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: -568409294339076591
       segments: 
       - 0
       version: "0"
@@ -116,7 +137,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
       segments: 
       - 1
       - 3
@@ -124,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: transitions
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3