sunspot 1.1.0 → 1.2.0

data/lib/sunspot/dsl/standard_query.rb

@@ -103,22 +103,18 @@ module Sunspot
       end
       alias_method :keywords, :fulltext
 
-      #
-      # Scope the search by geographical distance from a given point.
-      # +coordinates+ should either respond to #first and #last (e.g. a
-      # two-element array), or to #lat and one of #lng, #lon, or #long.
-      # +options+ should be one or both of the following:
-      #
-      # :distance:: The maximum distance in miles from which results can come
-      # :sort::
-      #   Whether to sort by distance from these coordinates. If other sorts are
-      #   specified, they take precedence over distance sort.
-      #
-      def near(coordinates, options)
-        if options.respond_to?(:to_f)
-          options = { :distance => options }
+      def with(*args)
+        case args.first
+        when String, Symbol
+          field_name = args[0]
+          value = args.length > 1 ? args[1] : Scope::NONE
+          if value == Scope::NONE
+            return DSL::RestrictionWithNear.new(@setup.field(field_name.to_sym), @scope, @query, false)
+          end
         end
-        @query.add_location_restriction(coordinates, options)
+
+        # else
+        super
       end
     end
   end

data/lib/sunspot/field.rb

@@ -4,13 +4,15 @@ module Sunspot
     attr_accessor :type # The Type of the field
     attr_accessor :reference # Model class that the value of this field refers to
     attr_reader :boost
+    attr_reader :indexed_name # Name with which this field is indexed internally. Based on public name and type or the +:as+ option.
 
-    # 
+    #
     #
     def initialize(name, type, options = {}) #:nodoc
       @name, @type = name.to_sym, type
       @stored = !!options.delete(:stored)
       @more_like_this = !!options.delete(:more_like_this)
+      set_indexed_name(options)
       raise ArgumentError, "Field of type #{type} cannot be used for more_like_this" unless type.accepts_more_like_this? or !@more_like_this
     end
 
@@ -56,19 +58,7 @@ module Sunspot
       @type.cast(value)
     end
 
-    # 
-    # Name with which this field is indexed internally. Based on public name and
-    # type.
-    #
-    # ==== Returns
-    #
-    # String:: Internal name of the field
     #
-    def indexed_name
-      @type.indexed_name(@name)
-    end
-
-    # 
     # Whether this field accepts multiple values.
     #
     # ==== Returns
@@ -79,7 +69,7 @@ module Sunspot
       !!@multiple
     end
 
-    # 
+    #
     # Whether this field can be used for more_like_this queries.
     # If true, the field is configured to store termVectors.
     #
@@ -99,9 +89,30 @@ module Sunspot
       indexed_name == field.indexed_name
     end
     alias_method :==, :eql?
+
+    private
+
+    #
+    # Determine the indexed name. If the :as option is given use that, otherwise
+    # create the value based on the indexed_name of the type with additional
+    # suffixes for multiple, stored, and more_like_this.
+    #
+    # ==== Returns
+    #
+    # String: The field's indexed name
+    #
+    def set_indexed_name(options)
+      @indexed_name =
+        if options[:as]
+          options.delete(:as)
+        else
+          "#{@type.indexed_name(@name).to_s}#{'m' if @multiple }#{'s' if @stored}#{'v' if more_like_this?}"
+        end
+    end
+
   end
 
-  # 
+  #
   # FulltextField instances represent fields that are indexed as fulltext.
   # These fields are tokenized in the index, and can have boost applied to
   # them. They also always allow multiple values (since the only downside of
@@ -121,11 +132,11 @@ module Sunspot
     end
 
     def indexed_name
-      "#{super}#{'s' if @stored}#{'v' if more_like_this?}"
+      "#{super}"
     end
   end
 
-  # 
+  #
   # AttributeField instances encapsulate non-tokenized attribute data.
   # AttributeFields can have any type except TextType, and can also have
   # a reference (for instantiated facets), optionally allow multiple values
@@ -134,8 +145,8 @@ module Sunspot
   #
   class AttributeField < Field #:nodoc:
     def initialize(name, type, options = {})
-      super(name, type, options)
       @multiple = !!options.delete(:multiple)
+      super(name, type, options)
       @reference =
         if (reference = options.delete(:references)).respond_to?(:name)
           reference.name
@@ -145,17 +156,6 @@ module Sunspot
       raise ArgumentError, "Unknown field option #{options.keys.first.inspect} provided for field #{name.inspect}" unless options.empty?
     end
 
-    # The name of the field as it is indexed in Solr. The indexed name
-    # contains a suffix that contains information about the type as well as
-    # whether the field allows multiple values for a document.
-    #
-    # ==== Returns
-    #
-    # String:: The field's indexed name
-    #
-    def indexed_name
-      "#{super}#{'m' if @multiple}#{'s' if @stored}#{'v' if more_like_this?}"
-    end
   end
 
   class TypeField #:nodoc:
@@ -190,3 +190,4 @@ module Sunspot
     end
   end
 end
+

data/lib/sunspot/field_factory.rb

@@ -125,23 +125,5 @@ module Sunspot
         [@name, @type]
       end
     end
-
-    class Coordinates
-      def initialize(name = nil, &block)
-        if block
-          @data_extractor = DataExtractor::BlockExtractor.new(&block)
-        else
-          @data_extractor = DataExtractor::AttributeExtractor.new(name)
-        end
-      end
-
-      def populate_document(document, model)
-        if coordinates = @data_extractor.value_for(model)
-          coordinates = Util::Coordinates.new(coordinates)
-          document.add_field(:lat, coordinates.lat)
-          document.add_field(:lng, coordinates.lng)
-        end
-      end
-    end
   end
 end

data/lib/sunspot/installer/solrconfig_updater.rb

@@ -44,8 +44,6 @@ module Sunspot
             )
           end
           @root = @document.root
-          maybe_create_spatial_component
-          maybe_add_spatial_component_to_standard_handler
           maybe_add_more_like_this_handler
           original_path = "#{@solrconfig_path}.orig"
           FileUtils.cp(@solrconfig_path, original_path)
@@ -62,34 +60,6 @@ module Sunspot
 
       private
 
-      def maybe_create_spatial_component
-        if @root.xpath('searchComponent[@name="spatial"]').any?
-          say('Spatial search component already defined')
-        else
-          say('Defining spatial search component')
-          search_component_node =
-            Nokogiri::XML::Node.new('searchComponent', @document)
-          search_component_node['name'] = 'spatial'
-          search_component_node['class'] =
-            'me.outofti.solrspatiallight.SpatialQueryComponent'
-          @root << search_component_node
-        end
-      end
-
-      def maybe_add_spatial_component_to_standard_handler
-        standard_handler_node =
-          @root.xpath('requestHandler[@name="standard"]').first
-        last_components_node =
-          standard_handler_node.xpath('arr[@name="last-components"]').first ||
-          add_element(standard_handler_node, 'arr', 'name' => 'last-components')
-        if last_components_node.xpath('str[normalize-space()="spatial"]').any?
-          say('Spatial search component already in standard search handler')
-        else
-          say('Adding spatial search component into standard search handler')
-          add_element(last_components_node, 'str').content = 'spatial'
-        end
-      end
-
       def maybe_add_more_like_this_handler
         unless @root.xpath('requestHandler[@name="/mlt"]').first
           mlt_node = add_element(

data/lib/sunspot/query.rb

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

data/lib/sunspot/query/common_query.rb

@@ -6,9 +6,9 @@ module Sunspot
         @sort = SortComposite.new
         @components = [@scope, @sort]
         if types.length == 1
-          @scope.add_restriction(TypeField.instance, Restriction::EqualTo, types.first)
+          @scope.add_positive_restriction(TypeField.instance, Restriction::EqualTo, types.first)
         else
-          @scope.add_restriction(TypeField.instance, Restriction::AnyOf, types)
+          @scope.add_positive_restriction(TypeField.instance, Restriction::AnyOf, types)
         end
       end
 

data/lib/sunspot/query/composite_fulltext.rb

@@ -9,15 +9,20 @@ module Sunspot
         @components << dismax = Dismax.new(keywords)
         dismax
       end
+      
+      def add_location(field, lat, lng, options)
+        @components << location = Geo.new(field, lat, lng, options)
+        location
+      end
 
       def to_params
         case @components.length
         when 0
           {}
         when 1
-          @components.first.to_params
+          @components.first.to_params.merge(:fl => '* score')
         else
-          to_subqueries
+          to_subqueries.merge(:fl => '* score')
         end
       end
 

data/lib/sunspot/query/connective.rb

@@ -15,22 +15,37 @@ module Sunspot
         # 
         # Add a restriction to the connective.
         #
-        def add_restriction(field, restriction_type, value, negated = false)
-          add_component(restriction_type.new(field, value, negated))
+        def add_restriction(negated, field, restriction_type, *value)
+          add_component(restriction_type.new(negated, field, *value))
         end
 
         # 
         # Add a shorthand restriction; the restriction type is determined by
         # the value.
         #
-        def add_shorthand_restriction(field, value, negated = false)
+        def add_shorthand_restriction(negated, field, value)
           restriction_type =
             case value
             when Array then Restriction::AnyOf
             when Range then Restriction::Between
             else Restriction::EqualTo
             end
-          add_restriction(field, restriction_type, value, negated)
+          add_restriction(negated, field, restriction_type, value)
+        end
+
+        # 
+        # Add a positive restriction. The restriction will match all
+        # documents who match the terms fo the restriction.
+        #
+        def add_positive_restriction(field, restriction_type, value)
+          add_restriction(false, field, restriction_type, value)
+        end
+
+        # 
+        # Add a positive shorthand restriction (see add_shorthand_restriction)
+        #
+        def add_positive_shorthand_restriction(field, value)
+          add_shorthand_restriction(false, field, value)
         end
 
         # 
@@ -38,14 +53,14 @@ module Sunspot
         # documents who do not match the terms of the restriction.
         #
         def add_negated_restriction(field, restriction_type, value)
-          add_restriction(field, restriction_type, value, true)
+          add_restriction(true, field, restriction_type, value)
         end
 
         # 
         # Add a negated shorthand restriction (see add_shorthand_restriction)
         #
         def add_negated_shorthand_restriction(field, value)
-          add_shorthand_restriction(field, value, true)
+          add_shorthand_restriction(true, field, value)
         end
 
         # 

data/lib/sunspot/query/dismax.rb

@@ -62,6 +62,7 @@ module Sunspot
       def to_subquery
         params = self.to_params
         params.delete :defType
+        params.delete :fl
         keywords = params.delete(:q)
         options = params.map { |key, value| "#{key}='#{escape_quotes(value)}'"}.join(' ')
         "_query_:\"{!dismax #{options}}#{escape_quotes(keywords)}\""

data/lib/sunspot/query/geo.rb

@@ -0,0 +1,53 @@
+begin
+  require 'geohash'
+rescue LoadError => e
+  require 'pr_geohash'
+end
+
+module Sunspot
+  module Query
+    class Geo
+      MAX_PRECISION = 12
+      DEFAULT_PRECISION = 7
+      DEFAULT_PRECISION_FACTOR = 16.0
+
+      def initialize(field, lat, lng, options)
+        @field, @options = field, options
+        @geohash = GeoHash.encode(lat.to_f, lng.to_f, MAX_PRECISION)
+      end
+
+      def to_params
+        { :q => to_boolean_query }
+      end
+
+      def to_subquery
+        "(#{to_boolean_query})"
+      end
+
+      private
+
+      def to_boolean_query
+        queries = []
+        MAX_PRECISION.downto(precision) do |i|
+          star = i == MAX_PRECISION ? '' : '*'
+          precision_boost = Util.format_float(
+            boost * precision_factor ** (i-MAX_PRECISION).to_f, 3)
+          queries << "#{@field.indexed_name}:#{@geohash[0, i]}#{star}^#{precision_boost}"
+        end
+        queries.join(' OR ')
+      end
+
+      def precision
+        @options[:precision] || DEFAULT_PRECISION
+      end
+
+      def precision_factor
+        @options[:precision_factor] || DEFAULT_PRECISION_FACTOR
+      end
+
+      def boost
+        @options[:boost] || 1.0
+      end
+    end
+  end
+end

data/lib/sunspot/query/more_like_this.rb

@@ -5,6 +5,7 @@ module Sunspot
 
       def initialize(document)
         @document_scope = Restriction::EqualTo.new(
+          false,
           IdField.instance,
           Adapters::InstanceAdapter.adapt(document).index_id
         )

data/lib/sunspot/query/restriction.rb

@@ -42,8 +42,9 @@ module Sunspot
 
         RESERVED_WORDS = Set['AND', 'OR', 'NOT']
 
-        def initialize(field, value, negated = false)
-          @field, @value, @negated = field, value, negated
+        def initialize(negated, field, value)
+          raise ArgumentError.new("RFCTR") unless [true, false].include?(negated)
+          @negated, @field, @value = negated, field, value
         end
 
         # 
@@ -116,7 +117,7 @@ module Sunspot
         # is used by disjunction denormalization.
         #
         def negate
-          self.class.new(@field, @value, !@negated)
+          self.class.new(!@negated, @field, @value)
         end
 
         protected
@@ -218,8 +219,7 @@ module Sunspot
         end
 
         def to_solr_conditional
-          first, last = [@value.first, @value.last].sort
-          "[#{solr_value(first)} TO #{solr_value(last)}]"
+          "[#{solr_value(@value.first)} TO #{solr_value(@value.last)}]"
         end
       end
 

data/lib/sunspot/query/standard_query.rb

@@ -11,10 +11,6 @@ module Sunspot
       def add_fulltext(keywords)
         @fulltext.add(keywords)
       end
-
-      def add_location_restriction(coordinates, radius)
-        @components << @local = Local.new(coordinates, radius)
-      end
     end
   end
 end