ruby_speech 2.1.0-java

data/spec/ruby_speech/ssml/voice_spec.rb

@@ -0,0 +1,200 @@
+require 'spec_helper'
+
+module RubySpeech
+  module SSML
+    describe Voice do
+      its(:node_name) { should == 'voice' }
+      its(:name) { should be_nil }
+
+      describe "setting options in initializers" do
+        subject { Voice.new :language => 'jp', :gender => :male, :age => 25, :variant => 2, :name => "paul" }
+
+        its(:language)  { should == 'jp' }
+        its(:gender)    { should == :male }
+        its(:age)       { should == 25 }
+        its(:variant)   { should == 2 }
+        its(:name)      { should == 'paul' }
+      end
+
+      it 'registers itself' do
+        Element.class_from_registration(:voice).should == Voice
+      end
+
+      describe "from a document" do
+        let(:document) { '<voice xml:lang="jp" gender="male" age="25" variant="2" name="paul"/>' }
+
+        subject { Element.import document }
+
+        it { should be_instance_of Voice }
+
+        its(:language)  { should == 'jp' }
+        its(:gender)    { should == :male }
+        its(:age)       { should == 25 }
+        its(:variant)   { should == 2 }
+        its(:name)      { should == 'paul' }
+      end
+
+      describe "#language" do
+        before { subject.language = 'jp' }
+
+        its(:language) { should == 'jp' }
+      end
+
+      describe "#gender" do
+        before { subject.gender = :male }
+
+        its(:gender) { should == :male }
+
+        it "with a valid gender" do
+          lambda { subject.gender = :male }.should_not raise_error
+          lambda { subject.gender = :female }.should_not raise_error
+          lambda { subject.gender = :neutral }.should_not raise_error
+        end
+
+        it "with an invalid gender" do
+          lambda { subject.gender = :something }.should raise_error(ArgumentError, "You must specify a valid gender (:male, :female, :neutral)")
+        end
+      end
+
+      describe "#age" do
+        before { subject.age = 12 }
+
+        its(:age) { should == 12 }
+
+        it "with an integer of 0" do
+          lambda { subject.age = 0 }.should_not raise_error
+        end
+
+        it "with an integer less than 0" do
+          lambda { subject.age = -1 }.should raise_error(ArgumentError, "You must specify a valid age (non-negative integer)")
+        end
+
+        it "with something other than an integer" do
+          lambda { subject.age = "bah" }.should raise_error(ArgumentError, "You must specify a valid age (non-negative integer)")
+        end
+      end
+
+      describe "#variant" do
+        before { subject.variant = 12 }
+
+        its(:variant) { should == 12 }
+
+        it "with an integer less than 1" do
+          lambda { subject.variant = 0 }.should raise_error(ArgumentError, "You must specify a valid variant (positive integer)")
+        end
+
+        it "with something other than an integer" do
+          lambda { subject.variant = "bah" }.should raise_error(ArgumentError, "You must specify a valid variant (positive integer)")
+        end
+      end
+
+      describe "#name" do
+        before { subject.name = 'george' }
+
+        its(:name) { should == 'george' }
+
+        context "with an array of names" do
+          before { subject.name = %w{george frank} }
+
+          its(:name) { should == %w{george frank} }
+        end
+      end
+
+      describe "comparing objects" do
+        it "should be equal if the content, language, gender, age, variant, name are the same" do
+          Voice.new(:language => 'jp', :gender => :male, :age => 25, :variant => 2, :name => "paul", :content => "hello").should == Voice.new(:language => 'jp', :gender => :male, :age => 25, :variant => 2, :name => "paul", :content => "hello")
+        end
+
+        describe "when the content is different" do
+          it "should not be equal" do
+            Voice.new(:content => "Hello").should_not == Voice.new(:content => "Hello there")
+          end
+        end
+
+        describe "when the language is different" do
+          it "should not be equal" do
+            Voice.new(:language => "Hello").should_not == Voice.new(:language => "Hello there")
+          end
+        end
+
+        describe "when the gender is different" do
+          it "should not be equal" do
+            Voice.new(:gender => :male).should_not == Voice.new(:gender => :female)
+          end
+        end
+
+        describe "when the age is different" do
+          it "should not be equal" do
+            Voice.new(:age => 20).should_not == Voice.new(:age => 30)
+          end
+        end
+
+        describe "when the variant is different" do
+          it "should not be equal" do
+            Voice.new(:variant => 1).should_not == Voice.new(:variant => 2)
+          end
+        end
+
+        describe "when the name is different" do
+          it "should not be equal" do
+            Voice.new(:name => "Hello").should_not == Voice.new(:name => "Hello there")
+          end
+        end
+      end
+
+      describe "<<" do
+        it "should accept String" do
+          lambda { subject << 'anything' }.should_not raise_error
+        end
+
+        it "should accept Audio" do
+          lambda { subject << Audio.new }.should_not raise_error
+        end
+
+        it "should accept Break" do
+          lambda { subject << Break.new }.should_not raise_error
+        end
+
+        it "should accept Emphasis" do
+          lambda { subject << Emphasis.new }.should_not raise_error
+        end
+
+        it "should accept Mark" do
+          lambda { subject << Mark.new }.should_not raise_error
+        end
+
+        it "should accept P" do
+          lambda { subject << P.new }.should_not raise_error
+        end
+
+        it "should accept Phoneme" do
+          lambda { subject << Phoneme.new }.should_not raise_error
+        end
+
+        it "should accept Prosody" do
+          lambda { subject << Prosody.new }.should_not raise_error
+        end
+
+        it "should accept SayAs" do
+          lambda { subject << SayAs.new(:interpret_as => :foo) }.should_not raise_error
+        end
+
+        it "should accept Sub" do
+          lambda { subject << Sub.new }.should_not raise_error
+        end
+
+        it "should accept S" do
+          lambda { subject << S.new }.should_not raise_error
+        end
+
+        it "should accept Voice" do
+          lambda { subject << Voice.new }.should_not raise_error
+        end
+
+        it "should raise InvalidChildError with non-acceptable objects" do
+          lambda { subject << 1 }.should raise_error(InvalidChildError, "A Voice can only accept String, Audio, Break, Emphasis, Mark, P, Phoneme, Prosody, SayAs, Sub, S, Voice as children")
+        end
+      end
+    end # Voice
+  end # SSML
+end # RubySpeech

data/spec/ruby_speech/ssml_spec.rb

@@ -0,0 +1,285 @@
+require 'spec_helper'
+
+module RubySpeech
+  describe SSML do
+    describe "#draw" do
+      it "should create an SSML document" do
+        expected_doc = SSML::Speak.new
+        SSML.draw.should == expected_doc
+      end
+
+      it "can draw with a language" do
+        expected_doc = SSML::Speak.new language: 'pt-BR'
+        SSML.draw(language: 'pt-BR').should == expected_doc
+      end
+
+      describe "when the return value of the block is a string" do
+        it "should be inserted into the document" do
+          expected_doc = SSML::Speak.new(:content => "Hi, I'm Fred")
+          SSML.draw { "Hi, I'm Fred" }.should == expected_doc
+        end
+      end
+
+      describe "when the return value of the block is not a string" do
+        it "should not be inserted into the document" do
+          expected_doc = SSML::Speak.new
+          SSML.draw { :foo }.should == expected_doc
+        end
+      end
+
+      describe "when inserting a string" do
+        it "should work" do
+          expected_doc = SSML::Speak.new(:content => "Hi, I'm Fred")
+          SSML.draw { string "Hi, I'm Fred" }.should == expected_doc
+        end
+      end
+
+      it "should allow other SSML elements to be inserted in the document" do
+        doc = SSML.draw { voice :gender => :male, :name => 'fred' }
+        expected_doc = SSML::Speak.new
+        expected_doc << SSML::Voice.new(:gender => :male, :name => 'fred')
+        doc.should == expected_doc
+      end
+
+      it "should allow nested block return values" do
+        doc = RubySpeech::SSML.draw do
+          voice :gender => :male, :name => 'fred' do
+            "Hi, I'm Fred."
+          end
+        end
+        expected_doc = SSML::Speak.new
+        expected_doc << SSML::Voice.new(:gender => :male, :name => 'fred', :content => "Hi, I'm Fred.")
+        doc.should == expected_doc
+      end
+
+      it "should allow nested SSML elements" do
+        doc = RubySpeech::SSML.draw do
+          voice :gender => :male, :name => 'fred' do
+            string "Hi, I'm Fred. The time is currently "
+            say_as :interpret_as => 'date', :format => 'dmy' do
+              "01/02/1960"
+            end
+          end
+        end
+        voice = SSML::Voice.new(:gender => :male, :name => 'fred', :content => "Hi, I'm Fred. The time is currently ")
+        voice << SSML::SayAs.new(:interpret_as => 'date', :format => 'dmy', :content => "01/02/1960")
+        expected_doc = SSML::Speak.new
+        expected_doc << voice
+        doc.should == expected_doc
+      end
+
+      it "should allow accessing methods defined outside the block" do
+        def foo
+          'bar'
+        end
+
+        doc = SSML.draw do
+          string foo
+        end
+
+        expected_doc = SSML::Speak.new :content => foo
+        doc.should == expected_doc
+      end
+
+      describe "embedding" do
+        it "SSML documents" do
+          doc1 = RubySpeech::SSML.draw do
+            string "Hi, I'm Fred. The time is currently "
+            say_as :interpret_as => 'date', :format => 'dmy' do
+              "01/02/1960"
+            end
+          end
+
+          doc2 = RubySpeech::SSML.draw do
+            voice :gender => :male, :name => 'fred' do
+              embed doc1
+            end
+          end
+
+          expected_doc = RubySpeech::SSML.draw do
+            voice :gender => :male, :name => 'fred' do
+              string "Hi, I'm Fred. The time is currently "
+              say_as :interpret_as => 'date', :format => 'dmy' do
+                "01/02/1960"
+              end
+            end
+          end
+
+          doc2.should == expected_doc
+        end
+
+        it "SSML elements" do
+          element = SSML::Emphasis.new(:content => "HELLO?")
+
+          doc = RubySpeech::SSML.draw do
+            voice :gender => :male, :name => 'fred' do
+              embed element
+            end
+          end
+
+          expected_doc = RubySpeech::SSML.draw do
+            voice :gender => :male, :name => 'fred' do
+              emphasis do
+                "HELLO?"
+              end
+            end
+          end
+
+          doc.should == expected_doc
+        end
+
+        it "strings" do
+          string = "How now, brown cow?"
+
+          doc = RubySpeech::SSML.draw do
+            voice :gender => :male, :name => 'fred' do
+              embed string
+            end
+          end
+
+          expected_doc = RubySpeech::SSML.draw do
+            voice :gender => :male, :name => 'fred' do
+              string "How now, brown cow?"
+            end
+          end
+
+          doc.should == expected_doc
+        end
+      end
+
+      it "should properly escape string input" do
+        doc = RubySpeech::SSML.draw do
+          voice { string "I <3 nachos." }
+          voice { "I <3 nachos." }
+        end
+        expected_doc = SSML::Speak.new
+        2.times do
+          expected_doc << SSML::Voice.new(:native_content => "I <3 nachos.")
+        end
+        doc.should == expected_doc
+      end
+
+      it "should allow all permutations of possible nested SSML elements" do
+        doc = RubySpeech::SSML.draw do
+          string "Hello world."
+          ssml_break
+          audio :src => "hello" do
+            string "HELLO?"
+            ssml_break
+            audio :src => "hello"
+            emphasis
+            prosody
+            say_as :interpret_as => 'date'
+            voice
+          end
+          emphasis do
+            string "HELLO?"
+            ssml_break
+            audio :src => "hello"
+            emphasis
+            prosody
+            say_as :interpret_as => 'date'
+            voice
+          end
+          prosody :rate => :slow do
+            string "H...E...L...L...O?"
+            ssml_break
+            audio :src => "hello"
+            emphasis
+            prosody
+            say_as :interpret_as => 'date'
+            voice
+          end
+          say_as :interpret_as => 'date', :format => 'dmy' do
+            "01/02/1960"
+          end
+          voice :gender => :male, :name => 'fred' do
+            string "Hi, I'm Fred. The time is currently "
+            say_as :interpret_as => 'date', :format => 'dmy' do
+              "01/02/1960"
+            end
+            ssml_break
+            audio :src => "hello"
+            emphasis do
+              "I'm so old"
+            end
+            prosody :rate => :fast do
+              "And yet so spritely!"
+            end
+            voice :age => 12 do
+              "And I'm young Fred"
+            end
+          end
+        end
+        expected_doc = SSML::Speak.new(:content => "Hello world.")
+        expected_doc << SSML::Break.new
+        audio = SSML::Audio.new(:src => "hello", :content => "HELLO?")
+        audio << SSML::Break.new
+        audio << SSML::Audio.new(:src => "hello")
+        audio << SSML::Emphasis.new
+        audio << SSML::Prosody.new
+        audio << SSML::SayAs.new(:interpret_as => 'date')
+        audio << SSML::Voice.new
+        expected_doc << audio
+        emphasis = SSML::Emphasis.new(:content => "HELLO?")
+        emphasis << SSML::Break.new
+        emphasis << SSML::Audio.new(:src => "hello")
+        emphasis << SSML::Emphasis.new
+        emphasis << SSML::Prosody.new
+        emphasis << SSML::SayAs.new(:interpret_as => 'date')
+        emphasis << SSML::Voice.new
+        expected_doc << emphasis
+        prosody = SSML::Prosody.new(:rate => :slow, :content => "H...E...L...L...O?")
+        prosody << SSML::Break.new
+        prosody << SSML::Audio.new(:src => "hello")
+        prosody << SSML::Emphasis.new
+        prosody << SSML::Prosody.new
+        prosody << SSML::SayAs.new(:interpret_as => 'date')
+        prosody << SSML::Voice.new
+        expected_doc << prosody
+        expected_doc << SSML::SayAs.new(:interpret_as => 'date', :format => 'dmy', :content => "01/02/1960")
+        voice = SSML::Voice.new(:gender => :male, :name => 'fred', :content => "Hi, I'm Fred. The time is currently ")
+        voice << SSML::SayAs.new(:interpret_as => 'date', :format => 'dmy', :content => "01/02/1960")
+        voice << SSML::Break.new
+        voice << SSML::Audio.new(:src => "hello")
+        voice << SSML::Emphasis.new(:content => "I'm so old")
+        voice << SSML::Prosody.new(:rate => :fast, :content => "And yet so spritely!")
+        voice << SSML::Voice.new(:age => 12, :content => "And I'm young Fred")
+        expected_doc << voice
+        doc.should == expected_doc
+      end
+    end
+
+    describe "importing nested tags" do
+      let(:say_as) { SSML::SayAs.new :interpret_as => 'date', :format => 'dmy', :content => "01/02/1960" }
+      let(:string) { "Hi, I'm Fred. The time is currently " }
+      let :voice do
+        SSML::Voice.new(:gender => :male, :name => 'fred', :content => string).tap do |voice|
+          voice << say_as
+        end
+      end
+
+      let :document do
+        SSML::Speak.new.tap { |doc| doc << voice }.to_s
+      end
+
+      let(:import) { SSML.import document }
+
+      subject { import }
+
+      it "should work" do
+        lambda { subject }.should_not raise_error
+      end
+
+      it { should be_a SSML::Speak }
+
+      its(:children) { should == [voice] }
+
+      describe "voice" do
+        subject { import.children.first }
+
+        its(:children) { should == [string, say_as] }
+      end
+    end
+  end
+end

data/spec/ruby_speech_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+
+describe RubySpeech do
+  describe ".parse" do
+    subject do
+      RubySpeech.parse example_document
+    end
+
+    context "with an SSML document" do
+      let :example_document do
+        '''<?xml version="1.0"?>
+<!DOCTYPE speak PUBLIC "-//W3C//DTD SYNTHESIS 1.0//EN"
+                  "http://www.w3.org/TR/speech-synthesis/synthesis.dtd">
+<speak version="1.0"
+       xmlns="http://www.w3.org/2001/10/synthesis"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:schemaLocation="http://www.w3.org/2001/10/synthesis
+                   http://www.w3.org/TR/speech-synthesis/synthesis.xsd"
+       xml:lang="en-US">
+  <p>
+    <s>You have 4 new messages.</s>
+    <s>The first is from Stephanie Williams and arrived at <break/> 3:45pm.
+    </s>
+    <s>
+      The subject is <prosody rate="-20%">ski trip</prosody>
+    </s>
+
+  </p>
+</speak>
+        '''
+      end
+
+      it { should be_a RubySpeech::SSML::Element }
+    end
+
+    context "with a GRXML document" do
+      let :example_document do
+        '''<?xml version="1.0" encoding="UTF-8"?>
+
+<!DOCTYPE grammar PUBLIC "-//W3C//DTD GRAMMAR 1.0//EN"
+                  "http://www.w3.org/TR/speech-grammar/grammar.dtd">
+
+<grammar xmlns="http://www.w3.org/2001/06/grammar" xml:lang="en"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://www.w3.org/2001/06/grammar
+                             http://www.w3.org/TR/speech-grammar/grammar.xsd"
+         version="1.0" mode="voice" root="basicCmd">
+
+<meta name="author" content="Stephanie Williams"/>
+
+<rule id="basicCmd" scope="public">
+  <example> please move the window </example>
+  <example> open a file </example>
+
+  <ruleref uri="http://grammar.example.com/politeness.grxml#startPolite"/>
+
+  <ruleref uri="#command"/>
+  <ruleref uri="http://grammar.example.com/politeness.grxml#endPolite"/>
+
+</rule>
+
+<rule id="command">
+  <ruleref uri="#action"/> <ruleref uri="#object"/>
+</rule>
+
+<rule id="action">
+   <one-of>
+      <item weight="10"> open   <tag>TAG-CONTENT-1</tag> </item>
+      <item weight="2">  close  <tag>TAG-CONTENT-2</tag> </item>
+      <item weight="1">  delete <tag>TAG-CONTENT-3</tag> </item>
+      <item weight="1">  move   <tag>TAG-CONTENT-4</tag> </item>
+    </one-of>
+</rule>
+
+<rule id="object">
+  <item repeat="0-1">
+    <one-of>
+      <item> the </item>
+      <item> a </item>
+    </one-of>
+  </item>
+
+  <one-of>
+      <item> window </item>
+      <item> file </item>
+      <item> menu </item>
+  </one-of>
+</rule>
+
+</grammar>
+        '''
+      end
+
+      it { should be_a RubySpeech::GRXML::Element }
+    end
+
+    context "with an NLSML document" do
+      let :example_document do
+        '''
+<result xmlns="http://www.ietf.org/xml/ns/mrcpv2" grammar="http://flight">
+  <interpretation confidence="60">
+    <input mode="speech">I want to go to Pittsburgh</input>
+    <instance>
+      <airline>
+        <to_city>Pittsburgh</to_city>
+      </airline>
+    </instance>
+  </interpretation>
+  <interpretation confidence="40">
+    <input>I want to go to Stockholm</input>
+    <instance>
+      <airline>
+        <to_city>Stockholm</to_city>
+      </airline>
+    </instance>
+  </interpretation>
+</result>
+        '''
+      end
+
+      it { should be_a RubySpeech::NLSML::Document }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'ruby_speech'
+
+include RubySpeech::GRXML
+include RubySpeech::XML::Language
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+schema_file_path = File.expand_path File.join(__FILE__, '../../assets/synthesis.xsd')
+puts "Loading the SSML Schema from #{schema_file_path}..."
+SSML_SCHEMA = Nokogiri::XML::Schema File.open(schema_file_path)
+puts "Finished loading schema."
+
+schema_file_path = File.expand_path File.join(__FILE__, '../../assets/grammar.xsd')
+puts "Loading the GRXML Schema from #{schema_file_path}..."
+GRXML_SCHEMA = Nokogiri::XML::Schema File.open(schema_file_path)
+puts "Finished loading schema."
+
+RSpec.configure do |config|
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

data/spec/support/match_examples.rb

@@ -0,0 +1,43 @@
+shared_examples_for "match" do
+  subject do
+    described_class.new :mode => :dtmf,
+              :confidence     => 1,
+              :utterance      => '6',
+              :interpretation => 'foo'
+  end
+
+  its(:mode)            { should == :dtmf }
+  its(:confidence)      { should == 1 }
+  its(:utterance)       { should == '6' }
+  its(:interpretation)  { should == 'foo' }
+
+  describe "equality" do
+    it "should be equal when mode, confidence, utterance and interpretation are the same" do
+      described_class.new(:mode => :dtmf, :confidence => 1, :utterance => '6', :interpretation => 'foo').should == described_class.new(:mode => :dtmf, :confidence => 1, :utterance => '6', :interpretation => 'foo')
+    end
+
+    describe "when the mode is different" do
+      it "should not be equal" do
+        described_class.new(:mode => :dtmf).should_not == described_class.new(:mode => :speech)
+      end
+    end
+
+    describe "when the confidence is different" do
+      it "should not be equal" do
+        described_class.new(:confidence => 1).should_not == described_class.new(:confidence => 0)
+      end
+    end
+
+    describe "when the utterance is different" do
+      it "should not be equal" do
+        described_class.new(:utterance => '6').should_not == described_class.new(:utterance => 'foo')
+      end
+    end
+
+    describe "when the interpretation is different" do
+      it "should not be equal" do
+        described_class.new(:interpretation => 'foo').should_not == described_class.new(:interpretation => 'bar')
+      end
+    end
+  end
+end