ruby_speech 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f773e0cb875c8a40f62c2fbf8763293fc1666ff7
-  data.tar.gz: 7c54e1b650e3e9542740608f108a7455c7625e9c
+  metadata.gz: 891276a2d84f160536a3eb7bd4841b96a466a462
+  data.tar.gz: b97014a5a89012d01a7a7429aa4a0a0055af58e4
 SHA512:
-  metadata.gz: 31b7e25e0214bf2738601217c0a417c308c8057a5a109f39eaa80632dbfc9fc7423122ac9dc7e7c2de665b4a6be4fe563338749f0d4093fb648246dad27656b2
-  data.tar.gz: 5140d70c2c151201ffe5fe75e14653292944111470f86caa483d4fee774fc0f92d21ddea656f62f722e95482deba0da8e6fb16e5652b3bcb4cc76041bf956392
+  metadata.gz: 54672c541a1203e51fa9058f7fff47f469854ddb551c90b0c786dd8c370bf2f9177360abe61d2bb357cf6d266b5b84e4e069851c499c7311cce9dc035acf119e
+  data.tar.gz: 9493a2b75a32fc7d2217708362848f131a69136fdade9f95fd9dff6d9b84c947567f56beb55e4535186a59fa18c66620e7933e44ca44f84d56814754044463fe

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # [develop](https://github.com/benlangfeld/ruby_speech)
 
+# [2.3.0](https://github.com/benlangfeld/ruby_speech/compare/v2.2.2...v2.3.0) - [2013-09-30](https://rubygems.org/gems/ruby_speech/versions/2.3.0)
+  * Feature: Allow generation of a boolean, date, digits, currency, number, phone or time grammar including from URIs
+  * Bugfix: Ensure that rule refs can be reused when inlining grammars
+
 # [2.2.2](https://github.com/benlangfeld/ruby_speech/compare/v2.2.1...v2.2.2) - [2013-09-03](https://rubygems.org/gems/ruby_speech/versions/2.2.2)
   * Bugfix: Fix an exception message to include object type
 

data/README.md

@@ -135,6 +135,56 @@ which becomes
 </grammar>
 ```
 
+#### Built-in grammars
+
+There are some grammars pre-defined which are available from the `RubySpeech::GRXML::Builtins` module like so:
+
+```ruby
+require 'ruby_speech'
+
+RubySpeech::GRXML::Builtins.currency
+```
+
+which yields
+
+```xml
+<grammar xmlns="http://www.w3.org/2001/06/grammar" version="1.0" xml:lang="en-US" mode="dtmf" root="currency">
+  <rule id="currency" scope="public">
+    <item repeat="0-">
+      <ruleref uri="#digit"/>
+    </item>
+    <item>*</item>
+    <item repeat="2">
+      <ruleref uri="#digit"/>
+    </item>
+  </rule>
+  <rule id="digit">
+    <one-of>
+      <item>0</item>
+      <item>1</item>
+      <item>2</item>
+      <item>3</item>
+      <item>4</item>
+      <item>5</item>
+      <item>6</item>
+      <item>7</item>
+      <item>8</item>
+      <item>9</item>
+    </one-of>
+  </rule>
+</grammar>
+```
+
+These grammars come from the VoiceXML specification, and can be used as indicated there (including parameterisation). They can be used just like any you would manually create, and there's nothing special about them except that they are already defined for you. A full list of available grammars can be found in [the API documentation](http://rubydoc.info/gems/ruby_speech/RubySpeech/GRXML/Builtins).
+
+These grammars are also available via URI like so:
+
+```ruby
+require 'ruby_speech'
+
+RubySpeech::GRXML.from_uri('builtin:dtmf/boolean?y=3;n=4')
+```
+
 #### Grammar matching
 
 It is possible to match some arbitrary input against a GRXML grammar, like so:

data/ext/ruby_speech/ruby_speech.c

@@ -50,7 +50,7 @@ static int is_match_end(pcre *compiled_regex, const char *input)
     search_input[input_size] = *search++;
     result = pcre_exec(compiled_regex, NULL, search_input, input_size + 1, 0, 0,
       ovector, sizeof(ovector) / sizeof(ovector[0]));
-    if (result > 0) return 0;
+    if (result > -1) return 0;
   }
   return 1;
 }
@@ -82,7 +82,7 @@ static VALUE method_find_match(VALUE self, VALUE buffer)
     }
     return rb_funcall(self, rb_intern("match_for_buffer"), 1, buffer);
   }
-  if (result == PCRE_ERROR_PARTIAL) {
+  if (result == PCRE_ERROR_PARTIAL || (int)strlen(input) == 0) {
     VALUE PotentialMatch = rb_const_get(GRXML, rb_intern("PotentialMatch"));
     return rb_class_new_instance(0, NULL, PotentialMatch);
   }

data/lib/ruby_speech/grxml.rb

@@ -8,6 +8,7 @@ module RubySpeech
     GRXML_NAMESPACE = 'http://www.w3.org/2001/06/grammar'
 
     %w{
+      builtins
       grammar
       rule
       item
@@ -29,5 +30,28 @@ module RubySpeech
     def self.import(other)
       Element.import other
     end
+
+    URI_REGEX = /builtin:(?<class>.*)\/(?<type>\w*)(\?)?(?<query>(\w*=\w*;?)*)?/.freeze
+
+    #
+    # Fetch a builtin grammar by URI
+    #
+    # @param [String] uri The builtin grammar URI of the form "builtin:dtmf/type?param=value"
+    #
+    # @return [RubySpeech::GRXML::Grammar] a grammar from the builtin set
+    #
+    def self.from_uri(uri)
+      match = uri.match(URI_REGEX)
+      raise ArgumentError, "Only builtin grammars are supported" unless match
+      raise ArgumentError, "Only DTMF builtins are supported" unless match[:class] == 'dtmf'
+      type = match[:type]
+      query = {}
+      match[:query].split(';').each do |s|
+        key, value = s.split('=')
+        query[key] = value
+      end
+      raise ArgumentError, "#{type} is an invalid builtin grammar" unless Builtins.respond_to?(type)
+      Builtins.send type, query
+    end
   end # GRXML
 end # RubySpeech

data/lib/ruby_speech/grxml/builtins.rb

@@ -0,0 +1,174 @@
+module RubySpeech::GRXML::Builtins
+  #
+  # Create a grammar for interpreting a boolean response, where 1 is true and two is false.
+  #
+  # @param [Hash] options Options to parameterize the grammar
+  # @option options [#to_s] :y The positive/truthy/affirmative digit
+  # @option options [#to_s] :n The negative/falsy digit
+  #
+  # @return [RubySpeech::GRXML::Grammar] a grammar for interpreting a boolean response.
+  #
+  # @raise [ArgumentError] if the :y and :n options are the same
+  #
+  def self.boolean(options = {})
+    truthy_digit = (options[:y] || options['y'] || '1').to_s
+    falsy_digit = (options[:n] || options['n'] || '2').to_s
+
+    raise ArgumentError, "Yes and no values cannot be the same" if truthy_digit == falsy_digit
+
+    RubySpeech::GRXML.draw mode: :dtmf, root: 'boolean' do
+      rule id: 'boolean', scope: 'public' do
+        one_of do
+          item do
+            tag { 'true' }
+            truthy_digit
+          end
+          item do
+            tag { 'false' }
+            falsy_digit
+          end
+        end
+      end
+    end
+  end
+
+  #
+  # Create a grammar for interpreting a date.
+  #
+  # @return [RubySpeech::GRXML::Grammar] a grammar for interpreting a date in the format yyyymmdd
+  #
+  def self.date(options = nil)
+    RubySpeech::GRXML.draw mode: :dtmf, root: 'date' do
+      rule id: 'date', scope: 'public' do
+        item repeat: '8' do
+          one_of do
+            0.upto(9) { |d| item { d.to_s } }
+          end
+        end
+      end
+    end
+  end
+
+  #
+  # Create a grammar for interpreting a string of digits.
+  #
+  # @param [Hash] options Options to parameterize the grammar
+  # @option options [#to_i] :minlength Minimum length for the string of digits.
+  # @option options [#to_i] :maxlength Maximum length for the string of digits.
+  # @option options [#to_i] :length Absolute length for the string of digits.
+  #
+  # @return [RubySpeech::GRXML::Grammar] a grammar for interpreting a boolean response.
+  #
+  # @raise [ArgumentError] if any of the length attributes logically conflict
+  #
+  def self.digits(options = {})
+    raise ArgumentError, "Cannot specify both absolute length and a length range" if options[:length] && (options[:minlength] || options[:maxlength])
+
+    minlength = options[:minlength] || options['minlength'] || 0
+    maxlength = options[:maxlength] || options['maxlength']
+    length = options[:length] || options['length']
+
+    repeat = length ? length : "#{minlength}-#{maxlength}"
+
+    RubySpeech::GRXML.draw mode: :dtmf, root: 'digits' do
+      rule id: 'digits', scope: 'public' do
+        item repeat: repeat do
+          one_of do
+            0.upto(9) { |d| item { d.to_s } }
+          end
+        end
+      end
+    end
+  end
+
+  #
+  # Create a grammar for interpreting a monetary value. Uses '*' as the decimal point.
+  # Matches any number of digits, optionally followed by a '*' and up to two more digits.
+  #
+  # @return [RubySpeech::GRXML::Grammar] a grammar for interpreting a monetary value.
+  #
+  def self.currency(options = nil)
+    RubySpeech::GRXML.draw mode: :dtmf, root: 'currency' do
+      rule id: 'currency', scope: 'public' do
+        item repeat: '0-' do
+          ruleref uri: '#digit'
+        end
+        item repeat: '0-1' do
+          item { '*' }
+          item repeat: '0-2' do
+            ruleref uri: '#digit'
+          end
+        end
+      end
+
+      rule id: 'digit' do
+        one_of do
+          0.upto(9) { |d| item { d.to_s } }
+        end
+      end
+    end
+  end
+
+  #
+  # Create a grammar for interpreting a numeric value. Uses '*' as the decimal point.
+  # Matches any number of digits, optionally followed by a '*' and any number more digits.
+  #
+  # @return [RubySpeech::GRXML::Grammar] a grammar for interpreting a numeric value.
+  #
+  def self.number(options = nil)
+    RubySpeech::GRXML.draw mode: :dtmf, root: 'number' do
+      rule id: 'number', scope: 'public' do
+        item repeat: '0-' do
+          ruleref uri: '#digit'
+        end
+        item repeat: '0-1' do
+          item { '*' }
+          item repeat: '0-' do
+            ruleref uri: '#digit'
+          end
+        end
+      end
+
+      rule id: 'digit' do
+        one_of do
+          0.upto(9) { |d| item { d.to_s } }
+        end
+      end
+    end
+  end
+
+  #
+  # Create a grammar for interpreting a phone number. Uses '*' to represent 'x' for a number with an extension.
+  #
+  # @return [RubySpeech::GRXML::Grammar] a grammar for interpreting a phone number.
+  #
+  def self.phone(options = nil)
+    RubySpeech::GRXML.draw mode: :dtmf, root: 'number' do
+      rule id: 'number', scope: 'public' do
+        item repeat: '1-' do
+          one_of do
+            0.upto(9) { |d| item { d.to_s } }
+            item { '*' }
+          end
+        end
+      end
+    end
+  end
+
+  #
+  # Create a grammar for interpreting a time.
+  #
+  # @return [RubySpeech::GRXML::Grammar] a grammar for interpreting a time.
+  #
+  def self.time(options = nil)
+    RubySpeech::GRXML.draw mode: :dtmf, root: 'time' do
+      rule id: 'time', scope: 'public' do
+        item repeat: '1-4' do
+          one_of do
+            0.upto(9) { |d| item { d.to_s } }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby_speech/grxml/grammar.rb

@@ -118,7 +118,7 @@ module RubySpeech
       def inline!
         xpath("//ns:ruleref", :ns => GRXML_NAMESPACE).each do |ref|
           rule = rule_with_id ref[:uri].sub(/^#/, '')
-          ref.swap rule.children
+          ref.swap rule.dup.children
         end
 
         query = "./ns:rule[@id!='#{root}']"

data/lib/ruby_speech/version.rb

@@ -1,3 +1,3 @@
 module RubySpeech
-  VERSION = "2.2.2"
+  VERSION = "2.3.0"
 end

data/ruby_speech.gemspec

@@ -10,6 +10,8 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/benlangfeld/ruby_speech"
   s.summary     = %q{A Ruby library for TTS & ASR document preparation}
   s.description = %q{Prepare SSML and GRXML documents with ease}
+  
+  s.license = 'MIT'
 
   s.rubyforge_project = "ruby_speech"
 

data/spec/ruby_speech/grxml/builtins_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+
+describe RubySpeech::GRXML::Builtins do
+  describe "boolean" do
+    subject(:grammar) { described_class.boolean }
+
+    it { should max_match('1').and_interpret_as('true') }
+    it { should max_match('2').and_interpret_as('false') }
+
+    it { should not_match('0') }
+    it { should not_match('3') }
+    it { should not_match('10') }
+
+    context "with the true/false digits parameterized" do
+      subject { described_class.boolean y: 3, n: 7 }
+
+      it { should max_match('3').and_interpret_as('true') }
+      it { should max_match('7').and_interpret_as('false') }
+
+      it { should not_match('1') }
+      it { should not_match('2') }
+      it { should not_match('4') }
+
+      context "both the same" do
+        it "should raise ArgumentError" do
+          expect { described_class.boolean y: '1', n: 1 }.to raise_error(ArgumentError, /same/)
+        end
+      end
+    end
+  end
+
+  describe "date" do
+    subject(:grammar) { described_class.date }
+
+    it { should max_match('20130929').and_interpret_as('dtmf-2 dtmf-0 dtmf-1 dtmf-3 dtmf-0 dtmf-9 dtmf-2 dtmf-9') }
+
+    it { should potentially_match('130929') }
+    it { should potentially_match('0929') }
+    it { should potentially_match('29') }
+    it { should potentially_match('1') }
+  end
+
+  describe "digits" do
+    subject(:grammar) { described_class.digits }
+
+    it { should match('1').and_interpret_as('dtmf-1') }
+    it { should match('123').and_interpret_as('dtmf-1 dtmf-2 dtmf-3') }
+    it { should match('1').and_interpret_as('dtmf-1') }
+
+    context "with a minimum length" do
+      subject { described_class.digits minlength: 3 }
+
+      it { should match('123').and_interpret_as('dtmf-1 dtmf-2 dtmf-3') }
+      it { should match('1234567890').and_interpret_as('dtmf-1 dtmf-2 dtmf-3 dtmf-4 dtmf-5 dtmf-6 dtmf-7 dtmf-8 dtmf-9 dtmf-0') }
+
+      it { should potentially_match('1') }
+      it { should potentially_match('11') }
+      it { should potentially_match('4') }
+    end
+
+    context "with a maximum length" do
+      subject { described_class.digits maxlength: 3 }
+
+      it { should match('1').and_interpret_as('dtmf-1') }
+      it { should match('12').and_interpret_as('dtmf-1 dtmf-2') }
+      it { should match('123').and_interpret_as('dtmf-1 dtmf-2 dtmf-3') }
+
+      it { should not_match('1111') }
+      it { should not_match('1111111') }
+    end
+
+    context "with an absolute length" do
+      subject { described_class.digits length: 3 }
+
+      it { should max_match('123').and_interpret_as('dtmf-1 dtmf-2 dtmf-3') }
+      it { should max_match('111').and_interpret_as('dtmf-1 dtmf-1 dtmf-1') }
+
+      it { should potentially_match('1') }
+      it { should potentially_match('12') }
+
+      it { should not_match('1234') }
+      it { should not_match('12345') }
+    end
+
+    context "when the min and max lengths are swapped" do
+      it "should raise ArgumentError" do
+        expect { described_class.digits minlength: 5, maxlength: 2 }.to raise_error(ArgumentError, /repeat/)
+      end
+    end
+
+    context "when the length and minlength are specified" do
+      it "should raise ArgumentError" do
+        expect { described_class.digits minlength: 5, length: 5 }.to raise_error(ArgumentError, /absolute length/)
+      end
+    end
+
+    context "when the length and maxlength are specified" do
+      it "should raise ArgumentError" do
+        expect { described_class.digits maxlength: 5, length: 5 }.to raise_error(ArgumentError, /absolute length/)
+      end
+    end
+  end
+
+  describe "currency" do
+    subject(:grammar) { described_class.currency }
+
+    it { should max_match('1*01').and_interpret_as('dtmf-1 dtmf-star dtmf-0 dtmf-1') }
+    it { should max_match('01*00').and_interpret_as('dtmf-0 dtmf-1 dtmf-star dtmf-0 dtmf-0') }
+    it { should max_match('100000000000*00').and_interpret_as('dtmf-1 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-star dtmf-0 dtmf-0') }
+    it { should max_match('0*08').and_interpret_as('dtmf-0 dtmf-star dtmf-0 dtmf-8') }
+    it { should max_match('*59').and_interpret_as('dtmf-star dtmf-5 dtmf-9') }
+
+    it { should match('0').and_interpret_as('dtmf-0') }
+    it { should match('0*0').and_interpret_as('dtmf-0 dtmf-star dtmf-0') }
+    it { should match('10*5').and_interpret_as('dtmf-1 dtmf-0 dtmf-star dtmf-5') }
+    it { should match('123').and_interpret_as('dtmf-1 dtmf-2 dtmf-3') }
+    it { should match('123*').and_interpret_as('dtmf-1 dtmf-2 dtmf-3 dtmf-star') }
+
+    it { should not_match('#') }
+  end
+
+  describe "number" do
+    subject(:grammar) { described_class.number }
+
+    it { should match('0').and_interpret_as('dtmf-0') }
+    it { should match('123').and_interpret_as('dtmf-1 dtmf-2 dtmf-3') }
+    it { should match('1*01').and_interpret_as('dtmf-1 dtmf-star dtmf-0 dtmf-1') }
+    it { should match('01*00').and_interpret_as('dtmf-0 dtmf-1 dtmf-star dtmf-0 dtmf-0') }
+    it { should match('100000000000*00').and_interpret_as('dtmf-1 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-0 dtmf-star dtmf-0 dtmf-0') }
+    it { should match('0*08').and_interpret_as('dtmf-0 dtmf-star dtmf-0 dtmf-8') }
+    it { should match('*59').and_interpret_as('dtmf-star dtmf-5 dtmf-9') }
+    it { should match('0*0').and_interpret_as('dtmf-0 dtmf-star dtmf-0') }
+    it { should match('10*5').and_interpret_as('dtmf-1 dtmf-0 dtmf-star dtmf-5') }
+    it { should match('123*').and_interpret_as('dtmf-1 dtmf-2 dtmf-3 dtmf-star') }
+    it { should match('123*2342').and_interpret_as('dtmf-1 dtmf-2 dtmf-3 dtmf-star dtmf-2 dtmf-3 dtmf-4 dtmf-2') }
+
+    it { should not_match('#') }
+  end
+
+  describe "phone" do
+    subject(:grammar) { described_class.phone }
+
+    it { should match('0').and_interpret_as('dtmf-0') }
+    it { should match('0123').and_interpret_as('dtmf-0 dtmf-1 dtmf-2 dtmf-3') }
+    it { should match('0123*456').and_interpret_as('dtmf-0 dtmf-1 dtmf-2 dtmf-3 dtmf-star dtmf-4 dtmf-5 dtmf-6') }
+    it { should match('0123*456*789').and_interpret_as('dtmf-0 dtmf-1 dtmf-2 dtmf-3 dtmf-star dtmf-4 dtmf-5 dtmf-6 dtmf-star dtmf-7 dtmf-8 dtmf-9') }
+
+    it { should potentially_match('') }
+
+    it { should not_match('#') }
+  end
+
+  describe "time" do
+    subject(:grammar) { described_class.time }
+
+    it { should max_match('1235').and_interpret_as('dtmf-1 dtmf-2 dtmf-3 dtmf-5') }
+
+    it { should match('12').and_interpret_as('dtmf-1 dtmf-2') }
+    it { should match('4').and_interpret_as('dtmf-4') }
+    it { should match('123').and_interpret_as('dtmf-1 dtmf-2 dtmf-3') }
+
+    it { should not_match('*') }
+    it { should not_match('#') }
+  end
+end

data/spec/ruby_speech/grxml/grammar_spec.rb

@@ -185,6 +185,8 @@ module RubySpeech
                   item :repeat => '4' do
                     ruleref :uri => '#digits'
                   end
+                  item { '*' }
+                  item { ruleref uri: '#digits' }
                   "#"
                 end
                 item do
@@ -205,6 +207,12 @@ module RubySpeech
                       0.upto(9) { |d| item { d.to_s } }
                     end
                   end
+                  item { '*' }
+                  item do
+                    one_of do
+                      0.upto(9) { |d| item { d.to_s } }
+                    end
+                  end
                   "#"
                 end
                 item do

data/spec/ruby_speech/grxml/matcher_spec.rb

@@ -27,6 +27,10 @@ module RubySpeech
             input.should == '6'
           end
 
+          it "should potentially match an empty buffer" do
+            subject.match('').should == GRXML::PotentialMatch.new
+          end
+
           %w{1 2 3 4 5 7 8 9 10 66 26 61}.each do |input|
             it "should not match '#{input}'" do
               subject.match(input).should == GRXML::NoMatch.new

data/spec/ruby_speech/grxml_spec.rb

@@ -2,6 +2,36 @@ require 'spec_helper'
 
 module RubySpeech
   describe GRXML do
+    describe ".from_uri" do
+      context "with a builtin URI" do
+        it "should fetch a simple builtin grammar by type" do
+          subject.from_uri("builtin:dtmf/phone").should == GRXML::Builtins.phone
+        end
+
+        it "should fetch a parameterized builtin grammar" do
+          subject.from_uri("builtin:dtmf/boolean?y=3;n=4").should == GRXML::Builtins.boolean(y: 3, n: 4)
+        end
+
+        context "for speech" do
+          it "should raise ArgumentError" do
+            expect { subject.from_uri("builtin:speech/phone") }.to raise_error(ArgumentError, /Only DTMF/)
+          end
+        end
+
+        context "that doesn't exist" do
+          it "should raise ArgumentError" do
+            expect { subject.from_uri("builtin:dtmf/foobar") }.to raise_error(ArgumentError, /invalid/)
+          end
+        end
+      end
+
+      context "with an http URI" do
+        it "should raise ArgumentError" do
+          expect { subject.from_uri("http://foo.com/grammar.grxml") }.to raise_error(ArgumentError, /builtin/)
+        end
+      end
+    end
+
     describe "#draw" do
       let(:doc) { Nokogiri::XML::Document.new }
 

data/spec/spec_helper.rb

@@ -18,4 +18,5 @@ puts "Finished loading schema."
 RSpec.configure do |config|
   config.filter_run :focus => true
   config.run_all_when_everything_filtered = true
+  config.treat_symbols_as_metadata_keys_with_true_values = true
 end

data/spec/support/grammar_matchers.rb

@@ -0,0 +1,79 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :not_match do |input|
+  match do |grammar|
+    @result = RubySpeech::GRXML::Matcher.new(grammar).match(input)
+    @result.is_a?(RubySpeech::GRXML::NoMatch)
+  end
+
+  failure_message_for_should do |grammar|
+    "expected #{grammar} to not match #{input}, but received a #{@result.class}"
+  end
+end
+
+RSpec::Matchers.define :potentially_match do |input|
+  match do |grammar|
+    @result = RubySpeech::GRXML::Matcher.new(grammar).match(input)
+    @result.is_a?(RubySpeech::GRXML::PotentialMatch)
+  end
+
+  failure_message_for_should do |grammar|
+    "expected #{grammar} to potentially match #{input}, but received a #{@result.class}"
+  end
+end
+
+RSpec::Matchers.define :match do |input|
+  match do |grammar|
+    @result = RubySpeech::GRXML::Matcher.new(grammar).match(input)
+    @result.is_a?(RubySpeech::GRXML::Match) && (@interpretation ? @result.interpretation == @interpretation : true)
+  end
+
+  chain :and_interpret_as do |interpretation|
+    @interpretation = interpretation
+  end
+
+  description do
+    %{#{default_description} and interpret as "#{@interpretation}"}
+  end
+
+  failure_message_for_should do |grammar|
+    messages = []
+    unless @result.is_a?(RubySpeech::GRXML::Match)
+      messages << "expected #{grammar} to match, got a #{@result.class}"
+    end
+
+    if @result.respond_to?(:interpretation) && @result.interpretation != @interpretation
+      messages << %{expected interpretation to be "#{@interpretation}" but received "#{@result.interpretation}"}
+    end
+
+    messages.join(' ')
+  end
+end
+
+RSpec::Matchers.define :max_match do |input|
+  match do |grammar|
+    @result = RubySpeech::GRXML::Matcher.new(grammar).match(input)
+    @result.is_a?(RubySpeech::GRXML::MaxMatch) && (@interpretation ? @result.interpretation == @interpretation : true)
+  end
+
+  chain :and_interpret_as do |interpretation|
+    @interpretation = interpretation
+  end
+
+  description do
+    %{#{default_description} and interpret as "#{@interpretation}"}
+  end
+
+  failure_message_for_should do |grammar|
+    messages = []
+    unless @result.is_a?(RubySpeech::GRXML::MaxMatch)
+      messages << "expected #{grammar} to max-match, got a #{@result.class}"
+    end
+
+    if @result.respond_to?(:interpretation) && @result.interpretation != @interpretation
+      messages << %{expected interpretation to be "#{@interpretation}" but received "#{@result.interpretation}"}
+    end
+
+    messages.join(' ')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_speech
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Ben Langfeld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-03 00:00:00.000000000 Z
+date: 2013-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -227,6 +227,7 @@ files:
 - lib/ruby_speech.rb
 - lib/ruby_speech/generic_element.rb
 - lib/ruby_speech/grxml.rb
+- lib/ruby_speech/grxml/builtins.rb
 - lib/ruby_speech/grxml/element.rb
 - lib/ruby_speech/grxml/grammar.rb
 - lib/ruby_speech/grxml/item.rb
@@ -261,6 +262,7 @@ files:
 - lib/ruby_speech/version.rb
 - lib/ruby_speech/xml/language.rb
 - ruby_speech.gemspec
+- spec/ruby_speech/grxml/builtins_spec.rb
 - spec/ruby_speech/grxml/grammar_spec.rb
 - spec/ruby_speech/grxml/item_spec.rb
 - spec/ruby_speech/grxml/match_spec.rb
@@ -291,10 +293,12 @@ files:
 - spec/ruby_speech/ssml_spec.rb
 - spec/ruby_speech_spec.rb
 - spec/spec_helper.rb
+- spec/support/grammar_matchers.rb
 - spec/support/match_examples.rb
 - spec/support/matchers.rb
 homepage: https://github.com/benlangfeld/ruby_speech
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -317,6 +321,7 @@ signing_key:
 specification_version: 4
 summary: A Ruby library for TTS & ASR document preparation
 test_files:
+- spec/ruby_speech/grxml/builtins_spec.rb
 - spec/ruby_speech/grxml/grammar_spec.rb
 - spec/ruby_speech/grxml/item_spec.rb
 - spec/ruby_speech/grxml/match_spec.rb
@@ -347,6 +352,7 @@ test_files:
 - spec/ruby_speech/ssml_spec.rb
 - spec/ruby_speech_spec.rb
 - spec/spec_helper.rb
+- spec/support/grammar_matchers.rb
 - spec/support/match_examples.rb
 - spec/support/matchers.rb
 has_rdoc: