xapit 0.1.0 → 0.2.0

data/lib/xapit/rake_tasks.rb

@@ -0,0 +1,13 @@
+# TODO investigate why this is needed to ensure it doesn't load twice
+unless @xapit_rake_loaded
+  @xapit_rake_loaded = true
+  namespace :xapit do
+    desc "Index all xapit models."
+    task :index => :environment do
+      Xapit.remove_database
+      Xapit.index_all do |member_class|
+        puts "Indexing #{member_class.name}"
+      end
+    end
+  end
+end

data/rails_generators/xapit/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Generates files necessary to setup Xapit. This includes an initializer
+    to specify the configuration (setup_xapit.rb) and a rake file to load
+    the rake tasks (xapit.rake).
+    
+    IMPORTANT: Only use this generator if you are using the gem version of
+    Xapit, it is not needed if you are installing via Rails plugin.
+
+Examples:
+    script/generate xapit
+
+        Initializer: config/initializers/setup_xapit.rb
+        Rake Tasks:  lib/tasks/xapit.rake

data/rails_generators/xapit/templates/setup_xapit.rb

@@ -0,0 +1 @@
+Xapit.setup(:database_path => "#{Rails.root}/db/xapiandb")

data/rails_generators/xapit/templates/xapit.rake

@@ -0,0 +1,4 @@
+begin
+  require 'xapit/rake_tasks'
+rescue MissingSourceFile
+end

data/rails_generators/xapit/xapit_generator.rb

@@ -0,0 +1,20 @@
+class XapitGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.directory "config/initializers"
+      m.file "setup_xapit.rb", "config/initializers/setup_xapit.rb"
+      
+      m.directory "lib/tasks"
+      m.file "xapit.rake", "lib/tasks/xapit.rake"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Generates files necessary to setup Xapit.
+
+USAGE: #{$0} #{spec.name}
+EOS
+    end
+end

data/spec/spec_helper.rb

@@ -8,8 +8,8 @@ require File.dirname(__FILE__) + '/xapit_member'
 Spec::Runner.configure do |config|
   config.mock_with :rr
   config.before(:each) do
-    Xapit::Config.setup(:database_path => File.dirname(__FILE__) + '/tmp/xapiandb')
-    Xapit::Config.remove_database
+    Xapit.setup(:database_path => File.dirname(__FILE__) + '/tmp/xapiandb')
+    Xapit.remove_database
     XapitMember.delete_all
   end
 end

data/spec/xapit/adapters/active_record_adapter_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Xapit::ActiveRecordAdapter do
+  it "should be used for ActiveRecord::Base subclasses" do
+    Xapit::ActiveRecordAdapter.should_not be_for_class(Object)
+    klass = Object.new
+    stub(klass).ancestors { ["ActiveRecord::Base"] }
+    Xapit::ActiveRecordAdapter.should be_for_class(klass)
+  end
+  
+  it "should pass find_single to find method to target" do
+    target = Object.new
+    mock(target).find(1) { :record }
+    adapter = Xapit::ActiveRecordAdapter.new(target)
+    adapter.find_single(1).should == :record
+  end
+  
+  it "should pass find_multiple to find method to target" do
+    target = Object.new
+    mock(target).find([1, 2]) { :record }
+    adapter = Xapit::ActiveRecordAdapter.new(target)
+    adapter.find_multiple([1, 2]).should == :record
+  end
+  
+  it "should pass find_each to target" do
+    target = Object.new
+    mock(target).find_each(:args) { 5 }
+    adapter = Xapit::ActiveRecordAdapter.new(target)
+    adapter.find_each(:args).should == 5
+  end
+end

data/spec/xapit/adapters/data_mapper_adapter_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Xapit::DataMapperAdapter do
+  it "should be used for DataMapper::Resource model" do
+    Xapit::DataMapperAdapter.should_not be_for_class(Object)
+    klass = Object.new
+    stub(klass).ancestors { ["DataMapper::Resource"] }
+    Xapit::DataMapperAdapter.should be_for_class(klass)
+  end
+end

data/spec/xapit/facet_option_spec.rb

@@ -9,7 +9,7 @@ describe Xapit::FacetOption do
   end
   
   it "should remove current identifier from previous identifiers if it exists" do
-    Xapit::Config.setup(:breadcrumb_facets => false)
+    Xapit.setup(:breadcrumb_facets => false)
     option = Xapit::FacetOption.new(nil, nil, nil)
     option.existing_facet_identifiers = ["abc", "123", "foo"]
     stub(option).identifier { "foo" }
@@ -17,7 +17,7 @@ describe Xapit::FacetOption do
   end
   
   it "should support breadcrumb style facets" do
-    Xapit::Config.setup(:breadcrumb_facets => true)
+    Xapit.setup(:breadcrumb_facets => true)
     option = Xapit::FacetOption.new(nil, nil, nil)
     option.existing_facet_identifiers = ["abc", "123", "foo"]
     stub(option).identifier { "123" }

data/spec/xapit/index_blueprint_spec.rb

@@ -2,6 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Xapit::IndexBlueprint do
   before(:each) do
+    XapitMember.xapit { } # call so methods are generated
     @index = Xapit::IndexBlueprint.new(XapitMember)
   end
   
@@ -36,7 +37,14 @@ describe Xapit::IndexBlueprint do
     @index.facet(:foo)
     @index.facet(:test)
     @index.sortable(:bar, :blah)
-    @index.sortable_position_for(:blah).should == 3
+    @index.position_of_sortable(:blah).should == 3
+  end
+  
+  it "should have a field position offset by facets + sortable" do
+    @index.facet(:foo)
+    @index.sortable(:bar, :blah)
+    @index.field(:bar, :blah)
+    @index.position_of_field(:blah).should == 4
   end
   
   it "should index member document into database" do
@@ -53,8 +61,8 @@ describe Xapit::IndexBlueprint do
   end
   
   it "should pass in extra arguments to each method" do
-    index = Xapit::IndexBlueprint.new(Object, :foo, :bar => :blah)
-    mock(Object).find_each(:foo, :bar => :blah)
+    index = Xapit::IndexBlueprint.new(XapitMember, :foo, :bar => :blah)
+    mock(XapitMember).find_each(:foo, :bar => :blah)
     index.index_all
   end
 end

data/spec/xapit/indexers/abstract_indexer_spec.rb

@@ -71,4 +71,41 @@ describe Xapit::AbstractIndexer do
     @index.field(:created_on)
     @indexer.field_terms(member).should == ["Xcreated_on-#{member.created_on.to_time.to_i}"]
   end
+  
+  it "should use sortable_serialze for numeric sortable" do
+    member = Object.new
+    stub(member).age { 7.89 }
+    @index.sortable(:age)
+    @indexer.values(member).should == [Xapian.sortable_serialise(7.89)]
+  end
+  
+  it "should only use first value if sortable attribute is an array" do
+    member = Object.new
+    stub(member).age { [1, 2] }
+    @index.sortable(:age)
+    @indexer.values(member).should == [Xapian.sortable_serialise(1)]
+  end
+  
+  it "should add sortable_serialze value for numeric field" do
+    member = Object.new
+    stub(member).age { [1, 2] }
+    @index.field(:age)
+    @indexer.values(member).should == [Xapian.sortable_serialise(1)]
+  end
+  
+  it "should use sortable_serialze for date field" do
+    date = Date.today
+    member = Object.new
+    stub(member).age { date }
+    @index.field(:age)
+    @indexer.values(member).should == [Xapian.sortable_serialise(date.to_time.to_i)]
+  end
+  
+  it "should use sortable_serialze for time field" do
+    time = Time.now
+    member = Object.new
+    stub(member).age { time }
+    @index.field(:age)
+    @indexer.values(member).should == [Xapian.sortable_serialise(time.to_i)]
+  end
 end

data/spec/xapit/indexers/classic_indexer_spec.rb

@@ -23,4 +23,13 @@ describe Xapit::ClassicIndexer do
     @indexer.index_text_attributes(member, document)
     document.terms.map(&:term).sort.should == %w[6].sort
   end
+  
+  it "should return terms separated by array" do
+    member = Object.new
+    stub(member).description { ["foo bar", 6, "", nil] }
+    @index.text(:description)
+    document = Xapian::Document.new
+    @indexer.index_text_attributes(member, document)
+    document.terms.map(&:term).sort.should == ["foo bar", "6"].sort
+  end
 end

data/spec/xapit/indexers/simple_indexer_spec.rb

@@ -10,21 +10,21 @@ describe Xapit::SimpleIndexer do
     member = Object.new
     stub(member).description { "This is a test" }
     @index.text(:description)
-    @indexer.terms_for_attribute_without_stemming(member, :description, {}).should == %w[this is a test]
+    @indexer.terms_for_attribute(member, :description, {}).should == %w[this is a test]
   end
   
-  it "should return text term with stemming added" do
+  it "should return text terms with stemming added" do
     member = Object.new
     stub(member).description { "jumping high" }
     @index.text(:description)
-    @indexer.terms_for_attribute(member, :description, {}).should == %w[jumping Zjump high Zhigh]
+    @indexer.stemmed_terms_for_attribute(member, :description, {}).should == %w[Zjump Zhigh]
   end
   
   it "should convert attribute to string when converting text to terms" do
     member = Object.new
     stub(member).num { 123 }
     @index.text(:num)
-    @indexer.terms_for_attribute_without_stemming(member, :num, {}).should == %w[123]
+    @indexer.terms_for_attribute(member, :num, {}).should == %w[123]
   end
   
   it "should add text terms to document when indexing attributes" do
@@ -32,14 +32,14 @@ describe Xapit::SimpleIndexer do
     stub(@indexer).terms_for_attribute { %w[term list] }
     document = Xapian::Document.new
     @indexer.index_text_attributes(nil, document)
-    document.terms.map(&:term).sort.should == %w[term list].sort
+    document.terms.map(&:term).sort.should == %w[Zlist Zterm list term].sort
   end
   
   it "should use given block to generate text terms" do
     member = Object.new
     stub(member).name { "foobar" }
     proc = lambda { |t| [t.length] }
-    @indexer.terms_for_attribute_without_stemming(member, :name, { :proc => proc }).should == ["6"]
+    @indexer.terms_for_attribute(member, :name, { :proc => proc }).should == ["6"]
   end
   
   it "should increment term frequency by weight option" do
@@ -50,4 +50,20 @@ describe Xapit::SimpleIndexer do
     @indexer.index_text_attributes(member, document)
     document.terms.first.wdf.should == 10
   end
+  
+  it "should increment term frequency by weight option" do
+    member = Object.new
+    stub(member).description { "This is a test" }
+    @index.text(:description, :weight => 10)
+    document = Xapian::Document.new
+    @indexer.index_text_attributes(member, document)
+    document.terms.first.wdf.should == 10
+  end
+  
+  it "should return terms separated by array" do
+    member = Object.new
+    stub(member).description { ["foo bar", 6, "", nil] }
+    @index.text(:description)
+    @indexer.terms_for_attribute(member, :description, {}).should == ["foo bar", "6"]
+  end
 end

data/spec/xapit/membership_spec.rb

@@ -21,11 +21,13 @@ describe XapitMember do
       XapitMember.xapit do |index|
         index.text :description
       end
+      XapitMember.instance_variable_set("@xapit_adapter", nil)
     end
     
     it "should have xapit index blueprint" do
       XapitMember.xapit_index_blueprint.should be_kind_of(Xapit::IndexBlueprint)
     end
+    
     it "should return collection from search" do
       XapitMember.search("foo").class.should == Xapit::Collection
     end
@@ -35,5 +37,19 @@ describe XapitMember do
       member.xapit_relevance = 123
       member.xapit_relevance.should == 123
     end
+    
+    it "should have an adapter" do
+      XapitMember.xapit_adapter.class.should == Xapit::ActiveRecordAdapter
+    end
+    
+    it "should use DataMapper adapter if that is ancestor" do
+      stub(XapitMember).ancestors { ["DataMapper::Resource"] }
+      XapitMember.xapit_adapter.class.should == Xapit::DataMapperAdapter
+    end
+    
+    it "should raise an exception when no adapter is found" do
+      stub(XapitMember).ancestors { [] }
+      lambda { XapitMember.xapit_adapter }.should raise_error
+    end
   end
 end

data/spec/xapit/query_parsers/abstract_query_parser_spec.rb

@@ -4,20 +4,38 @@ describe Xapit::AbstractQueryParser do
   before(:each) do
   end
     
-  it "parse conditions hash into terms" do
+  it "should parse conditions hash into terms" do
     parser = Xapit::AbstractQueryParser.new(:conditions => { :foo => 'bar', 'hello' => :world })
     parser.condition_terms.sort.should == ["Xfoo-bar", "Xhello-world"].sort
   end
     
-  it "convert time into integer before placing in condition term" do
+  it "should convert time into integer before placing in condition term" do
     time = Time.now
     parser = Xapit::AbstractQueryParser.new(:conditions => { :time => time })
     parser.condition_terms.should == ["Xtime-#{time.to_i}"]
   end
     
-  it "convert date into time then integer before placing in condition term" do
+  it "should convert date into time then integer before placing in condition term" do
     date = Date.today
     parser = Xapit::AbstractQueryParser.new(:conditions => { :date => date })
     parser.condition_terms.should == ["Xdate-#{date.to_time.to_i}"]
   end
+    
+  it "should give spelling suggestion on full term" do
+    Xapit::Config.writable_database.add_spelling("foo bar")
+    parser = Xapit::AbstractQueryParser.new(nil, "foo barr")
+    parser.spelling_suggestion.should == "foo bar"
+  end
+    
+  it "should allow an array of conditions to be specified and use OR xapian query." do
+    parser = Xapit::AbstractQueryParser.new(:not_conditions => { :foo => %w[hello world]})
+    parser.not_condition_terms.first.xapian_query.description.should == Xapit::Query.new(%w[Xfoo-hello Xfoo-world], :or).xapian_query.description
+  end
+    
+  it "should allow range condition to be specified and use VALUE_RANGE xapian query." do
+    XapitMember.xapit { |i| i.field :foo }
+    expected = Xapian::Query.new(Xapian::Query::OP_VALUE_RANGE, 0, Xapian.sortable_serialise(2), Xapian.sortable_serialise(5))
+    parser = Xapit::AbstractQueryParser.new(XapitMember, :conditions => { :foo => 2..5 })
+    parser.condition_terms.first.description.should == expected.description
+  end
 end

data/spec/xapit/query_spec.rb

@@ -19,6 +19,12 @@ describe Xapit::Query do
     query.xapian_query.description.should == expected.description
   end
   
+  it "should build a query from an array of strings with :or operator" do
+    expected = Xapian::Query.new(Xapian::Query::OP_OR, %w[foo bar])
+    query = Xapit::Query.new(%w[foo bar], :or)
+    query.xapian_query.description.should == expected.description
+  end
+  
   it "should AND two queries together" do
     expected = Xapian::Query.new(Xapian::Query::OP_AND,
       Xapian::Query.new(Xapian::Query::OP_AND, ["foo"]),
@@ -38,4 +44,19 @@ describe Xapit::Query do
     query.or_query("bar")
     query.xapian_query.description.should == expected.description
   end
+  
+  it "should build a query from an array of mixed strings and queries" do
+    expected = Xapian::Query.new(Xapian::Query::OP_AND,
+      Xapian::Query.new(Xapian::Query::OP_AND, ["foo"]),
+      Xapian::Query.new(Xapian::Query::OP_AND, ["bar"])
+    )
+    query = Xapit::Query.new([Xapit::Query.new("foo"), Xapian::Query.new(Xapian::Query::OP_AND, ["bar"])])
+    query.xapian_query.description.should == expected.description
+  end
+  
+  it "should use xapit query passed in" do
+    expected = Xapian::Query.new(Xapian::Query::OP_AND, ["foo bar"])
+    query = Xapit::Query.new(Xapit::Query.new("foo bar"))
+    query.xapian_query.description.should == expected.description
+  end
 end

data/spec/xapit_member.rb

@@ -3,6 +3,12 @@ class XapitMember
   
   attr_reader :id
   
+  # Make it look like this inherits from ActiveRecord::Base
+  # so it will use the ActiveRecord adapter.
+  def self.ancestors
+    ["ActiveRecord::Base"]
+  end
+  
   def self.find_each(&block)
     @@records.each(&block) if @@records
   end
@@ -11,8 +17,13 @@ class XapitMember
     @@records = []
   end
   
-  def self.find(id)
-    @@records.detect { |r| r.id == id.to_i }
+  def self.find(ids)
+    if ids.kind_of? Array
+      # change the order to mimic database where we can't predict the order
+      ids.sort.map { |id| @@records.detect { |r| r.id == id.to_i } }
+    else
+      @@records.detect { |r| r.id == ids.to_i }
+    end
   end
   
   def initialize(attributes = {})

data/tasks/xapit.rake

@@ -1,9 +1 @@
-namespace :xapit do
-  desc "Index all xapit models."
-  task :index => :environment do
-    Xapit::Config.remove_database
-    Xapit.index_all do |member_class|
-      puts "Indexing #{member_class.name}"
-    end
-  end
-end
+require File.join(File.dirname(__FILE__), '/../lib/xapit/rake_tasks')