sunspot 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 698b438f344a3e391c87d9f755dc227869fefad88555b261ef4dcd9cc9d9c1d1
-  data.tar.gz: 2ba1b782a43a5eafd6f1bc6397ef221fe94bbbb92f1036505530719a50f07882
+  metadata.gz: 385375ab001841dcd220a07df21307f581e5ed8d4c41c6907e4d2f05783259e5
+  data.tar.gz: 0cd9f3eb2a5225b46429988a7a9d10f2ecbd488fd2c824448831a5f908a69c75
 SHA512:
-  metadata.gz: 8f89e196fd125f6c0b2bd8eda2aecf7c288860ff14ab128d695f61252344fc07b0011ed8c10d8c5578227eae814df368fecf3332d306ae2a79e9b5da593dfc97
-  data.tar.gz: 780ca66b8d6e569a994670b2e6f990444333dc03f109bd015c7f26924673e801281f611f5d08b14b48afb35b6177099747113e0bbdc10a07aebe4cee5f93c8ea
+  metadata.gz: 97c5760b633b1ab3cbfb8a04a3dd49e9c0bd40485151c94b5c8196104a2b0fc47f1fdd97ff2d85b738c4d225820316dc1e42cceb5a19ea8c7f084a9b82e224f0
+  data.tar.gz: 6ca3b17c3c28f89f56160ebdbaf2c924103976eb939df6832f0755d30a368c757dd912b5491b9a84caf38498e8320252ad14d59cd86ca4e8d071e3b2d95518e1

data/Appraisals

@@ -1,7 +1,7 @@
-appraise 'rsolr-1.1.x' do
-  gem 'rsolr', '~> 1.1.0'
+appraise 'rsolr-1.x' do
+  gem 'rsolr', '>= 1', '< 2'
 end
 
-appraise 'rsolr-2.1.x' do
-  gem 'rsolr', '~> 2.1.0'
+appraise 'rsolr-2.x' do
+  gem 'rsolr', '>= 2', '< 3'
 end

data/lib/sunspot/data_extractor.rb

@@ -5,16 +5,46 @@ module Sunspot
   # method, which takes an object and returns the value extracted from it.
   #
   module DataExtractor #:nodoc: all
+    #
+    # Abstract extractor to perform common actions on extracted values
+    #
+    class AbstractExtractor
+      BLACKLIST_REGEXP = /[\x0-\x8\xB\xC\xE-\x1F\x7f]/
+
+      def value_for(object)
+        extract_value_from(object)
+      end
+
+      private
+
+      def extract_value_from(object)
+        case object
+          when String
+            remove_blacklisted_chars(object)
+          when Array
+            object.map { |o| extract_value_from(o) }
+          when Hash
+            object.inject({}) { |h, (k, v)| h.merge(extract_value_from(k) => extract_value_from(v)) }
+          else
+            object
+        end
+      end
+
+      def remove_blacklisted_chars(object)
+        object.gsub(BLACKLIST_REGEXP, '')
+      end
+    end
+
     # 
     # AttributeExtractors extract data by simply calling a method on the block.
     #
-    class AttributeExtractor
+    class AttributeExtractor < AbstractExtractor
       def initialize(attribute_name)
         @attribute_name = attribute_name
       end
 
       def value_for(object)
-        object.send(@attribute_name)
+        super object.send(@attribute_name)
       end
     end
 
@@ -24,26 +54,26 @@ module Sunspot
     # as the argument to the block. Either way, the return value of the block is
     # the value returned by the extractor.
     #
-    class BlockExtractor
+    class BlockExtractor < AbstractExtractor
       def initialize(&block)
         @block = block
       end
 
       def value_for(object)
-        Util.instance_eval_or_call(object, &@block)
+        super Util.instance_eval_or_call(object, &@block)
       end
     end
 
     # 
     # Constant data extractors simply return the same value for every object.
     #
-    class Constant
+    class Constant < AbstractExtractor
       def initialize(value)
         @value = value
       end
 
       def value_for(object)
-        @value
+        super @value
       end
     end
   end

data/lib/sunspot/dsl/group.rb

@@ -59,6 +59,16 @@ module Sunspot
         @group.truncate = true
       end
 
+      #
+      # The group.ngroups option true return the total number of groups
+      # this is expensive and sometimes you don't need it!
+      # If ngroups is false paginated_collection last_page? and total_pages wont't work.
+      # Defaults to true.
+      #
+      def ngroups(enabled)
+        @group.ngroups = enabled
+      end
+
       # Specify the order that results should be returned in. This method can
       # be called multiple times; precedence will be in the order given.
       #

data/lib/sunspot/dsl/scope.rb

@@ -199,25 +199,25 @@ module Sunspot
 
       def add_restriction(negated, *args)
         case args.first
-          when String, Symbol
-            raise ArgumentError if args.length > 2
-            field = @setup.field(args[0].to_sym)
-            if args.length > 1
-              value = args[1]
-              @scope.add_shorthand_restriction(negated, field, value)
-            else # NONE
-              DSL::Restriction.new(field, @scope, negated)
-            end
-          else # args are instances
-            @scope.add_restriction(
-              negated,
-              IdField.instance,
-              Sunspot::Query::Restriction::AnyOf,
-              args.flatten.map { |instance|
-                Sunspot::Adapters::InstanceAdapter.adapt(instance).index_id }
-            )
+        when String, Symbol
+          raise ArgumentError if args.length > 2
+          field = @setup.field(args[0].to_sym)
+          if args.length > 1
+            value = args[1]
+            @scope.add_shorthand_restriction(negated, field, value)
+          else # NONE
+            DSL::Restriction.new(field, @scope, negated)
           end
+        else # args are instances
+          @scope.add_restriction(
+            negated,
+            IdField.instance,
+            Sunspot::Query::Restriction::AnyOf,
+            args.flatten.map { |instance|
+              Sunspot::Adapters::InstanceAdapter.adapt(instance).index_id }
+          )
         end
+      end
     end
   end
 end

data/lib/sunspot/query/group.rb

@@ -4,7 +4,7 @@ module Sunspot
     # A Group groups by the unique values of a given field, or by given queries.
     #
     class Group
-      attr_accessor :limit, :truncate
+      attr_accessor :limit, :truncate, :ngroups
       attr_reader :fields, :queries
 
       def initialize
@@ -30,16 +30,15 @@ module Sunspot
 
       def to_params
         params = {
-          :group            => "true",
-          :"group.ngroups"  => "true",
+          :group            => 'true',
+          :"group.ngroups"  => @ngroups.nil? ? 'true' : @ngroups.to_s
         }
 
-        params.merge!(@sort.to_params("group."))
+        params.merge!(@sort.to_params('group.'))
         params[:"group.field"] = @fields.map(&:indexed_name) if @fields.any?
         params[:"group.query"] = @queries.map(&:to_boolean_phrase) if @queries.any?
         params[:"group.limit"] = @limit if @limit
         params[:"group.truncate"] = @truncate if @truncate
-
         params
       end
     end

data/lib/sunspot/query/join.rb

@@ -42,12 +42,10 @@ module Sunspot
         keywords = escape_quotes(params.delete(:q))
         options = params.map { |key, value| escape_param(key, value) }.join(' ')
         q_name = "q#{@target.name}#{self.object_id}"
-        fq_name = "f#{q_name}"
 
         {
-          :q => "_query_:\"{!join from=#{@from} to=#{@to} v=$#{q_name} fq=$#{fq_name}}\"",
-          q_name => "_query_:\"{!edismax #{options}}#{keywords}\"",
-          fq_name => "type:#{@target.name}"
+          :q     => "_query_:\"{!join from=#{@from} to=#{@to} v=$#{q_name}}\"",
+          q_name => "_query_:\"{!field f=type}#{@target.name}\"+_query_:\"{!edismax #{options}}#{keywords}\""
         }
       end
 

data/lib/sunspot/query/restriction.rb

@@ -135,7 +135,7 @@ module Sunspot
 
         protected
 
-        # 
+        #
         # Return escaped Solr API representation of given value
         #
         # ==== Parameters
@@ -158,9 +158,13 @@ module Sunspot
       end
 
       class InRadius < Base
-        def initialize(negated, field, lat, lon, radius)
-          @lat, @lon, @radius = lat, lon, radius
-          super negated, field, [lat, lon, radius]
+        def initialize(negated, field, *value)
+          @lat, @lon, @radius = value
+          super negated, field, value
+        end
+
+        def negate
+          self.class.new(!@negated, @field, *@value)
         end
 
         private

data/lib/sunspot/search/abstract_search.rb

@@ -16,7 +16,7 @@ module Sunspot
       # Retrieve all facet objects defined for this search, in order they were
       # defined. To retrieve an individual facet by name, use #facet()
       #
-      attr_reader :facets, :groups, :stats
+      attr_reader :facets, :groups
       attr_reader :query #:nodoc:
       attr_accessor :request_handler
 

data/lib/sunspot/version.rb

@@ -1,3 +1,3 @@
 module Sunspot
-  VERSION = '2.3.0'
+  VERSION = '2.4.0'
 end

data/spec/api/data_extractor_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Sunspot::DataExtractor do
+  it "removes special characters from strings" do
+    extractor = Sunspot::DataExtractor::AttributeExtractor.new(:name)
+    blog      = Blog.new(:name => "Te\x0\x1\x7\x6\x8st\xB\xC\xE Bl\x1Fo\x7fg")
+
+    expect(extractor.value_for(blog)).to eq "Test Blog"
+  end
+
+  it "removes special characters from arrays" do
+    extractor = Sunspot::DataExtractor::BlockExtractor.new { tags }
+    post      = Post.new(:tags => ["Te\x0\x1\x7\x6\x8st Ta\x1Fg\x7f 1", "Test\xB\xC\xE Tag 2"])
+
+    expect(extractor.value_for(post)).to eq ["Test Tag 1", "Test Tag 2"]
+  end
+
+  it "removes special characters from hashes" do
+    extractor = Sunspot::DataExtractor::Constant.new({ "Te\x0\x1\x7\x6\x8st" => "Ta\x1Fg\x7f" })
+
+    expect(extractor.value_for(Post.new)).to eq({ "Test" => "Tag" })
+  end
+
+  it "skips other data types" do
+    [
+      :"Te\x0\x1\x7\x6\x8st",
+      123,
+      123.0,
+      nil,
+      false,
+      true,
+      Sunspot::Util::Coordinates.new(40.7, -73.5)
+    ].each do |value|
+      extractor = Sunspot::DataExtractor::Constant.new(value)
+
+      expect(extractor.value_for(Post.new)).to eq value
+    end
+  end
+end

data/spec/api/query/fulltext_examples.rb

@@ -418,11 +418,9 @@ shared_examples_for 'fulltext query' do
 
       obj_id = find_ob_id(srch)
       q_name = "qPhoto#{obj_id}"
-      fq_name = "f#{q_name}"
 
-      expect(connection.searches.last[:q]).to 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\")"
-      expect(connection.searches.last[q_name]).to eq "_query_:\"{!edismax qf='caption_text'}keyword1\""
-      expect(connection.searches.last[fq_name]).to eq "type:Photo"
+      expect(connection.searches.last[:q]).to eq "(_query_:\"{!join from=photo_container_id_i to=id_i v=$#{q_name}}\" OR _query_:\"{!edismax qf='description_text^1.2'}keyword2\")"
+      expect(connection.searches.last[q_name]).to eq "_query_:\"{!field f=type}Photo\"+_query_:\"{!edismax qf='caption_text'}keyword1\""
     end
 
     it "should be able to resolve name conflicts with the :prefix option" do
@@ -435,11 +433,9 @@ shared_examples_for 'fulltext query' do
 
       obj_id = find_ob_id(srch)
       q_name = "qPhoto#{obj_id}"
-      fq_name = "f#{q_name}"
 
-      expect(connection.searches.last[:q]).to 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}}\")"
-      expect(connection.searches.last[q_name]).to eq "_query_:\"{!edismax qf='description_text'}keyword2\""
-      expect(connection.searches.last[fq_name]).to eq "type:Photo"
+      expect(connection.searches.last[:q]).to eq "(_query_:\"{!edismax qf='description_text^1.2'}keyword1\" OR _query_:\"{!join from=photo_container_id_i to=id_i v=$#{q_name}}\")"
+      expect(connection.searches.last[q_name]).to eq "_query_:\"{!field f=type}Photo\"+_query_:\"{!edismax qf='description_text'}keyword2\""
     end
 
     it "should recognize fields when adding from DSL, e.g. when calling boost_fields" do
@@ -453,11 +449,9 @@ shared_examples_for 'fulltext query' do
 
       obj_id = find_ob_id(srch)
       q_name = "qPhoto#{obj_id}"
-      fq_name = "f#{q_name}"
 
-      expect(connection.searches.last[:q]).to 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}}\")"
-      expect(connection.searches.last[q_name]).to eq "_query_:\"{!edismax qf='description_text^1.3'}keyword1\""
-      expect(connection.searches.last[fq_name]).to eq "type:Photo"
+      expect(connection.searches.last[:q]).to eq "(_query_:\"{!edismax qf='description_text^1.5'}keyword1\" OR _query_:\"{!join from=photo_container_id_i to=id_i v=$#{q_name}}\")"
+      expect(connection.searches.last[q_name]).to eq "_query_:\"{!field f=type}Photo\"+_query_:\"{!edismax qf='description_text^1.3'}keyword1\""
     end
 
     private

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/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,45 @@
+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")
+    @photo1  = Photo.new(:photo_container_id => @container1.id, :description => "two")
+    @photo2  = Photo.new(:photo_container_id => @container2.id, :description => "three")
+
+    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
+end

data/spec/mocks/photo.rb

@@ -13,6 +13,15 @@ Sunspot.setup(Photo) do
   time :created_at, :trie => true
 end
 
+class Picture < MockRecord
+  attr_accessor :description, :photo_container_id
+end
+
+Sunspot.setup(Picture) do
+  text :description
+  integer :photo_container_id
+end
+
 class PhotoContainer < MockRecord
   attr_accessor :description
 
@@ -25,8 +34,9 @@ Sunspot.setup(PhotoContainer) do
   integer :id
   text :description, :default_boost => 1.2
 
-  join(:caption, :target => Photo, :type => :string, :join => { :from => :photo_container_id, :to => :id })
-  join(:photo_rating, :target => Photo, :type => :trie_float, :join => { :from => :photo_container_id, :to => :id }, :as => 'average_rating_ft')
-  join(:caption, :target => Photo, :type => :text, :join => { :from => :photo_container_id, :to => :id })
-  join(:description, :prefix => "photo", :target => Photo, :type => :text, :join => { :from => :photo_container_id, :to => :id })
+  join(:caption,      :target => Photo,   :type => :string,     :join => { :from => :photo_container_id, :to => :id })
+  join(:photo_rating, :target => Photo,   :type => :trie_float, :join => { :from => :photo_container_id, :to => :id }, :as => 'average_rating_ft')
+  join(:caption,      :target => Photo,   :type => :text,       :join => { :from => :photo_container_id, :to => :id })
+  join(:description,  :target => Photo,   :type => :text,       :join => { :from => :photo_container_id, :to => :id }, :prefix => "photo")
+  join(:description,  :target => Picture, :type => :text,       :join => { :from => :photo_container_id, :to => :id }, :prefix => "picture")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sunspot
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Mat Brown
@@ -30,7 +30,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-08 00:00:00.000000000 Z
+date: 2019-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rsolr
@@ -126,7 +126,6 @@ files:
 - LICENSE
 - Rakefile
 - TODO
-- gemfiles/.gitkeep
 - lib/light_config.rb
 - lib/sunspot.rb
 - lib/sunspot/adapters.rb
@@ -240,6 +239,7 @@ files:
 - spec/api/batcher_spec.rb
 - spec/api/binding_spec.rb
 - spec/api/class_set_spec.rb
+- spec/api/data_extractor_spec.rb
 - spec/api/hit_enumerable_spec.rb
 - spec/api/indexer/attributes_spec.rb
 - spec/api/indexer/batch_spec.rb
@@ -305,6 +305,7 @@ files:
 - spec/integration/geospatial_spec.rb
 - spec/integration/highlighting_spec.rb
 - spec/integration/indexing_spec.rb
+- spec/integration/join_spec.rb
 - spec/integration/keyword_search_spec.rb
 - spec/integration/local_search_spec.rb
 - spec/integration/more_like_this_spec.rb
@@ -355,8 +356,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: sunspot
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Library for expressive, powerful interaction with the Solr search engine
@@ -365,6 +365,7 @@ test_files:
 - spec/api/batcher_spec.rb
 - spec/api/binding_spec.rb
 - spec/api/class_set_spec.rb
+- spec/api/data_extractor_spec.rb
 - spec/api/hit_enumerable_spec.rb
 - spec/api/indexer/attributes_spec.rb
 - spec/api/indexer/batch_spec.rb
@@ -430,6 +431,7 @@ test_files:
 - spec/integration/geospatial_spec.rb
 - spec/integration/highlighting_spec.rb
 - spec/integration/indexing_spec.rb
+- spec/integration/join_spec.rb
 - spec/integration/keyword_search_spec.rb
 - spec/integration/local_search_spec.rb
 - spec/integration/more_like_this_spec.rb