ruby_speech 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4f1b109d9aca99877fdea094ae7898d160c2bc5
-  data.tar.gz: 61f380357241df94f39f25db15e17433d6766bb5
+  metadata.gz: de37299d09f7a9dc63c8c5944db79f80594bfffc
+  data.tar.gz: c01558ff39e76c034f1b18df7288c27d04ec84b1
 SHA512:
-  metadata.gz: 01c6b26ae73ae0627b8ce474ea6fdddc8d0b87779a07c3908c57b71e3101ec8a447a8980a88d17de53c216442137122b03c821026146fd650066ec44030ce949
-  data.tar.gz: 7075b29b0be7f4a7f1ca2b83fc3694be0e09566dbd0ef12be3c66933538cb885053d9971a933e094ac59c5090f56bdb82774ef0c3afcd69cd4eedc21d3a2bf82
+  metadata.gz: a2dc9ae2659cc93d40f7f0d55a2d6b4344accf12f7b1d7cf130aba09c4949a868bc47e2c641183aecad8bd42b0312a50d3a14d27eb9b933664fbaaa15de60cdc
+  data.tar.gz: 3df44bf14ab55473bd2dab097e2e972493744d299390085506e90ff437eb82441f535a3b29b1a45ac73d22c1770d0f4e4de9dbbb954d3d3c7c6983f12a741b75

data/.travis.yml

@@ -7,7 +7,9 @@ rvm:
   - jruby-19mode
   - rbx-19mode
   - ruby-head
-
+matrix:
+  allow_failures:
+    # - rvm: jruby-19mode
 before_install:
   - sudo apt-get install libpcre3 libpcre3-dev
 

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # [develop](https://github.com/benlangfeld/ruby_speech)
 
+# [2.0.2](https://github.com/benlangfeld/ruby_speech/compare/v2.0.1...v2.0.2) - [2013-05-01](https://rubygems.org/gems/ruby_speech/versions/2.0.2)
+  * Bugfix: Differentiate between GRXML match cases with are and are not maximal
+    * A Match can accept further input while still matching, while a a MaxMatch cannot.
+    * Matching implementation moved down to C/Java to avoid repeated regex compilation and confusing jumping about.
+  * Bugfix: Back to functioning on JRuby with latest Nokogiri release
+
 # [2.0.1](https://github.com/benlangfeld/ruby_speech/compare/v2.0.0...v2.0.1) - [2013-04-27](https://rubygems.org/gems/ruby_speech/versions/2.0.1)
   * Bugfix: Build native C extension in the correct location
 

data/Guardfile

@@ -1,5 +1,5 @@
 guard 'rake', :task => 'compile' do
-  watch(%r{^ext/(.+)\.c$})
+  watch(%r{^ext/(.+)\.(c|java)$})
 end
 
 guard 'rspec', :cli => '--format documentation' do

data/ext/ruby_speech/RubySpeechGRXMLMatcher.java

@@ -17,26 +17,48 @@ import java.util.regex.*;
 @JRubyClass(name="RubySpeech::GRXML::Matcher")
 public class RubySpeechGRXMLMatcher extends RubyObject {
 
+  Pattern p;
+
   public RubySpeechGRXMLMatcher(final Ruby runtime, RubyClass rubyClass) {
     super(runtime, rubyClass);
   }
 
   @JRubyMethod(visibility=Visibility.PRIVATE)
-  public IRubyObject check_potential_match(ThreadContext context, IRubyObject buffer)
-  {
+  public IRubyObject compile_regex(ThreadContext context, IRubyObject regex) {
     Ruby runtime = context.getRuntime();
+    p = Pattern.compile(regex.toString());
+    return runtime.getNil();
+  }
 
-    IRubyObject regex = getInstanceVariable("@regex");
-
-    Pattern p = Pattern.compile(regex.toString());
-    Matcher m = p.matcher(buffer.toString());
+  @JRubyMethod(visibility=Visibility.PUBLIC)
+  public IRubyObject find_match(ThreadContext context, IRubyObject buffer)
+  {
+    Ruby runtime = context.getRuntime();
+    String string_buffer = buffer.toString();
+    Matcher m = p.matcher(string_buffer);
 
     if (m.matches()) {
+      if (is_max_match(string_buffer)) {
+        return RuntimeHelpers.invoke(context, this, "match_for_buffer", buffer, runtime.getTrue());
+      }
+      return callMethod(context, "match_for_buffer", buffer);
     } else if (m.hitEnd()) {
       RubyModule potential_match = runtime.getClassFromPath("RubySpeech::GRXML::PotentialMatch");
-      return RuntimeHelpers.invoke(context, potential_match, "new");
+      return potential_match.callMethod(context, "new");
     }
-    return runtime.getNil();
+    RubyModule nomatch = runtime.getClassFromPath("RubySpeech::GRXML::NoMatch");
+    return nomatch.callMethod(context, "new");
+  }
+
+  public Boolean is_max_match(String buffer)
+  {
+    String search_set = "0123456789#*ABCD";
+    for (int i = 0; i < 16; i++) {
+      String new_buffer = buffer + search_set.charAt(i);
+      Matcher m = p.matcher(new_buffer);
+      if (m.matches()) return false;
+    }
+    return true;
   }
 
 }

data/ext/ruby_speech/ruby_speech.c

@@ -2,33 +2,88 @@
 #include "pcre.h"
 #include <stdio.h>
 
-static VALUE method_check_potential_match(VALUE self, VALUE buffer)
+static VALUE method_compile_regex(VALUE self, VALUE regex_string)
 {
-  int erroffset = 0;
-  const char *errptr = "";
-  int options = 0;
-  VALUE regex_string = rb_funcall(rb_iv_get(self, "@regex"), rb_intern("to_s"), 0);
-  const char *regex = StringValueCStr(regex_string);
+  int erroffset       = 0;
+  const char *errptr  = "";
+  int options         = 0;
+  const char *regex   = StringValueCStr(regex_string);
 
   pcre *compiled_regex = pcre_compile(regex, options, &errptr, &erroffset, NULL);
+  VALUE compiled_regex_wrapper = Data_Wrap_Struct(rb_cObject, 0, pcre_free, compiled_regex);
+  rb_iv_set(self, "@regex", compiled_regex_wrapper);
 
+  return Qnil;
+}
+
+#define MAX_INPUT_SIZE 128
+#define OVECTOR_SIZE 30
+#define WORKSPACE_SIZE 1024
+
+/**
+ * Check if no more digits can be added to input and match
+ * @param compiled_regex the regex used in the initial match
+ * @param input the input to check
+ * @return true if end of match (no more input can be added)
+ */
+static int is_match_end(pcre *compiled_regex, const char *input)
+{
+  int ovector[OVECTOR_SIZE];
+  int input_size = (int)strlen(input);
+  char search_input[MAX_INPUT_SIZE + 2];
+  const char *search_set = "0123456789#*ABCD";
+  const char *search = strchr(search_set, input[input_size - 1]); /* start with last digit in input */
+
+  /* For each digit in search_set, check if input + search_set digit is a potential match.
+     If so, then this is not a match end.
+   */
+  sprintf(search_input, "%sZ", input);
+  int i;
+  for (i = 0; i < 16; i++) {
+    int result;
+    if (!*search) {
+      search = search_set;
+    }
+    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;
+  }
+  return 1;
+}
+
+static VALUE method_find_match(VALUE self, VALUE buffer)
+{
+  VALUE RubySpeech  = rb_const_get(rb_cObject, rb_intern("RubySpeech"));
+  VALUE GRXML       = rb_const_get(RubySpeech, rb_intern("GRXML"));
+  VALUE NoMatch     = rb_const_get(GRXML, rb_intern("NoMatch"));
+  pcre *compiled_regex;
   int result = 0;
-  int ovector[30];
-  int workspace[1024];
+  int ovector[OVECTOR_SIZE];
+  int workspace[WORKSPACE_SIZE];
   char *input = StringValueCStr(buffer);
-  result = pcre_dfa_exec(compiled_regex, NULL, input, strlen(input), 0, PCRE_PARTIAL,
+
+  Data_Get_Struct(rb_iv_get(self, "@regex"), pcre, compiled_regex);
+
+  if (!compiled_regex) {
+    return rb_class_new_instance(0, NULL, NoMatch);
+  }
+
+  result = pcre_dfa_exec(compiled_regex, NULL, input, (int)strlen(input), 0, PCRE_PARTIAL,
     ovector, sizeof(ovector) / sizeof(ovector[0]),
     workspace, sizeof(workspace) / sizeof(workspace[0]));
-  pcre_free(compiled_regex);
 
+  if (result > 0) {
+    if (is_match_end(compiled_regex, input)) {
+      return rb_funcall(self, rb_intern("match_for_buffer"), 2, buffer, Qtrue);
+    }
+    return rb_funcall(self, rb_intern("match_for_buffer"), 1, buffer);
+  }
   if (result == PCRE_ERROR_PARTIAL) {
-    VALUE RubySpeech      = rb_const_get(rb_cObject, rb_intern("RubySpeech"));
-    VALUE GRXML           = rb_const_get(RubySpeech, rb_intern("GRXML"));
-    VALUE PotentialMatch  = rb_const_get(GRXML, rb_intern("PotentialMatch"));
-
+    VALUE PotentialMatch = rb_const_get(GRXML, rb_intern("PotentialMatch"));
     return rb_class_new_instance(0, NULL, PotentialMatch);
   }
-  return Qnil;
+  return rb_class_new_instance(0, NULL, NoMatch);
 }
 
 void Init_ruby_speech()
@@ -37,5 +92,6 @@ void Init_ruby_speech()
   VALUE GRXML       = rb_define_module_under(RubySpeech, "GRXML");
   VALUE Matcher     = rb_define_class_under(GRXML, "Matcher", rb_cObject);
 
-  rb_define_method(Matcher, "check_potential_match", method_check_potential_match, 1);
+  rb_define_method(Matcher, "find_match", method_find_match, 1);
+  rb_define_method(Matcher, "compile_regex", method_compile_regex, 1);
 }

data/lib/ruby_speech/generic_element.rb

@@ -109,17 +109,14 @@ module RubySpeech
 
     def children(type = nil, attributes = nil)
       if type
-        expression = type.to_s
+        expression = namespace_href ? 'ns:' : ''
+        expression << type.to_s
 
         expression << '[' << attributes.inject([]) do |h, (key, value)|
-          h << "@#{key}='#{value}'"
+          h << "@#{namespace_href && Nokogiri.jruby? ? 'ns:' : ''}#{key}='#{value}'"
         end.join(',') << ']' if attributes
 
-        if namespace_href
-          xpath "ns:#{expression}", :ns => namespace_href
-        else
-          xpath expression
-        end
+        xpath expression, :ns => namespace_href
       else
         super()
       end.map { |c| self.class.import c }

data/lib/ruby_speech/grxml/grammar.rb

@@ -109,7 +109,7 @@ module RubySpeech
           ref.swap rule.nokogiri_children
         end
 
-        non_root_rules = xpath "./ns:rule[@id!='#{root}']", :ns => namespace_href
+        non_root_rules = xpath "./ns:rule[@#{namespace_href && Nokogiri.jruby? ? 'ns:' : ''}id!='#{root}']", :ns => namespace_href
         non_root_rules.remove
 
         self

data/lib/ruby_speech/grxml/match.rb

@@ -8,7 +8,7 @@ module RubySpeech
       end
 
       def eql?(o)
-        o.is_a?(self.class) && [:mode, :confidence, :utterance, :interpretation].all? { |f| self.__send__(f) == o.__send__(f) }
+        o.instance_of?(self.class) && [:mode, :confidence, :utterance, :interpretation].all? { |f| self.__send__(f) == o.__send__(f) }
       end
       alias :== :eql?
     end

data/lib/ruby_speech/grxml/matcher.rb

@@ -8,15 +8,12 @@ end
 module RubySpeech
   module GRXML
     class Matcher
-
-      BLANK_REGEX = //.freeze
-
-      attr_reader :grammar, :regex
+      attr_reader :grammar
 
       def initialize(grammar)
         @grammar = grammar
         prepare_grammar
-        @regex = /^#{regexp_content.join}$/
+        compile_regex regexp_content
       end
 
       ##
@@ -24,7 +21,7 @@ module RubySpeech
       #
       # @param [String] other the input string to check for a match with the grammar
       #
-      # @return [NoMatch, Match] depending on the result of a match attempt. If a match can be found, it will be returned with appropriate mode/confidence/utterance and interpretation attributes
+      # @return [NoMatch, PotentialMatch, Match, MaxMatch] depending on the result of a match attempt. A potential match indicates that the buffer is valid, but incomplete. A MaxMatch is differentiated from a Match in that it cannot accept further input. If a match can be found, it will be returned with appropriate mode/confidence/utterance and interpretation attributes
       #
       # @example A grammar that takes a 4 digit pin terminated by hash, or the *9 escape sequence
       #     ```ruby
@@ -85,34 +82,27 @@ module RubySpeech
       #       ```
       #
       def match(buffer)
-        buffer = buffer.dup
-
-        return check_potential_match(buffer) if regex == BLANK_REGEX
-
-        check_full_match(buffer) || check_potential_match(buffer) || NoMatch.new
+        find_match buffer.dup
       end
 
       private
 
+      def regexp_content
+        '^' + grammar.root_rule.children.map(&:regexp_content).join + '$'
+      end
+
       def prepare_grammar
         grammar.inline!
         grammar.tokenize!
         grammar.normalize_whitespace
       end
 
-      def check_full_match(buffer)
-        match = regex.match buffer
-
-        return unless match
-
-        Match.new :mode           => grammar.mode,
-                  :confidence     => grammar.dtmf? ? 1 : 0,
-                  :utterance      => buffer,
-                  :interpretation => interpret_utterance(buffer)
-      end
-
-      def regexp_content
-        grammar.root_rule.children.map &:regexp_content
+      def match_for_buffer(buffer, maximal = false)
+        match_class = maximal ? MaxMatch : Match
+        match_class.new mode:     grammar.mode,
+                  confidence:     grammar.dtmf? ? 1 : 0,
+                  utterance:      buffer,
+                  interpretation: interpret_utterance(buffer)
       end
 
       def interpret_utterance(utterance)

data/lib/ruby_speech/grxml/max_match.rb

@@ -0,0 +1,6 @@
+module RubySpeech
+  module GRXML
+    class MaxMatch < Match
+    end
+  end
+end

data/lib/ruby_speech/grxml.rb

@@ -15,6 +15,7 @@ module RubySpeech
 
     autoload :Match
     autoload :Matcher
+    autoload :MaxMatch
     autoload :NoMatch
     autoload :PotentialMatch
 

data/lib/ruby_speech/version.rb

@@ -1,3 +1,3 @@
 module RubySpeech
-  VERSION = "2.0.1"
+  VERSION = "2.0.2"
 end

data/ruby_speech.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
     s.extensions = ['ext/ruby_speech/extconf.rb']
   end
 
-  s.add_runtime_dependency %q<niceogiri>, ["~> 1.1", ">= 1.1.1"]
+  s.add_runtime_dependency %q<niceogiri>, ["~> 1.1", ">= 1.1.2"]
   s.add_runtime_dependency %q<nokogiri>, ["~> 1.5", ">= 1.5.6"]
   s.add_runtime_dependency %q<activesupport>, [">= 3.0.7"]
 

data/spec/ruby_speech/grxml/match_spec.rb

@@ -3,45 +3,11 @@ require 'spec_helper'
 module RubySpeech
   module GRXML
     describe Match do
-      subject do
-        Match.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' }
+      it_behaves_like "match"
 
       describe "equality" do
-        it "should be equal when mode, confidence, utterance and interpretation are the same" do
-          Match.new(:mode => :dtmf, :confidence => 1, :utterance => '6', :interpretation => 'foo').should == Match.new(:mode => :dtmf, :confidence => 1, :utterance => '6', :interpretation => 'foo')
-        end
-
-        describe "when the mode is different" do
-          it "should not be equal" do
-            Match.new(:mode => :dtmf).should_not == Match.new(:mode => :speech)
-          end
-        end
-
-        describe "when the confidence is different" do
-          it "should not be equal" do
-            Match.new(:confidence => 1).should_not == Match.new(:confidence => 0)
-          end
-        end
-
-        describe "when the utterance is different" do
-          it "should not be equal" do
-            Match.new(:utterance => '6').should_not == Match.new(:utterance => 'foo')
-          end
-        end
-
-        describe "when the interpretation is different" do
-          it "should not be equal" do
-            Match.new(:interpretation => 'foo').should_not == Match.new(:interpretation => 'bar')
-          end
+        it "should never be equal to a MaxMatch" do
+          described_class.new.should_not eql(MaxMatch.new)
         end
       end
     end

data/spec/ruby_speech/grxml/matcher_spec.rb

@@ -17,9 +17,9 @@ module RubySpeech
             end
           end
 
-          it "should match '6'" do
+          it "should max-match '6'" do
             input = '6'
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '6',
                                               :interpretation => 'dtmf-6'
@@ -43,8 +43,8 @@ module RubySpeech
             end
           end
 
-          it "should match '56'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '56'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '56',
                                               :interpretation => 'dtmf-5 dtmf-6'
@@ -73,8 +73,8 @@ module RubySpeech
             end
           end
 
-          it "should match '*6'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '*6'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '*6',
                                               :interpretation => 'dtmf-star dtmf-6'
@@ -101,8 +101,8 @@ module RubySpeech
             end
           end
 
-          it "should match '#6'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '#6'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '#6',
                                               :interpretation => 'dtmf-pound dtmf-6'
@@ -134,8 +134,8 @@ module RubySpeech
             end
           end
 
-          it "should match '*6'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '*6'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '*6',
                                               :interpretation => 'dtmf-star dtmf-6'
@@ -165,16 +165,16 @@ module RubySpeech
             end
           end
 
-          it "should match '6'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '6'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '6',
                                               :interpretation => 'dtmf-6'
             subject.match('6').should == expected_match
           end
 
-          it "should match '7'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '7'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '7',
                                               :interpretation => 'dtmf-7'
@@ -206,16 +206,16 @@ module RubySpeech
             end
           end
 
-          it "should match '65'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '65'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '65',
                                               :interpretation => 'dtmf-6 dtmf-5'
             subject.match('65').should == expected_match
           end
 
-          it "should match '72'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '72'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '72',
                                               :interpretation => 'dtmf-7 dtmf-2'
@@ -255,16 +255,16 @@ module RubySpeech
             end
           end
 
-          it "should match '652'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '652'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '652',
                                               :interpretation => 'dtmf-6 dtmf-5 dtmf-2'
             subject.match('652').should == expected_match
           end
 
-          it "should match '728'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '728'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '728',
                                               :interpretation => 'dtmf-7 dtmf-2 dtmf-8'
@@ -297,16 +297,16 @@ module RubySpeech
             end
           end
 
-          it "should match '*6'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '*6'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '*6',
                                               :interpretation => 'dtmf-star dtmf-6'
             subject.match('*6').should == expected_match
           end
 
-          it "should match '*7'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '*7'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '*7',
                                               :interpretation => 'dtmf-star dtmf-7'
@@ -337,24 +337,26 @@ module RubySpeech
             end
           end
 
-          it "should match '6*'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '6*'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '6*',
                                               :interpretation => 'dtmf-6 dtmf-star'
             subject.match('6*').should == expected_match
           end
 
-          it "should match '7*'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '7*'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '7*',
                                               :interpretation => 'dtmf-7 dtmf-star'
             subject.match('7*').should == expected_match
           end
 
-          it "should potentially match '6'" do
-            subject.match('6').should == GRXML::PotentialMatch.new
+          %w{6 7}.each do |input|
+            it "should potentially match '#{input}'" do
+              subject.match(input).should == GRXML::PotentialMatch.new
+            end
           end
 
           it "should potentially match '7'" do
@@ -380,8 +382,8 @@ module RubySpeech
             end
           end
 
-          it "should match '166'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '166'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '166',
                                               :interpretation => 'dtmf-1 dtmf-6 dtmf-6'
@@ -413,8 +415,8 @@ module RubySpeech
             end
           end
 
-          it "should match '661'" do
-            expected_match = GRXML::Match.new :mode           => :dtmf,
+          it "should maximally match '661'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                               :confidence     => 1,
                                               :utterance      => '661',
                                               :interpretation => 'dtmf-6 dtmf-6 dtmf-1'
@@ -446,11 +448,18 @@ module RubySpeech
             end
           end
 
+          it "should maximally match '1666'" do
+            expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
+                                              :confidence     => 1,
+                                              :utterance      => '1666',
+                                              :interpretation => 'dtmf-1 dtmf-6 dtmf-6 dtmf-6'
+            subject.match('1666').should == expected_match
+          end
+
           {
             '1' => 'dtmf-1',
             '16' => 'dtmf-1 dtmf-6',
             '166' => 'dtmf-1 dtmf-6 dtmf-6',
-            '1666' => 'dtmf-1 dtmf-6 dtmf-6 dtmf-6'
           }.each_pair do |input, interpretation|
             it "should match '#{input}'" do
               expected_match = GRXML::Match.new :mode           => :dtmf,
@@ -486,8 +495,8 @@ module RubySpeech
             '661' => 'dtmf-6 dtmf-6 dtmf-1',
             '6661' => 'dtmf-6 dtmf-6 dtmf-6 dtmf-1'
           }.each_pair do |input, interpretation|
-            it "should match '#{input}'" do
-              expected_match = GRXML::Match.new :mode           => :dtmf,
+            it "should maximally match '#{input}'" do
+              expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                                 :confidence     => 1,
                                                 :utterance      => input,
                                                 :interpretation => interpretation
@@ -564,8 +573,8 @@ module RubySpeech
             '6661' => 'dtmf-6 dtmf-6 dtmf-6 dtmf-1',
             '66661' => 'dtmf-6 dtmf-6 dtmf-6 dtmf-6 dtmf-1'
           }.each_pair do |input, interpretation|
-            it "should match '#{input}'" do
-              expected_match = GRXML::Match.new :mode           => :dtmf,
+            it "should maximally match '#{input}'" do
+              expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                                 :confidence     => 1,
                                                 :utterance      => input,
                                                 :interpretation => interpretation
@@ -617,8 +626,8 @@ module RubySpeech
             '5678#' => 'dtmf-5 dtmf-6 dtmf-7 dtmf-8 dtmf-pound',
             '1111#' => 'dtmf-1 dtmf-1 dtmf-1 dtmf-1 dtmf-pound'
           }.each_pair do |input, interpretation|
-            it "should match '#{input}'" do
-              expected_match = GRXML::Match.new :mode           => :dtmf,
+            it "should maximally match '#{input}'" do
+              expected_match = GRXML::MaxMatch.new :mode        => :dtmf,
                                                 :confidence     => 1,
                                                 :utterance      => input,
                                                 :interpretation => interpretation

data/spec/ruby_speech/grxml/max_match_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+module RubySpeech
+  module GRXML
+    describe MaxMatch do
+      it_behaves_like "match"
+
+      it { should be_a Match }
+
+      describe "equality" do
+        it "should never be equal to a MaxMatch" do
+          described_class.new.should_not eql(Match.new)
+        end
+      end
+    end
+  end
+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

data/spec/support/matchers.rb

@@ -14,13 +14,7 @@ class SpeechDocMatcher
   end
 
   def subject=(s)
-    if s.is_a? Nokogiri::XML::Document
-      @subject = s
-    else
-      doc = Nokogiri::XML::Document.new
-      doc << s.to_xml
-      @subject = doc
-    end
+    @subject = Nokogiri::XML(s.to_xml)
   end
 
   def failure_message

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_speech
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Ben Langfeld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-27 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
@@ -19,7 +19,7 @@ dependencies:
         version: '1.1'
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '1.1'
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -238,6 +238,7 @@ files:
 - lib/ruby_speech/grxml/item.rb
 - lib/ruby_speech/grxml/match.rb
 - lib/ruby_speech/grxml/matcher.rb
+- lib/ruby_speech/grxml/max_match.rb
 - lib/ruby_speech/grxml/no_match.rb
 - lib/ruby_speech/grxml/one_of.rb
 - lib/ruby_speech/grxml/potential_match.rb
@@ -271,6 +272,7 @@ files:
 - spec/ruby_speech/grxml/item_spec.rb
 - spec/ruby_speech/grxml/match_spec.rb
 - spec/ruby_speech/grxml/matcher_spec.rb
+- spec/ruby_speech/grxml/max_match_spec.rb
 - spec/ruby_speech/grxml/no_match_spec.rb
 - spec/ruby_speech/grxml/one_of_spec.rb
 - spec/ruby_speech/grxml/potential_match_spec.rb
@@ -296,6 +298,7 @@ files:
 - spec/ruby_speech/ssml_spec.rb
 - spec/ruby_speech_spec.rb
 - spec/spec_helper.rb
+- spec/support/match_examples.rb
 - spec/support/matchers.rb
 homepage: https://github.com/benlangfeld/ruby_speech
 licenses: []
@@ -325,6 +328,7 @@ test_files:
 - spec/ruby_speech/grxml/item_spec.rb
 - spec/ruby_speech/grxml/match_spec.rb
 - spec/ruby_speech/grxml/matcher_spec.rb
+- spec/ruby_speech/grxml/max_match_spec.rb
 - spec/ruby_speech/grxml/no_match_spec.rb
 - spec/ruby_speech/grxml/one_of_spec.rb
 - spec/ruby_speech/grxml/potential_match_spec.rb
@@ -350,5 +354,6 @@ test_files:
 - spec/ruby_speech/ssml_spec.rb
 - spec/ruby_speech_spec.rb
 - spec/spec_helper.rb
+- spec/support/match_examples.rb
 - spec/support/matchers.rb
 has_rdoc: