benjaminkrause-sunspot 0.9.7

data/lib/sunspot/query/query_facet_row.rb

@@ -0,0 +1,19 @@
+module Sunspot
+  module Query
+    # 
+    # QueryFacetRow objects encapsulate restrictions for a particular
+    # QueryFacet. They also contain a label attribute, which is used as the
+    # value for the search result's corresponding facet row object.
+    #
+    # See Query::Scope for the API provided.
+    #
+    class QueryFacetRow < Connective::Conjunction #:nodoc:
+      attr_reader :label
+
+      def initialize(label, setup)
+        super(setup)
+        @label = label
+      end
+    end
+  end
+end

data/lib/sunspot/query/query_field_facet.rb

@@ -0,0 +1,20 @@
+module Sunspot
+  module Query
+    # 
+    # QueryFieldFacets are used for the "restricted field facet" feature, which
+    # allows an :only parameter for field facets, specifying a set of values in
+    # which the searcher is interested. Since Solr does not support this feature
+    # directly in field facets, build query facets that replicate field facet
+    # behavior.
+    #
+    class QueryFieldFacet < QueryFacet #:nodoc:
+      def initialize(field, values, options)
+        super(field.name, options)
+        @field = field
+        values.each do |value|
+          add_row(value).add_component(Restriction::EqualTo.new(field, value))
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/query/restriction.rb

@@ -0,0 +1,272 @@
+module Sunspot
+  module Query
+    module Restriction #:nodoc:
+      class <<self
+        #
+        # Return the names of all of the restriction classes that should be made
+        # available to the DSL.
+        #
+        # ==== Returns
+        # 
+        # Array:: Collection of restriction class names
+        #
+        def names
+          constants - %w(Base SameAs) #XXX this seems ugly
+        end
+
+        # 
+        # Convenience method to access a restriction class by an underscored
+        # symbol or string
+        #
+        def [](restriction_name)
+          @types ||= {}
+          @types[restriction_name.to_sym] ||= const_get(Sunspot::Util.camel_case(restriction_name.to_s))
+        end
+      end
+
+      # 
+      # Subclasses of this class represent restrictions that can be applied to
+      # a Sunspot query. The Sunspot::DSL::Restriction class presents a builder
+      # API for instances of this class.
+      #
+      # Implementations of this class must respond to #to_params and
+      # #to_negated_params. Instead of implementing those methods, they may
+      # choose to implement any of:
+      #
+      # * #to_positive_boolean_phrase, and optionally #to_negated_boolean_phrase
+      # * #to_solr_conditional
+      #
+      class Base #:nodoc:
+        include RSolr::Char
+
+        def initialize(field, value, negated = false)
+          @field, @value, @negated = field, value, negated
+        end
+
+        # 
+        # A hash representing this restriction in solr-ruby's parameter format.
+        # All restriction implementations must respond to this method; however,
+        # the base implementation delegates to the #to_positive_boolean_phrase method, so
+        # subclasses may (and probably should) choose to implement that method
+        # instead.
+        #
+        # ==== Returns
+        #
+        # Hash:: Representation of this restriction as solr-ruby parameters
+        #
+        def to_params
+          { :fq => [to_boolean_phrase] }
+        end
+
+        # 
+        # Return the boolean phrase associated with this restriction object.
+        # Differentiates between positive and negated boolean phrases depending
+        # on whether this restriction is negated.
+        #
+        def to_boolean_phrase
+          unless negated?
+            to_positive_boolean_phrase
+          else
+            to_negated_boolean_phrase
+          end
+        end
+
+        # 
+        # Boolean phrase representing this restriction in the positive. Subclasses
+        # may choose to implement this method rather than #to_params; however,
+        # this method delegates to the abstract #to_solr_conditional method, which
+        # in most cases will be what subclasses will want to implement.
+        # #to_solr_conditional contains the boolean phrase representing the
+        # condition but leaves out the field name (see built-in implementations
+        # for examples)
+        #
+        # ==== Returns
+        #
+        # String:: Boolean phrase for restriction in the positive
+        #
+        def to_positive_boolean_phrase
+          "#{escape(@field.indexed_name)}:#{to_solr_conditional}"
+        end
+
+        # 
+        # Boolean phrase representing this restriction in the negated. Subclasses
+        # may choose to implement this method, but it is not necessary, as the
+        # base implementation delegates to #to_positive_boolean_phrase.
+        #
+        # ==== Returns
+        #
+        # String:: Boolean phrase for restriction in the negated
+        #
+        def to_negated_boolean_phrase
+          "-#{to_positive_boolean_phrase}"
+        end
+
+        # 
+        # Whether this restriction should be negated from its original meaning
+        #
+        def negated? #:nodoc:
+          !!@negated
+        end
+
+        # 
+        # Return a new restriction that is the negated version of this one. It
+        # is used by disjunction denormalization.
+        #
+        def negate
+          self.class.new(@field, @value, !@negated)
+        end
+
+        protected
+
+        # 
+        # Return escaped Solr API representation of given value
+        #
+        # ==== Parameters
+        #
+        # value<Object>::
+        #   value to convert to Solr representation (default: @value)
+        #
+        # ==== Returns
+        #
+        # String:: Solr API representation of given value
+        #
+        def solr_value(value = @value)
+          solr_value = escape(@field.to_indexed(value))
+        end
+      end
+
+      # 
+      # Results must have field with value equal to given value. If the value
+      # is nil, results must have no value for the given field.
+      #
+      class EqualTo < Base
+        def to_positive_boolean_phrase
+          unless @value.nil?
+            super
+          else
+            "#{escape(@field.indexed_name)}:[* TO *]"
+          end
+        end
+
+        def negated?
+          if @value.nil?
+            !super
+          else
+            super
+          end
+        end
+
+        private
+
+        def to_solr_conditional
+          "#{solr_value}"
+        end
+      end
+
+      # 
+      # Results must have field with value less than given value
+      #
+      class LessThan < Base
+        private
+
+        def solr_value(value = @value)
+          solr_value = super
+          solr_value = "\"#{solr_value}\"" if solr_value.index(' ')
+          solr_value
+        end
+
+        def to_solr_conditional
+          "[* TO #{solr_value}]"
+        end
+      end
+
+      # 
+      # Results must have field with value greater than given value
+      #
+      class GreaterThan < Base
+        private
+
+        def solr_value(value = @value)
+          solr_value = super
+          solr_value = "\"#{solr_value}\"" if solr_value.index(' ')
+          solr_value
+        end
+
+        def to_solr_conditional
+          "[#{solr_value} TO *]"
+        end
+      end
+
+      # 
+      # Results must have field with value in given range
+      #
+      class Between < Base
+        private
+
+        def solr_value(value = @value)
+          solr_value = super
+          solr_value = "\"#{solr_value}\"" if solr_value.index(' ')
+          solr_value
+        end
+
+        def to_solr_conditional
+          first, last = [@value.first, @value.last].sort
+          "[#{solr_value(first)} TO #{solr_value(last)}]"
+        end
+      end
+
+      # 
+      # Results must have field with value included in given collection
+      #
+      class AnyOf < Base
+        private
+
+        def to_solr_conditional
+          "(#{@value.map { |v| solr_value v } * ' OR '})"
+        end
+      end
+
+      #
+      # Results must have field with values matching all values in given
+      # collection (only makes sense for fields with multiple values)
+      #
+      class AllOf < Base
+        private
+
+        def to_solr_conditional
+          "(#{@value.map { |v| solr_value v } * ' AND '})"
+        end
+      end
+
+      # 
+      # Results must have a field with a value that begins with the argument.
+      # Most useful for strings, but in theory will work with anything.
+      #
+      class StartingWith < Base
+        private
+
+        def to_solr_conditional
+          "#{solr_value(@value)}*"
+        end
+      end
+
+      # 
+      # Result must be the exact instance given (only useful when negated).
+      #
+      class SameAs < Base
+        def initialize(object, negated = false)
+          @object, @negated = object, negated
+        end
+
+        def to_positive_boolean_phrase
+          adapter = Adapters::InstanceAdapter.adapt(@object)
+          "id:#{escape(adapter.index_id)}"
+        end
+
+        def negate
+          SameAs.new(@object, !negated?)
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/query/scope.rb

@@ -0,0 +1,185 @@
+module Sunspot
+  module Query
+    # 
+    # The Scope class encapsulates a set of restrictions that scope search
+    # results (as well as query facets rows). This class's API is exposed by
+    # Query::Query and Query::QueryFacetRow.
+    # 
+    class Scope #:nodoc:
+      def initialize(setup)
+        @setup = setup
+        @components = []
+      end
+
+      # 
+      # Add a restriction to the query.
+      # 
+      # ==== Parameters
+      #
+      # field_name<Symbol>:: Name of the field to which the restriction applies
+      # restriction_type<Class,Symbol>::
+      #   Subclass of Sunspot::Query::Restriction::Base, or snake_cased name as symbol
+      #   (e.g., +:equal_to+)
+      # value<Object>::
+      #   Value against which the restriction applies (e.g. less_than(2) has a
+      #   value of 2)
+      # negated::
+      #   Whether this restriction should be negated (use add_negated_restriction)
+      #
+      def add_restriction(field_name, restriction_type, value, negated = false)
+        if restriction_type.is_a?(Symbol)
+          restriction_type = Restriction[restriction_type]
+        end
+        add_component(
+          restriction = restriction_type.new(
+            build_field(field_name), value, negated
+          )
+        )
+        restriction
+      end
+
+      # 
+      # Add a negated restriction to the query. The restriction will be taken as
+      # the opposite of its usual meaning (e.g., an :equal_to restriction will
+      # be "not equal to".
+      #
+      # ==== Parameters
+      #
+      # field_name<Symbol>:: Name of the field to which the restriction applies
+      # restriction_type<Class>::
+      #   Subclass of Sunspot::Query::Restriction::Base to instantiate
+      # value<Object>::
+      #   Value against which the restriction applies (e.g. less_than(2) has a
+      #   value of 2)
+      #
+      def add_negated_restriction(field_name, restriction_type, value)
+        add_restriction(field_name, restriction_type, value, true)
+      end
+
+      # 
+      # Add a disjunction to the scope. The disjunction can then take a set of
+      # restrictions, which are combined with OR semantics.
+      #
+      # ==== Returns
+      #
+      # Connective::Disjunction:: New disjunction
+      #
+      def add_disjunction
+        add_component(disjunction = Connective::Disjunction.new(@setup))
+        disjunction
+      end
+
+      # 
+      # Add a conjunction to the scope. In most cases, this will simply return
+      # the Scope object itself, since scopes by default combine their
+      # restrictions with OR semantics. The Connective::Disjunction class
+      # overrides this method to return a Connective::Conjunction.
+      #
+      # ==== Returns
+      #
+      # Scope:: Self or another scope with conjunctive semantics.
+      #
+      def add_conjunction
+        self
+      end
+      
+      #
+      # Exclude a particular instance from the search results
+      #
+      # ==== Parameters
+      #
+      # instance<Object>:: instance to exclude from results
+      #
+      def exclude_instance(instance)
+        add_component(Restriction::SameAs.new(instance, true))
+      end
+
+      # 
+      # Generate a DynamicQuery instance for the given base name.
+      # This gives you access to a subset of the Query API but the operations
+      # apply to dynamic fields inside the dynamic field definition specified
+      # by +base_name+.
+      # 
+      # ==== Parameters
+      # 
+      # base_name<Symbol>::
+      #   Base name of the dynamic field definition to use in the dynamic query
+      #   operations
+      #
+      # ==== Returns
+      #
+      # DynamicQuery::
+      #   Instance providing dynamic query functionality for the given field
+      #   definitions.
+      #
+      def dynamic_query(base_name)
+        DynamicQuery.new(@setup.dynamic_field_factory(base_name), self)
+      end
+
+      # 
+      # Determine which restriction type to add based on the type of the value.
+      # Used to interpret query conditions passed as a hash, as well as the
+      # short-form DSL::Scope#with method.
+      #
+      # ==== Parameters
+      #
+      # field_name<Symbol>:: Name of the field on which to apply the restriction
+      # value<Object,Array,Range>:: Value to which to apply to the restriction
+      #--
+      # negated<Boolean>:: Whether to negate the restriction.
+      #
+      def add_shorthand_restriction(field_name, value, negated = false) #:nodoc:
+        restriction_type =
+          case value
+          when Range
+            Restriction::Between
+          when Array
+            Restriction::AnyOf
+          else
+            Restriction::EqualTo
+          end
+        add_restriction(field_name, restriction_type, value, negated)
+      end
+
+      # 
+      # Add a negated shorthand restriction. See #add_shorthand_restriction
+      #
+      def add_negated_shorthand_restriction(field_name, value)
+        add_shorthand_restriction(field_name, value, true)
+      end
+
+      # 
+      # Add a component to the connective. All components must implement the
+      # #to_boolean_phrase method.
+      #
+      def add_component(component) #:nodoc:
+        @components << component
+      end
+
+      # 
+      # Representation of this query as solr parameters.
+      #
+      # ==== Returns
+      #
+      # Hash:: Representation of query in Solr form
+      #
+      def to_params #:nodoc:
+        params = {}
+        for component in @components
+          Util.deep_merge!(params, component.to_params)
+        end
+        params
+      end
+
+      private
+
+      # 
+      # Build a field with the given field name. Subclasses may override this
+      # method.
+      #
+      def build_field(field_name)
+        @setup.field(field_name)
+      end
+    end
+  end
+end

data/lib/sunspot/query/sort.rb

@@ -0,0 +1,105 @@
+module Sunspot
+  module Query
+    # 
+    # The classes in this module implement query components that build sort
+    # parameters for Solr. As well as regular sort on fields, there are several
+    # "special" sorts that allow ordering for metrics calculated during the
+    # search.
+    # 
+    module Sort #:nodoc: all
+      DIRECTIONS = {
+        :asc => 'asc',
+        :ascending => 'asc',
+        :desc => 'desc',
+        :descending => 'desc'
+      }
+
+      class <<self
+        # 
+        # Certain field names are "special", referring to specific non-field
+        # sorts, which are generally by other metrics associated with hits.
+        #
+        # XXX I'm not entirely convinced it's a good idea to prevent anyone from
+        # ever sorting by a field named 'score', etc.
+        #
+        def special(name)
+          special_class_name = "#{Util.camel_case(name.to_s)}Sort"
+          if const_defined?(special_class_name) && special_class_name != 'FieldSort'
+            const_get(special_class_name)
+          end
+        end
+      end
+
+      # 
+      # Base class for sorts. All subclasses should implement the #to_param
+      # method, which is a string that is then concatenated with other sort
+      # strings by the SortComposite to form the sort parameter.
+      #
+      class Abstract
+        def initialize(direction)
+          @direction = (direction || :asc).to_sym
+        end
+
+        private
+
+        # 
+        # Translate fairly forgiving direction argument into solr direction
+        #
+        def direction_for_solr
+          DIRECTIONS[@direction] || 
+            raise(
+              ArgumentError,
+              "Unknown sort direction #{@direction}. Acceptable input is: #{DIRECTIONS.keys.map { |input| input.inspect } * ', '}"
+          )
+        end
+      end
+
+      # 
+      # A FieldSort is the usual kind of sort, by the value of a particular
+      # field, ascending or descending
+      #
+      class FieldSort < Abstract
+        def initialize(field, direction = nil)
+          if field.multiple?
+            raise(ArgumentError, "#{field.name} cannot be used for ordering because it is a multiple-value field")
+          end
+          @field, @direction = field, (direction || :asc).to_sym
+        end
+
+        def to_param
+          "#{@field.indexed_name.to_sym} #{direction_for_solr}"
+        end
+      end
+
+      # 
+      # A RandomSort uses Solr's random field functionality to sort results
+      # (usually) randomly.
+      #
+      class RandomSort < Abstract
+        def to_param
+          "random_#{rand(1<<16)} #{direction_for_solr}"
+        end
+      end
+
+      # 
+      # A ScoreSort sorts by keyword relevance score. This is only useful when
+      # performing fulltext search.
+      #
+      class ScoreSort < Abstract
+        def to_param
+          "score #{direction_for_solr}"
+        end
+      end
+
+      # 
+      # A DistanceSort sorts by distance from the origin coordinates of a
+      # geographical distance search.
+      #
+      class DistanceSort < Abstract
+        def to_param
+          "geo_distance #{direction_for_solr}"
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/query/sort_composite.rb

@@ -0,0 +1,33 @@
+module Sunspot
+  module Query
+    # 
+    # The SortComposite class encapsulates an ordered collection of Sort
+    # objects. It's necessary to keep this as a separate class as Solr takes
+    # the sort as a single parameter, so adding sorts as regular components
+    # would not merge correctly in the #to_params method.
+    #
+    class SortComposite #:nodoc:
+      def initialize
+        @sorts = []
+      end
+
+      # 
+      # Add a sort to the composite
+      #
+      def <<(sort)
+        @sorts << sort
+      end
+
+      # 
+      # Combine the sorts into a single param by joining them
+      #
+      def to_params
+        unless @sorts.empty?
+          { :sort => @sorts.map { |sort| sort.to_param } * ', ' }
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/query/text_field_boost.rb

@@ -0,0 +1,15 @@
+module Sunspot
+  module Query
+    class TextFieldBoost #:nodoc:
+      def initialize(field, boost = nil)
+        @field, @boost = field, boost
+      end
+
+      def to_boosted_field
+        boosted_field = @field.indexed_name
+        boosted_field.concat("^#{@boost}") if @boost
+        boosted_field
+      end
+    end
+  end
+end