sunspot 2.1.1 → 2.2.0

data/lib/sunspot/version.rb

@@ -1,3 +1,3 @@
 module Sunspot
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 end

data/spec/api/query/fulltext_examples.rb

@@ -188,7 +188,8 @@ shared_examples_for 'fulltext query' do
     search Photo do
       keywords 'great pizza'
     end
-    connection.should have_last_search_with(:qf => 'caption_text^1.5')
+    # Hashes in 1.8 aren't ordered
+    connection.searches.last[:qf].split(" ").sort.join(" ").should eq 'caption_text^1.5 description_text'
   end
 
   it 'sets default boost with fields specified in options' do
@@ -310,4 +311,152 @@ shared_examples_for 'fulltext query' do
       end
     end.should raise_error(Sunspot::UnrecognizedFieldError)
   end
+
+  describe 'connective examples' do
+    it 'creates a disjunction between two subqueries' do
+      search Post do
+        any do
+          fulltext 'keywords1', :fields => :title
+          fulltext 'keyword2', :fields => :body
+        end
+      end
+
+      connection.searches.last[:q].should eq "(_query_:\"{!edismax qf='title_text'}keywords1\" OR _query_:\"{!edismax qf='body_textsv'}keyword2\")"
+    end
+
+    it 'creates a conjunction inside of a disjunction' do
+      search do
+        any do
+          fulltext 'keywords1', :fields => :body
+
+          all do
+            fulltext 'keyword2', :fields => :body
+            fulltext 'keyword3', :fields => :body
+          end
+        end
+      end
+
+      connection.searches.last[:q].should eq "(_query_:\"{!edismax qf='body_textsv'}keywords1\" OR (_query_:\"{!edismax qf='body_textsv'}keyword2\" AND _query_:\"{!edismax qf='body_textsv'}keyword3\"))"
+    end
+
+    it 'does nothing special if #all/#any called from the top level or called multiple times' do
+      search Post do
+        all do
+          fulltext 'keywords1', :fields => :title
+          fulltext 'keyword2', :fields => :body
+        end
+      end
+
+      connection.searches.last[:q].should eq "(_query_:\"{!edismax qf='title_text'}keywords1\" AND _query_:\"{!edismax qf='body_textsv'}keyword2\")"
+    end
+
+    it 'does nothing special if #all/#any are mixed and called multiple times' do
+      search Post do
+        all do
+          any do
+            all do
+              fulltext 'keywords1', :fields => :title
+              fulltext 'keyword2', :fields => :body
+            end
+          end
+        end
+      end
+
+      connection.searches.last[:q].should eq "(_query_:\"{!edismax qf='title_text'}keywords1\" AND _query_:\"{!edismax qf='body_textsv'}keyword2\")"
+
+      search Post do
+        any do
+          all do
+            any do
+              fulltext 'keywords1', :fields => :title
+              fulltext 'keyword2', :fields => :body
+            end
+          end
+        end
+      end
+
+      connection.searches.last[:q].should eq "(_query_:\"{!edismax qf='title_text'}keywords1\" OR _query_:\"{!edismax qf='body_textsv'}keyword2\")"
+    end
+
+    it "does not add empty parentheses" do
+      search Post do
+        any do
+          all do
+          end
+
+          any do
+            fulltext 'keywords1', :fields => :title
+            all do
+            end
+          end
+        end
+      end
+
+      connection.searches.last[:q].should eq "_query_:\"{!edismax qf='title_text'}keywords1\""
+    end
+  end
+
+  describe "joins" do
+    it "should search by join" do
+      srch = search PhotoContainer do
+        any do
+          fulltext 'keyword1', :fields => :caption
+          fulltext 'keyword2', :fields => :description
+        end
+      end
+
+      obj_id = find_ob_id(srch)
+      q_name = "qPhoto#{obj_id}"
+      fq_name = "f#{q_name}"
+
+      connection.searches.last[:q].should eq "(_query_:\"{!join from=photo_container_id_i to=id_i v=$#{q_name} fq=$#{fq_name}}\" OR _query_:\"{!edismax qf='description_text^1.2'}keyword2\")"
+      connection.searches.last[q_name].should eq "_query_:\"{!edismax qf='caption_text'}keyword1\""
+      connection.searches.last[fq_name].should eq "type:Photo"
+    end
+
+    it "should be able to resolve name conflicts with the :prefix option" do
+      srch = search PhotoContainer do
+        any do
+          fulltext 'keyword1', :fields => :description
+          fulltext 'keyword2', :fields => :photo_description
+        end
+      end
+
+      obj_id = find_ob_id(srch)
+      q_name = "qPhoto#{obj_id}"
+      fq_name = "f#{q_name}"
+
+      connection.searches.last[:q].should eq "(_query_:\"{!edismax qf='description_text^1.2'}keyword1\" OR _query_:\"{!join from=photo_container_id_i to=id_i v=$#{q_name} fq=$#{fq_name}}\")"
+      connection.searches.last[q_name].should eq "_query_:\"{!edismax qf='description_text'}keyword2\""
+      connection.searches.last[fq_name].should eq "type:Photo"
+    end
+
+    it "should recognize fields when adding from DSL, e.g. when calling boost_fields" do
+      srch = search PhotoContainer do
+        any do
+          fulltext 'keyword1', :fields => [:photo_description, :description] do
+            boost_fields(:photo_description => 1.3, :description => 1.5)
+          end
+        end
+      end
+
+      obj_id = find_ob_id(srch)
+      q_name = "qPhoto#{obj_id}"
+      fq_name = "f#{q_name}"
+
+      connection.searches.last[:q].should eq "(_query_:\"{!edismax qf='description_text^1.5'}keyword1\" OR _query_:\"{!join from=photo_container_id_i to=id_i v=$#{q_name} fq=$#{fq_name}}\")"
+      connection.searches.last[q_name].should eq "_query_:\"{!edismax qf='description_text^1.3'}keyword1\""
+      connection.searches.last[fq_name].should eq "type:Photo"
+    end
+
+    private
+
+    def find_ob_id(search)
+      search.query.
+        instance_variable_get("@components").find { |c| c.is_a?(Sunspot::Query::Conjunction) }.
+        instance_variable_get("@components").find { |c| c.is_a?(Sunspot::Query::Disjunction) }.
+        instance_variable_get("@components").find { |c| c.is_a?(Sunspot::Query::Join) }.
+        object_id
+    end
+  end
 end

data/spec/api/query/geo_examples.rb

@@ -41,12 +41,8 @@ shared_examples_for 'geohash query' do
       fulltext 'pizza', :fields => :title
       with(:coordinates).near(40.7, -73.5)
     end
-    expected =
-      "{!edismax fl='* score' qf='title_text'}pizza (#{build_geo_query})"
-    connection.should have_last_search_including(
-      :q,
-      %Q(_query_:"{!edismax qf='title_text'}pizza" (#{build_geo_query}))
-    )
+    expected = %Q((_query_:"{!edismax qf='title_text'}pizza" AND (#{build_geo_query})))
+    connection.should have_last_search_including(:q, expected)
   end
 
   private

data/spec/api/query/join_spec.rb

@@ -6,7 +6,7 @@ describe 'join' do
       with(:caption, 'blah')
     end
     connection.should have_last_search_including(
-      :fq, "{!join from=photo_container_id to=id}caption_s:blah")
+      :fq, "{!join from=photo_container_id_i to=id_i}caption_s:blah")
   end
 
   it 'should greater_than search by join' do
@@ -14,6 +14,6 @@ describe 'join' do
       with(:photo_rating).greater_than(3)
     end
     connection.should have_last_search_including(
-      :fq, "{!join from=photo_container_id to=id}average_rating_ft:{3\\.0 TO *}")
+      :fq, "{!join from=photo_container_id_i to=id_i}average_rating_ft:{3\\.0 TO *}")
   end
-end
+end

data/spec/api/query/ordering_pagination_examples.rb

@@ -46,6 +46,20 @@ shared_examples_for 'sortable query' do
     connection.should have_last_search_with(:rows => 15, :start => 30)
   end
 
+  it 'paginates with initial cursor' do
+    search do
+      paginate :cursor => '*', :per_page => 15
+    end
+    connection.should have_last_search_with(:rows => 15, :cursorMark => '*')
+  end
+
+  it 'paginates with given cursor' do
+    search do
+      paginate :cursor => 'AoIIP4AAACxQcm9maWxlIDEwMTk='
+    end
+    connection.should have_last_search_with(:cursorMark => 'AoIIP4AAACxQcm9maWxlIDEwMTk=')
+  end
+
   it 'orders by a single field' do
     search do
       order_by :average_rating, :desc

data/spec/api/query/spellcheck_examples.rb

@@ -0,0 +1,20 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+shared_examples_for 'spellcheck query' do
+
+  it 'sends spellcheck parameters to solr' do
+    search do
+      spellcheck
+    end
+    connection.should have_last_search_including(:spellcheck, true)
+  end
+
+
+  it "sends additional spellcheck parameters with camel casing" do
+    search do
+      spellcheck :only_more_popular => true, :count => 5
+    end
+    connection.should have_last_search_including('spellcheck.onlyMorePopular', true)
+    connection.should have_last_search_including('spellcheck.count', 5)
+  end
+end

data/spec/api/query/standard_spec.rb

@@ -13,6 +13,7 @@ describe 'standard query', :type => :query do
   it_should_behave_like "geohash query"
   it_should_behave_like "spatial query"
   it_should_behave_like "stats query"
+  it_should_behave_like "spellcheck query"
 
   it 'adds a no-op query to :q parameter when no :q provided' do
     session.search Post do

data/spec/api/search/cursor_paginated_collection_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe "CursorPaginatedCollection" do
+  subject { Sunspot::Search::CursorPaginatedCollection.new [], 10, 20, '*', 'AoIIP4AAACxQcm9maWxlIDEwMTk=' }
+
+  it { subject.should be_an(Array) }
+
+  describe "#send" do
+    it 'should allow send' do
+      expect { subject.send(:current_cursor) }.to_not raise_error
+    end
+  end
+
+  describe "#respond_to?" do
+    it 'should return true for current_cursor' do
+      subject.respond_to?(:current_cursor).should be_true
+    end
+  end
+
+  context "behaves like a WillPaginate::Collection" do
+    it { subject.total_entries.should eql(20) }
+    it { subject.total_pages.should eql(2) }
+    it { subject.current_cursor.should eql('*') }
+    it { subject.per_page.should eql(10) }
+    it { subject.next_page_cursor.should eql('AoIIP4AAACxQcm9maWxlIDEwMTk=') }
+  end
+
+  context "behaves like Kaminari" do
+    it { subject.total_count.should eql(20) }
+    it { subject.num_pages.should eql(2) }
+    it { subject.limit_value.should eql(10) }
+    it { subject.first_page?.should be_true }
+    it { subject.last_page?.should be_true }
+  end
+end

data/spec/api/search/paginated_collection_spec.rb

@@ -23,6 +23,7 @@ describe "PaginatedCollection" do
     it { subject.current_page.should eql(1) }
     it { subject.per_page.should eql(10) }
     it { subject.previous_page.should be_nil }
+    it { subject.prev_page.should be_nil }
     it { subject.next_page.should eql(2) }
     it { subject.out_of_bounds?.should_not be_true }
     it { subject.offset.should eql(0) }

data/spec/api/session_spec.rb

@@ -35,6 +35,26 @@ shared_examples_for 'all sessions' do
     end
   end
 
+  context '#commit(bool)' do
+    it 'should soft-commit if bool=true' do
+      @session.commit(true)
+      connection.should have(1).commits
+      connection.should have(1).soft_commits
+    end
+
+    it 'should hard-commit if bool=false' do
+      @session.commit(false)
+      connection.should have(1).commits
+      connection.should have(0).soft_commits
+    end
+
+    it 'should hard-commit if bool is not specified' do
+      @session.commit
+      connection.should have(1).commits
+      connection.should have(0).soft_commits
+    end
+  end
+
   context '#optimize()' do
     before :each do
       @session.optimize
@@ -202,17 +222,31 @@ describe 'Session' do
       connection.should have(0).commits
     end
 
-    it 'should commit when commit_if_dirty called on dirty session' do
+    it 'should hard commit when commit_if_dirty called on dirty session' do
       @session.index(Post.new)
       @session.commit_if_dirty
       connection.should have(1).commits
     end
     
-    it 'should commit when commit_if_delete_dirty called on delete_dirty session' do
+    it 'should soft commit when commit_if_dirty called on dirty session' do
+      @session.index(Post.new)
+      @session.commit_if_dirty(true)
+      connection.should have(1).commits
+      connection.should have(1).soft_commits
+    end
+    
+    it 'should hard commit when commit_if_delete_dirty called on delete_dirty session' do
       @session.remove(Post.new)
       @session.commit_if_delete_dirty
       connection.should have(1).commits
     end
+
+    it 'should soft commit when commit_if_delete_dirty called on delete_dirty session' do
+      @session.remove(Post.new)
+      @session.commit_if_delete_dirty(true)
+      connection.should have(1).commits
+      connection.should have(1).soft_commits
+    end
   end
 
   context 'session proxy' do

data/spec/integration/spellcheck_spec.rb

@@ -0,0 +1,74 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+include SearchHelper
+
+describe 'spellcheck' do
+  before :each do
+    Sunspot.remove_all
+
+    @posts = [
+      Post.new(:title => 'Clojure Developer'),
+      Post.new(:title => 'Conjure Flow'),
+      Post.new(:title => 'Clojure Analyst'),
+      Post.new(:title => 'C++ Developer'),
+      Post.new(:title => 'C++ Developing')
+    ]
+
+    Sunspot.index!(*@posts)
+    Sunspot.commit
+  end
+
+  it 'has no spellchecking by default' do
+    search = Sunspot.search(Post) do
+      keywords 'Closure'
+    end
+    search.spellcheck_suggestions.should == {}
+  end
+
+  it 'returns the list of suggestions' do
+    search = Sunspot.search(Post) do
+      keywords 'Closure'
+      spellcheck :count => 3
+    end
+    search.spellcheck_suggestions['closure']['suggestion'].should == [
+      {'word'=>'clojure', 'freq'=>2}, {'word'=>'conjure', 'freq'=>1}
+    ]
+  end
+
+  it 'returns suggestion with highest frequency' do
+    search = Sunspot.search(Post) do
+      keywords 'Closure'
+      spellcheck :count => 3
+    end
+    search.spellcheck_suggestion_for('closure').should == 'clojure'
+  end
+
+  it 'returns suggestion without collation when only more popular is true' do
+    search = Sunspot.search(Post) do
+      keywords 'Closure'
+      spellcheck :count => 3, :only_more_popular => true, :collate => false
+    end
+
+    search.spellcheck_suggestion_for('closure').should == 'clojure'
+  end
+
+  context 'spellcheck collation' do
+    it 'replaces terms that are not in the index if terms are provided' do
+
+      search = Sunspot.search(Post) do
+        keywords 'lojure developing'
+        spellcheck :count => 3, :only_more_popular => true
+      end
+      search.spellcheck_collation('lojure', 'developing').should == 'clojure developing'
+    end
+
+    it 'returns Solr collation if terms are not provided' do
+
+      search = Sunspot.search(Post) do
+        keywords 'lojure developing'
+        spellcheck :count => 3, :only_more_popular => true
+      end
+      search.spellcheck_collation.should == 'clojure developer'
+    end
+  end
+
+end

data/spec/mocks/connection.rb

@@ -22,7 +22,7 @@ module Mock
   end
 
   class Connection
-    attr_reader :adds, :commits, :optims, :searches, :message, :opts, :deletes_by_query
+    attr_reader :adds, :commits, :soft_commits, :optims, :searches, :message, :opts, :deletes_by_query
     attr_accessor :response
     attr_writer :expected_handler
     undef_method :select # annoyingly defined on Object
@@ -30,7 +30,7 @@ module Mock
     def initialize(opts = {})
       @opts = opts
       @message = OpenStruct.new
-      @adds, @deletes, @deletes_by_query, @commits, @optims, @searches = Array.new(6) { [] }
+      @adds, @deletes, @deletes_by_query, @commits, @soft_commits, @optims, @searches = Array.new(7) { [] }
       @expected_handler = :select
     end
 
@@ -46,8 +46,10 @@ module Mock
       @deletes_by_query << query
     end
 
-    def commit
+    def commit(opts = {})
+      commit_attrs = opts.delete(:commit_attributes) || {}
       @commits << Time.now
+      @soft_commits << Time.now if commit_attrs[:softCommit]
     end
 
     def optimize