ruby_speech 0.2.2 → 0.3.0

data/spec/ruby_speech/grxml_spec.rb

@@ -0,0 +1,251 @@
+require 'spec_helper'
+
+module RubySpeech
+  describe GRXML do
+    describe "#draw" do
+      it "should create a GRXML document" do
+        GRXML.draw.should == GRXML::Grammar.new
+      end
+
+      it "should have a rule with id equal to the root attribute if set" do
+        pending 'check that a rule exists with the id equal to root if that attribute is set'
+      end
+
+      # TODO: Maybe GRXML#draw should create a Rule to pass the string
+      describe "when the return value of the block is a string" do
+        it "should be inserted into the document" do
+          lambda { GRXML.draw { "Hello Fred" }}.should raise_error(InvalidChildError, "A Grammar can only accept Rule and Tag as children")
+        end
+      end
+
+      it "should allow other GRXML elements to be inserted in the document" do
+        doc = GRXML.draw(:mode => :voice, :root => 'main') { rule :id => :main, :content => "Hello Fred" }
+
+        expected_doc = GRXML::Grammar.new(:mode => :voice, :root => 'main')
+        rule = GRXML::Rule.new(:id => "main")
+        rule << "Hello Fred"
+        expected_doc << rule
+        doc.should == expected_doc
+      end
+
+      it "should raise error if given an empty rule" do
+        pending 'Reject empty rules -- http://www.w3.org/TR/2002/CR-speech-grammar-20020626/#S3.1 http://www.w3.org/Voice/2003/srgs-ir/test/rule-no-empty.grxml'
+        lambda { GRXML.draw { rule :id => 'main' }}.should raise_error
+      end
+
+      it "should allow nested block return values" do
+        doc = RubySpeech::GRXML.draw do
+          rule :scope => 'public', :id => :main do
+            "Hello Fred"
+          end
+        end
+        expected_doc = GRXML::Grammar.new
+        expected_doc << GRXML::Rule.new(:scope => :public, :id => :main, :content => "Hello Fred")
+        doc.should == expected_doc
+      end
+
+      it "should allow nested GRXML elements" do
+        doc = RubySpeech::GRXML.draw do
+          rule :id => :main, :scope => 'public' do
+            string "Hello Fred. I like ninjas and pirates"
+            one_of do
+              item :content => "ninja"
+              item :content => "pirate"
+            end
+          end
+        end
+        rule = GRXML::Rule.new(:id => :main, :scope => 'public', :content => "Hello Fred. I like ninjas and pirates")
+        oneof = GRXML::OneOf.new
+        oneof << GRXML::Item.new(:content => "ninja")
+        oneof << GRXML::Item.new(:content => "pirate")
+        rule << oneof
+        expected_doc = GRXML::Grammar.new
+        expected_doc << rule
+        doc.should == expected_doc
+      end
+
+      # TODO: maybe turn a rule embedded in anthoer rule into a ruleref??
+      describe "embedding" do
+        context "GRXML documents" do
+          let :doc1 do
+            RubySpeech::GRXML.draw :mode => :dtmf, :root => 'digits' do
+              rule :id => :digits do
+                one_of do
+                  item { "1" }
+                  item { "2" }
+                end
+              end
+            end
+          end
+
+          let :doc2 do
+            doc = doc1
+            RubySpeech::GRXML.draw do
+              embed doc
+              rule :id => :main do
+                "Hello Fred"
+              end
+            end
+          end
+
+          let :expected_doc do
+            RubySpeech::GRXML.draw do
+              rule :id => :digits do
+                one_of do
+                 item :content => "1"
+                 item :content => "2"
+                end
+              end
+              rule :id => :main, :content => 'Hello Fred'
+            end
+          end
+
+          it "should embed the document" do
+            doc2.should == expected_doc
+          end
+
+          context "of different modes (dtmf in voice or vice-versa)" do
+            it "should raise an exception"
+          end
+        end
+
+        it "GRXML elements" do
+          element = GRXML::Item.new :content => "HELLO?"
+
+          doc = RubySpeech::GRXML.draw do
+            rule :id => :main, :scope => 'public' do
+              embed element
+            end
+          end
+
+          expected_doc = RubySpeech::GRXML.draw do
+            rule :id => :main, :scope => 'public' do
+              item do
+                "HELLO?"
+              end
+            end
+          end
+
+          doc.should == expected_doc
+        end
+
+        it "strings" do
+          string = "How now, brown cow?"
+
+          doc = RubySpeech::GRXML.draw do
+            rule :id => :main, :scope => 'public' do
+              embed string
+            end
+          end
+
+          expected_doc = RubySpeech::GRXML.draw do
+            rule :id => :main, :scope => 'public' do
+              string "How now, brown cow?"
+            end
+          end
+
+          doc.should == expected_doc
+        end
+      end
+
+      it "should properly escape string input" do
+        doc = RubySpeech::GRXML.draw do
+          rule { string "I <3 nachos." }
+          rule { "I <3 nachos." }
+          rule { 'I <3 nachos.' }
+        end
+        expected_doc = GRXML::Grammar.new
+        3.times do
+          expected_doc << GRXML::Rule.new(:content => "I <3 nachos.")
+        end
+        doc.should == expected_doc
+      end
+
+      # TODO: verfify rule is in document if named in a ruleref
+      # TODO: ruleref must have named rule id
+
+      it "should allow all permutations of possible nested GRXML elements" do
+        doc = RubySpeech::GRXML.draw do
+          rule :id => "hello" do
+            string "HELLO?"
+            item :weight => 2.5
+            one_of do
+              item { "1" }
+              item { "2" }
+            end
+            ruleref :uri => '#test'
+            item { "last" }
+          end
+          rule :id => "test" do
+            string "TESTING"
+          end
+          rule :id => :hello2 do
+            item :weight => 5.5 do
+              "hello"
+            end
+            string "H...E...L...L...O?"
+            token { "test token" }
+            tag { }
+            item { "" }
+            one_of { item { "single item" } }
+          end
+        end
+        expected_doc = GRXML::Grammar.new
+        rule = GRXML::Rule.new(:id => "hello", :content => "HELLO?")
+        rule << GRXML::Item.new(:weight => 2.5)
+        oneof = GRXML::OneOf.new
+        1.upto(2) { |d| oneof << GRXML::Item.new(:content => d.to_s) }
+        rule << oneof
+        rule << GRXML::Ruleref.new(:uri => '#test')
+        rule << GRXML::Item.new(:content => "last")
+        expected_doc << rule
+
+        rule = GRXML::Rule.new(:id => "test", :content => "TESTING")
+        expected_doc << rule
+
+        rule = GRXML::Rule.new(:id => "hello2")
+        rule << GRXML::Item.new(:weight => 5.5, :content => "hello")
+        rule << "H...E...L...L...O?"
+        rule << GRXML::Token.new(:content => "test token")
+        rule << GRXML::Tag.new
+        rule << GRXML::Item.new
+        oneof = GRXML::OneOf.new
+        oneof << GRXML::Item.new(:content => "single item")
+        rule << oneof
+        expected_doc << rule
+        doc.should == expected_doc
+      end
+
+      describe "importing nested tags" do
+        let(:item) { GRXML::Item.new(:weight => 1.5, :content => "Are you a pirate or ninja?") }
+        let(:string) { "Hello Fred. I like pirates and ninjas " }
+        let :rule do
+          GRXML::Rule.new(:id => :main, :scope => 'public', :content => string).tap do |rule|
+            rule << item
+          end
+        end
+
+        let :document do
+          GRXML::Grammar.new.tap { |doc| doc << rule }.to_s
+        end
+
+        let(:import) { GRXML::Element.import parse_xml(document).root }
+
+        subject { import }
+
+        it "should work" do
+          lambda { subject }.should_not raise_error
+        end
+
+        it { should be_a GRXML::Grammar }
+
+        its(:children) { should == [rule] }
+
+        describe "rule" do
+          subject { import.children.first }
+          its(:children) { should == [string,item] }
+        end
+      end
+    end # draw
+  end # GRXML
+end # RubySpeech

data/spec/spec_helper.rb

@@ -2,6 +2,9 @@ require 'rubygems'
 require 'ruby_speech'
 require 'mocha'
 
+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')
@@ -9,6 +12,12 @@ 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.mock_with :mocha
   config.filter_run :focus => true

data/spec/support/matchers.rb

@@ -1,3 +1,7 @@
+def be_a_valid_grxml_document
+  GRXMLMatcher.new
+end
+
 def be_a_valid_ssml_document
   SSMLMatcher.new
 end
@@ -43,3 +47,46 @@ class SSMLMatcher
     end
 
 end
+
+
+class GRXMLMatcher
+  attr_reader :subject
+
+  def subject=(s)
+    if s.is_a? Nokogiri::XML::Document
+      @subject = s
+    else
+      doc = Nokogiri::XML::Document.new
+      doc << s
+      @subject = doc
+    end
+  end
+
+  def failure_message
+    " expected #{subject} to be a valid GRXML document\n#{errors}"
+  end
+
+  def negative_failure_message
+    " expected #{subject} not to be a valid GRXML document"
+  end
+
+  def description
+    "to be a valid GRXML document"
+  end
+
+  def matches?(s)
+    self.subject = s
+    GRXML_SCHEMA.valid? subject
+  end
+
+  def does_not_match?(s)
+    !matches? s
+  end
+
+  private
+
+    def errors
+      GRXML_SCHEMA.validate(subject).map(&:message).join "\n"
+    end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_speech
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-12 00:00:00.000000000 +01:00
+date: 2011-09-22 00:00:00.000000000 +01:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
-  requirement: &2153165820 !ruby/object:Gem::Requirement
+  requirement: &2164745280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2153165820
+  version_requirements: *2164745280
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2153165300 !ruby/object:Gem::Requirement
+  requirement: &2164744760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *2153165300
+  version_requirements: *2164744760
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2153164820 !ruby/object:Gem::Requirement
+  requirement: &2164744280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2153164820
+  version_requirements: *2164744280
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153164340 !ruby/object:Gem::Requirement
+  requirement: &2164743800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2153164340
+  version_requirements: *2164743800
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2153163860 !ruby/object:Gem::Requirement
+  requirement: &2164743320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: 1.6.3
   type: :development
   prerelease: false
-  version_requirements: *2153163860
+  version_requirements: *2164743320
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2153163380 !ruby/object:Gem::Requirement
+  requirement: &2164742820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *2153163380
+  version_requirements: *2164742820
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153162900 !ruby/object:Gem::Requirement
+  requirement: &2164742300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153162900
+  version_requirements: *2164742300
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2153162420 !ruby/object:Gem::Requirement
+  requirement: &2164741820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153162420
+  version_requirements: *2164741820
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2153161940 !ruby/object:Gem::Requirement
+  requirement: &2164741300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,7 +110,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153161940
+  version_requirements: *2164741300
 description: Prepare SSML and GRXML documents with ease
 email:
 - ben@langfeld.me
@@ -126,10 +126,21 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- assets/grammar-core.xsd
+- assets/grammar.xsd
 - assets/synthesis-core.xsd
 - assets/synthesis.xsd
 - assets/xml.xsd
 - lib/ruby_speech.rb
+- lib/ruby_speech/grxml.rb
+- lib/ruby_speech/grxml/element.rb
+- lib/ruby_speech/grxml/grammar.rb
+- lib/ruby_speech/grxml/item.rb
+- lib/ruby_speech/grxml/one_of.rb
+- lib/ruby_speech/grxml/rule.rb
+- lib/ruby_speech/grxml/ruleref.rb
+- lib/ruby_speech/grxml/tag.rb
+- lib/ruby_speech/grxml/token.rb
 - lib/ruby_speech/ssml.rb
 - lib/ruby_speech/ssml/audio.rb
 - lib/ruby_speech/ssml/break.rb
@@ -143,6 +154,14 @@ files:
 - lib/ruby_speech/xml.rb
 - lib/ruby_speech/xml/language.rb
 - ruby_speech.gemspec
+- spec/ruby_speech/grxml/grammar_spec.rb
+- spec/ruby_speech/grxml/item_spec.rb
+- spec/ruby_speech/grxml/one_of_spec.rb
+- spec/ruby_speech/grxml/rule_spec.rb
+- spec/ruby_speech/grxml/ruleref_spec.rb
+- spec/ruby_speech/grxml/tag_spec.rb
+- spec/ruby_speech/grxml/token_spec.rb
+- spec/ruby_speech/grxml_spec.rb
 - spec/ruby_speech/ssml/audio_spec.rb
 - spec/ruby_speech/ssml/break_spec.rb
 - spec/ruby_speech/ssml/emphasis_spec.rb
@@ -179,6 +198,14 @@ signing_key:
 specification_version: 3
 summary: A ruby library for TTS & ASR document preparation
 test_files:
+- spec/ruby_speech/grxml/grammar_spec.rb
+- spec/ruby_speech/grxml/item_spec.rb
+- spec/ruby_speech/grxml/one_of_spec.rb
+- spec/ruby_speech/grxml/rule_spec.rb
+- spec/ruby_speech/grxml/ruleref_spec.rb
+- spec/ruby_speech/grxml/tag_spec.rb
+- spec/ruby_speech/grxml/token_spec.rb
+- spec/ruby_speech/grxml_spec.rb
 - spec/ruby_speech/ssml/audio_spec.rb
 - spec/ruby_speech/ssml/break_spec.rb
 - spec/ruby_speech/ssml/emphasis_spec.rb