xapit 0.2.4 → 0.2.5

data/CHANGELOG

@@ -1,3 +1,12 @@
+*0.2.5* (June 26th, 2009)
+
+* adding wildcard matching for general search query (ClassicQueryParser only)
+
+* adding wildcard matching when asterisk exists at end of condition
+
+  :conditions => { :name => "foo*" }
+
+
 *0.2.4* (June 23rd, 2009)
 
 * only create/update record in index if it matches xapit find conditions

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('xapit', '0.2.4') do |p|
+Echoe.new('xapit', '0.2.5') do |p|
   p.summary        = "Ruby library for interacting with Xapian, a full text search engine."
   p.description    = "Ruby library for interacting with Xapian, a full text search engine."
   p.url            = "http://github.com/ryanb/xapit"

data/features/finding.feature

@@ -73,3 +73,39 @@ Scenario: Query Range of Integer
     | Jack | 24  |
   When I query "age" between 8 and 15
   Then I should find records named "John, Jane"
+
+Scenario: Query Partial Match on Condition
+  Given the following indexed records
+    | name | sirname  |
+    | John | Jacobson |
+    | Jane | Niel     |
+    | Jack | Striker  |
+  When I query "name" matching "Ja*"
+  Then I should find records named "Jane, Jack"
+
+Scenario: Query no partial match on conditions with one letter
+  Given the following indexed records
+    | name | sirname  |
+    | John | Jacobson |
+    | Jane | Niel     |
+    | Jack | Striker  |
+  When I query "name" matching " J*"
+  Then I should find 0 records
+
+Scenario: Query partial match in keywords
+  Given the following indexed records
+    | name | sirname  |
+    | John | Jacobson |
+    | Bill | Niel     |
+    | Jack | Striker  |
+  When I query for "Ja*"
+  Then I should find records named "John, Jack"
+
+Scenario: Query no partial match in keywords with one letter
+  Given the following indexed records
+    | name | sirname  |
+    | John | Jacobson |
+    | Bill | Niel     |
+    | Jack | J        |
+  When I query for " J*"
+  Then I should find records named "Jack"

data/lib/xapit/membership.rb

@@ -89,6 +89,9 @@ module Xapit
         #   # no need to specify first query string when searching all records
         #   @articles = Article.search(:conditions => { :category_id => params[:category_id] })
         #
+        #   # search partial terms with asterisk (only supported at end of term)
+        #   @articles = Article.search("sab*", :conditions => { :name => "Din*" })
+        #
         def search(*args)
           Collection.new(self, *args)
         end

data/lib/xapit/query_parsers/abstract_query_parser.rb

@@ -126,6 +126,8 @@ module Xapit
       if value.kind_of?(Range) && @member_class
         position = @member_class.xapit_index_blueprint.position_of_field(name)
         Xapian::Query.new(Xapian::Query::OP_VALUE_RANGE, position, Xapit.serialize_value(value.begin), Xapit.serialize_value(value.end))
+      elsif value.to_s.ends_with?("*") && value.to_s.strip.length > 2
+        wildcard_query(value, "X#{name}-")
       else
         if value.kind_of? Time
           value = value.to_i
@@ -135,5 +137,14 @@ module Xapit
         "X#{name}-#{value.to_s.downcase}"
       end
     end
+    
+    # Expands the wildcard in the term (just at the end) and returns a query
+    # which will match any term that starts with the given term.
+    def wildcard_query(term, prefix = "")
+      partial_term = term.sub(/\*$/, '') # remove asterisk at end if it exists
+      parser = Xapian::QueryParser.new
+      parser.database = Xapit::Config.database
+      parser.parse_query(partial_term, Xapian::QueryParser::FLAG_PARTIAL, prefix)
+    end
   end
 end

data/lib/xapit/query_parsers/classic_query_parser.rb

@@ -1,15 +1,20 @@
 module Xapit
   class ClassicQueryParser < AbstractQueryParser
     def xapian_query_from_text(text)
-      xapian_parser.parse_query(text)
+      xapian_parser.parse_query(cleanup_text(text), Xapian::QueryParser::FLAG_WILDCARD | Xapian::QueryParser::FLAG_PHRASE | Xapian::QueryParser::FLAG_BOOLEAN | Xapian::QueryParser::FLAG_LOVEHATE)
     end
     
     def xapian_parser
       @xapian_parser ||= build_xapian_parser
     end
     
+    def cleanup_text(text)
+      text.gsub(/\b([a-z])\*/i) { $1 }
+    end
+    
     def build_xapian_parser
       parser = Xapian::QueryParser.new
+      parser.database = Config.database
       parser.stemmer = Xapian::Stem.new(Config.stemming)
       parser.stemming_strategy = Xapian::QueryParser::STEM_SOME
       parser.default_op = Xapian::Query::OP_AND

data/spec/xapit/query_parsers/classic_query_parser_spec.rb

@@ -6,10 +6,15 @@ describe Xapit::ClassicQueryParser do
   end
   
   it "should have an initial xapian parser with stemming and default operator support" do
+    Xapit::Config.writable_database # just so a database exists
     expected = Xapian::QueryParser.new
     expected.stemmer = Xapian::Stem.new("english")
     expected.stemming_strategy = Xapian::QueryParser::STEM_SOME
     expected.default_op = Xapian::Query::OP_AND
     @parser.xapian_query_from_text("foo bar").description.should == expected.parse_query("foo bar").description
   end
+  
+  it "should remove asterisks from terms with one letter" do
+    @parser.cleanup_text("J*").should == "J"
+  end
 end

data/xapit.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{xapit}
-  s.version = "0.2.4"
+  s.version = "0.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Bates"]
-  s.date = %q{2009-06-23}
+  s.date = %q{2009-06-26}
   s.description = %q{Ruby library for interacting with Xapian, a full text search engine.}
   s.email = %q{ryan (at) railscasts (dot) com}
   s.extra_rdoc_files = ["CHANGELOG", "lib/xapit/adapters/abstract_adapter.rb", "lib/xapit/adapters/active_record_adapter.rb", "lib/xapit/adapters/data_mapper_adapter.rb", "lib/xapit/collection.rb", "lib/xapit/config.rb", "lib/xapit/facet.rb", "lib/xapit/facet_blueprint.rb", "lib/xapit/facet_option.rb", "lib/xapit/index_blueprint.rb", "lib/xapit/indexers/abstract_indexer.rb", "lib/xapit/indexers/classic_indexer.rb", "lib/xapit/indexers/simple_indexer.rb", "lib/xapit/membership.rb", "lib/xapit/query.rb", "lib/xapit/query_parsers/abstract_query_parser.rb", "lib/xapit/query_parsers/classic_query_parser.rb", "lib/xapit/query_parsers/simple_query_parser.rb", "lib/xapit/rake_tasks.rb", "lib/xapit.rb", "LICENSE", "README.rdoc", "tasks/spec.rb", "tasks/xapit.rake", "TODO"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: xapit
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors: 
 - Ryan Bates
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-23 00:00:00 -07:00
+date: 2009-06-26 00:00:00 -07:00
 default_executable: 
 dependencies: []