adzap-voice_form 0.2.0 → 0.3.0

data/lib/voice_form/form_methods.rb

@@ -1,13 +1,13 @@
 module VoiceForm
  
   def self.included(base)
-    base.extend MacroMethods
+    base.extend ClassMethods
     base.class_eval do
       include FormMethods
     end
   end
   
-  module MacroMethods
+  module ClassMethods
     
     def voice_form(options={}, &block)
       raise "Voice form requires block" unless block_given?
@@ -16,24 +16,32 @@ module VoiceForm
         include InstanceMethods
     
         cattr_accessor :voice_form_options
-        attr_accessor :form, :call_context
+        attr_accessor :form, :call
       end
 
       self.voice_form_options = [options, block]
     end
+
+    def start_voice_form(call)
+      raise "No voice form defined" unless voice_form_options
+      self.new.start_voice_form(call)
+    end
     
   end
 
   module InstanceMethods
-  
+
     def start_voice_form(call)
-      raise "No voice form defined" unless self.voice_form_options
+      raise "No voice form defined" unless self.class.voice_form_options
       options, block = *self.class.voice_form_options
-      @call_context = call
+      @call = call
       self.form = VoiceForm::Form.new(options, &block)
       self.form.run(self)
     end
 
+    def as_digits(string)
+      string.scan(/\d/).map {|v| v.to_i }
+    end
   end
 
   module FormMethods
@@ -44,9 +52,7 @@ module VoiceForm
       
       form_field = VoiceForm::FormField.new(field_name, options, self, &block)
       
-      raise 'A field requires a prompt to be defined' if form_field.prompts.empty?
-      
-      if self.class == VoiceForm::Form
+      if self.is_a?(VoiceForm::Form)
         self.form_stack << form_field
       else
         unless self.respond_to?(field_name)

data/spec/form_field_spec.rb

@@ -3,67 +3,67 @@ require File.dirname(__FILE__) + '/spec_helper'
 describe VoiceForm::FormField do
   include VoiceForm::FormMethods
 
-  attr_accessor :call_context, :my_field
+  attr_accessor :call, :my_field
 
   before do
-    @call_context = mock('CallContext', :play => nil, :speak => nil)
-    @call_context.stub!(:input).with(any_args).and_return('')
+    @call = mock('Call', :play => nil, :speak => nil)
+    @call.stub!(:input).with(any_args).and_return('')
   end
 
   it "should define accessor for field in component" do
     field(:my_field) do
-      prompt :speak => 'test'
+      prompt :play => 'test'
     end
     self.methods.include?(:my_field)
   end
 
   it "should raise error if no prompts defined" do
-    item = form_field(:my_field) do
-    end
-    lambda { item.run }.should raise_error
+    lambda {
+      form_field(:my_field) {}
+    }.should raise_error
   end
 
   it "should raise error if reprompt defined before prompt" do
     lambda {
       form_field(:my_field) do
-        reprompt :speak => 'and again'
+        reprompt :play => 'again'
       end
      }.should raise_error
   end
 
   it "should return same prompt for for all attempts if single prompt" do
     item = form_field(:my_field) do
-      prompt :speak => "first"
+      prompt :play => "first"
     end
-    item.send(:prompt_for_attempt, 1)[:speak].should == 'first'
-    item.send(:prompt_for_attempt, 2)[:speak].should == 'first'
+    item.send(:prompt_for_attempt, 1)[:message].should == 'first'
+    item.send(:prompt_for_attempt, 2)[:message].should == 'first'
   end
 
   it "should return reprompt for subsequent prompts" do
     item = form_field(:my_field) do
-      prompt :speak => "first"
-      reprompt :speak => 'next'
+      prompt :play => "first"
+      reprompt :play => 'next'
     end
-    item.send(:prompt_for_attempt, 1)[:speak].should == 'first'
-    item.send(:prompt_for_attempt, 2)[:speak].should == 'next'
-    item.send(:prompt_for_attempt, 3)[:speak].should == 'next'
+    item.send(:prompt_for_attempt, 1)[:message].should == 'first'
+    item.send(:prompt_for_attempt, 2)[:message].should == 'next'
+    item.send(:prompt_for_attempt, 3)[:message].should == 'next'
   end
 
   it "should return prompt for given number of repeats before subsequent prompts" do
     item = form_field(:my_field) do
-      prompt :speak => "first", :repeats => 2
-      reprompt :speak => 'next'
+      prompt :play => "first", :repeats => 2
+      reprompt :play => 'next'
     end
-    item.send(:prompt_for_attempt, 1)[:speak].should == 'first'
-    item.send(:prompt_for_attempt, 2)[:speak].should == 'first'
-    item.send(:prompt_for_attempt, 3)[:speak].should == 'next'
+    item.send(:prompt_for_attempt, 1)[:message].should == 'first'
+    item.send(:prompt_for_attempt, 2)[:message].should == 'first'
+    item.send(:prompt_for_attempt, 3)[:message].should == 'next'
   end
 
   it "should set input value in component" do
     item = form_field(:my_field, :length => 3) do
-      prompt :speak => "first"
+      prompt :play => "first"
     end
-    call_context.stub!(:input).and_return('123')
+    call.stub!(:input).and_return('123')
     item.run
 
     my_field.should == '123'
@@ -72,10 +72,10 @@ describe VoiceForm::FormField do
   it "should run setup callback once" do
     call_me = i_should_be_called
     item = form_field(:my_field, :attempts => 3) do
-      prompt :speak => "first"
+      prompt :play => "first"
       setup { call_me.call }
     end
-    call_context.should_receive(:input).and_return('')
+    call.should_receive(:input).and_return('')
 
     item.run
   end
@@ -83,38 +83,49 @@ describe VoiceForm::FormField do
   it "should run timeout callback if no input" do
     call_me = i_should_be_called
     item = form_field(:my_field, :attempts => 1) do
-      prompt :speak => "first"
+      prompt :play => "first"
       timeout { call_me.call }
     end
-    call_context.should_receive(:input).and_return('')
+    call.should_receive(:input).and_return('')
+
+    item.run
+  end
+
+  it "should run timeout callback if input not valid length" do
+    call_me = i_should_be_called
+    item = form_field(:my_field, :attempts => 1, :length => 3) do
+      prompt :play => "first"
+      timeout { call_me.call }
+    end
+    call.should_receive(:input).and_return('12')
 
     item.run
   end
 
   it "should make all attempts to get valid input" do
     item = form_field(:my_field) do
-      prompt :speak => "first"
+      prompt :play => "first"
     end
-    call_context.should_receive(:input).exactly(3).times
+    call.should_receive(:input).exactly(3).times
 
     item.run
   end
 
   it "should make one attempt if input is valid" do
     item = form_field(:my_field) do
-      prompt :speak => "first"
+      prompt :play => "first"
     end
     item.stub!(:input_valid?).and_return(true)
-    call_context.should_receive(:input).once
+    call.should_receive(:input).once
 
     item.run
   end
 
   it "should check if input_valid?" do
     item = form_field(:my_field, :length => 3) do
-      prompt :speak => "first"
+      prompt :play => "first"
     end
-    call_context.should_receive(:input).and_return('123')
+    call.should_receive(:input).and_return('123')
     item.should_receive(:input_valid?)
 
     item.run
@@ -123,10 +134,10 @@ describe VoiceForm::FormField do
   it "should run validation callback if defined" do
     call_me = i_should_be_called
     item = form_field(:my_field, :length => 3, :attempts => 1) do
-      prompt :speak => "first"
+      prompt :play => "first"
       validate { call_me.call }
     end
-    call_context.stub!(:input).and_return('123')
+    call.stub!(:input).and_return('123')
 
     item.run
   end
@@ -134,10 +145,10 @@ describe VoiceForm::FormField do
   it "should run confirm callback if defined" do
     call_me = i_should_be_called
     item = form_field(:my_field, :length => 3, :attempts => 1) do
-      prompt :speak => "first"
+      prompt :play => "first"
       confirm { call_me.call; [] }
     end
-    call_context.stub!(:input).and_return('123')
+    call.stub!(:input).and_return('123')
 
     item.run
   end
@@ -147,81 +158,81 @@ describe VoiceForm::FormField do
     it "should not run if not valid input" do
       dont_call_me = i_should_not_be_called
       item = form_field(:my_field, :length => 3, :attempts => 1) do
-        prompt :speak => "first"
+        prompt :play => "first"
         validate { false }
         confirm { dont_call_me.call }
       end
-      call_context.stub!(:input).and_return('123')
+      call.stub!(:input).and_return('123')
 
       item.run
     end
 
     it "should be run the number of attempts if no valid response" do
-      call_context.should_receive(:input).with(3, anything).and_return('123')
+      call.should_receive(:input).with(3, anything).and_return('123')
       item = form_field(:my_field, :length => 3, :attempts => 1) do
-        prompt :speak => "first"
+        prompt :play => "first"
 
         confirm(:attempts => 3) { [] }
       end
-      call_context.should_receive(:input).with(1, anything).exactly(3).times.and_return('')
+      call.should_receive(:input).with(1, anything).exactly(3).times.and_return('')
 
       item.run
     end
 
     it "should run success callback if accept value entered" do
       call_me = i_should_be_called
-      call_context.should_receive(:input).with(3, anything).and_return('123')
+      call.should_receive(:input).with(3, anything).and_return('123')
       item = form_field(:my_field, :length => 3, :attempts => 1) do
-        prompt :speak => "first"
+        prompt :play => "first"
 
         success { call_me.call }
         confirm(:accept => '1', :reject => '2') { [] }
       end
-      call_context.should_receive(:input).with(1, anything).and_return('1')
+      call.should_receive(:input).with(1, anything).and_return('1')
 
       item.run
     end
 
     it "should run failure callback if reject value entered" do
       call_me = i_should_be_called
-      call_context.should_receive(:input).with(3, anything).and_return('123')
+      call.should_receive(:input).with(3, anything).and_return('123')
       item = form_field(:my_field, :length => 3, :attempts => 1) do
-        prompt :speak => "first"
+        prompt :play => "first"
 
         failure { call_me.call }
         confirm(:accept => '1', :reject => '2') { [] }
       end
-      call_context.should_receive(:input).with(1, anything).and_return('2')
+      call.should_receive(:input).with(1, anything).and_return('2')
 
       item.run
     end
 
     it "should play confirmation input prompt if confirm block return value is array" do
       call_me = i_should_be_called
-      call_context.should_receive(:input).with(3, anything).and_return('123')
+      call.should_receive(:input).with(3, anything).and_return('123')
 
       item = form_field(:my_field, :length => 3, :attempts => 1) do
-        prompt :speak => "first"
+        prompt :play => "first"
 
         success { call_me.call }
         confirm(:timeout => 3) { [] }
       end
-      call_context.should_receive(:input).with(1, {:play => [], :timeout => 3}).and_return('1')
+      call.should_receive(:input).with(1, {:play => [], :timeout => 3}).and_return('1')
 
       item.run
     end
 
     it "should speak confirmation input prompt if confirm block return value is string" do
       call_me = i_should_be_called
-      call_context.should_receive(:input).with(3, anything).and_return('123')
+      call.should_receive(:input).with(3, anything).and_return('123')
 
       item = form_field(:my_field, :length => 3, :attempts => 1) do
-        prompt :speak => "first"
+        prompt :play => "first"
 
         success { call_me.call }
-        confirm(:timeout => 3) { '' }
+        confirm(:timeout => 3) { 'speak me' }
       end
-      call_context.should_receive(:input).with(1, {:speak => '', :timeout => 3}).and_return('1')
+      call.should_receive(:input).with(1, {:speak => 'speak me', :timeout => 3}).and_return('1')
 
       item.run
     end
@@ -230,10 +241,10 @@ describe VoiceForm::FormField do
   it "should run failure callback if no input" do
     call_me = i_should_be_called
     item = form_field(:my_field, :length => 3) do
-      prompt :speak => "first"
+      prompt :play => "first"
       failure { call_me.call }
     end
-    call_context.should_receive(:input).and_return('')
+    call.should_receive(:input).and_return('')
 
     item.run
   end
@@ -241,10 +252,10 @@ describe VoiceForm::FormField do
   it "should run success callback if input valid length" do
     call_me = i_should_be_called
     item = form_field(:my_field, :length => 3) do
-      prompt :speak => "first"
+      prompt :play => "first"
       success { call_me.call }
     end
-    call_context.should_receive(:input).and_return('123')
+    call.should_receive(:input).and_return('123')
 
     item.run
   end
@@ -253,14 +264,34 @@ describe VoiceForm::FormField do
     validate_me = i_should_be_called
     call_me = i_should_be_called
     item = form_field(:my_field, :length => 3) do
-      prompt :speak => "first"
+      prompt :play => "first"
       validate do
         validate_me.call
         my_field.to_i > 100
       end
       success { call_me.call }
     end
-    call_context.should_receive(:input).and_return('123')
+    call.should_receive(:input).and_return('123')
+
+    item.run
+  end
+
+  it "should execute input with message when bargein is true" do
+    item = form_field(:my_field, :length => 3) do
+      prompt :play => "first", :bargein => true
+    end
+    call.should_not_receive(:play)
+    call.should_receive(:input).with(3, :play => "first", :timeout => 5)
+
+    item.run
+  end
+
+  it "should execute playback method with message and input without message when bargein is false" do
+    item = form_field(:my_field, :length => 3) do
+      prompt :play => "first", :bargein => false
+    end
+    call.should_receive(:play).with('first')
+    call.should_receive(:input).with(3, :timeout => 5)
 
     item.run
   end

data/spec/form_spec.rb

@@ -3,36 +3,41 @@ require File.dirname(__FILE__) + '/spec_helper'
 describe VoiceForm::Form do
   include VoiceForm
 
-  attr_accessor :call_context
+  attr_accessor :call
   
   before do
-    new_voice_form
-    @call_context = mock('CallContext', :play => nil, :speak => nil)
-    @call_context.stub!(:input).with(any_args).and_return('')
+    @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
-   
-    self.class.voice_form &call_me
-   
-    start_voice_form(@call_context)
+    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
-    form.setup &i_should_be_called
-    
+    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
     
-    form.field(:my_field) do
-      prompt :speak => 'enter value'
-      setup { call_me.call }
+    voice_form do
+      field(:my_field) do
+        prompt :play => nil
+        setup { call_me.call }
+      end
     end
-    
+
     run_form
   end
   
@@ -40,14 +45,16 @@ describe VoiceForm::Form do
     first_call_me = i_should_be_called
     second_call_me = i_should_be_called
     
-    form.field(:first_field) do
-      prompt :speak => 'enter value'
-      setup { first_call_me.call }
-    end
-    form.field(:second_field) do
-      prompt :speak => 'enter value'
-      setup { second_call_me.call }
-    end
+    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
@@ -55,7 +62,10 @@ describe VoiceForm::Form do
   it "should run do_blocks" do
     do_block_call_me = i_should_be_called
 
-    form.do_block { do_block_call_me.call }
+    voice_form do
+      do_block { do_block_call_me.call }
+      field(:my_field) { prompt :play => nil }
+    end
     
     run_form
   end
@@ -64,11 +74,13 @@ describe VoiceForm::Form do
     field_call_me = i_should_be_called
     do_block_call_me = i_should_be_called
     
-    form.field(:first_field) do
-      prompt :speak => 'enter value'
-      setup { field_call_me.call }
+    voice_form do
+      field(:first_field) do
+        prompt :play => nil
+        setup { field_call_me.call }
+      end
+      do_block { do_block_call_me.call }
     end
-    form.do_block { do_block_call_me.call }
     
     run_form
   end
@@ -78,17 +90,19 @@ describe VoiceForm::Form do
     do_block_call_me = i_should_not_be_called
     second_call_me   = i_should_be_called
     
-    form.field(:first_field, :attempts => 1) do
-      prompt :speak => 'enter value'
-      setup { first_call_me.call }
-      failure { form.goto :second_field }
-    end
-    
-    form.do_block { do_block_call_me.call }
+    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 }
 
-    form.field(:second_field) do
-      prompt :speak => 'enter value'
-      setup { second_call_me.call }
+      field(:second_field) do
+        prompt :play => nil
+        setup { second_call_me.call }
+      end
     end
     
     run_form
@@ -99,22 +113,24 @@ describe VoiceForm::Form do
     do_block_call_me = i_should_be_called(2)
     second_call_me   = i_should_be_called(2)
     
-    form.field(:first_field, :attempts => 1) do
-      prompt :speak => 'enter value'
-      setup { first_call_me.call }
-    end
+    voice_form do
+      field(:first_field, :attempts => 1) do
+        prompt :play => nil
+        setup { first_call_me.call }
+      end
     
-    form.do_block { do_block_call_me.call }
+      do_block { do_block_call_me.call }
 
-    form.field(:second_field) do
-      prompt :speak => 'enter value'
-      setup { second_call_me.call }
-      failure { 
-        unless @once
-          @once = true
-          form.goto :first_field 
-        end
-      }
+      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
@@ -125,22 +141,24 @@ describe VoiceForm::Form do
     do_block_call_me = i_should_be_called(2)
     second_call_me   = i_should_be_called(2)
     
-    form.field(:first_field, :attempts => 1) do
-      prompt :speak => 'enter value'
-      setup { first_call_me.call }
-    end
-    
-    form.do_block { do_block_call_me.call }
+    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 }
 
-    form.field(:second_field) do
-      prompt :speak => 'enter value'
-      setup { second_call_me.call }
-      failure { 
-        unless @once
-          @once = true
-          form.restart
-        end
-      }
+      field(:second_field) do
+        prompt :play => nil
+        setup { second_call_me.call }
+        failure {
+          unless @once
+            @once = true
+            form.restart
+          end
+        }
+      end
     end
     
     run_form
@@ -151,31 +169,31 @@ describe VoiceForm::Form do
     do_block_call_me = i_should_not_be_called
     second_call_me   = i_should_not_be_called
     
-    form.field(:first_field, :attempts => 1) do
-      prompt :speak => 'enter value'
-      setup   { first_call_me.call }
-      failure { form.exit }
-    end
-    
-    form.do_block { do_block_call_me.call }
+    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 }
 
-    form.field(:second_field) do
-      prompt :speak => 'enter value'
-      setup { second_call_me.call }
+      field(:second_field) do
+        prompt :play => nil
+        setup { second_call_me.call }
+      end
     end
     
     run_form
   end
   
   describe "current_field" do
-    before do
-      @field = nil
-    end
-    
     it "should be name of current field being run" do
-      form.field(:my_field) do
-        prompt :speak => 'enter value'
-        setup { @field = form.current_field }
+      voice_form do
+        field(:my_field) do
+          prompt :play => nil
+          setup { @field = form.current_field }
+        end
       end
       run_form
       
@@ -183,8 +201,9 @@ describe VoiceForm::Form do
     end
     
     it "should be nil in do_block" do
-      form.do_block do
-        @field = form.current_field
+      voice_form do
+        field(:my_field) { prompt :play => nil }
+        do_block { @field = form.current_field }
       end
       run_form
       
@@ -192,8 +211,8 @@ describe VoiceForm::Form do
     end
     
     it "should be nil after form is run" do
-      form.field(:my_field) do
-        prompt :speak => 'enter value'
+      voice_form do
+        field(:my_field) { prompt :play => nil }
       end
       run_form
       
@@ -201,8 +220,8 @@ describe VoiceForm::Form do
     end
   end
 
-  def new_voice_form
-    self.class.voice_form { }
+  def voice_form(&block)
+    self.class.voice_form &block
     options, block = *self.class.voice_form_options
     self.form = VoiceForm::Form.new(options, &block)
   end