gojee-sunspot 2.0.3 → 2.0.4

data/spec/helpers/search_helper.rb

@@ -0,0 +1,68 @@
+module SearchHelper
+  def stub_nil_results
+    connection.response = { 'response' => nil }
+  end
+
+  def stub_full_results(*results)
+    count =
+      if results.last.is_a?(Integer) then results.pop
+      else results.length
+      end
+    docs = results.map do |result|
+      instance = result.delete('instance')
+      result.merge('id' => "#{instance.class.name} #{instance.id}")
+    end
+    response = {
+      'response' => {
+        'docs' => docs,
+        'numFound' => count
+      }
+    }
+    connection.response = response
+    response
+  end
+
+  def stub_results(*results)
+    stub_full_results(
+      *results.map do |result|
+        if result.is_a?(Integer)
+          result
+        else
+          { 'instance' => result }
+        end
+      end
+    )
+  end
+
+  def stub_facet(name, values)
+    connection.response = {
+      'facet_counts' => {
+        'facet_fields' => {
+          name.to_s => values.to_a.sort_by { |value, count| -count }.flatten
+        }
+      }
+    }
+  end
+
+  def stub_date_facet(name, gap, values)
+    connection.response = {
+      'facet_counts' => {
+        'facet_dates' => {
+          name.to_s => { 'gap' => "+#{gap}SECONDS" }.merge(values)
+        }
+      }
+    }
+  end
+
+  def stub_query_facet(values)
+    connection.response = { 'facet_counts' => { 'facet_queries' => values } }
+  end
+
+  def facet_values(result, field_name)
+    result.facet(field_name).rows.map { |row| row.value }
+  end
+
+  def facet_counts(result, field_name)
+    result.facet(field_name).rows.map { |row| row.count }
+  end
+end

data/spec/integration/dynamic_fields_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+
+describe 'dynamic fields' do
+  before :each do
+    Sunspot.remove_all
+    @posts = Post.new(:custom_string => { :cuisine => 'Pizza' }),
+             Post.new(:custom_string => { :cuisine => 'Greek' }),
+             Post.new(:custom_string => { :cuisine => 'Greek' })
+    Sunspot.index!(@posts)
+  end
+
+  it 'should search for dynamic string field' do
+    Sunspot.search(Post) do
+      dynamic(:custom_string) do
+        with(:cuisine, 'Pizza')
+      end
+    end.results.should == [@posts.first]
+  end
+
+  describe 'faceting' do
+    before :each do
+      @search = Sunspot.search(Post) do
+        dynamic :custom_string do
+          facet :cuisine
+        end
+      end
+    end
+
+    it 'should return value "value" with count 2' do
+      row = @search.dynamic_facet(:custom_string, :cuisine).rows[0]
+      row.value.should == 'Greek'
+      row.count.should == 2
+    end
+
+    it 'should return value "other" with count 1' do
+      row = @search.dynamic_facet(:custom_string, :cuisine).rows[1]
+      row.value.should == 'Pizza'
+      row.count.should == 1
+    end
+  end
+
+  it 'should order by dynamic string field ascending' do
+    Sunspot.search(Post) do
+      dynamic :custom_string do
+        order_by :cuisine, :asc
+      end
+    end.results.last.should == @posts.first
+  end
+
+  it 'should order by dynamic string field descending' do
+    Sunspot.search(Post) do
+      dynamic :custom_string do
+        order_by :cuisine, :desc
+      end
+    end.results.first.should == @posts.first
+  end
+end

data/spec/integration/faceting_spec.rb

@@ -0,0 +1,251 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+
+describe 'search faceting' do
+  def self.test_field_type(name, attribute, field, *args)
+    clazz, value1, value2 =
+      if args.length == 2
+        [Post, args.first, args.last]
+      else
+        args
+      end
+
+    context "with field of type #{name}" do
+      before :all do
+        Sunspot.remove_all
+        2.times do
+          Sunspot.index(clazz.new(attribute => value1))
+        end
+        Sunspot.index(clazz.new(attribute => value2))
+        Sunspot.commit
+      end
+
+      before :each do
+        @search = Sunspot.search(clazz) do
+          facet(field)
+        end
+      end
+
+      it "should return value #{value1.inspect} with count 2" do
+        row = @search.facet(field).rows[0]
+        row.value.should == value1
+        row.count.should == 2
+      end
+
+      it "should return value #{value2.inspect} with count 1" do
+        row = @search.facet(field).rows[1]
+        row.value.should == value2
+        row.count.should == 1
+      end
+    end
+  end
+
+  test_field_type('String', :title, :title, 'Title 1', 'Title 2')
+  test_field_type('Integer', :blog_id, :blog_id, 3, 4)
+  test_field_type('Float', :ratings_average, :average_rating, 2.2, 1.1)
+  test_field_type('Time', :published_at, :published_at, Time.mktime(2008, 02, 17, 17, 45, 04),
+                                                        Time.mktime(2008, 07, 02, 03, 56, 22))
+  test_field_type('Trie Integer', :size, :size, Photo, 3, 4)
+  test_field_type('Float', :average_rating, :average_rating, Photo, 2.2, 1.1)
+  test_field_type('Time', :created_at, :created_at, Photo, Time.mktime(2008, 02, 17, 17, 45, 04),
+                                                           Time.mktime(2008, 07, 02, 03, 56, 22))
+  test_field_type('Boolean', :featured, :featured, true, false)
+
+  context 'facet options' do
+    before :all do
+      Sunspot.remove_all
+      facet_values = %w(zero one two three four)
+      facet_values.each_with_index do |value, i|
+        i.times { Sunspot.index(Post.new(:title => value, :blog_id => 1)) }
+      end
+      Sunspot.index(Post.new(:blog_id => 1))
+      Sunspot.index(Post.new(:title => 'zero', :blog_id => 2))
+      Sunspot.commit
+    end
+
+    it 'should limit the number of facet rows' do
+      search = Sunspot.search(Post) do
+        facet :title, :limit => 3
+      end
+      search.facet(:title).should have(3).rows
+    end
+
+    it 'should not return zeros by default' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        facet :title
+      end
+      search.facet(:title).rows.map { |row| row.value }.should_not include('zero')
+    end
+
+    it 'should return zeros when specified' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        facet :title, :zeros => true
+      end
+      search.facet(:title).rows.map { |row| row.value }.should include('zero')
+    end
+
+    it 'should return a specified minimum count' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        facet :title, :minimum_count => 2
+      end
+      search.facet(:title).rows.map { |row| row.value }.should == %w(four three two)
+    end
+
+    it 'should order facets lexically' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        facet :title, :sort => :index
+      end
+      search.facet(:title).rows.map { |row| row.value }.should == %w(four one three two)
+    end
+
+    it 'should order facets by count' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        facet :title, :sort => :count
+      end
+      search.facet(:title).rows.map { |row| row.value }.should == %w(four three two one)
+    end
+
+    it 'should limit facet values by prefix' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        facet :title, :prefix => 't'
+      end
+      search.facet(:title).rows.map { |row| row.value }.sort.should == %w(three two)
+    end
+
+    it 'should return :all facet' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        facet :title, :extra => :any
+      end
+      search.facet(:title).rows.first.value.should == :any
+      search.facet(:title).rows.first.count.should == 10
+    end
+
+    it 'should return :none facet' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        facet :title, :extra => :none
+      end
+      search.facet(:title).rows.first.value.should == :none
+      search.facet(:title).rows.first.count.should == 1
+    end
+
+    it 'gives correct facet count when group == true and truncate == true' do
+      search = Sunspot.search(Post) do
+        group :title do
+          truncate
+        end
+
+        facet :title, :extra => :any
+      end
+
+      # Should be 5 instead of 11
+      search.facet(:title).rows.first.count.should == 5
+    end
+  end
+
+  context 'multiselect faceting' do
+    before do
+      Sunspot.remove_all
+      Sunspot.index!(
+        Post.new(:blog_id => 1, :category_ids => [1]),
+        Post.new(:blog_id => 1, :category_ids => [2]),
+        Post.new(:blog_id => 3, :category_ids => [3])
+      )
+    end
+
+    it 'should exclude filter from faceting' do
+      search = Sunspot.search(Post) do
+        with(:blog_id, 1)
+        category_filter = with(:category_ids, 1)
+        facet(:category_ids, :exclude => category_filter)
+      end
+      search.facet(:category_ids).rows.map { |row| row.value }.to_set.should == Set[1, 2]
+    end
+
+    it 'should use facet keys to facet more than once with different exclusions' do
+      search = Sunspot.search(Post) do
+        with(:blog_id, 1)
+        category_filter = with(:category_ids, 1)
+        facet(:category_ids)
+        facet(:category_ids, :exclude => category_filter, :name => :all_category_ids)
+      end
+      search.facet(:category_ids).rows.map { |row| row.value }.should == [1]
+      search.facet(:all_category_ids).rows.map { |row| row.value }.to_set.should == Set[1, 2]
+    end
+  end
+
+  context 'date facets' do
+    before :all do
+      Sunspot.remove_all
+      time = Time.utc(2009, 7, 8)
+      Sunspot.index!(
+        (0..2).map { |i| Post.new(:published_at => time + i*60*60*16) }
+      )
+    end
+
+    it 'should return time ranges' do
+      time = Time.utc(2009, 7, 8)
+      search = Sunspot.search(Post) do
+        facet :published_at, :time_range => time..(time + 60*60*24*2), :sort => :count
+      end
+      search.facet(:published_at).rows.first.value.should == (time..(time + 60*60*24))
+      search.facet(:published_at).rows.first.count.should == 2
+      search.facet(:published_at).rows.last.value.should == ((time + 60*60*24)..(time + 60*60*24*2))
+      search.facet(:published_at).rows.last.count.should == 1
+    end
+  end
+
+  context 'class facets' do
+    before :all do
+      Sunspot.remove_all
+      Sunspot.index!(Post.new, Post.new, Namespaced::Comment.new)
+    end
+
+    it 'should return classes' do
+      search = Sunspot.search(Post, Namespaced::Comment) do
+        facet(:class, :sort => :count)
+      end
+      search.facet(:class).rows.first.value.should == Post
+      search.facet(:class).rows.first.count.should == 2
+      search.facet(:class).rows.last.value.should == Namespaced::Comment
+      search.facet(:class).rows.last.count.should == 1
+    end
+  end
+
+  context 'query facets' do
+    before :all do
+      Sunspot.remove_all
+      Sunspot.index!(
+        [1.1, 1.2, 3.2, 3.4, 3.9, 4.1].map do |rating|
+          Post.new(:ratings_average => rating)
+        end
+      )
+    end
+
+    it 'should return specified facets' do
+      search = Sunspot.search(Post) do
+        facet :rating_range, :sort => :count do
+          for rating in [1.0, 2.0, 3.0, 4.0]
+            range = rating..(rating + 1.0)
+            row range do
+              with :average_rating, rating..(rating + 1.0)
+            end
+          end
+        end
+      end
+      facet = search.facet(:rating_range)
+      facet.rows[0].value.should == (3.0..4.0)
+      facet.rows[0].count.should == 3
+      facet.rows[1].value.should == (1.0..2.0)
+      facet.rows[1].count.should == 2
+      facet.rows[2].value.should == (4.0..5.0)
+      facet.rows[2].count.should == 1
+    end
+  end
+end

data/spec/integration/field_grouping_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path("../spec_helper", File.dirname(__FILE__))
+require File.expand_path("../helpers/search_helper", File.dirname(__FILE__))
+
+describe "field grouping" do
+  before :each do
+    Sunspot.remove_all
+
+    @posts = [
+      Post.new(:title => "Title1", :ratings_average => 4),
+      Post.new(:title => "Title1", :ratings_average => 5),
+      Post.new(:title => "Title2", :ratings_average => 3)
+    ]
+
+    Sunspot.index!(*@posts)
+  end
+
+  it "allows grouping by a field" do
+    search = Sunspot.search(Post) do
+      group :title
+    end
+
+    search.group(:title).groups.should include { |g| g.value == "Title1" }
+    search.group(:title).groups.should include { |g| g.value == "Title2" }
+  end
+
+  it "provides access to the number of matches before grouping" do
+    search = Sunspot.search(Post) do
+      group :title
+    end
+
+    search.group(:title).matches.should == @posts.length
+  end
+
+  it "allows grouping by multiple fields" do
+    search = Sunspot.search(Post) do
+      group :title, :sort_title
+    end
+
+    search.group(:title).groups.should_not be_empty
+    search.group(:sort_title).groups.should_not be_empty
+  end
+
+  it "allows specification of the number of documents per group" do
+    search = Sunspot.search(Post) do
+      group :title do
+        limit 2
+      end
+    end
+
+    title1_group = search.group(:title).groups.detect { |g| g.value == "Title1" }
+    title1_group.hits.length.should == 2
+  end
+
+  it "allows specification of the sort within groups" do
+    search = Sunspot.search(Post) do
+      group :title do
+        order_by(:average_rating, :desc)
+      end
+    end
+
+    highest_ranked_post = @posts.sort_by { |p| -p.ratings_average }.first
+
+    title1_group = search.group(:title).groups.detect { |g| g.value == "Title1" }
+    title1_group.hits.first.primary_key.to_i.should == highest_ranked_post.id
+  end
+end

data/spec/integration/geospatial_spec.rb

@@ -0,0 +1,85 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+
+describe "geospatial search" do
+  describe "filtering by radius" do
+    before :all do
+      Sunspot.remove_all
+
+      @post = Post.new(:title       => "Howdy",
+                       :coordinates => Sunspot::Util::Coordinates.new(32, -68))
+      Sunspot.index!(@post)
+    end
+
+    it "matches posts within the radius" do
+      results = Sunspot.search(Post) {
+        with(:coordinates_new).in_radius(32, -68, 1)
+      }.results
+
+      results.should include(@post)
+    end
+
+    it "filters out posts not in the radius" do
+      results = Sunspot.search(Post) {
+        with(:coordinates_new).in_radius(33, -68, 1)
+      }.results
+
+      results.should_not include(@post)
+    end
+  end
+
+  describe "filtering by bounding box" do
+    before :all do
+      Sunspot.remove_all
+
+      @post = Post.new(:title       => "Howdy",
+                       :coordinates => Sunspot::Util::Coordinates.new(32, -68))
+      Sunspot.index!(@post)
+    end
+
+    it "matches post within the bounding box" do
+      results = Sunspot.search(Post) {
+        with(:coordinates_new).in_bounding_box [31, -69], [33, -67]
+      }.results
+
+      results.should include(@post)
+    end
+
+    it "filters out posts not in the bounding box" do
+      results = Sunspot.search(Post) {
+        with(:coordinates_new).in_bounding_box [20, -70], [21, -69]
+      }.results
+
+      results.should_not include(@post)
+    end
+  end
+
+  describe "ordering by geodist" do
+    before :all do
+      Sunspot.remove_all
+
+      @posts = [
+        Post.new(:title => "Howdy", :coordinates => Sunspot::Util::Coordinates.new(34, -68)),
+        Post.new(:title => "Howdy", :coordinates => Sunspot::Util::Coordinates.new(33, -68)),
+        Post.new(:title => "Howdy", :coordinates => Sunspot::Util::Coordinates.new(32, -68))
+      ]
+
+      Sunspot.index!(@posts)
+    end
+
+    it "orders posts by distance ascending" do
+      results = Sunspot.search(Post) {
+        order_by_geodist(:coordinates_new, 32, -68)
+      }.results
+
+      results.should == @posts.reverse
+    end
+
+    it "orders posts by distance descending" do
+      results = Sunspot.search(Post) {
+        order_by_geodist(:coordinates_new, 32, -68, :desc)
+      }.results
+
+      results.should == @posts
+    end
+  end
+end

data/spec/integration/highlighting_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+
+describe 'keyword highlighting' do
+  before :all do
+    @posts = []
+    @posts << Post.new(:body => 'And the fox laughed')
+    @posts << Post.new(:body => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit', :blog_id => 1)
+    @posts << Post.new(:body => 'Lorem ipsum dolor sit amet', :title => 'consectetur adipiscing elit', :blog_id => 1)
+    Sunspot.index!(*@posts)
+    @search_result = Sunspot.search(Post) { keywords 'fox', :highlight => true }
+  end
+  
+  it 'should include highlights in the results' do
+    @search_result.hits.first.highlights.length.should == 1
+  end
+  
+  it 'should return formatted highlight fragments' do
+    @search_result.hits.first.highlights(:body).first.format.should == 'And the <em>fox</em> laughed'
+  end
+  
+  it 'should be empty for non-keyword searches' do
+    search_result = Sunspot.search(Post){ with :blog_id, 1 }
+    search_result.hits.first.highlights.should be_empty
+  end
+  
+  it "should process multiple keyword request on different fields with highlights correctly" do
+    search_results = nil
+    lambda do
+      search_results = Sunspot.search(Post) do 
+        keywords 'Lorem ipsum', :fields => [:body] do
+          highlight :body
+        end
+        keywords 'consectetur', :fields => [:title] do
+          highlight :title
+        end
+      end
+    end.should_not raise_error(RSolr::Error::Http)
+    search_results.results.length.should eq(1)
+    search_results.results.first.should eq(@posts.last)
+    # this one might be a Solr bug, therefore not related to Sunspot itself
+    # search_results.hits.first.highlights.should_not be_empty
+  end
+  
+end

data/spec/integration/indexing_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+
+describe 'indexing' do
+  it 'should index non-multivalued field with newlines' do
+    lambda do
+      Sunspot.index!(Post.new(:title => "A\nTitle"))
+    end.should_not raise_error
+  end
+
+  it 'should correctly remove by model instance' do
+    post = Post.new(:title => 'test post')
+    Sunspot.index!(post)
+    Sunspot.remove!(post)
+    Sunspot.search(Post) { with(:title, 'test post') }.results.should be_empty
+  end
+
+  it 'should correctly delete by ID' do
+    post = Post.new(:title => 'test post')
+    Sunspot.index!(post)
+    Sunspot.remove_by_id!(Post, post.id)
+    Sunspot.search(Post) { with(:title, 'test post') }.results.should be_empty
+  end
+
+  it 'removes documents by query' do
+    Sunspot.remove_all!
+    posts = [Post.new(:title => 'birds'), Post.new(:title => 'monkeys')]
+    Sunspot.index!(posts)
+    Sunspot.remove! do
+      with(:title, 'birds')
+    end
+    Sunspot.search(Post).should have(2).results
+  end
+
+
+  describe "in batches" do
+    let(:post_1) { Post.new :title => 'A tittle' }
+    let(:post_2) { Post.new :title => 'Another title' }
+
+    describe "nested" do
+      let(:a_nested_batch) do
+        Sunspot.batch do
+          Sunspot.index post_1
+
+          Sunspot.batch do
+            Sunspot.index post_2
+          end
+        end
+      end
+
+      it "does not fail" do
+        expect { a_nested_batch }.to_not raise_error
+      end
+    end
+  end
+end