voice_form 0.3.0

data/spec/form_spec.rb

@@ -0,0 +1,232 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe VoiceForm::Form do
+  include VoiceForm
+
+  attr_accessor :call
+  
+  before do
+    @call = mock('CallContext', :play => nil, :speak => nil)
+    @call.stub!(:input).with(any_args).and_return('')
+  end
+
+  it "should define form and run it" do
+    call_me = i_should_be_called
+    voice_form do
+      field(:my_field) { prompt :play => nil }
+      setup { call_me.call }
+    end
+    start_voice_form(@call)
+  end
+
+  it "should call setup block" do
+    call_me = i_should_be_called
+    voice_form do
+      setup { call_me.call }
+      field(:my_field) { prompt :play => nil }
+    end
+    run_form
+  end
+  
+  it "should run single form field" do
+    call_me = i_should_be_called
+    
+    voice_form do
+      field(:my_field) do
+        prompt :play => nil
+        setup { call_me.call }
+      end
+    end
+
+    run_form
+  end
+  
+  it "should run all form fields" do
+    first_call_me = i_should_be_called
+    second_call_me = i_should_be_called
+    
+    voice_form do
+      field(:first_field) do
+        prompt :play => nil
+        setup { first_call_me.call }
+      end
+      field(:second_field) do
+        prompt :play => nil
+        setup { second_call_me.call }
+      end
+   end
+    
+    run_form
+  end
+  
+  it "should run do_blocks" do
+    do_block_call_me = i_should_be_called
+
+    voice_form do
+      do_block { do_block_call_me.call }
+      field(:my_field) { prompt :play => nil }
+    end
+    
+    run_form
+  end
+  
+  it "should run all fields and do_blocks" do
+    field_call_me = i_should_be_called
+    do_block_call_me = i_should_be_called
+    
+    voice_form do
+      field(:first_field) do
+        prompt :play => nil
+        setup { field_call_me.call }
+      end
+      do_block { do_block_call_me.call }
+    end
+    
+    run_form
+  end
+  
+  it "should jump forward in form stack to field in goto" do
+    first_call_me    = i_should_be_called
+    do_block_call_me = i_should_not_be_called
+    second_call_me   = i_should_be_called
+    
+    voice_form do
+      field(:first_field, :attempts => 1) do
+        prompt :play => nil
+        setup { first_call_me.call }
+        failure { form.goto :second_field }
+      end
+      
+      do_block { do_block_call_me.call }
+
+      field(:second_field) do
+        prompt :play => nil
+        setup { second_call_me.call }
+      end
+    end
+    
+    run_form
+  end
+  
+  it "should jump back in form stack to goto field and repeat form stack items" do
+    first_call_me    = i_should_be_called(2)
+    do_block_call_me = i_should_be_called(2)
+    second_call_me   = i_should_be_called(2)
+    
+    voice_form do
+      field(:first_field, :attempts => 1) do
+        prompt :play => nil
+        setup { first_call_me.call }
+      end
+    
+      do_block { do_block_call_me.call }
+
+      field(:second_field) do
+        prompt :play => nil
+        setup { second_call_me.call }
+        failure {
+          unless @once
+            @once = true
+            form.goto :first_field
+          end
+        }
+      end
+    end
+    
+    run_form
+  end
+
+  it "should restart form and repeat all form stack items" do
+    first_call_me    = i_should_be_called(2)
+    do_block_call_me = i_should_be_called(2)
+    second_call_me   = i_should_be_called(2)
+    
+    voice_form do
+      field(:first_field, :attempts => 1) do
+        prompt :play => nil
+        setup { first_call_me.call }
+      end
+      
+      do_block { do_block_call_me.call }
+
+      field(:second_field) do
+        prompt :play => nil
+        setup { second_call_me.call }
+        failure {
+          unless @once
+            @once = true
+            form.restart
+          end
+        }
+      end
+    end
+    
+    run_form
+  end
+  
+  it "should exit form and not run subsequent fields" do
+    first_call_me    = i_should_be_called
+    do_block_call_me = i_should_not_be_called
+    second_call_me   = i_should_not_be_called
+    
+    voice_form do
+      field(:first_field, :attempts => 1) do
+        prompt :play => nil
+        setup   { first_call_me.call }
+        failure { form.exit }
+      end
+      
+      do_block { do_block_call_me.call }
+
+      field(:second_field) do
+        prompt :play => nil
+        setup { second_call_me.call }
+      end
+    end
+    
+    run_form
+  end
+  
+  describe "current_field" do
+    it "should be name of current field being run" do
+      voice_form do
+        field(:my_field) do
+          prompt :play => nil
+          setup { @field = form.current_field }
+        end
+      end
+      run_form
+      
+      @field.should == :my_field
+    end
+    
+    it "should be nil in do_block" do
+      voice_form do
+        field(:my_field) { prompt :play => nil }
+        do_block { @field = form.current_field }
+      end
+      run_form
+      
+      @field.should be_nil
+    end
+    
+    it "should be nil after form is run" do
+      voice_form do
+        field(:my_field) { prompt :play => nil }
+      end
+      run_form
+      
+      form.current_field.should be_nil
+    end
+  end
+
+  def voice_form(&block)
+    self.class.voice_form &block
+    options, block = *self.class.voice_form_options
+    self.form = VoiceForm::Form.new(options, &block)
+  end
+  
+  def run_form
+    form.run(self)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+$: << File.dirname(__FILE__) + '/../lib'
+$: << File.dirname(__FILE__)
+
+require 'rubygems'
+require 'spec'
+require 'active_support'
+
+require 'voice_form/form_methods'
+require 'voice_form/form'
+require 'voice_form/form_field'
+
+module SpecHelpers
+  def i_should_be_called(times=1, &block)
+    proc = mock('Proc should be called')
+    proc.should_receive(:call).exactly(times).times.instance_eval(&(block || Proc.new {}))
+    Proc.new { |*args| proc.call(*args) }
+  end
+  
+  def i_should_not_be_called(&block)
+    proc = mock('Proc should be called')
+    proc.should_not_receive(:call).instance_eval(&(block || Proc.new {}))
+    Proc.new { |*args| proc.call(*args) }
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include SpecHelpers
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: voice_form
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Adam Meehan
+autorequire: voice_form
+bindir: bin
+cert_chain: []
+
+date: 2009-03-23 00:00:00 +11:00
+default_executable: 
+dependencies: []
+
+description: A plugin for Adhearsion to create forms in the style of the VoiceXML form element.
+email: adam.meehan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+files: 
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- lib/voice_form.rb
+- lib/voice_form
+- lib/voice_form/form.rb
+- lib/voice_form/form_field.rb
+- lib/voice_form/form_methods.rb
+- spec/form_field_spec.rb
+- spec/spec_helper.rb
+- spec/form_spec.rb
+- examples/my_component.rb
+- examples/simon_game_voice_form.rb
+- History.txt
+has_rdoc: false
+homepage: http://github.com/adzap/voice_form
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A plugin for Adhearsion to create forms in the style of the VoiceXML form element.
+test_files: []
+