state_machine 0.3.1 → 0.4.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: state_machine
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-26 00:00:00 -04:00
+date: 2008-12-14 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -22,40 +22,47 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- examples/Car_state.jpg
+- examples/Vehicle_state.png
+- examples/AutoShop_state.png
 - lib/state_machine
 - lib/state_machine/event.rb
+- lib/state_machine/guard.rb
+- lib/state_machine/integrations
+- lib/state_machine/integrations/data_mapper
+- lib/state_machine/integrations/data_mapper/observer.rb
+- lib/state_machine/integrations/sequel.rb
+- lib/state_machine/integrations/active_record.rb
+- lib/state_machine/integrations/data_mapper.rb
+- lib/state_machine/eval_helpers.rb
 - lib/state_machine/transition.rb
+- lib/state_machine/callback.rb
+- lib/state_machine/extensions.rb
+- lib/state_machine/assertions.rb
 - lib/state_machine/machine.rb
 - lib/state_machine.rb
-- test/app_root
-- test/app_root/app
-- test/app_root/app/models
-- test/app_root/app/models/highway.rb
-- test/app_root/app/models/switch.rb
-- test/app_root/app/models/motorcycle.rb
-- test/app_root/app/models/toggle_switch.rb
-- test/app_root/app/models/vehicle.rb
-- test/app_root/app/models/car.rb
-- test/app_root/app/models/switch_observer.rb
-- test/app_root/app/models/auto_shop.rb
-- test/app_root/config
-- test/app_root/config/environment.rb
-- test/app_root/db
-- test/app_root/db/migrate
-- test/app_root/db/migrate/002_create_auto_shops.rb
-- test/app_root/db/migrate/003_create_highways.rb
-- test/app_root/db/migrate/004_create_vehicles.rb
-- test/app_root/db/migrate/001_create_switches.rb
+- test/sequel.log
+- test/active_record.log
+- test/test_helper.rb
 - test/functional
 - test/functional/state_machine_test.rb
-- test/test_helper.rb
-- test/factory.rb
+- test/data_mapper.log
+- test/classes
+- test/classes/switch.rb
 - test/unit
-- test/unit/transition_test.rb
+- test/unit/integrations
+- test/unit/integrations/data_mapper_test.rb
+- test/unit/integrations/active_record_test.rb
+- test/unit/integrations/sequel_test.rb
+- test/unit/state_machine_test.rb
+- test/unit/callback_test.rb
 - test/unit/invalid_transition_test.rb
-- test/unit/machine_test.rb
+- test/unit/transition_test.rb
+- test/unit/eval_helpers_test.rb
 - test/unit/event_test.rb
-- test/unit/state_machine_test.rb
+- test/unit/guard_test.rb
+- test/unit/assertions_test.rb
+- test/unit/machine_test.rb
 - CHANGELOG.rdoc
 - init.rb
 - LICENSE
@@ -86,11 +93,18 @@ rubyforge_project: pluginaweek
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Adds support for creating state machines for attributes within a model
+summary: Adds support for creating state machines for attributes on any Ruby class
 test_files: 
 - test/functional/state_machine_test.rb
-- test/unit/transition_test.rb
+- test/unit/integrations/data_mapper_test.rb
+- test/unit/integrations/active_record_test.rb
+- test/unit/integrations/sequel_test.rb
+- test/unit/state_machine_test.rb
+- test/unit/callback_test.rb
 - test/unit/invalid_transition_test.rb
-- test/unit/machine_test.rb
+- test/unit/transition_test.rb
+- test/unit/eval_helpers_test.rb
 - test/unit/event_test.rb
-- test/unit/state_machine_test.rb
+- test/unit/guard_test.rb
+- test/unit/assertions_test.rb
+- test/unit/machine_test.rb

data/test/app_root/app/models/auto_shop.rb

@@ -1,34 +0,0 @@
-class AutoShop < ActiveRecord::Base
-  state_machine :state, :initial => 'available' do
-    after_transition :from => 'available', :do => :increment_customers
-    after_transition :from => 'busy', :do => :decrement_customers
-    
-    event :tow_vehicle do
-      transition :to => 'busy', :from => 'available'
-    end
-    
-    event :fix_vehicle do
-      transition :to => 'available', :from => 'busy'
-    end
-  end
-  
-  # Is the Auto Shop available for new customers?
-  def available?
-    state == 'available'
-  end
-  
-  # Is the Auto Shop currently not taking new customers?
-  def busy?
-    state == 'busy'
-  end
-  
-  # Increments the number of customers in service
-  def increment_customers
-    update_attribute(:num_customers, num_customers + 1)
-  end
-  
-  # Decrements the number of customers in service
-  def decrement_customers
-    update_attribute(:num_customers, num_customers - 1)
-  end
-end

data/test/app_root/app/models/car.rb

@@ -1,19 +0,0 @@
-class Car < Vehicle
-  state_machine :state do
-    event :reverse do
-      transition :to => 'backing_up', :from => %w(parked idling first_gear)
-    end
-    
-    event :park do
-      transition :to => 'parked', :from => 'backing_up'
-    end
-    
-    event :idle do
-      transition :to => 'idling', :from => 'backing_up'
-    end
-    
-    event :shift_up do
-      transition :to => 'first_gear', :from => 'backing_up'
-    end
-  end
-end

data/test/app_root/app/models/highway.rb

@@ -1,3 +0,0 @@
-class Highway < ActiveRecord::Base
-  has_many :vehicles
-end

data/test/app_root/app/models/motorcycle.rb

@@ -1,3 +0,0 @@
-class Motorcycle < Vehicle
-  state_machine :state, :initial => 'idling'
-end

data/test/app_root/app/models/switch.rb

@@ -1,23 +0,0 @@
-class Switch < ActiveRecord::Base
-  # Tracks the callbacks that were invoked
-  attr_reader :callbacks
-  
-  # Dynamic sets the initial state
-  attr_accessor :initial_state
-  
-  # Whether or not validations should fail
-  attr_accessor :fail_validation
-  validate Proc.new {|switch| switch.errors.add_to_base 'is invalid' if switch.fail_validation}
-  
-  # Whether or not saves should fail
-  attr_accessor :fail_save
-  before_save Proc.new {|switch| !switch.fail_save}
-  
-  # Arbitrary data associated with the switch
-  attr_accessor :data
-  
-  def initialize(attributes = nil)
-    @callbacks = []
-    super
-  end
-end

data/test/app_root/app/models/switch_observer.rb

@@ -1,20 +0,0 @@
-class SwitchObserver < ActiveRecord::Observer
-  cattr_accessor :notifications
-  self.notifications = []
-  
-  def before_turn_on(switch, from_state, to_state)
-    notifications << ['before_turn_on', switch, from_state, to_state]
-  end
-  
-  def after_turn_on(switch, from_state, to_state)
-    notifications << ['after_turn_on', switch, from_state, to_state]
-  end
-  
-  def before_transition(switch, attribute, event, from_state, to_state)
-    notifications << ['before_transition', switch, attribute, event, from_state, to_state]
-  end
-  
-  def after_transition(switch, attribute, event, from_state, to_state)
-    notifications << ['after_transition', switch, attribute, event, from_state, to_state]
-  end
-end

data/test/app_root/app/models/toggle_switch.rb

@@ -1,2 +0,0 @@
-class ToggleSwitch < Switch
-end

data/test/app_root/app/models/vehicle.rb

@@ -1,78 +0,0 @@
-class Vehicle < ActiveRecord::Base
-  belongs_to :auto_shop
-  belongs_to :highway
-  
-  attr_accessor :force_idle
-  attr_accessor :callbacks
-  
-  # Defines the state machine for the state of the vehicled
-  state_machine :state, :initial => Proc.new {|vehicle| vehicle.force_idle ? 'idling' : 'parked'} do
-    before_transition :from => 'parked', :do => :put_on_seatbelt
-    before_transition :to => 'stalled', :do => :increase_insurance_premium
-    after_transition :to => 'parked', :do => lambda {|vehicle| vehicle.update_attribute(:seatbelt_on, false)}
-    after_transition :on => 'crash', :do => :tow!
-    after_transition :on => 'repair', :do => :fix!
-    
-    # Callback tracking for initial state callbacks
-    after_transition :to => 'parked', :do => lambda {|vehicle| (vehicle.callbacks ||= []) << 'before_enter_parked'}
-    before_transition :to => 'idling', :do => lambda {|vehicle| (vehicle.callbacks ||= []) << 'before_enter_idling'}
-    
-    event :park do
-      transition :to => 'parked', :from => %w(idling first_gear)
-    end
-    
-    event :ignite do
-      transition :to => 'stalled', :from => 'stalled'
-      transition :to => 'idling', :from => 'parked'
-    end
-    
-    event :idle do
-      transition :to => 'idling', :from => 'first_gear'
-    end
-    
-    event :shift_up do
-      transition :to => 'first_gear', :from => 'idling'
-      transition :to => 'second_gear', :from => 'first_gear'
-      transition :to => 'third_gear', :from => 'second_gear'
-    end
-    
-    event :shift_down do
-      transition :to => 'second_gear', :from => 'third_gear'
-      transition :to => 'first_gear', :from => 'second_gear'
-    end
-    
-    event :crash do
-      transition :to => 'stalled', :from => %w(first_gear second_gear third_gear), :if => lambda {|vehicle| vehicle.auto_shop.available?}
-    end
-    
-    event :repair do
-      transition :to => 'parked', :from => 'stalled', :if => :auto_shop_busy?
-    end
-  end
-  
-  # Tows the vehicle to the auto shop
-  def tow!
-    auto_shop.tow_vehicle!
-  end
-  
-  # Fixes the vehicle; it will no longer be in the auto shop
-  def fix!
-    auto_shop.fix_vehicle!
-  end
-  
-  private
-    # Safety first! Puts on our seatbelt
-    def put_on_seatbelt
-      self.seatbelt_on = true
-    end
-    
-    # We crashed! Increase the insurance premium on the vehicle
-    def increase_insurance_premium
-      update_attribute(:insurance_premium, self.insurance_premium + 100)
-    end
-    
-    # Is the auto shop currently servicing another customer?
-    def auto_shop_busy?
-      auto_shop.busy?
-    end
-end

data/test/app_root/config/environment.rb

@@ -1,7 +0,0 @@
-require 'config/boot'
-
-Rails::Initializer.run do |config|
-  config.cache_classes = false
-  config.whiny_nils = true
-  config.active_record.observers = :switch_observer
-end

data/test/app_root/db/migrate/001_create_switches.rb

@@ -1,12 +0,0 @@
-class CreateSwitches < ActiveRecord::Migration
-  def self.up
-    create_table :switches do |t|
-      t.string :state, :null => false
-      t.string :kind
-    end
-  end
-  
-  def self.down
-    drop_table :switches
-  end
-end

data/test/app_root/db/migrate/002_create_auto_shops.rb

@@ -1,13 +0,0 @@
-class CreateAutoShops < ActiveRecord::Migration
-  def self.up
-    create_table :auto_shops do |t|
-      t.string :name, :null => false
-      t.integer :num_customers, :null => false
-      t.string :state, :null => false
-    end
-  end
-  
-  def self.down
-    drop_table :auto_shops
-  end
-end

data/test/app_root/db/migrate/003_create_highways.rb

@@ -1,11 +0,0 @@
-class CreateHighways < ActiveRecord::Migration
-  def self.up
-    create_table :highways do |t|
-      t.string :name, :null => false
-    end
-  end
-  
-  def self.down
-    drop_table :highways
-  end
-end

data/test/app_root/db/migrate/004_create_vehicles.rb

@@ -1,16 +0,0 @@
-class CreateVehicles < ActiveRecord::Migration
-  def self.up
-    create_table :vehicles do |t|
-      t.references :highway, :null => false
-      t.references :auto_shop, :null => false
-      t.boolean :seatbelt_on, :null => false
-      t.integer :insurance_premium, :null => false
-      t.string :state, :null => false
-      t.string :type
-    end
-  end
-  
-  def self.down
-    drop_table :vehicles
-  end
-end

data/test/factory.rb

@@ -1,77 +0,0 @@
-module Factory
-  # Build actions for the model
-  def self.build(model, &block)
-    name = model.to_s.underscore
-    
-    define_method("#{name}_attributes", block)
-    define_method("valid_#{name}_attributes") {|*args| valid_attributes_for(model, *args)}
-    define_method("new_#{name}")              {|*args| new_record(model, *args)}
-    define_method("create_#{name}")           {|*args| create_record(model, *args)}
-  end
-  
-  # Get valid attributes for the model
-  def valid_attributes_for(model, attributes = {})
-    name = model.to_s.underscore
-    send("#{name}_attributes", attributes)
-    attributes.stringify_keys!
-    attributes
-  end
-  
-  # Build an unsaved record
-  def new_record(model, *args)
-    attributes = valid_attributes_for(model, *args)
-    record = model.new(attributes)
-    attributes.each {|attr, value| record.send("#{attr}=", value) if model.accessible_attributes && !model.accessible_attributes.include?(attr) || model.protected_attributes && model.protected_attributes.include?(attr)}
-    record
-  end
-  
-  # Build and save/reload a record
-  def create_record(model, *args)
-    record = new_record(model, *args)
-    record.save!
-    record.reload
-    record
-  end
-  
-  build AutoShop do |attributes|
-    attributes.reverse_merge!(
-      :name => "Joe's Auto Body",
-      :num_customers => 0
-    )
-  end
-  
-  build Car do |attributes|
-    valid_vehicle_attributes(attributes)
-  end
-  
-  build Highway do |attributes|
-    attributes.reverse_merge!(
-      :name => 'Route 66'
-    )
-  end
-  
-  build Motorcycle do |attributes|
-    valid_car_attributes(attributes)
-  end
-  
-  build Switch do |attributes|
-    attributes.reverse_merge!(
-      :state => 'off'
-    )
-  end
-  
-  build ToggleSwitch do |attributes|
-    attributes.reverse_merge!(
-      :state => 'off'
-    )
-  end
-  
-  build Vehicle do |attributes|
-    attributes[:highway] = create_highway unless attributes.include?(:highway)
-    attributes[:auto_shop] = create_auto_shop unless attributes.include?(:auto_shop)
-    attributes.reverse_merge!(
-      :seatbelt_on => false,
-      :insurance_premium => 50
-    )
-  end
-end