nxa-sunspot 0.10.7

data/lib/sunspot/configuration.rb

@@ -0,0 +1,56 @@
+module Sunspot
+  # The Sunspot::Configuration module provides a factory method for Sunspot
+  # configuration objects. Available properties are:
+  #
+  # Sunspot.config.http_client::
+  #   The client to use for HTTP communication with Solr. Available options are
+  #   :net_http, which is the default and uses Ruby's built-in pure-Ruby HTTP
+  #   library; and :curb, which uses Ruby's libcurl bindings and requires
+  #   installation of the 'curb' gem.
+  # Sunspot.config.xml_builder::
+  #   The library use to build XML messages sent to Solr. As of this writing the
+  #   options are :builder and :libxml - the latter is faster but less portable,
+  #   as it is native code. Check the documentation for RSolr::Message::Adapter
+  #   for more information.
+  # Sunspot.config.solr.url::
+  #   The URL at which to connect to Solr
+  #   (default: 'http://localhost:8983/solr')
+  # Sunspot.config.pagination.default_per_page::
+  #   Solr always paginates its results. This sets Sunspot's default result
+  #   count per page if it is not explicitly specified in the query.
+  #
+  module Configuration
+    class <<self
+      # Factory method to build configuration instances.
+      #
+      # ==== Returns
+      #
+      # LightConfig::Configuration:: new configuration instance with defaults
+      #
+      def build #:nodoc:
+        LightConfig.build do
+          solr do
+            url 'http://127.0.0.1:8983/solr'
+          end
+          master_solr do
+            url nil
+          end
+          pagination do
+            default_per_page 30
+          end
+        end
+      end
+      
+      # Location for the default solr configuration files,
+      # required for bootstrapping a new solr installation
+      #
+      # ==== Returns
+      #
+      # String:: Directory with default solr config files
+      #
+      def solr_default_configuration_location
+        File.join( File.dirname(__FILE__), '../../solr/solr/conf' )
+      end
+    end
+  end
+end

data/lib/sunspot/data_extractor.rb

@@ -0,0 +1,50 @@
+module Sunspot
+  # 
+  # DataExtractors present an internal API for the indexer to use to extract
+  # field values from models for indexing. They must implement the #value_for
+  # method, which takes an object and returns the value extracted from it.
+  #
+  module DataExtractor #:nodoc: all
+    # 
+    # AttributeExtractors extract data by simply calling a method on the block.
+    #
+    class AttributeExtractor
+      def initialize(attribute_name)
+        @attribute_name = attribute_name
+      end
+
+      def value_for(object)
+        object.send(@attribute_name)
+      end
+    end
+
+    # 
+    # BlockExtractors extract data by evaluating a block in the context of the
+    # object instance, or if the block takes an argument, by passing the object
+    # as the argument to the block. Either way, the return value of the block is
+    # the value returned by the extractor.
+    #
+    class BlockExtractor
+      def initialize(&block)
+        @block = block
+      end
+
+      def value_for(object)
+        Util.instance_eval_or_call(object, &@block)
+      end
+    end
+
+    # 
+    # Constant data extractors simply return the same value for every object.
+    #
+    class Constant
+      def initialize(value)
+        @value = value
+      end
+
+      def value_for(object)
+        @value
+      end
+    end
+  end
+end

data/lib/sunspot/dsl.rb

@@ -0,0 +1,4 @@
+%w(fields scope field_query query query_facet fulltext restriction
+   search).each do |file|
+  require File.join(File.dirname(__FILE__), 'dsl', file)
+end

data/lib/sunspot/dsl/field_query.rb

@@ -0,0 +1,150 @@
+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.
+    #
+    class FieldQuery < Scope
+      def initialize(search, query, setup) #:nodoc:
+        @search, @query = search, query
+        super(query.scope, setup)
+      end
+
+      # Specify the order that results should be returned in. This method can
+      # be called multiple times; precedence will be in the order given.
+      #
+      # ==== Parameters
+      #
+      # field_name<Symbol>:: the field to use for ordering
+      # direction<Symbol>:: :asc or :desc (default :asc)
+      #
+      def order_by(field_name, direction = nil)
+        sort =
+          if special = Sunspot::Query::Sort.special(field_name)
+            special.new(direction)
+          else
+            Sunspot::Query::Sort::FieldSort.new(
+              @setup.field(field_name), direction
+            )
+          end
+        @query.add_sort(sort)
+      end
+
+      # 
+      # DEPRECATED Use <code>order_by(:random)</code>
+      #
+      def order_by_random
+        order_by(:random)
+      end
+
+      # Request facets on the given field names. If the last argument is a hash,
+      # the given options will be applied to all specified fields. See
+      # Sunspot::Search#facet and Sunspot::Facet for information on what is
+      # returned.
+      #
+      # ==== Parameters
+      #
+      # field_names...<Symbol>:: fields for which to return field facets
+      #
+      # ==== Options
+      #
+      # :sort<Symbol>::
+      #   Either :count (values matching the most terms first) or :index (lexical)
+      # :limit<Integer>::
+      #   The maximum number of facet rows to return
+      # :minimum_count<Integer>::
+      #   The minimum count a facet row must have to be returned
+      # :zeros<Boolean>::
+      #   Return facet rows for which there are no matches (equivalent to
+      #   :minimum_count => 0). Default is false.
+      # :extra<Symbol,Array>::
+      #   One or more of :any and :none. :any returns a facet row with a count
+      #   of all matching documents that have some value for this field. :none
+      #   returns a facet row with a count of all matching documents that have
+      #   no value for this field. The facet row(s) corresponding to the extras
+      #   have a value of the symbol passed.
+      #
+      def facet(*field_names, &block)
+        options = Sunspot::Util.extract_options_from(field_names)
+
+        if block
+          if field_names.length != 1
+            raise(
+              ArgumentError,
+              "wrong number of arguments (#{field_names.length} for 1)"
+            )
+          end
+          search_facet = @search.add_query_facet(field_names.first, options)
+          Sunspot::Util.instance_eval_or_call(
+            QueryFacet.new(@query, @setup, search_facet),
+            &block
+          )
+        elsif options[:only]
+          field_names.each do |field_name|
+            field = @setup.field(field_name)
+            search_facet = @search.add_field_facet(field, options)
+            Util.Array(options[:only]).each do |value|
+              facet = Sunspot::Query::QueryFacet.new
+              facet.add_restriction(field, Sunspot::Query::Restriction::EqualTo, value)
+              @query.add_query_facet(facet)
+              search_facet.add_row(value, facet.to_boolean_phrase)
+            end
+          end
+        else
+          field_names.each do |field_name|
+            search_facet = nil
+            field = @setup.field(field_name)
+            facet =
+              if options[:time_range]
+                unless field.type == Sunspot::Type::TimeType
+                  raise(
+                    ArgumentError,
+                    ':time_range can only be specified for Date or Time fields'
+                  )
+                end
+                search_facet = @search.add_date_facet(field, options)
+                Sunspot::Query::DateFieldFacet.new(field, options)
+              else
+                search_facet = @search.add_field_facet(field)
+                Sunspot::Query::FieldFacet.new(field, options)
+              end
+            @query.add_field_facet(facet)
+            Util.Array(options[:extra]).each do |extra|
+              extra_facet = Sunspot::Query::QueryFacet.new
+              case extra
+              when :any
+                extra_facet.add_negated_restriction(
+                  field,
+                  Sunspot::Query::Restriction::EqualTo,
+                  nil
+                )
+              when :none
+                extra_facet.add_restriction(
+                  field,
+                  Sunspot::Query::Restriction::EqualTo,
+                  nil
+                )
+              else
+                raise(
+                  ArgumentError,
+                  "Allowed values for :extra are :any and :none"
+                )
+              end
+              search_facet.add_row(extra, extra_facet.to_boolean_phrase)
+              @query.add_query_facet(extra_facet)
+            end
+          end
+        end
+      end
+
+      def dynamic(base_name, &block)
+        dynamic_field_factory = @setup.dynamic_field_factory(base_name)
+        Sunspot::Util.instance_eval_or_call(
+          FieldQuery.new(@search, @query, dynamic_field_factory),
+          &block
+        )
+      end
+    end
+  end
+end

data/lib/sunspot/dsl/fields.rb

@@ -0,0 +1,100 @@
+module Sunspot
+  module DSL #:nodoc:
+    # The Fields class provides a DSL for specifying field definitions in the
+    # Sunspot.setup block. As well as the #text method, which creates fulltext
+    # fields, uses #method_missing to allow definition of typed fields. The
+    # available methods are determined by the constants defined in 
+    # Sunspot::Type - in theory (though this is untested), plugin developers
+    # should be able to add support for new types simply by creating new
+    # implementations in Sunspot::Type
+    #
+    class Fields
+      def initialize(setup) #:nodoc:
+        @setup = setup
+      end
+
+      # Add a text field. Text fields are tokenized before indexing and are
+      # the only fields searched in fulltext searches. If a block is passed,
+      # create a virtual field; otherwise create an attribute field.
+      #
+      # If options are passed, they will be applied to all the given fields.
+      #
+      # ==== Parameters
+      #
+      # names...<Symbol>:: One or more field names
+      #
+      # ==== Options
+      #
+      # :boost<Float>::
+      #   Index-time boost that should be applied to this field for keyword search
+      # :default_boost<Float>::
+      #   Default search-time boost to apply to this field during keyword
+      #   search. Can be overriden with DSL::Fulltext#fields or
+      #   DSL::Fulltext#boost_fields method.
+      #
+      def text(*names, &block)
+        options = names.pop if names.last.is_a?(Hash)
+        names.each do |name|
+          @setup.add_text_field_factory(
+            name,
+            options || {},
+            &block
+          )
+        end
+      end
+
+      # 
+      # Specify a method or block that returns the geographical coordinates
+      # associated with the document. The object returned must respond to #first
+      # and #last (e.g., a two-element Array); or to #lat and one of #lng, #lon,
+      # or #long
+      #
+      def coordinates(name = nil, &block)
+        @setup.set_coordinates_field(name, &block)
+      end
+
+      # 
+      # Specify a document-level boost. As with fields, you have the option of
+      # passing an attribute name which will be called on each model, or a block
+      # to be evaluated in the model's context. As well as these two options,
+      # this method can also take a constant number, meaning that all indexed
+      # documents of this class will have the specified boost.
+      #
+      # ==== Parameters
+      #
+      # attr_name<Symbol,~.to_f>:: Attribute name to call or a numeric constant
+      #
+      def boost(attr_name = nil, &block)
+        @setup.add_document_boost(attr_name, &block)
+      end
+
+      # method_missing is used to provide access to typed fields, because
+      # developers should be able to add new Sunspot::Type implementations
+      # dynamically and have them recognized inside the Fields DSL. Like #text,
+      # these methods will create a VirtualField if a block is passed, or an
+      # AttributeField if not.
+      #
+      # ==== Example
+      #
+      #   Sunspot.setup(File) do
+      #     time :mtime
+      #   end
+      #
+      # The call to +time+ will create a field of type Sunspot::Types::TimeType
+      #
+      def method_missing(method, *args, &block)
+        begin
+          type = Type.const_get("#{Util.camel_case(method.to_s.sub(/^dynamic_/, ''))}Type")
+        rescue(NameError)
+          super(method.to_sym, *args, &block) and return
+        end
+        name = args.shift
+        if method.to_s =~ /^dynamic_/
+          @setup.add_dynamic_field_factory(name, type, *args, &block)
+        else
+          @setup.add_field_factory(name, type, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/dsl/fulltext.rb

@@ -0,0 +1,228 @@
+module Sunspot
+  module DSL
+    # 
+    # This DSL exposes the functionality provided by Solr's fulltext Dismax
+    # handler.
+    #
+    class Fulltext
+      attr_reader :exclude_fields #:nodoc:
+
+      def initialize(query, setup) #:nodoc:
+        @query, @setup = query, setup
+        @fields_added = false
+        @exclude_fields = []
+      end
+
+      # 
+      # Specify which fields to search. Field names specified as arguments are
+      # given default boost; field boosts can be specified by passing a hash of
+      # field names keyed to boost values as the last argument.
+      #
+      # If you wish to boost certain fields without restricting which fields are
+      # searched, use #boost_fields
+      #
+      # === Example
+      #
+      #   Sunspot.search(Post) do
+      #     keywords 'search is cool' do
+      #       fields(:body, :title => 2.0)
+      #     end
+      #   end
+      #
+      # This would search the :body field with default boost (1.0), and the :title
+      # field with a boost of 2.0
+      #
+      def fields(*field_names)
+        @fields_added = true
+        boosted_fields = field_names.pop if field_names.last.is_a?(Hash)
+        field_names.each do |field_name|
+          @setup.text_fields(field_name).each do |field|
+            @query.add_fulltext_field(field, field.default_boost)
+          end
+        end
+        if boosted_fields
+          boosted_fields.each_pair do |field_name, boost|
+            @setup.text_fields(field_name).each do |field|
+              @query.add_fulltext_field(field, boost)
+            end
+          end
+        end
+      end
+
+      # 
+      # Exclude the given fields from the search. All fields that are configured
+      # for the types under search and not listed here will be searched.
+      #
+      def exclude_fields(*field_names)
+        @exclude_fields.concat(field_names)
+      end
+
+      # 
+      # Enable keyword highlighting for this search. By default, the fields 
+      # under search will be highlighted; you may also may pass one or more
+      # symbol arguments indicating fields to be highlighted (they don't even
+      # have to be the same fields you're searching).
+      #
+      # === Example
+      #
+      #   Sunspot.search(Post) do
+      #     keywords 'show me the highlighting' do
+      #       highlight :title, :body
+      #     end
+      #   end
+      #
+      # You may also pass a hash of options as the last argument. Options are
+      # the following:
+      #
+      # Full disclosure: I barely understand what these options actually do;
+      # this documentation is pretty much just copied from the
+      # (http://wiki.apache.org/solr/HighlightingParameters#head-23ecd5061bc2c86a561f85dc1303979fe614b956)[Solr Wiki]
+      # 
+      # :max_snippets::
+      #   The maximum number of highlighted snippets to generate per field
+      # :fragment_size::
+      #   The number of characters to consider for a highlighted fragment
+      # :merge_continuous_fragments::
+      #   Collapse continuous fragments into a single fragment
+      # :phrase_highlighter::
+      #   Highlight phrase terms only when they appear within the query phrase
+      #   in the document
+      # :require_field_match::
+      #   If true, a field will only be highlighted if the query matched in
+      #   this particular field (only has an effect if :phrase_highlighter is
+      #   true as well)
+      #
+      def highlight(*args)
+        options = args.last.kind_of?(Hash) ? args.pop : {}
+        fields = []
+        args.each { |field_name| fields.concat(@setup.text_fields(field_name)) }
+
+        @query.add_highlight(fields, options)
+      end
+
+      # 
+      # Phrase fields are an awesome dismax feature that adds extra boost to
+      # documents for which all the fulltext keywords appear in close proximity
+      # in one of the given fields. Excellent for titles, headlines, etc.
+      #
+      # Boosted fields are specified in a hash of field names to a boost, as
+      # with the #fields and #boost_fields methods.
+      #
+      # === Example
+      #
+      #   Sunspot.search(Post) do
+      #     keywords 'nothing reveals like relevance' do
+      #       phrase_fields :title => 2.0
+      #     end
+      #   end
+      #
+      def phrase_fields(boosted_fields)
+        if boosted_fields
+          boosted_fields.each_pair do |field_name, boost|
+            @setup.text_fields(field_name).each do |field|
+              @query.add_phrase_field(field, boost)
+            end
+          end
+        end
+      end
+
+      # 
+      # The maximum number of words that can appear between search terms for a
+      # field to qualify for phrase field boost. See #query_phrase_slop for
+      # examples. Phrase slop is only meaningful if phrase fields are specified
+      # (see #phrase_fields), and it does not have an effect on which results
+      # are returned; only on what their respective boosts are.
+      #
+      def phrase_slop(slop)
+        @query.phrase_slop = slop
+      end
+
+      # 
+      # Boost queries allow specification of an arbitrary scope for which
+      # matching documents should receive an extra boost. The block is evaluated
+      # in the usual scope DSL, and field names are attribute fields, not text
+      # fields, as in other scope.
+      #
+      # This method can be called more than once for different boost queries
+      # with different boosts.
+      #
+      # === Example
+      #
+      #   Sunspot.search(Post) do
+      #     keywords 'super fan' do
+      #       boost(2.0) do
+      #         with(:featured, true)
+      #       end
+      #     end
+      #   end
+      #
+      # In the above search, featured posts will receive a boost of 2.0.
+      #
+      def boost(factor, &block)
+        Sunspot::Util.instance_eval_or_call(
+          Scope.new(@query.create_boost_query(factor), @setup),
+          &block
+        )
+      end
+
+      #
+      # Add boost to certain fields, without restricting which fields are
+      # searched.
+      #
+      # === Example
+      #
+      #   Sunspot.search(Post) do
+      #     keywords('pork sandwich') do
+      #       boost_fields :title => 1.5
+      #     end
+      #   end
+      #
+      def boost_fields(boosts)
+        boosts.each_pair do |field_name, boost|
+          begin
+            @setup.text_fields(field_name).each do |field|
+              @query.add_fulltext_field(field, boost)
+            end
+          rescue Sunspot::UnrecognizedFieldError
+            # We'll let this one slide.
+          end
+        end
+      end
+      
+      #
+      # The minimum number of search terms that a result must match. By
+      # default, all search terms must match; if the number of search terms
+      # is less than this number, the default behavior applies.
+      #
+      def minimum_match(minimum_match)
+        @query.minimum_match = minimum_match
+      end
+
+      #
+      # The number of words that can appear between the words in a
+      # user-entered phrase (i.e., keywords in quotes) and still match. For
+      # instance, in a search for "\"great pizza\"" with a query phrase slop of
+      # 1, "great pizza" and "great big pizza" will match, but "great monster of
+      # a pizza" will not. Default behavior is a query phrase slop of zero.
+      #
+      def query_phrase_slop(slop)
+        @query.query_phrase_slop = slop
+      end
+
+      #
+      # A tiebreaker coefficient for scores derived from subqueries that are
+      # lower-scoring than the maximum score subquery. Typically a near-zero
+      # value is useful. See
+      # http://wiki.apache.org/solr/DisMaxRequestHandler#tie_.28Tie_breaker.29
+      # for more information.
+      #
+      def tie(tie)
+        @query.tie = tie
+      end
+
+      def fields_added? #:nodoc:
+        @fields_added
+      end
+    end
+  end
+end