xapit 0.2.5 → 0.2.6

data/CHANGELOG

@@ -1,3 +1,16 @@
+*0.2.6* (July 6th, 2009)
+
+* search for field conditions in query string, only supported by ClassicQueryParser
+  
+  search("age:17")
+
+* check if xapian database exists before removing
+
+* search multiple conditions with OR by passing an array
+
+  :conditions => [{ :category_id => 1 }, { :priority => 2 }]
+
+
 *0.2.5* (June 26th, 2009)
 
 * adding wildcard matching for general search query (ClassicQueryParser only)

data/Manifest

@@ -57,5 +57,4 @@ spec/xapit/query_spec.rb
 spec/xapit_member.rb
 tasks/spec.rb
 tasks/xapit.rake
-TODO
 uninstall.rb

data/Rakefile

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

@@ -109,3 +109,22 @@ Scenario: Query no partial match in keywords with one letter
     | Jack | J        |
   When I query for " J*"
   Then I should find records named "Jack"
+
+Scenario: Query for separate OR conditions
+  Given the following indexed records
+    | name | age |
+    | John | 23  |
+    | Jane | 17  |
+    | Jack | 18  |
+  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 |
+    | John | 23  |
+    | Jane | 17  |
+    | Jack | 17  |
+  When I query for "age:17"
+  Then I should find records named "Jane, Jack"

data/features/step_definitions/xapit_steps.rb

@@ -67,27 +67,31 @@ Then /^I should have ([0-9]+) records? total$/ do |num|
 end
 
 When /^I query "([^\"]*)" matching "([^\"]*)"$/ do |field, value|
-  @records = XapitMember.search("", :conditions => { field.to_sym => value })
+  @records = XapitMember.search(:conditions => { field.to_sym => value })
 end
 
 When /^I query "([^\"]*)" not matching "([^\"]*)"$/ do |field, value|
-  @records = XapitMember.search("", :not_conditions => { field.to_sym => value })
+  @records = XapitMember.search(:not_conditions => { field.to_sym => value })
+end
+
+When /^I query "([^\"]*)" matching "([^\"]*)" or "([^\"]*)" matching "([^\"]*)"$/ do |field1, value1, field2, value2|
+  @records = XapitMember.search(:conditions => [{ field1.to_sym => value1 }, { field2.to_sym => value2 }])
 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 })
+  @records = XapitMember.search(:conditions => { field.to_sym => beginning.to_i..ending.to_i })
 end
 
 When /^I query page ([0-9]+) at ([0-9]+) per page$/ do |page, per_page|
-  @records = XapitMember.search("", :page => page, :per_page => per_page.to_i)
+  @records = XapitMember.search(:page => page, :per_page => per_page.to_i)
 end
 
 When /^I query facets "([^\"]*)"$/ do |facets|
-  @records = XapitMember.search("", :facets => facets)
+  @records = XapitMember.search(:facets => facets)
 end
 
 When /^I query "([^\"]*)" sorted by (.*?)( descending)?$/ do |keywords, sort, descending|
-  @records = XapitMember.search("", :order => sort.split(', '), :descending => descending)
+  @records = XapitMember.search(:order => sort.split(', '), :descending => descending)
 end
 
 When /^I query for similar records for "([^\"]*)"$/ do |keywords|

data/lib/xapit/config.rb

@@ -65,8 +65,8 @@ module Xapit
       end
       
       # Removes the configured database file and clears the stored one in memory.
-      def remove_database # this can be a bit dangers, maybe do some checking here first?
-        FileUtils.rm_rf(path) if File.exist? path
+      def remove_database
+        FileUtils.rm_rf(path) if File.exist? File.join(path, "iamflint")
         @database = nil
         @writable_database = nil
       end

data/lib/xapit/index_blueprint.rb

@@ -49,7 +49,7 @@ module Xapit
     # Adds a field attribute. Field terms are not split by word so it is not designed for full text search.
     # Instead you can filter through a field using the :conditions hash in a search query.
     #
-    #   Article.search("", :conditions => { :priority => 5 })
+    #   Article.search(:conditions => { :priority => 5 })
     # 
     # Multiple field values are supported if the given attribute is an array.
     # 

data/lib/xapit/membership.rb

@@ -84,7 +84,10 @@ module Xapit
         #   @articles = Article.search("phone", :order => [:category_id, :id], :descending => true)
         #
         #   # basic boolean matching is supported
-        #   @articles = Article.search("phone or fax not email")
+        #   @articles = Article.search("phone OR fax NOT email")
+        #
+        #   # field conditions in query string
+        #   @articles = Article.search("priority:3")
         #
         #   # no need to specify first query string when searching all records
         #   @articles = Article.search(:conditions => { :category_id => params[:category_id] })
@@ -92,6 +95,9 @@ module Xapit
         #   # search partial terms with asterisk (only supported at end of term)
         #   @articles = Article.search("sab*", :conditions => { :name => "Din*" })
         #
+        #   # search multiple conditions with OR by passing an array
+        #   @articles = Article.search(:conditions => [{ :category_id => 1 }, { :priority => 2 }])
+        #
         def search(*args)
           Collection.new(self, *args)
         end

data/lib/xapit/query_parsers/abstract_query_parser.rb

@@ -68,11 +68,11 @@ module Xapit
     end
     
     def condition_terms
-      condition_terms_from_hash(@options[:conditions])
+      parse_conditions(@options[:conditions])
     end
     
     def not_condition_terms
-      condition_terms_from_hash(@options[:not_conditions])
+      parse_conditions(@options[:not_conditions])
     end
     
     def facet_terms
@@ -108,20 +108,26 @@ module Xapit
     
     private
     
-    def condition_terms_from_hash(conditions)
-      if conditions
-        conditions.map do |name, value|
-          if value.kind_of? Array
-            Query.new(value.map { |v| condition_term(name, v) }, :or)
-          else
-            condition_term(name, value)
-          end
-        end.flatten
+    def parse_conditions(conditions)
+      if conditions.kind_of? Array
+        [Query.new(conditions.map { |hash| Query.new(condition_terms_from_hash(hash)) }, :or)]
+      elsif conditions.kind_of? Hash
+        condition_terms_from_hash(conditions)
       else
         []
       end
     end
     
+    def condition_terms_from_hash(conditions)
+      conditions.map do |name, value|
+        if value.kind_of? Array
+          Query.new(value.map { |v| condition_term(name, v) }, :or)
+        else
+          condition_term(name, value)
+        end
+      end.flatten
+    end
+    
     def condition_term(name, value)
       if value.kind_of?(Range) && @member_class
         position = @member_class.xapit_index_blueprint.position_of_field(name)

data/lib/xapit/query_parsers/classic_query_parser.rb

@@ -18,6 +18,11 @@ module Xapit
       parser.stemmer = Xapian::Stem.new(Config.stemming)
       parser.stemming_strategy = Xapian::QueryParser::STEM_SOME
       parser.default_op = Xapian::Query::OP_AND
+      if @member_class
+        @member_class.xapit_index_blueprint.field_attributes.each do |field|
+          parser.add_prefix(field.to_s, "X#{field}-")
+        end
+      end
       parser
     end
   end

data/spec/xapit/config_spec.rb

@@ -45,4 +45,18 @@ describe Xapit::Config do
     Xapit::Config.setup(:stemming => "german")
     Xapit::Config.stemming == "german"
   end
+  
+  it "should remove the database if it is a true xapian database" do
+    Xapit::Config.writable_database # load the database
+    Xapit::Config.remove_database
+    File.exist?(Xapit::Config.path).should be_false
+  end
+  
+  it "should NOT remove the database if it is not a xapian database" do
+    path = Xapit::Config.path + "/testing"
+    FileUtils.mkdir_p(path)
+    Xapit::Config.remove_database
+    File.exist?(Xapit::Config.path).should be_true
+    FileUtils.rm_rf(Xapit::Config.path)
+  end
 end

data/spec/xapit/facet_spec.rb

@@ -65,7 +65,7 @@ describe Xapit::Facet do
       
       it "should not list facets if only one option is found" do
         blueprint = Xapit::FacetBlueprint.new(XapitMember, 0, :visible)
-        facets = XapitMember.search("", :facets => blueprint.identifiers_for(@visible1)).facets
+        facets = XapitMember.search(:facets => blueprint.identifiers_for(@visible1)).facets
         facets.should be_empty
       end
     end

data/xapit.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{xapit}
-  s.version = "0.2.5"
+  s.version = "0.2.6"
 
   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-26}
+  s.date = %q{2009-07-06}
   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"]
-  s.files = ["CHANGELOG", "features/facets.feature", "features/finding.feature", "features/indexing.feature", "features/sorting.feature", "features/step_definitions/common_steps.rb", "features/step_definitions/xapit_steps.rb", "features/suggestions.feature", "features/support/env.rb", "features/support/xapit_helpers.rb", "init.rb", "install.rb", "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", "Manifest", "rails_generators/xapit/templates/setup_xapit.rb", "rails_generators/xapit/templates/xapit.rake", "rails_generators/xapit/USAGE", "rails_generators/xapit/xapit_generator.rb", "Rakefile", "README.rdoc", "spec/spec_helper.rb", "spec/xapit/adapters/active_record_adapter_spec.rb", "spec/xapit/adapters/data_mapper_adapter_spec.rb", "spec/xapit/collection_spec.rb", "spec/xapit/config_spec.rb", "spec/xapit/facet_blueprint_spec.rb", "spec/xapit/facet_option_spec.rb", "spec/xapit/facet_spec.rb", "spec/xapit/index_blueprint_spec.rb", "spec/xapit/indexers/abstract_indexer_spec.rb", "spec/xapit/indexers/classic_indexer_spec.rb", "spec/xapit/indexers/simple_indexer_spec.rb", "spec/xapit/membership_spec.rb", "spec/xapit/query_parsers/abstract_query_parser_spec.rb", "spec/xapit/query_parsers/classic_query_parser_spec.rb", "spec/xapit/query_parsers/simple_query_parser_spec.rb", "spec/xapit/query_spec.rb", "spec/xapit_member.rb", "tasks/spec.rb", "tasks/xapit.rake", "TODO", "uninstall.rb", "xapit.gemspec"]
+  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"]
+  s.files = ["CHANGELOG", "features/facets.feature", "features/finding.feature", "features/indexing.feature", "features/sorting.feature", "features/step_definitions/common_steps.rb", "features/step_definitions/xapit_steps.rb", "features/suggestions.feature", "features/support/env.rb", "features/support/xapit_helpers.rb", "init.rb", "install.rb", "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", "Manifest", "rails_generators/xapit/templates/setup_xapit.rb", "rails_generators/xapit/templates/xapit.rake", "rails_generators/xapit/USAGE", "rails_generators/xapit/xapit_generator.rb", "Rakefile", "README.rdoc", "spec/spec_helper.rb", "spec/xapit/adapters/active_record_adapter_spec.rb", "spec/xapit/adapters/data_mapper_adapter_spec.rb", "spec/xapit/collection_spec.rb", "spec/xapit/config_spec.rb", "spec/xapit/facet_blueprint_spec.rb", "spec/xapit/facet_option_spec.rb", "spec/xapit/facet_spec.rb", "spec/xapit/index_blueprint_spec.rb", "spec/xapit/indexers/abstract_indexer_spec.rb", "spec/xapit/indexers/classic_indexer_spec.rb", "spec/xapit/indexers/simple_indexer_spec.rb", "spec/xapit/membership_spec.rb", "spec/xapit/query_parsers/abstract_query_parser_spec.rb", "spec/xapit/query_parsers/classic_query_parser_spec.rb", "spec/xapit/query_parsers/simple_query_parser_spec.rb", "spec/xapit/query_spec.rb", "spec/xapit_member.rb", "tasks/spec.rb", "tasks/xapit.rake", "uninstall.rb", "xapit.gemspec"]
   s.homepage = %q{http://github.com/ryanb/xapit}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Xapit", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: xapit
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors: 
 - Ryan Bates
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-26 00:00:00 -07:00
+date: 2009-07-06 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -44,7 +44,6 @@ extra_rdoc_files:
 - README.rdoc
 - tasks/spec.rb
 - tasks/xapit.rake
-- TODO
 files: 
 - CHANGELOG
 - features/facets.feature
@@ -105,7 +104,6 @@ files:
 - spec/xapit_member.rb
 - tasks/spec.rb
 - tasks/xapit.rake
-- TODO
 - uninstall.rb
 - xapit.gemspec
 has_rdoc: true

data/TODO

@@ -1,23 +0,0 @@
-Indexing
-+ re-indexing support for new/changed models (?)
-+ auto-reload xapian database in memory if database recently indexed
-
-Finding
-? support non-ascii characters in find (å, ä, ö)
-+ range in conditions
-+ support "age:17" condition matching in query
-+ add classes option to Xapit.search to limit which classes are included
-+ support @collection.facets on Xapit.search (multiple classes)
-+ support :order option for Xapit.search (multiple classes)
-
-Facets
-+ sort facet options
-+ handle unique id collision gracefully
-
-Performance
-- benchmark indexing
-- multiple id finds in a single query
-
-Other
-- turn into Ruby Gem with clear instructions on requirements
-+ remove dependency on active_support