Ticket #420: xapian-perl.patch

search-xapian/t/index.t

@@ -32 +32 @@
 
   my $term = 'test';
   ok( $term = $stemmer->stem_word( $term ) );
+  if ($backend ne "inmemory") {
+    # inmemory doesn't implement spelling correction support.
+    $database->add_spelling( $term, 1 );
+  }
 
   my $docid;
   for my $num qw( one two three ) {
@@ -44 +48 @@
     $docs{$num}->add_posting( $num, 1 );
 
     $docs{$num}->add_value(0, $num);
+
+    if ($backend ne "inmemory") {
+      # inmemory doesn't implement spelling correction support.
+      $database->add_spelling( "x" . $term, 1 );
+      $database->add_spelling( $term, 1 );
+      $database->remove_spelling( "x" . $term, 1 );
+    }
     ok( $docid = $database->add_document( $docs{$num} ) );
   }
   $database->delete_document( $docid );

search-xapian/t/parser.t

@@ -6 +6 @@
 
 use Test;
 use Devel::Peek;
-BEGIN { plan tests => 53 };
+BEGIN { plan tests => 54 };
 use Search::Xapian qw(:standard);
 ok(1); # If we made it this far, we're ok.
 
@@ -29 +29 @@
 $qp->set_default_op( OP_AND );
 
 my $query;
-ok( $query = $qp->parse_query( 'one or two', FLAG_BOOLEAN|FLAG_BOOLEAN_ANY_CASE ) );
+ok( $query = $qp->parse_query( 'one or two', FLAG_BOOLEAN|FLAG_BOOLEAN_ANY_CASE|FLAG_SPELLING_CORRECTION ) );
+ok( not $qp->get_corrected_query_string());
 ok( $query->get_description(), "Xapian::Query((one:(pos=1) OR two:(pos=2)))" );
 
 ok( $query = $qp->parse_query( 'one OR (two AND three)' ) );
@@ -130 +131 @@
     ok( $query->get_description(), "Xapian::Query($res)" );
 }
 
+
+
 # Regression test for Search::Xapian bug fixed in 1.0.5.0.  In 1.0.0.0-1.0.4.0
 # we tried to catch const char * not Xapian::Error, so std::terminate got
 # called.

search-xapian/t/search.t

@@ -6 +6 @@
 # change 'tests => 1' to 'tests => last_test_to_print';
 
 use Test::More;
-BEGIN { plan tests => 114 };
+BEGIN { plan tests => 115 };
 use Search::Xapian qw(:ops);
 
 #########################
@@ -55 +55 @@
 
 ok( $enq = $db->enquire( $query ), "db queries return ok"  );
 ok( $enq = $db->enquire( OP_OR, 'test', 'help' ), "in-line db queries return ok" );
+is( $db->get_spelling_suggestion( 'tost' ), 'test', "spelling suggestion ok" );
 
 ok( $query = Search::Xapian::Query->new(OP_SCALE_WEIGHT, $query, 3.14), "OP_SCALE_WEIGHT understood" );
 

search-xapian/Xapian/Database.pm

@@ -138 +138 @@
 
 return a description of this object.
 
+=item get_spelling_suggestion
+
+returns a suggested spelling correction.
+
 =item allterms_begin [<prefix>]
 
 Returns a L<Search::Xapian::TermIterator> iterating over the termlist for the

search-xapian/Xapian/QueryParser.pm

@@ -157 +157 @@
 
 Returns a string describing this object.
 
+=item get_corrected_query_string
+
+Get the spelling-corrected query string.
+
+This will only be set if FLAG_SPELLING_CORRECTION is specified when
+QueryParser::parse_query() was last called.
+
+If there were no corrections, an empty string is returned.
+
 =back
 
 =head1 REFERENCE

search-xapian/Xapian/WritableDatabase.pm

@@ -174 +174 @@
 replaced and an exception is thrown (possibly at a later time when flush is
 called or the database is closed).
 
+=item add_spelling <word> <freqinc>
+
+Add a word to the spelling dictionary.
+
+If the word is already present, its frequency is increased.
+
+Parameters:
+    word        The word to add.
+    freqinc     How much to increase its frequency by (default 1).
+
+=item remove_spelling <word> <freqdec>
+
+Remove a word from the spelling dictionary.
+
+The word's requency is decreased, and if would become zero or less
+then the word is removed completely.
+
+Parameters:
+    word        The word to remove.
+    freqdec     How much to decrease its frequency by (default 1).
+
 =item reopen
 
-Re-open the database. makes sure you have a fresh db handle.
+Re-open the database. Makes sure you have a fresh db handle.
+
+=item close
+
+Close the database. This also implies a flush().
 
 =back
 

search-xapian/XS/Database.xs

@@ -256 +256 @@
         RETVAL
 
 string
+Database::get_spelling_suggestion(word, max_edit_distance = 2)
+    string  word
+    int     max_edit_distance
+    CODE:
+    try {
+        RETVAL = THIS->get_spelling_suggestion(word, max_edit_distance);
+        }
+        catch (const Error &error) {
+            croak( "Exception: %s", error.get_msg().c_str() );
+        }
+    OUTPUT:
+        RETVAL
+
+string
 Database::get_metadata(string key)
 
 void

search-xapian/XS/QueryParser.xs

@@ -99 +99 @@
         RETVAL
 
 string
+QueryParser::get_corrected_query_string()
+    CODE:
+    try {
+            RETVAL = THIS->get_corrected_query_string();
+    }
+    catch (const Error &error) {
+        croak( "Exception: %s", error.get_msg().c_str() );
+    }
+    OUTPUT:
+        RETVAL
+    
+
+string
 QueryParser::get_description()
 
 void

search-xapian/XS/WritableDatabase.xs

@@ -417 +417 @@
         } catch (const Error &error) {
             croak( "Exception: %s", error.get_msg().c_str() );
         }
+
+void
+WritableDatabase::add_spelling(word, freqinc = 1)
+    string word
+    termcount freqinc
+    CODE:
+        try {
+            THIS->add_spelling(word, freqinc);
+        } catch (const Error &error) {
+            croak( "Exception: %s", error.get_msg().c_str() );
+        }
+
+void
+WritableDatabase::remove_spelling(word, freqdec  = 1)
+    string word
+    termcount freqdec
+    CODE:
+        try {
+            THIS->remove_spelling(word, freqdec);
+        } catch (const Error &error) {
+            croak( "Exception: %s", error.get_msg().c_str() );
+        }