sunspot 2.1.0 → 2.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e84a7b3df6b149b54fbea2bb14a67cd561cbb71
+  data.tar.gz: 61c35909935859b351c2608362e733aceaf65394
+SHA512:
+  metadata.gz: 23311e3c435b010699df2bbb6c6fe634ad64178d0a02637d9bdc500e4d5814678d6cfb45c83cad7c118f08b5d68ddae766257f91496f5db946c696f3a99efb13
+  data.tar.gz: 4d16d14e56f6734e1d0516794979e10d2ba8bd3719e97a295f124f58c914841df0fcf0a04929ad31516da7e8b2b0056203dd4a5af12e69d86e2e1d382c0efd71

data/Gemfile

@@ -3,3 +3,7 @@ source "http://rubygems.org"
 gem 'sunspot_solr', :path => File.expand_path('../../sunspot_solr', __FILE__)
 
 gemspec
+
+group :development do
+  gem 'rake'
+end

data/History.txt

@@ -1,3 +1,13 @@
+== 2.1.0
+* Dropped support for rails 2.x. Added support for Rails 4.
+* Bundled Solr installation (`sunspot_solr`) is version 4.2.0
+* Upgrade to Jetty 8 and changed solr config directory structure.
+* Removed interactive warning prompt from sunspot:reindex rake task.
+* Support Rails 4 custom primary keys i.e. UUID
+* Switch to EDismax query parser from dismax.
+* Extend Sunspot.remove! to accept a block, and enable .remove_by_id! to accept multiple ids.
+* add 'order_by_function' method to field queries. Allowing for Solr FunctionQuery, nesting, and literal constants.
+
 == 2.0.0
 * Adds support for field grouping (Andy Lindeman)
 * Adds support for native geospatial searches and ordering (Eric Tang, Bruno Miranda, Andy Lindeman)

data/lib/sunspot.rb

@@ -417,8 +417,8 @@ module Sunspot
     #
     # objects...<Object>:: Objects to remove from the index
     #
-    def remove!(*objects)
-      session.remove!(*objects)
+    def remove!(*objects, &block)
+      session.remove!(*objects, &block)
     end
 
     # 
@@ -433,16 +433,16 @@ module Sunspot
     #   Primary key of the object. This should be the same id that would be
     #   returned by the class's instance adapter.
     #
-    def remove_by_id(clazz, id)
-      session.remove_by_id(clazz, id)
+    def remove_by_id(clazz, *ids)
+      session.remove_by_id(clazz, ids)
     end
 
     # 
     # Remove an object by class name and primary key, and immediately commit.
     # See #remove_by_id and #commit
     #
-    def remove_by_id!(clazz, id)
-      session.remove_by_id!(clazz, id)
+    def remove_by_id!(clazz, *ids)
+      session.remove_by_id!(clazz, ids)
     end
 
     # Remove all objects of the given classes from the index. There isn't much

data/lib/sunspot/batcher.rb

@@ -12,7 +12,7 @@ module Sunspot
   #   end
   #
   # it is the Batcher's job to keep track of these nestings. The inner will
-  # be sent of to be indexed first.
+  # be sent off to be indexed first.
   #
   class Batcher
     include Enumerable

data/lib/sunspot/dsl.rb

@@ -1,5 +1,5 @@
 %w(fields scope paginatable adjustable field_query standard_query query_facet
    functional fulltext restriction restriction_with_near search
-   more_like_this_query function field_group).each do |file|
+   more_like_this_query function field_group field_stats).each do |file|
   require File.join(File.dirname(__FILE__), 'dsl', file)
 end

data/lib/sunspot/dsl/field_query.rb

@@ -1,6 +1,6 @@
 module Sunspot
   module DSL
-    # 
+    #
     # Provides an API for areas of the query DSL that operate on specific
     # fields. This functionality is provided by the query DSL and the dynamic
     # query DSL.
@@ -45,14 +45,14 @@ module Sunspot
       #   the reference longitude
       # direction<Symbol>::
       #   :asc or :desc (default :asc)
-      # 
+      #
       def order_by_geodist(field_name, lat, lon, direction = nil)
         @query.add_sort(
           Sunspot::Query::Sort::GeodistSort.new(@setup.field(field_name), lat, lon, direction)
         )
       end
 
-      # 
+      #
       # DEPRECATED Use <code>order_by(:random)</code>
       #
       def order_by_random
@@ -109,7 +109,7 @@ module Sunspot
       #     with(:blog_id, 1)
       #     facet(:category_id)
       #   end
-      #   
+      #
       # The facet specified above will have a row for each category_id that is
       # present in a document which also has a blog_id of 1.
       #
@@ -125,12 +125,12 @@ module Sunspot
       #     category_filter = with(:category_id, 2)
       #     facet(:category_id, :exclude => category_filter)
       #   end
-      # 
+      #
       # Although the results of the above search will be restricted to those
       # with a category_id of 2, the category_id facet will operate as if a
       # category had not been selected, allowing the user to select additional
       # categories (which will presumably be ORed together).
-      # 
+      #
       # It possible to exclude multiple filters by passing an array:
       #
       #   Sunspot.search(Post) do
@@ -141,7 +141,7 @@ module Sunspot
       #           :exclude => [category_filter, author_filter].compact)
       #   end
       #
-      # You should consider using +.compact+ to ensure that the array does not 
+      # You should consider using +.compact+ to ensure that the array does not
       # contain any nil values.
       #
       # <strong>As far as I can tell, Solr only supports multi-select with
@@ -331,6 +331,22 @@ module Sunspot
         end
       end
 
+      def stats(*field_names, &block)
+        options = Sunspot::Util.extract_options_from(field_names)
+
+        field_names.each do |field_name|
+          field = @setup.field(field_name)
+          query_stats = @query.add_stats(
+            Sunspot::Query::FieldStats.new(field, options)
+          )
+          search_stats = @search.add_field_stats(field)
+
+          Sunspot::Util.instance_eval_or_call(
+            FieldStats.new(query_stats, @setup, search_stats),
+            &block) if block
+        end
+      end
+
       def dynamic(base_name, &block)
         dynamic_field_factory = @setup.dynamic_field_factory(base_name)
         Sunspot::Util.instance_eval_or_call(
@@ -338,6 +354,30 @@ module Sunspot
           &block
         )
       end
+      #
+      # Specify that results should be ordered based on a
+      # FunctionQuery - http://wiki.apache.org/solr/FunctionQuery
+      # Solr 3.1 and up
+      #
+      #  For example, to order by field1 + (field2*field3):
+      #
+      #    order_by_function :sum, :field1, [:product, :field2, :field3], :desc
+      #
+      # ==== Parameters
+      # function_name<Symbol>::
+      #   the function to run
+      # arguments::
+      #   the arguments for this function.
+      #   - Symbol for a field or function name
+      #   - Array for a nested function
+      #   - String for a literal constant
+      # direction<Symbol>::
+      #   :asc or :desc
+      def order_by_function(*args)
+        @query.add_sort(
+          Sunspot::Query::Sort::FunctionSort.new(@setup,args)
+        )
+      end
     end
   end
 end

data/lib/sunspot/dsl/field_stats.rb

@@ -0,0 +1,18 @@
+module Sunspot
+  module DSL
+    class FieldStats #:nodoc:
+      def initialize(query_stats, setup, search_stats) #:nodoc:
+        @query_stats, @setup, @search_stats = query_stats, setup, search_stats
+      end
+
+      def facet *field_names
+        field_names.each do |field_name|
+          field = @setup.field(field_name)
+
+          @query_stats.add_facet(field)
+          @search_stats.add_facet(field)
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/dsl/fields.rb

@@ -74,10 +74,17 @@ module Sunspot
       #
       def method_missing(method, *args, &block)
         options = Util.extract_options_from(args)
-        type_const_name = "#{Util.camel_case(method.to_s.sub(/^dynamic_/, ''))}Type"
+        if method.to_s == 'join'
+          type_string = options.delete(:type).to_s
+        else
+          type_string = method.to_s
+        end
+        type_const_name = "#{Util.camel_case(type_string.sub(/^dynamic_/, ''))}Type"
         trie = options.delete(:trie)
         type_const_name = "Trie#{type_const_name}" if trie
         begin
+          
+            type_class = options[:type]
           type_class = Type.const_get(type_const_name)
         rescue(NameError)
           if trie
@@ -94,6 +101,8 @@ module Sunspot
           else
             super(method, *args, &block)
           end
+        elsif method.to_s == 'join'
+          @setup.add_join_field_factory(name, type, options, &block)
         else
           @setup.add_field_factory(name, type, options, &block)
         end

data/lib/sunspot/field.rb

@@ -159,6 +159,21 @@ module Sunspot
 
   end
 
+  class JoinField < Field #:nodoc:
+
+    def initialize(name, type, options = {})
+      @multiple = !!options.delete(:multiple)
+      super(name, type, options)
+      @join_string = options.delete(:join_string)
+      raise ArgumentError, "Unknown field option #{options.keys.first.inspect} provided for field #{name.inspect}" unless options.empty?
+    end
+
+    def local_params
+      "{!join #{@join_string}}"
+    end
+
+  end
+
   class TypeField #:nodoc:
     class <<self
       def instance

data/lib/sunspot/field_factory.rb

@@ -76,6 +76,39 @@ module Sunspot
       end
     end
 
+    class Join < Abstract
+      def initialize(name, type, options = {}, &block)
+        super(name, options, &block)
+        unless name.to_s =~ /^\w+$/
+          raise ArgumentError, "Invalid field name #{name}: only letters, numbers, and underscores are allowed."
+        end
+        @field =
+          JoinField.new(name, type, options)
+      end
+
+      # 
+      # Return the field instance built by this factory
+      #
+      def build
+        @field
+      end
+
+      # 
+      # Extract the encapsulated field's data from the given model and add it
+      # into the Solr document for indexing. (noop here for joins)
+      #
+      def populate_document(document, model) #:nodoc:
+
+      end
+
+      # 
+      # A unique signature identifying this field by name and type.
+      #
+      def signature
+        ['join', @field.name, @field.type]
+      end
+    end
+
     # 
     # DynamicFieldFactories create dynamic field instances based on dynamic
     # configuration.

data/lib/sunspot/indexer.rb

@@ -44,6 +44,7 @@ module Sunspot
     # Remove the model from the Solr index by specifying the class and ID
     #
     def remove_by_id(class_name, *ids)
+      ids.flatten!
       @connection.delete_by_id(
         ids.map { |id| Adapters::InstanceAdapter.index_id_for(class_name, id) }
       )

data/lib/sunspot/query.rb

@@ -1,7 +1,7 @@
 %w(filter abstract_field_facet connective boost_query date_field_facet range_facet dismax
    field_facet highlighting pagination restriction common_query
    standard_query more_like_this more_like_this_query geo geofilt bbox query_facet
-   scope sort sort_composite text_field_boost function_query
+   scope sort sort_composite text_field_boost function_query field_stats
    composite_fulltext field_group).each do |file|
   require(File.join(File.dirname(__FILE__), 'query', file))
 end

data/lib/sunspot/query/common_query.rb

@@ -48,6 +48,11 @@ module Sunspot
         geo
       end
 
+      def add_stats(stats)
+        @components << stats
+        stats
+      end
+
       def paginate(page, per_page, offset = nil)
         if @pagination
           @pagination.offset = offset

data/lib/sunspot/query/field_stats.rb

@@ -0,0 +1,28 @@
+module Sunspot
+  module Query
+    class FieldStats
+      def initialize(field, options)
+        @field, @options = field, options
+        @facets = []
+      end
+
+      def add_facet field
+        @facets << field
+      end
+
+      def to_params
+        params = { :stats => true, :"stats.field" => [@field.indexed_name]}
+        params[facet_key] = @facets.map(&:indexed_name) unless @facets.empty?
+        params
+      end
+
+      def facet_key
+        qualified_param 'facet'
+      end
+
+      def qualified_param name
+        :"f.#{@field.indexed_name}.stats.#{name}"
+      end
+    end
+  end
+end

data/lib/sunspot/query/geofilt.rb

@@ -1,15 +1,20 @@
 module Sunspot
   module Query
     class Geofilt
+      include Filter
+      attr_reader :field
+
       def initialize(field, lat, lon, radius, options = {})
         @field, @lat, @lon, @radius, @options = field, lat, lon, radius, options
       end
 
-      def to_params
+      def to_boolean_phrase
         func = @options[:bbox] ? "bbox" : "geofilt"
+        "{!#{func} sfield=#{@field.indexed_name} pt=#{@lat},#{@lon} d=#{@radius}}"
+      end
 
-        filter = "{!#{func} sfield=#{@field.indexed_name} pt=#{@lat},#{@lon} d=#{@radius}}"
-        {:fq => filter}
+      def to_params
+        {:fq => to_filter_query}
       end
     end
   end

data/lib/sunspot/query/restriction.rb

@@ -68,11 +68,14 @@ module Sunspot
         # on whether this restriction is negated.
         #
         def to_boolean_phrase
+          phrase = []
+          phrase << @field.local_params if @field.respond_to? :local_params
           unless negated?
-            to_positive_boolean_phrase
+            phrase << to_positive_boolean_phrase
           else
-            to_negated_boolean_phrase
+            phrase << to_negated_boolean_phrase
           end
+          phrase.join
         end
 
         # 

data/lib/sunspot/query/sort.rb

@@ -114,6 +114,41 @@ module Sunspot
           "geodist(#{@field.indexed_name.to_sym},#{@lat},#{@lon}) #{direction_for_solr}"
         end
       end
+
+      #
+      # A FunctionSort sorts by solr function.
+      # FunctionComp recursively parses arguments for nesting
+      #
+      class FunctionSort < Abstract
+        attr_reader :comp
+        def initialize(setup,args)
+          @direction = args.pop
+          @comp = FunctionComp.new(setup,args)
+        end
+        def to_param
+          "#{comp.to_s} #{direction_for_solr}"
+        end
+      end
+      class FunctionComp
+        attr_accessor :function,:fields
+        def initialize(setup,args)
+          @function=args.shift
+          @fields = []
+          args.each do |argument|
+            case argument.class.name
+            when "Array"
+              @fields<< FunctionComp.new(setup,argument)
+            when "Symbol"
+              @fields<< setup.field(argument).indexed_name
+            else
+              @fields<< argument
+            end
+          end
+        end
+        def to_s
+          "#{function}(#{fields.map(&:to_s).join(",")})"
+        end
+      end
     end
   end
 end