xapit 0.2.6 → 0.2.7

data/CHANGELOG

@@ -1,3 +1,14 @@
+*0.2.7* (July 7th, 2009)
+
+* support punctuation in wildcard matching
+
+* fixing nested search calls
+
+* chain a separate search with "or_search" to find records matching either one
+  
+  search("foo").or_search(:conditions => { :priority => 3 })
+
+
 *0.2.6* (July 6th, 2009)
 
 * search for field conditions in query string, only supported by ClassicQueryParser

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('xapit', '0.2.6') do |p|
+Echoe.new('xapit', '0.2.7') 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

@@ -119,7 +119,6 @@ Scenario: Query for separate OR conditions
   When I query "age" matching "17" or "name" matching "Jack"
   Then I should find records named "Jane, Jack"
 
-@focus
 Scenario: Query for condition in keywords string
   Given the following indexed records
     | name | age |
@@ -128,3 +127,12 @@ Scenario: Query for condition in keywords string
     | Jack | 17  |
   When I query for "age:17"
   Then I should find records named "Jane, Jack"
+
+Scenario: Query for separate OR conditions and keywords
+  Given the following indexed records
+    | name | age |
+    | John | 23  |
+    | Jane | 17  |
+    | Jack | 18  |
+  When I query for "John" or "age" matching "18" ordered by "name"
+  Then I should find records named "Jack, John"

data/features/step_definitions/xapit_steps.rb

@@ -78,6 +78,10 @@ When /^I query "([^\"]*)" matching "([^\"]*)" or "([^\"]*)" matching "([^\"]*)"$
   @records = XapitMember.search(:conditions => [{ field1.to_sym => value1 }, { field2.to_sym => value2 }])
 end
 
+When /^I query for "([^\"]*)" or "([^\"]*)" matching "([^\"]*)" ordered by "([^\"]*)"$/ do |keywords, field, value, order|
+  @records = XapitMember.search(keywords, :order => order).or_search(:conditions => { field.to_sym => value })
+end
+
 When /^I query "([^\"]*)" between (\d+) and (\d+)$/ do |field, beginning, ending|
   @records = XapitMember.search(:conditions => { field.to_sym => beginning.to_i..ending.to_i })
 end

data/lib/xapit/collection.rb

@@ -13,13 +13,14 @@ module Xapit
     [].methods.each do |m|
       delegate m, :to => :results unless m =~ /^__/ || NON_DELEGATE_METHODS.include?(m.to_s)
     end
+    delegate :query, :base_query, :base_query=, :extra_queries, :extra_queries=, :to => :@query_parser
     
     def self.search_similar(member, *args)
       collection = new(member.class, *args)
       indexer = SimpleIndexer.new(member.class.xapit_index_blueprint)
       terms = indexer.text_terms(member) + indexer.field_terms(member)
-      collection.base_query.and_query(terms, :or)
-      collection.base_query.not_query("Q#{member.class}-#{member.id}")
+      query = collection.base_query.and_query(terms, :or).not_query("Q#{member.class}-#{member.id}")
+      collection.base_query = query
       collection
     end
     
@@ -37,7 +38,7 @@ module Xapit
     def size
       @query_parser.query.count
     end
-    alias_method :total_entries, :size
+    alias_method :total_entries, :size # alias to total_entries to support will_paginate
     
     # Returns true if no results are found.
     def empty?
@@ -56,18 +57,29 @@ module Xapit
     
     # Perform another search on this one, inheriting all options already passed.
     # See Xapit::Membership for search options.
-    def search(keywords, options = {})
-      collection = Collection.new(@query_parser.member_class, keywords, options)
+    #
+    #   Article.search("kite").search("sky") # only performs one query
+    # 
+    def search(*args)
+      options = args.extract_options!
+      collection = Collection.new(@query_parser.member_class, args[0].to_s, @query_parser.options.merge(options))
       collection.base_query = @query_parser.query
       collection
     end
     
-    def base_query=(base_query)
-      @query_parser.base_query = base_query
-    end
-    
-    def base_query
-      @query_parser.base_query
+    # Chain another search returning all records matched by either this search or the previous search
+    # Inherits all options passed in earlier search (such as :page and :order)
+    # See Xapit::Membership for search options.
+    #
+    #   Article.search("kite").or_search(:conditions => { :priority => 1 })
+    # 
+    def or_search(*args)
+      options = args.extract_options!
+      collection = Collection.new(@query_parser.member_class, args[0].to_s, @query_parser.options.merge(options))
+      collection.base_query = @query_parser.base_query
+      collection.extra_queries = @query_parser.extra_queries
+      collection.extra_queries << @query_parser.primary_query
+      collection
     end
     
     # The page number we are currently on.
@@ -87,7 +99,7 @@ module Xapit
     
     # Total number of pages with found results.
     def total_pages
-      (total_entries / per_page.to_f).ceil
+      (size / per_page.to_f).ceil
     end
     
     # The previous page number. Returns nil if on first page.
@@ -151,14 +163,10 @@ module Xapit
     
     private
     
-    def matchset(options = {})
-      @query_parser.query.matchset(options)
-    end
-    
     # TODO this could use some refactoring
     # See issue #11 for why this is so complex.
     def fetch_results(options = {})
-      matches = matchset(options).matches
+      matches = @query_parser.matchset(options).matches
       records_by_class = {}
       matches.each do |match|
         class_name, id = match.document.data.split('-')

data/lib/xapit/facet.rb

@@ -16,7 +16,7 @@ module Xapit
     
     def initialize(blueprint, query, existing_facet_identifiers)
       @blueprint = blueprint
-      @query = query.dup
+      @query = query
       @existing_facet_identifiers = existing_facet_identifiers
     end
     

data/lib/xapit/query.rb

@@ -3,11 +3,10 @@ module Xapit
   # this class unless you are trying to query the Xapian database directly.
   # You may be looking for Xapit::Collection instead.
   class Query
-    attr_reader :default_options, :xapian_query
+    attr_reader :xapian_query
     
     def initialize(*args)
       @xapian_query = build_xapian_query(*args)
-      @default_options = { :offset => 0, :sort_descending => false }
     end
     
     def and_query(*args)
@@ -23,7 +22,7 @@ module Xapit
     end
     
     def matchset(options = {})
-      options.reverse_merge!(default_options)
+      options.reverse_merge! :offset => 0, :sort_descending => false
       enquire = Xapian::Enquire.new(Config.database)
       if options[:sort_by_values]
         sorter = Xapian::MultiValueSorter.new
@@ -49,9 +48,11 @@ module Xapit
     private
     
     def merge_query(operator, *args)
-      @count = nil
-      @xapian_query = Xapian::Query.new(xapian_operator(operator), @xapian_query, build_xapian_query(*args)) unless args.first.blank?
-      self
+      if args.first.blank?
+        self
+      else
+        Xapit::Query.new([@xapian_query, build_xapian_query(*args)], operator)
+      end
     end
     
     def build_xapian_query(query, operator = :and)

data/lib/xapit/query_parsers/abstract_query_parser.rb

@@ -1,15 +1,25 @@
 module Xapit
   class AbstractQueryParser
-    attr_reader :member_class
+    attr_reader :member_class, :options
     attr_writer :base_query
+    attr_accessor :extra_queries
     
     def initialize(*args)
       @options = args.extract_options!
       @member_class = args[0]
       @search_text = args[1].to_s
+      @extra_queries = []
     end
     
     def query
+      if @extra_queries.blank?
+        primary_query
+      else
+        Query.new([primary_query] + @extra_queries, :or)
+      end
+    end
+    
+    def primary_query
       if (@search_text.split + condition_terms + not_condition_terms + facet_terms).empty?
         base_query
       else
@@ -47,12 +57,7 @@ module Xapit
     end
     
     def initial_query
-      query = Query.new(initial_query_strings, :or)
-      query.default_options[:offset] = offset
-      query.default_options[:limit] = per_page
-      query.default_options[:sort_by_values] = sort_by_values
-      query.default_options[:sort_descending] = @options[:descending]
-      query
+      Query.new(initial_query_strings, :or)
     end
     
     def initial_query_strings
@@ -106,6 +111,19 @@ module Xapit
       suggestion.blank? ? nil : suggestion
     end
     
+    def matchset(options = {})
+      query.matchset(query_options.merge(options))
+    end
+    
+    def query_options
+      {
+        :offset => offset,
+        :limit => per_page,
+        :sort_by_values => sort_by_values,
+        :sort_descending => @options[:descending]
+      }
+    end
+    
     private
     
     def parse_conditions(conditions)
@@ -147,10 +165,10 @@ module Xapit
     # 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
+      full_term = (prefix + term.downcase).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)
+      parser.parse_query(full_term[-1..-1], Xapian::QueryParser::FLAG_PARTIAL, full_term[0..-2])
     end
   end
 end

data/spec/xapit/collection_spec.rb

@@ -50,10 +50,6 @@ describe Xapit::Collection do
         Xapit::Collection.new(XapitMember, "").last.should == @foo
       end
       
-      it "should support nested search" do
-        Xapit::Collection.new(XapitMember, "world").search("foo") == [@foo]
-      end
-      
       it "should support page and per_page options" do
         Xapit::Collection.new(XapitMember, :page => 1, :per_page => 1).should == [@hello]
         Xapit::Collection.new(XapitMember, :page => 2, :per_page => 1).should == [@foo]
@@ -148,6 +144,33 @@ describe Xapit::Collection do
         Xapit::Collection.new(nil, "foo", :classes => [String, Array]).should == []
         Xapit::Collection.new(nil, "foo", :classes => [String, Array, XapitMember]).should == [@foo]
       end
+      
+      it "should support nested or_search" do
+        Xapit::Collection.new(XapitMember, "world", :order => :name).or_search("foo").should == [@foo, @hello]
+      end
+      
+      it "should override options in nested or_search" do
+        Xapit::Collection.new(XapitMember, "world", :order => :name, :per_page => 2).or_search("foo", :per_page => 1).should == [@foo]
+      end
+      
+      it "should combine multiple or_search" do
+        @buz = XapitMember.new(:name => "buz")
+        @zot = XapitMember.new(:name => "zot")
+        Xapit.remove_database
+        Xapit.index_all
+        Xapit::Collection.new(XapitMember, "world", :order => :name).or_search("foo").or_search("buz").should == [@buz, @foo, @hello]
+      end
+      
+      it "should support nested search" do
+        @zap = XapitMember.new(:name => "zap world")
+        Xapit.remove_database
+        Xapit.index_all
+        Xapit::Collection.new(XapitMember, "world").search("zap") == [@zap]
+      end
+      
+      it "should inherit options in nested collection search" do
+        Xapit::Collection.new(XapitMember, "world", :per_page => 3).search("zap").per_page.should == 3
+      end
     end
   end
 end

data/spec/xapit/query_parsers/abstract_query_parser_spec.rb

@@ -48,4 +48,13 @@ describe Xapit::AbstractQueryParser do
     parser = Xapit::AbstractQueryParser.new(XapitMember, :conditions => { :foo => [2..5, 10] })
     parser.condition_terms.first.xapian_query.description.should == expected.description
   end
+    
+  it "should expand punctuated terms properly" do
+    XapitMember.xapit { |i| i.field :name }
+    bar = XapitMember.new(:name => "foo-bar")
+    baz = XapitMember.new(:name => "foo-baz")
+    zap = XapitMember.new(:name => "foo-zap")
+    Xapit.index_all
+    XapitMember.search(:conditions => { :name => "foo-b*"}).should == [bar, baz]
+  end
 end

data/spec/xapit/query_spec.rb

@@ -31,8 +31,7 @@ describe Xapit::Query do
       Xapian::Query.new(Xapian::Query::OP_AND, ["bar"])
     )
     query = Xapit::Query.new("foo")
-    query.and_query("bar")
-    query.xapian_query.description.should == expected.description
+    query.and_query("bar").xapian_query.description.should == expected.description
   end
   
   it "should OR two queries together" do
@@ -41,8 +40,7 @@ describe Xapit::Query do
       Xapian::Query.new(Xapian::Query::OP_AND, ["bar"])
     )
     query = Xapit::Query.new("foo")
-    query.or_query("bar")
-    query.xapian_query.description.should == expected.description
+    query.or_query("bar").xapian_query.description.should == expected.description
   end
   
   it "should build a query from an array of mixed strings and queries" do

data/xapit.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{xapit}
-  s.version = "0.2.6"
+  s.version = "0.2.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Bates"]
-  s.date = %q{2009-07-06}
+  s.date = %q{2009-07-07}
   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"]

metadata

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