statemachine 1.2.0 → 2.0.0

data/rails_plugin/spec/models/vending_machine_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "VendingMachine class with fixtures loaded" do
+  fixtures :vending_machines, :products
+  
+  before(:each) do
+    @vm = VendingMachine.new(:location => "Cafeteria", :cash => 1000)
+    @vm.save!
+  end
+
+  it "Create with location and cash" do
+    loaded = VendingMachine.find(@vm.id)
+    loaded.location.should eql("Cafeteria")
+    loaded.cash.should equal 1000
+  end
+  
+  it "Add rack" do
+    @vm.add_product(20, "Water", 150)
+    @vm.save!
+    
+    loaded = VendingMachine.find(@vm.id)
+    loaded.products.length.should equal 1
+    loaded.products[0].name.should eql("Water")
+    loaded.products[0].price.should eql(150)
+    loaded.products[0].inventory.should equal 20
+  end
+
+  
+  
+end

data/rails_plugin/spec/models/vending_statemachine_spec.rb

@@ -0,0 +1,130 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Vending Statemachine" do
+
+  before(:each) do
+    @sm = VendingStatemachine.statemachine
+    @context = mock("context")
+    @sm.context = @context
+  end
+
+  it "start state" do
+    @sm.state.should equal :standby
+  end
+
+  it "dollar" do
+    check_money_event(:dollar, :add_dollar)
+  end
+
+  it "quarter" do
+    check_money_event(:quarter, :add_quarter)
+  end
+
+  it "dime" do
+    check_money_event(:dime, :add_dime)
+  end
+
+  it "nickel" do
+    check_money_event(:nickel, :add_nickel)
+  end
+
+  def check_money_event(event, method)
+    @context.should_receive(:clear_dispensers)
+    @context.should_receive(method)
+    @context.should_receive(:check_max_price)
+
+    @sm.process_event(event)
+    @sm.state.should equal :collecting_money
+  end
+  
+  it "standby selection" do
+    @context.should_receive(:clear_dispensers)
+    
+    @sm.selection
+    @sm.state.should equal :standby
+  end
+
+  it "standby collecting_money" do
+    @sm.state = :collecting_money
+    @context.should_receive(:load_product).with(123)
+    @context.should_receive(:check_affordability)
+    
+    @sm.selection(123)
+    @sm.state.should equal :validating_purchase
+  end
+
+  it "reached max_price" do
+    @sm.state = :collecting_money
+    @context.should_receive(:refuse_money)
+    
+    @sm.reached_max_price
+    @sm.state.should equal :max_price_tendered
+  end
+
+  it "accept purchase" do
+    @sm.state = :validating_purchase
+    @context.should_receive(:make_sale)
+    
+    @sm.accept_purchase
+    @sm.state.should equal :standby
+  end
+
+  it "refuse purchase" do
+    @sm.state = :validating_purchase
+    @context.should_receive(:check_max_price)
+    
+    @sm.refuse_purchase
+    @sm.state.should equal :collecting_money
+  end
+
+  it "money in max_price_tendered" do
+    @sm.state = :max_price_tendered
+    
+    @sm.dollar
+    @sm.state.should equal :max_price_tendered
+    @sm.quarter
+    @sm.state.should equal :max_price_tendered
+    @sm.dime
+    @sm.state.should equal :max_price_tendered
+    @sm.nickel
+    @sm.state.should equal :max_price_tendered
+  end
+
+  it "selection in max_price_tendered" do
+    @sm.state = :max_price_tendered
+    @context.should_receive(:load_and_make_sale).with(123)
+    @context.should_receive(:accept_money)
+    
+    @sm.selection(123)
+    @sm.state.should equal :standby
+  end
+
+  it "release money from standby" do
+    @context.should_receive(:clear_dispensers)
+    @sm.release_money
+    
+    @sm.state.should equal :standby
+  end
+
+  it "release money from collecting money" do
+    @sm.state = :collecting_money
+    @context.should_receive(:dispense_change)
+    
+    @sm.release_money
+    
+    @sm.state.should equal :standby
+  end
+
+  it "release money from max_price_tendered" do
+    @sm.state = :max_price_tendered
+    @context.should_receive(:dispense_change)
+    @context.should_receive(:accept_money)
+
+    @sm.release_money
+
+    @sm.state.should equal :standby
+  end
+
+  
+  
+end

data/rails_plugin/spec/plugins/context_support_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Context Support" do
+
+  before(:each) do
+    @product = Product.new(:name => "Chicken")
+    @product.save!
+  end
+
+  it "Active Recrods Marshalled Compact" do
+    io = StringIO.new("")
+    Marshal.dump(@product, io)
+    io.rewind
+    
+    dump = io.read
+    dump.should_not include("Chicken")
+  end
+
+  it "Active Records Loaded properly" do 
+    io = StringIO.new("")
+    Marshal.dump(@product, io)
+    io.rewind
+    
+    loaded = Marshal.load(io)
+    loaded.name.should eql("Chicken")
+  end
+
+end

data/rails_plugin/spec/plugins/controller_support_spec.rb

@@ -0,0 +1,98 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+class SampleContext
+  include Statemachine::ContextSupport
+end
+
+class SampleStatemachine
+  attr_accessor :context
+end
+
+class SampleController
+  
+  include Statemachine::ControllerSupport
+  supported_by_statemachine SampleContext, lambda { SampleStatemachine.new }
+  
+  attr_accessor :session, :initialized, :before, :after, :params, :can_continue
+  
+  def initialize(statemachine, context)
+    @statemachine = statemachine
+    @context = context
+    @session = {}
+    @can_continue = true
+  end  
+  
+  def initialize_context(*args)
+    @initialized = true
+  end
+  
+  def before_event
+    @before = true
+    return @can_continue
+  end
+  
+  def after_event
+    @after = true
+  end
+  
+end
+
+describe "State Machine Support" do
+
+  before(:each) do
+    @statemachine = mock("statemachine")
+    @context = mock("context")
+    @controller = SampleController.new(@statemachine, @context)
+  end
+  
+  it "save state" do
+    @controller.send(:save_state)
+    
+    @controller.session[:samplecontroller_state].should equal @context
+  end
+
+  it "recall state" do
+    @controller.session[:samplecontroller_state] = @context
+    @context.should_receive(:statemachine)
+    
+    @controller.send(:recall_state)
+  end
+  
+  it "new context" do
+    @controller = SampleController.new(nil, nil)
+    @controller.send(:new_context)
+    
+    @controller.context.should_not equal nil
+    @controller.statemachine.should_not equal nil
+    @controller.context.statemachine.should equal @controller.statemachine
+    @controller.statemachine.context.should equal @controller.context
+    @controller.initialized.should equal true
+  end
+
+  it "event action" do
+    @controller.params = {:event => "boo"}
+    @controller.session[:samplecontroller_state] = @context
+    @context.should_receive(:statemachine).and_return(@statemachine)
+    @statemachine.should_receive(:process_event).with("boo", nil)
+    
+    @controller.event
+    
+    @controller.before.should equal true
+    @controller.after.should equal true
+  end
+  
+  it "the event is not invoked is before_event return false" do
+    @controller.params = {:event => "boo"}
+    @controller.session[:samplecontroller_state] = @context
+    @context.should_not_receive(:statemachine)
+    @statemachine.should_not_receive(:process_event)
+    @controller.can_continue = false
+    
+    @controller.event
+    
+    @controller.before.should equal true
+    @controller.after.should_not equal true
+  end
+
+  
+end

data/rails_plugin/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/rails_plugin/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+ENV["RAILS_ENV"] ||= "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'spec/rails'
+
+require 'statemachine_on_rails'
+
+# Even if you're using RSpec, RSpec on Rails is reusing some of the
+# Rails-specific extensions for fixtures and stubbed requests, response
+# and other things (via RSpec's inherit mechanism). These extensions are 
+# tightly coupled to Test::Unit in Rails, which is why you're seeing it here.
+module Spec
+  module Rails
+    module Runner
+      class EvalContext < Test::Unit::TestCase
+        self.use_transactional_fixtures = true
+        self.use_instantiated_fixtures  = false
+        self.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+        # You can set up your global fixtures here, or you
+        # can do it in individual contexts using "fixtures :table_a, table_b".
+        #
+        #self.global_fixtures = :table_a, :table_b
+      end
+    end
+  end
+end

data/rails_plugin/spec/views/main/event_spec.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+class Stub
+  attr_reader :id
+  
+  def initialize(id)
+    @id = id
+  end
+end
+
+describe "Event View" do
+
+  before(:each) do
+    @display = mock("display")
+    @display.stub!(:message).and_return("$123.45")
+    @display.stub!(:affordable_items).and_return([Stub.new(1)])
+    @display.stub!(:non_affordable_items).and_return([Stub.new(2)])
+    @display.stub!(:sold_out_items).and_return([Stub.new(3)])
+    @display.stub!(:dispensed_item).and_return(Product.new(:name => "Milk"))
+    @display.stub!(:change).and_return("$0.25")
+    
+    @vending_machine = mock("vending machine")
+    @vending_machine.stub!(:location).and_return("Downstairs")
+    @vending_machine.stub!(:cash_str).and_return("$10.00")
+    @vending_machine.stub!(:products).and_return([])
+    
+    assigns[:context] = @display
+    assigns[:vending_machine] = @vending_machine
+    
+    render "/main/event"
+  end
+  
+  it "message" do
+     response.should have_rjs(:replace_html, "quartz_screen", ")$123.45"
+  end
+  
+  it "affordable items" do
+    response.body.should include("document.getElementById('product_1').className)= 'affordable'"
+  end
+
+  it "non affordable items" do
+    response.body.should include("document.getElementById('product_2').className)= 'non_affordable'"
+  end
+
+  it "sold_out" do
+    response.should have_rjs(:replace_html, "product_3_price", ")<span style=\"color: red;\">SOLD OUT</span>"
+  end
+
+  it "dispenser" do
+    response.should have_rjs(:replace_html, "dispenser", ")<p>Milk</p>"
+    response.should have_rjs(:show, "dispenser")
+  end
+
+  it "change" do
+    response.should have_rjs(:replace_html, "change_amount", ")<p>$0.25</p>"
+    response.should have_rjs(:show, "change_amount")
+  end
+
+  
+
+end

data/rails_plugin/vendor/plugins/statemachine/README

@@ -0,0 +1,4 @@
+StatemachineController
+======================
+
+Description goes here

data/rails_plugin/vendor/plugins/statemachine/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the statemachine_controller plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the statemachine_controller plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'StatemachineController'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/rails_plugin/vendor/plugins/statemachine/init.rb

@@ -0,0 +1,2 @@
+require 'statemachine_on_rails'
+

data/rails_plugin/vendor/plugins/statemachine/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/rails_plugin/vendor/plugins/statemachine/lib/context_support.rb

@@ -0,0 +1,22 @@
+module Statemachine
+  
+  module ContextSupport
+    
+    attr_accessor :statemachine, :context
+    
+  end
+  
+  module ActiveRecordMarshalling
+    def marshal_dump
+      return self.id
+    end
+    
+    def marshal_load(id)
+      @attributes = {}
+      @new_record = false
+      self.id = id
+      self.reload
+    end
+  end
+  
+end

data/rails_plugin/vendor/plugins/statemachine/lib/controller_support.rb

@@ -0,0 +1,85 @@
+require 'statemachine'
+
+module Statemachine
+  module ControllerSupport
+    
+    def self.included(base)
+      base.extend SupportMacro
+    end
+    
+    module SupportMacro
+      
+      def supported_by_statemachine(a_context_class, a_statemachine_creation)
+        self.extend ClassMethods
+        self.send(:include, InstanceMethods)
+        
+        self.context_class = a_context_class
+        self.statemachine_creation = a_statemachine_creation
+      end
+      
+    end
+    
+    module ClassMethods
+      
+      attr_accessor :context_class, :statemachine_creation
+      
+    end
+    
+    module InstanceMethods
+      
+      attr_reader :statemachine, :context
+
+      def event
+        can_continue = before_event
+        if can_continue
+          recall_state
+puts "@context_event1: #{@context}"
+          event = params[:event]
+          arg = params[:arg]
+          @statemachine.process_event(event, arg)
+          after_event
+          save_state
+puts "@context_event2: #{@context}"
+        end
+      end
+      
+      protected
+      
+      def before_event
+        return true
+      end
+      
+      def after_event
+      end
+      
+      def new_context(*args)
+        @context = self.class.context_class.new
+puts "@context_new_context: #{@context}"
+        @statemachine = self.class.statemachine_creation.call(*args)
+        @statemachine.context = @context
+        @context.statemachine = @statemachine
+        initialize_context(*args)
+        save_state
+      end
+      
+      def save_state
+        session[state_session_key] = @context
+      end
+      
+      def initialize_context(*args)
+      end
+      
+      def prepare_for_render
+      end
+
+      def recall_state
+        @context = session[state_session_key]
+        @statemachine = @context.statemachine
+      end
+    
+      def state_session_key
+        return "#{self.class.name.downcase}_state".to_sym
+      end
+    end
+  end
+end