sunspot 0.9.7

data/lib/sunspot/query/sort.rb

@@ -0,0 +1,36 @@
+module Sunspot
+  module Query
+    # 
+    # The Sort class is a query component representing a sort by a given field.
+    # 
+    class Sort #:nodoc:
+      DIRECTIONS = {
+        :asc => 'asc',
+        :ascending => 'asc',
+        :desc => 'desc',
+        :descending => 'desc'
+      }
+
+      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
+
+      private
+
+      def direction_for_solr
+        DIRECTIONS[@direction] || 
+          raise(
+            ArgumentError,
+            "Unknown sort direction #{@direction}. Acceptable input is: #{DIRECTIONS.keys.map { |input| input.inspect } * ', '}"
+        )
+      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/schema.rb

@@ -0,0 +1,165 @@
+using_rubygems = false
+begin
+  require 'haml'
+rescue LoadError => e
+  if using_rubygems
+    raise(e)
+  else
+    using_rubygems = true
+    require 'rubygems'
+    retry
+  end
+end
+
+module Sunspot
+  # 
+  # Object that encapsulates schema information for building a Solr schema.xml
+  # file. This class is used by the schema:compile task as well as the
+  # sunspot-configure-solr executable.
+  #
+  class Schema #:nodoc:all
+    FieldType = Struct.new(:name, :class_name, :suffix)
+    FieldVariant = Struct.new(:attribute, :suffix)
+
+    DEFAULT_TOKENIZER = 'solr.StandardTokenizerFactory'
+    DEFAULT_FILTERS = %w(solr.StandardFilterFactory solr.LowerCaseFilterFactory)
+
+    FIELD_TYPES = [
+      FieldType.new('boolean', 'Bool', 'b'),
+      FieldType.new('sfloat', 'SortableFloat', 'f'),
+      FieldType.new('date', 'Date', 'd'),
+      FieldType.new('sint', 'SortableInt', 'i'),
+      FieldType.new('string', 'Str', 's')
+    ]
+
+    FIELD_VARIANTS = [
+      FieldVariant.new('multiValued', 'm'),
+      FieldVariant.new('stored', 's')
+    ]
+
+    attr_reader :tokenizer, :filters
+
+    def initialize
+      @tokenizer = DEFAULT_TOKENIZER
+      @filters = DEFAULT_FILTERS.dup
+    end
+
+    # 
+    # Attribute field types defined in the schema
+    #
+    def types
+      FIELD_TYPES
+    end
+
+    # 
+    # DynamicField instances representing all the available types and variants
+    #
+    def dynamic_fields
+      fields = []
+      for field_variants in variant_combinations
+        for type in FIELD_TYPES
+          fields << DynamicField.new(type, field_variants)
+        end
+      end
+      fields
+    end
+
+    # 
+    # Which tokenizer to use for text fields
+    #
+    def tokenizer=(tokenizer)
+      @tokenizer = 
+        if tokenizer =~ /\./
+          tokenizer
+        else
+          "solr.#{tokenizer}TokenizerFactory"
+        end
+    end
+
+    # 
+    # Add a filter for text field tokenization
+    #
+    def add_filter(filter)
+      @filters <<
+        if filter =~ /\./
+          filter
+        else
+          "solr.#{filter}FilterFactory"
+        end
+    end
+
+    # 
+    # Return an XML representation of this schema using the Haml template
+    #
+    def to_xml
+      template = File.read(
+        File.join(
+          File.dirname(__FILE__),
+          '..',
+          '..',
+          'templates',
+          'schema.xml.haml'
+        )
+      )
+      engine = Haml::Engine.new(template)
+      engine.render(Object.new, :schema => self)
+    end
+
+    private
+
+    #
+    # All of the possible combinations of variants
+    #
+    def variant_combinations
+      combinations = []
+      0.upto(2 ** FIELD_VARIANTS.length - 1) do |b|
+        combinations << combination = []
+        FIELD_VARIANTS.each_with_index do |variant, i|
+          combination << variant if b & 1<<i > 0
+        end
+      end
+      combinations
+    end
+
+    # 
+    # Represents a dynamic field (in the Solr schema sense, not the Sunspot
+    # sense).
+    #
+    class DynamicField
+      def initialize(type, field_variants)
+        @type, @field_variants = type, field_variants
+      end
+
+      # 
+      # Name of the field in the schema
+      #
+      def name
+        variant_suffixes = @field_variants.map { |variant| variant.suffix }.join
+        "*_#{@type.suffix}#{variant_suffixes}"
+      end
+
+      # 
+      # Name of the type as defined in the schema
+      #
+      def type
+        @type.name
+      end
+
+      # 
+      # Implement magic methods to ask if a field is of a particular variant.
+      # Returns "true" if the field is of that variant and "false" otherwise.
+      #
+      def method_missing(name, *args, &block)
+        if name.to_s =~ /\?$/ && args.empty?
+          if @field_variants.any? { |variant| "#{variant.attribute}?" == name.to_s }
+            'true'
+          else
+            'false'
+          end
+        else
+          super(name.to_sym, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/search.rb

@@ -0,0 +1,219 @@
+require File.join(File.dirname(__FILE__), 'search', 'hit')
+
+module Sunspot
+  # 
+  # This class encapsulates the results of a Solr search. It provides access
+  # to search results, total result count, facets, and pagination information.
+  # Instances of Search are returned by the Sunspot.search and
+  # Sunspot.new_search methods.
+  #
+  class Search
+    # Query information for this search. If you wish to build the query without
+    # using the search DSL, this method allows you to access the query API
+    # directly. See Sunspot#new_search for how to construct the search object
+    # in this case.
+    attr_reader :query 
+
+    def initialize(connection, setup, query) #:nodoc:
+      @connection, @setup, @query = connection, setup, query
+    end
+
+    #
+    # Execute the search on the Solr instance and store the results. If you
+    # use Sunspot#search() to construct your searches, there is no need to call
+    # this method as it has already been called. If you use
+    # Sunspot#new_search(), you will need to call this method after building the
+    # query.
+    #
+    def execute!
+      params = @query.to_params
+      @solr_result = @connection.select(params)
+      self
+    end
+
+    # 
+    # Get the collection of results as instantiated objects. If WillPaginate is
+    # available, the results will be a WillPaginate::Collection instance; if
+    # not, it will be a vanilla Array.
+    #
+    # ==== Returns
+    #
+    # WillPaginate::Collection or Array:: Instantiated result objects
+    #
+    def results
+      @results ||= if @query.page && defined?(WillPaginate::Collection)
+        WillPaginate::Collection.create(@query.page, @query.per_page, total) do |pager|
+          pager.replace(hits.map { |hit| hit.instance })
+        end
+      else
+        hits.map { |hit| hit.instance }
+      end
+    end
+
+    # 
+    # Access raw Solr result information. Returns a collection of Hit objects
+    # that contain the class name, primary key, keyword relevance score (if
+    # applicable), and any stored fields.
+    #
+    # ==== Returns
+    #
+    # Array:: Ordered collection of Hit objects
+    #
+    def hits
+      @hits ||= solr_response['docs'].map { |doc| Hit.new(doc, self) }
+    end
+    alias_method :raw_results, :hits
+
+    # 
+    # The total number of documents matching the query parameters
+    #
+    # ==== Returns
+    #
+    # Integer:: Total matching documents
+    #
+    def total
+      @total ||= solr_response['numFound']
+    end
+
+    # 
+    # Get the facet object for the given field. This field will need to have
+    # been requested as a field facet inside the search block.
+    #
+    # ==== Parameters
+    #
+    # field_name<Symbol>:: field name for which to get the facet
+    #
+    # ==== Returns
+    #
+    # Sunspot::Facet:: Facet object for the given field
+    #
+    def facet(field_name)
+      (@facets_cache ||= {})[field_name.to_sym] ||=
+        begin
+          facet_data = query_facet_data(field_name) ||
+            begin
+              field = field(field_name)
+              date_facet_data(field) ||
+                FacetData::FieldFacetData.new(@solr_result['facet_counts']['facet_fields'][field.indexed_name], field)
+            end
+          facet_class = facet_data.reference ? InstantiatedFacet : Facet
+          facet_class.new(facet_data)
+        end
+    end
+
+    # 
+    # Get the facet object for a given dynamic field. This dynamic field will
+    # need to have been requested as a field facet inside the search block.
+    #
+    # ==== Parameters
+    #
+    # base_name<Symbol>::
+    #   Base name of the dynamic field definiton (as specified in the setup
+    #   block)
+    # dynamic_name<Symbol>::
+    #   Dynamic field name to facet on
+    # 
+    # ==== Returns
+    #
+    # Sunspot::Facet:: Facet object for given dynamic field
+    # 
+    # ==== Example
+    #
+    #   search = Sunspot.search(Post) do
+    #     dynamic :custom do
+    #       facet :cuisine
+    #     end
+    #   end
+    #   search.dynamic_facet(:custom, :cuisine)
+    #     #=> Facet for the dynamic field :cuisine in the :custom field definition
+    # 
+    def dynamic_facet(base_name, dynamic_name)
+      (@dynamic_facets_cache ||= {})[[base_name.to_sym, dynamic_name.to_sym]] ||=
+        begin
+          field = @setup.dynamic_field_factory(base_name).build(dynamic_name)
+          Facet.new(FacetData::FieldFacetData.new(@solr_result['facet_counts']['facet_fields'][field.indexed_name], field))
+        end
+    end
+
+    # 
+    # Get the data accessor that will be used to load a particular class out of
+    # persistent storage. Data accessors can implement any methods that may be
+    # useful for refining how data is loaded out of storage. When building a
+    # search manually (e.g., using the Sunspot#new_search method), this should
+    # be used before calling #execute(). Use the
+    # Sunspot::DSL::Search#data_accessor_for method when building searches using
+    # the block DSL.
+    #
+    def data_accessor_for(clazz)
+      (@data_accessors ||= {})[clazz.name.to_sym] ||=
+        Adapters::DataAccessor.create(clazz)
+    end
+
+    # 
+    # Build this search using a DSL block.
+    #
+    def build(&block) #:nodoc:
+      Util.instance_eval_or_call(dsl, &block)
+      self
+    end
+
+    def populate_hits! #:nodoc:
+      id_hit_hash = Hash.new { |h, k| h[k] = {} }
+      hits.each do |hit|
+        id_hit_hash[hit.class_name][hit.primary_key] = hit
+      end
+      id_hit_hash.each_pair do |class_name, hits|
+        ids = hits.map { |id, hit| hit.primary_key }
+        data_accessor_for(Util.full_const_get(class_name)).load_all(ids).each do |instance|
+          hit = id_hit_hash[class_name][Adapters::InstanceAdapter.adapt(instance).id.to_s]
+          hit.instance = instance
+        end
+      end
+    end
+
+    private
+
+    def solr_response
+      @solr_response ||= @solr_result['response']
+    end
+
+    def doc_ids
+      @doc_ids ||= solr_response['docs'].map { |doc| doc['id'] }
+    end
+
+    def dsl
+      DSL::Search.new(self)
+    end
+
+    def raw_facet(field)
+      if field.type == Type::TimeType
+        @solr_result['facet_counts']['facet_dates'][field.indexed_name]
+      end || @solr_result['facet_counts']['facet_fields'][field.indexed_name]
+    end
+
+    def date_facet_data(field)
+      if field.type == Type::TimeType
+        if @solr_result['facet_counts'].has_key?('facet_dates')
+          if facet_result = @solr_result['facet_counts']['facet_dates'][field.indexed_name]
+            FacetData::DateFacetData.new(facet_result, field)
+          end
+        end
+      end
+    end
+
+    def query_facet_data(name)
+      if query_facet = @query.query_facet(name.to_sym)
+        if @solr_result['facet_counts'].has_key?('facet_queries')
+            FacetData::QueryFacetData.new(
+              query_facet,
+              @solr_result['facet_counts']['facet_queries']
+            )
+        end
+      end
+    end
+
+    def field(name)
+      @setup.field(name)
+    end
+  end
+end