state_machines 0.0.1

data/lib/state_machines/version.rb

@@ -0,0 +1,3 @@
+module StateMachines
+  VERSION = '0.0.1'
+end

data/lib/state_machines/yard.rb

@@ -0,0 +1,8 @@
+module StateMachines
+  # YARD plugin for automated documentation
+  module YARD
+  end
+end
+
+require 'state_machines/yard/handlers'
+require 'state_machines/yard/templates'

data/lib/state_machines.rb

@@ -0,0 +1,3 @@
+require 'state_machines/version'
+require 'state_machines/core'
+require 'state_machines/core_ext'

data/spec/errors/default_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe 'ErrorByDefault' do
+  let(:klass) { Class.new }
+  let(:machine) { StateMachines::Machine.new(klass) }
+  let(:collection) { StateMachines::NodeCollection.new(machine) }
+  it '#length' do
+    expect(collection.length).to eq(0)
+  end
+
+  it  do
+    expect(collection.machine).to eq(machine)
+  end
+end

data/spec/errors/with_message_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe 'ErrorWithMessage' do
+  let(:klass) { Class.new }
+  let(:machine) { StateMachines::Machine.new(klass) }
+  let(:collection) { StateMachines::NodeCollection.new(machine) }
+  it 'should_raise_exception_if_invalid_option_specified' do
+    expect { StateMachines::NodeCollection.new(machine, invalid: true) }.to raise_error(ArgumentError)
+    # assert_equal 'Invalid key(s): invalid', exception.message
+  end
+
+  it 'should_raise_exception_on_lookup_if_invalid_index_specified' do
+    expect { collection[:something, :invalid] }.to raise_error(ArgumentError)
+    # assert_equal 'Invalid index: :invalid', exception.message
+  end
+
+  it 'should raise exception on fetch if invalid index specified' do
+    expect { collection[:something, :invalid] }.to raise_error(ArgumentError)
+    # assert_equal 'Invalid index: :invalid', exception.message
+  end
+end
+
+# class ErrorWithMessageTest < Test::Unit::TestCase
+#
+#   it 'should_raise_exception_if_invalid_option_specified
+#     exception = assert_raise(ArgumentError) { StateMachines::NodeCollection.new(@machine, :invalid => true) }
+#     assert_equal 'Invalid key(s): invalid', exception.message
+#   end
+#
+#   it 'should_raise_exception_on_lookup_if_invalid_index_specified
+#     exception = assert_raise(ArgumentError) { @collection[:something, :invalid] }
+#     assert_equal 'Invalid index: :invalid', exception.message
+#   end
+#
+#   it 'should_raise_exception_on_fetch_if_invalid_index_specified
+#     exception = assert_raise(ArgumentError) { @collection.fetch(:something, :invalid) }
+#     assert_equal 'Invalid index: :invalid', exception.message
+#   end
+# end

data/spec/helpers/helper_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe StateMachines::HelperModule do
+  let(:klass) { Class.new }
+  let(:machine) { StateMachines::Machine.new(klass) }
+  let(:helper_module) { StateMachines::HelperModule.new(machine, :instance) }
+  it 'should not have a name' do
+    expect(helper_module.name.to_s).to eq('')
+  end
+
+  it 'should_provide_human_readable_to_s' do
+    expect(helper_module.to_s).to eq("#{klass} :state instance helpers")
+  end
+end

data/spec/internal/app/models/auto_shop.rb

@@ -0,0 +1,31 @@
+class AutoShop
+  attr_accessor :num_customers
+
+  def initialize
+    @num_customers = 0
+    super
+  end
+
+  state_machine initial: :available do
+    after_transition available: any, do: :increment_customers
+    after_transition busy: any, do: :decrement_customers
+
+    event :tow_vehicle do
+      transition available: :busy
+    end
+
+    event :fix_vehicle do
+      transition busy: :available
+    end
+  end
+
+  # Increments the number of customers in service
+  def increment_customers
+    self.num_customers += 1
+  end
+
+  # Decrements the number of customers in service
+  def decrement_customers
+    self.num_customers -= 1
+  end
+end

data/spec/internal/app/models/car.rb

@@ -0,0 +1,19 @@
+class Car < Vehicle
+  state_machine do
+    event :reverse do
+      transition [:parked, :idling, :first_gear] => :backing_up
+    end
+
+    event :park do
+      transition backing_up: :parked
+    end
+
+    event :idle do
+      transition backing_up: :idling
+    end
+
+    event :shift_up do
+      transition backing_up: :first_gear
+    end
+  end
+end

data/spec/internal/app/models/model_base.rb

@@ -0,0 +1,6 @@
+class ModelBase
+  def save
+    @saved = true
+    self
+  end
+end

data/spec/internal/app/models/motorcycle.rb

@@ -0,0 +1,9 @@
+class Motorcycle < Vehicle
+  state_machine initial: :idling do
+    state :first_gear do
+      def decibels
+        1.0
+      end
+    end
+  end
+end

data/spec/internal/app/models/traffic_light.rb

@@ -0,0 +1,47 @@
+class TrafficLight
+  state_machine initial: :stop do
+    event :cycle do
+      transition stop: :proceed, proceed: :caution, caution: :stop
+    end
+
+    state :stop do
+      def color(transform)
+        value = 'red'
+
+        if block_given?
+          yield value
+        else
+          value.send(transform)
+        end
+
+        value
+      end
+    end
+
+    state all - :proceed do
+      def capture_violations?
+        true
+      end
+    end
+
+    state :proceed do
+      def color(transform)
+        'green'
+      end
+
+      def capture_violations?
+        false
+      end
+    end
+
+    state :caution do
+      def color(transform)
+        'yellow'
+      end
+    end
+  end
+
+  def color(transform = :to_s)
+    super
+  end
+end

data/spec/internal/app/models/vehicle.rb

@@ -0,0 +1,123 @@
+class Vehicle < ModelBase
+  attr_accessor :auto_shop, :seatbelt_on, :insurance_premium, :force_idle, :callbacks, :saved, :time_elapsed, :last_transition_args
+
+  def initialize(attributes = {})
+    attributes = {
+      auto_shop: AutoShop.new,
+      seatbelt_on: false,
+      insurance_premium: 50,
+      force_idle: false,
+      callbacks: [],
+      saved: false
+    }.merge(attributes)
+
+    attributes.each { |attr, value| send("#{attr}=", value) }
+    super()
+  end
+
+  # Defines the state machine for the state of the vehicled
+  state_machine initial: lambda { |vehicle| vehicle.force_idle ? :idling : :parked }, action: :save do
+    before_transition { |vehicle, transition| vehicle.last_transition_args = transition.args }
+    before_transition parked: any, do: :put_on_seatbelt
+    before_transition any => :stalled, :do => :increase_insurance_premium
+    after_transition any => :parked, :do => lambda { |vehicle| vehicle.seatbelt_on = false }
+    after_transition on: :crash, do: :tow
+    after_transition on: :repair, do: :fix
+
+    # Callback tracking for initial state callbacks
+    after_transition any => :parked, :do => lambda { |vehicle| vehicle.callbacks << 'before_enter_parked' }
+    before_transition any => :idling, :do => lambda { |vehicle| vehicle.callbacks << 'before_enter_idling' }
+
+    around_transition do |vehicle, transition, block|
+      time = Time.now
+      block.call
+      vehicle.time_elapsed = Time.now - time
+    end
+
+    event all do
+      transition locked: :parked
+    end
+
+    event :park do
+      transition [:idling, :first_gear] => :parked
+    end
+
+    event :ignite do
+      transition stalled: :stalled
+      transition parked: :idling
+    end
+
+    event :idle do
+      transition first_gear: :idling
+    end
+
+    event :shift_up do
+      transition idling: :first_gear, first_gear: :second_gear, second_gear: :third_gear
+    end
+
+    event :shift_down do
+      transition third_gear: :second_gear
+      transition second_gear: :first_gear
+    end
+
+    event :crash do
+      transition [:first_gear, :second_gear, :third_gear] => :stalled, :if => lambda { |vehicle| vehicle.auto_shop.available? }
+    end
+
+    event :repair do
+      transition stalled: :parked, if: :auto_shop_busy?
+    end
+  end
+
+  state_machine :insurance_state, initial: :inactive, namespace: 'insurance' do
+    event :buy do
+      transition inactive: :active
+    end
+
+    event :cancel do
+      transition active: :inactive
+    end
+  end
+
+  def save
+    super
+  end
+
+  def new_record?
+    @saved == false
+  end
+
+  def park
+    super
+  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
+
+  def decibels
+    0.0
+  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
+    self.insurance_premium += 100
+  end
+
+  # Is the auto shop currently servicing another customer?
+  def auto_shop_busy?
+    auto_shop.busy?
+  end
+end