sunspot 2.3.0 → 2.6.0

data/spec/api/search/hits_spec.rb

@@ -12,6 +12,20 @@ describe 'hits', :type => :search do
     end).to eq([['Post', post_1.id.to_s], ['Post', post_2.id.to_s]])
   end
 
+  it "should return ID prefix when used with compositeId shard router" do
+    Sunspot.index!(ModelWithPrefixId.new)
+
+    expect(Sunspot.search(ModelWithPrefixId).
+      hits.map { |h| h.id_prefix }.uniq).to eq ["USERDATA!"]
+  end
+
+  it "should parse nested ID prefixes" do
+    Sunspot.index!(ModelWithNestedPrefixId.new)
+
+    expect(Sunspot.search(ModelWithNestedPrefixId).
+      hits.map { |h| h.id_prefix }.uniq).to eq ["USER!USERDATA!"]
+  end
+
   it 'returns search total as attribute of hits' do
     stub_results(Post.new, 4)
     expect(session.search(Post) do

data/spec/api/setup_spec.rb

@@ -0,0 +1,99 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Sunspot::Setup do
+  context '#id_prefix_for_class' do
+    subject { Sunspot::Setup.for(clazz).id_prefix_for_class }
+
+    context 'when `id_prefix` is defined on model' do
+      context 'as Proc' do
+        let(:clazz) { PostWithProcPrefixId }
+
+        it 'returns nil' do
+          is_expected.to be_nil
+        end
+      end
+
+      context 'as Symbol' do
+        let(:clazz) { PostWithSymbolPrefixId }
+
+        it 'returns nil' do
+          is_expected.to be_nil
+        end
+      end
+
+      context 'as String' do
+        let(:clazz) { PostWithStringPrefixId }
+
+        it 'returns `id_prefix` value' do
+          is_expected.to eq('USERDATA!')
+        end
+      end
+    end
+
+    context 'when `id_prefix` is not defined on model' do
+      let(:clazz) { PostWithoutPrefixId }
+
+      it 'returns nil' do
+        is_expected.to be_nil
+      end
+    end
+  end
+
+  context '#id_prefix_defined?' do
+    subject { Sunspot::Setup.for(clazz).id_prefix_defined? }
+
+    context 'when `id_prefix` is defined on model' do
+      let(:clazz) { PostWithProcPrefixId }
+
+      it 'returns true' do
+        is_expected.to be_truthy
+      end
+    end
+
+    context 'when `id_prefix` is not defined on model' do
+      let(:clazz) { PostWithoutPrefixId }
+
+      it 'returns false' do
+        is_expected.to be_falsey
+      end
+    end
+  end
+
+  context '#id_prefix_requires_instance?' do
+    subject { Sunspot::Setup.for(clazz).id_prefix_requires_instance? }
+
+    context 'when `id_prefix` is defined on model' do
+      context 'as Proc' do
+        let(:clazz) { PostWithProcPrefixId }
+
+        it 'returns true' do
+          is_expected.to be_truthy
+        end
+      end
+
+      context 'as Symbol' do
+        let(:clazz) { PostWithSymbolPrefixId }
+
+        it 'returns true' do
+          is_expected.to be_truthy
+        end
+      end
+
+      context 'as String' do
+        let(:clazz) { PostWithStringPrefixId }
+
+        it 'returns false' do
+          is_expected.to be_falsey
+        end
+      end
+    end
+
+    context 'when `id_prefix` is not defined on model' do
+      let(:clazz) { PostWithoutPrefixId }
+
+      it 'returns false' do
+        is_expected.to be_falsey
+      end
+    end
+  end
+end

data/spec/api/sunspot_spec.rb

@@ -24,6 +24,9 @@ describe Sunspot do
       config_before_reset = Sunspot.config
       Sunspot.reset!(true)
       expect(Sunspot.config).to eq(config_before_reset)
+
+      # Restore sunspot config after test
+      Sunspot.reset!(false)
     end
   end
 end

data/spec/helpers/indexer_helper.rb

@@ -14,4 +14,26 @@ module IndexerHelper
   def values_in_last_document_for(field_name)
     @connection.adds.last.last.fields_by_name(field_name).map { |field| field.value }
   end
+
+  def index_post(post)
+    Sunspot.index!(post)
+    hit = find_post(post)
+    expect(hit).not_to be_nil
+    hit
+  end
+
+  def find_post(post)
+    Sunspot.search(clazz).hits.find { |h| h.primary_key.to_i == post.id && h.id_prefix == id_prefix_value(post, id_prefix) }
+  end
+
+  def id_prefix_value(post, id_prefix)
+    return unless id_prefix
+    return id_prefix if id_prefix.is_a?(String)
+
+    id_prefix.call(post)
+  end
+
+  def post_solr_id
+    "#{id_prefix_value(post, id_prefix)}#{clazz} #{post.id}"
+  end
 end

data/spec/integration/atomic_updates_spec.rb

@@ -1,6 +1,79 @@
 require File.expand_path('../spec_helper', File.dirname(__FILE__))
 
-describe 'atomic updates' do
+shared_examples 'atomic update with instance as key' do
+  it 'updates record' do
+    post = clazz.new(title: 'A Title', featured: true)
+    Sunspot.index!(post)
+
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+    Sunspot.atomic_update!(clazz, post => { title: 'A New Title' })
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: 'A New Title', featured: true)
+
+    Sunspot.atomic_update!(clazz, post => { featured: false })
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: 'A New Title', featured: false)
+  end
+
+  it 'does not print warning' do
+    post = clazz.new(title: 'A Title', featured: true)
+    Sunspot.index!(post)
+
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+    expect do
+      Sunspot.atomic_update!(clazz, post => { title: 'A New Title' })
+    end.to_not output(Sunspot::AtomicUpdateRequireInstanceForCompositeIdMessage.call(clazz)).to_stderr
+  end
+
+  it 'does not create duplicate document' do
+    post = clazz.new(title: 'A Title', featured: true)
+    Sunspot.index!(post)
+
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+    Sunspot.atomic_update!(clazz, post => { title: 'A New Title' })
+    hit = find_indexed_post_with_prefix_id(post, nil)
+    expect(hit).to be_nil
+  end
+end
+
+shared_examples 'atomic update with id as key' do
+  it 'does not update record' do
+    post = clazz.new(title: 'A Title', featured: true)
+    Sunspot.index!(post)
+
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+    Sunspot.atomic_update!(clazz, post.id => { title: 'A New Title' })
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: 'A Title', featured: true)
+
+    Sunspot.atomic_update!(clazz, post.id => { featured: false })
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: 'A Title', featured: true)
+  end
+
+  it 'prints warning' do
+    post = clazz.new(title: 'A Title', featured: true)
+    Sunspot.index!(post)
+
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+    expect do
+      Sunspot.atomic_update!(clazz, post.id => { title: 'A New Title' })
+    end.to output(Sunspot::AtomicUpdateRequireInstanceForCompositeIdMessage.call(clazz) + "\n").to_stderr
+  end
+
+  it 'creates duplicate document that have only fields provided for update' do
+    post = clazz.new(title: 'A Title', featured: true)
+    Sunspot.index!(post)
+
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+    Sunspot.atomic_update!(clazz, post.id => { title: 'A New Title' })
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, nil), title: 'A New Title', featured: nil)
+  end
+end
+
+describe 'Atomic Update feature' do
   before :all do
     Sunspot.remove_all
   end
@@ -18,10 +91,27 @@ describe 'atomic updates' do
     hit
   end
 
-  it 'should update single record fields one by one' do
+  def find_and_validate_indexed_post_with_prefix_id(post, id_prefix)
+    hit = find_indexed_post_with_prefix_id(post, id_prefix_value(post, id_prefix))
+    expect(hit).not_to be_nil
+    hit
+  end
+
+  def find_indexed_post_with_prefix_id(post, id_prefix)
+    Sunspot.search(post.class).hits.find { |h| h.primary_key.to_i == post.id && h.id_prefix == id_prefix }
+  end
+
+  def id_prefix_value(post, id_prefix)
+    return unless id_prefix
+    return id_prefix if id_prefix.is_a?(String)
+
+    id_prefix.call(post)
+  end
+
+  it 'updates single record fields one by one' do
     post = Post.new(title: 'A Title', featured: true)
     Sunspot.index!(post)
-    
+
     validate_hit(find_indexed_post(post.id), title: post.title, featured: post.featured)
 
     Sunspot.atomic_update!(Post, post.id => {title: 'A New Title'})
@@ -31,7 +121,7 @@ describe 'atomic updates' do
     validate_hit(find_indexed_post(post.id), title: 'A New Title', featured: false)
   end
 
-  it 'should update fields for multiple records' do
+  it 'updates fields for multiple records' do
     post1 = Post.new(title: 'A First Title', featured: true)
     post2 = Post.new(title: 'A Second Title', featured: false)
     Sunspot.index!(post1, post2)
@@ -44,7 +134,7 @@ describe 'atomic updates' do
     validate_hit(find_indexed_post(post2.id), title: 'A Second Title', featured: true)
   end
 
-  it 'should clear field value properly' do
+  it 'clears field value properly' do
     post = Post.new(title: 'A Title', tags: %w(tag1 tag2), featured: true)
     Sunspot.index!(post)
     validate_hit(find_indexed_post(post.id), title: post.title, tag_list: post.tags, featured: true)
@@ -55,4 +145,78 @@ describe 'atomic updates' do
     Sunspot.atomic_update!(Post, post.id => {featured: nil})
     validate_hit(find_indexed_post(post.id), title: post.title, tag_list: nil, featured: nil)
   end
+
+  context 'when `id_prefix` is defined on model' do
+    context 'as Proc' do
+      let(:clazz) { PostWithProcPrefixId }
+      let(:id_prefix) { lambda { |post| "USERDATA-#{post.id}!" } }
+
+      context 'and instance passed as key' do
+        include_examples 'atomic update with instance as key'
+      end
+
+      context 'and id passed as key' do
+        include_examples 'atomic update with id as key'
+      end
+    end
+
+    context 'as Symbol' do
+      let(:clazz) { PostWithSymbolPrefixId }
+      let(:id_prefix) { lambda { |post| "#{post.title}!" } }
+
+      context 'and instance passed as key' do
+        include_examples 'atomic update with instance as key'
+      end
+
+      context 'and id passed as key' do
+        include_examples 'atomic update with id as key'
+      end
+    end
+
+    context 'as String' do
+      let(:clazz) { PostWithStringPrefixId }
+      let(:id_prefix) { 'USERDATA!' }
+
+      context 'and instance passed as key' do
+        include_examples 'atomic update with instance as key'
+      end
+
+      context 'and id passed as key' do
+        it 'updates record' do
+          post = clazz.new(title: 'A Title', featured: true)
+          Sunspot.index!(post)
+
+          validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+          Sunspot.atomic_update!(clazz, post.id => { title: 'A New Title' })
+          validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: 'A New Title', featured: true)
+
+          Sunspot.atomic_update!(clazz, post.id => { featured: false })
+          validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: 'A New Title', featured: false)
+        end
+
+        it 'does not print warning' do
+          post = clazz.new(title: 'A Title', featured: true)
+          Sunspot.index!(post)
+
+          validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+          expect do
+            Sunspot.atomic_update!(clazz, post.id => { title: 'A New Title' })
+          end.to_not output(Sunspot::AtomicUpdateRequireInstanceForCompositeIdMessage.call(clazz) + "\n").to_stderr
+        end
+
+        it 'does not create duplicate document' do
+          post = clazz.new(title: 'A Title', featured: true)
+          Sunspot.index!(post)
+
+          validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+          Sunspot.atomic_update!(clazz, post.id => { title: 'A New Title' })
+          hit = find_indexed_post_with_prefix_id(post, nil)
+          expect(hit).to be_nil
+        end
+      end
+    end
+  end
 end

data/spec/integration/faceting_spec.rb

@@ -84,7 +84,7 @@ describe 'search faceting' do
       end
       expect(search.facet(:title).rows.map { |row| row.value }).to include('zero')
     end
-    
+
     it 'should return facet rows from an offset' do
       search = Sunspot.search(Post) do
         facet :title, :offset => 3
@@ -214,6 +214,15 @@ describe 'search faceting' do
       expect(search.facet(:title).rows.map { |row| row.value }).to eq(%w(four three two one))
     end
 
+    it 'should include allBuckets and missing' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        json_facet :title, all_buckets: true, missing: true
+      end
+      expect(search.facet(:title).other_count('allBuckets')).to eq(10)
+      expect(search.facet(:title).other_count('missing')).to eq(1)
+    end
+
     it 'should limit facet values by prefix' do
       search = Sunspot.search(Post) do
         with :blog_id, 1
@@ -221,7 +230,64 @@ describe 'search faceting' do
       end
       expect(search.facet(:title).rows.map { |row| row.value }.sort).to eq(%w(three two))
     end
+  end
 
+  context 'date or time json facet' do
+    before :all do
+      Sunspot.remove_all
+      posts = [
+        Post.new(title: 'dt test', blog_id: 1, published_at: Time.new(2020, 8, 20)),
+        Post.new(title: 'dt test', blog_id: 1, published_at: Time.new(2020, 7, 20)),
+        Post.new(title: 'dt test', blog_id: 1, published_at: Time.new(2020, 6, 20)),
+        Post.new(title: 'dt test', blog_id: 1, published_at: Time.new(2020, 6, 15)),
+        Post.new(title: 'dt test', blog_id: 1, published_at: Time.new(2020, 5, 20)),
+        Post.new(title: 'dt test', blog_id: 1, published_at: Time.new(2020, 4, 20)),
+        Post.new(title: 'dt test', blog_id: 1, published_at: Time.new(2020, 3, 20))
+      ]
+      posts.each { |p| Sunspot.index(p) }
+      Sunspot.commit
+    end
+
+    it 'facets properly with the range specified as time_range' do
+      time_range = [Time.new(2020, 4, 1), Time.new(2020, 7, 31)]
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        json_facet :published_at, time_range: time_range, gap: 1, gap_unit: 'MONTHS'
+      end
+      expected_rows = [
+        { count: 1, value: Time.new(2020, 4, 1).utc.iso8601 },
+        { count: 1, value: Time.new(2020, 5, 1).utc.iso8601 },
+        { count: 2, value: Time.new(2020, 6, 1).utc.iso8601 },
+        { count: 1, value: Time.new(2020, 7, 1).utc.iso8601 }
+      ]
+      expect(search.facet(:published_at).rows.map { |row| { count: row.count, value: row.value } }).to eq(expected_rows)
+    end
+
+    it 'should use custom gap parameters if provided' do
+      time_range = [Time.new(2020, 4, 1), Time.new(2020, 7, 31)]
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        json_facet :published_at, range: time_range, gap: 1, gap_unit: 'MONTHS'
+      end
+      expected_rows = [
+        { count: 1, value: Time.new(2020, 4, 1).utc.iso8601 },
+        { count: 1, value: Time.new(2020, 5, 1).utc.iso8601 },
+        { count: 2, value: Time.new(2020, 6, 1).utc.iso8601 },
+        { count: 1, value: Time.new(2020, 7, 1).utc.iso8601 }
+      ]
+      expect(search.facet(:published_at).rows.map { |row| { count: row.count, value: row.value } }).to eq(expected_rows)
+    end
+
+    it 'should support computing other statistics' do
+      time_range = [Time.new(2020, 5, 1), Time.new(2020, 7, 1)]
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        json_facet :published_at, range: time_range, gap: 1, gap_unit: 'MONTHS', other: 'all'
+      end
+      expect(search.facet(:published_at).other_count('before')).to eq(2)
+      expect(search.facet(:published_at).other_count('after')).to eq(2)
+      expect(search.facet(:published_at).other_count('between')).to eq(3)
+    end
   end
 
   context 'nested json facet' do
@@ -237,7 +303,7 @@ describe 'search faceting' do
       end
 
       0.upto(9) { |i| Sunspot.index(Post.new(:title => 'zero', :author_name => "another#{i}", :blog_id => 1)) }
-      
+
       Sunspot.commit
     end
 
@@ -459,38 +525,6 @@ describe 'search faceting' do
       expect(search.facet(:published_at).rows.last.value).to eq((time + 60*60*24)..(time + 60*60*24*2))
       expect(search.facet(:published_at).rows.last.count).to eq(1)
     end
-
-    it 'json facet should return time ranges' do
-      days_diff = 15
-      time_from = Time.utc(2009, 7, 8)
-      time_to = Time.utc(2009, 7, 8 + days_diff)
-      search = Sunspot.search(Post) do
-        json_facet(
-            :published_at,
-            :time_range => time_from..time_to
-        )
-      end
-
-      expect(search.facet(:published_at).rows.size).to eq(days_diff)
-      expect(search.facet(:published_at).rows[0].count).to eq(2)
-      expect(search.facet(:published_at).rows[1].count).to eq(1)
-    end
-
-    it 'json facet should return time ranges with custom gap' do
-      days_diff = 10
-      time_from = Time.utc(2009, 7, 8)
-      time_to = Time.utc(2009, 7, 8 + days_diff)
-      search = Sunspot.search(Post) do
-        json_facet(
-            :published_at,
-            :time_range => time_from..time_to,
-            gap: 60*60*24*2
-        )
-      end
-      expect(search.facet(:published_at).rows.size).to eq(days_diff / 2)
-      expect(search.facet(:published_at).rows[0].count).to eq(3)
-    end
-
   end
 
   context 'class facets' do

data/spec/integration/field_grouping_spec.rb

@@ -94,6 +94,25 @@ describe "field grouping" do
     expect(search.group(:title).groups.length).to eql(1)
     expect(search.group(:title).groups.first.results).to eq([ @posts.last ])
   end
+  
+  context "returns a not paginated collection" do
+    subject do
+      search = Sunspot.search(Post) do
+        group :title do
+          ngroups false
+        end
+        paginate :per_page => 1, :page => 2
+
+      end
+      search.group(:title).groups
+    end
+
+    it { expect(subject.per_page).to      eql(1)   }
+    it { expect(subject.total_pages).to   eql(0)   }
+    it { expect(subject.current_page).to  eql(2)   }
+    it { expect(subject.first_page?).to   be(false) }
+    it { expect(subject.last_page?).to    be(true)  }
+  end
 
   context "returns a paginated collection" do
     subject do

data/spec/integration/field_lists_spec.rb

@@ -31,6 +31,22 @@ describe 'fields lists' do
     end
   end
 
+  it 'does not raise Sunspot::UnrecognizedFieldError when listing existing text fields' do
+    expect do
+      Sunspot.search(Post) {
+        field_list(:body)
+      }
+    end.to_not raise_error
+  end
+
+  it 'does raise Sunspot::UnrecognizedFieldError when listing a non-existent text fields' do
+    expect do
+      Sunspot.search(Post) {
+        field_list(:bogus_body)
+      }
+    end.to raise_error(Sunspot::UnrecognizedFieldError)
+  end
+
   it 'does not load any stored fields' do
     hit = Sunspot.search(Post) { without_stored_fields }.hits.first
 

data/spec/integration/geospatial_spec.rb

@@ -26,15 +26,30 @@ describe "geospatial search" do
       expect(results).not_to include(@post)
     end
 
+    it "filters out posts in the radius" do
+      results = Sunspot.search(Post) {
+        without(:coordinates_new).in_radius(32, -68, 1)
+      }.results
+
+      expect(results).not_to include(@post)
+    end
+
     it "allows conjunction queries with radius" do
+      post = Post.new(:title => "Howdy",
+                      :coordinates => Sunspot::Util::Coordinates.new(35, -68))
+
+      Sunspot.index!(post)
+
       results = Sunspot.search(Post) {
         any_of do
           with(:coordinates_new).in_radius(32, -68, 1)
           with(:coordinates_new).in_radius(35, 68, 1)
+          without(:coordinates_new).in_radius(35, -68, 1)
         end
       }.results
 
       expect(results).to include(@post)
+      expect(results).not_to include(post)
     end
 
     it "allows conjunction queries with bounding box" do

data/spec/integration/join_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+
+describe "searching by joined fields" do
+  before :each do
+    Sunspot.remove_all!
+
+    @container1 = PhotoContainer.new(:id => 1)
+    @container2 = PhotoContainer.new(:id => 2).tap { |c| allow(c).to receive(:id).and_return(2) }
+    @container3 = PhotoContainer.new(:id => 3).tap { |c| allow(c).to receive(:id).and_return(3) }
+
+    @picture = Picture.new(:photo_container_id => @container1.id, :description => "one", :published => true)
+    @photo1  = Photo.new(:photo_container_id => @container1.id, :description => "two", :published => true)
+    @photo2  = Photo.new(:photo_container_id => @container2.id, :description => "three", :published => false)
+
+    Sunspot.index!(@container1, @container2, @photo1, @photo2, @picture)
+  end
+
+  it "matches by joined fields" do
+    {
+      "one"   => [],
+      "two"   => [@container1],
+      "three" => [@container2]
+    }.each do |key, res|
+      results = Sunspot.search(PhotoContainer) {
+        fulltext(key, :fields => [:photo_description])
+      }.results
+
+      expect(results).to eq res
+    end
+  end
+
+  it "doesn't match by joined fields with the same name from other collections" do
+    {
+      "one"   => [@container1],
+      "two"   => [],
+      "three" => []
+    }.each do |key, res|
+      results = Sunspot.search(PhotoContainer) {
+        fulltext(key, :fields => [:picture_description])
+      }.results
+
+      expect(results).to eq res
+    end
+  end
+
+  it "matches by joined fields when using filter queries" do
+    {
+      :photo_published => [
+        [true,  [@container1]],
+        [false, [@container2]]
+      ],
+      :picture_published => [
+        [true,  [@container1]],
+        [false, []]
+      ]
+    }.each do |key, data|
+      data.each do |(value, res)|
+        results = Sunspot.search(PhotoContainer) { with(key, value) }.results
+
+        expect(results).to eq res
+      end
+    end
+  end
+end