UnderpantsGnome-sunspot 0.9.1.1 → 0.9.8.1

data/History.txt

@@ -1,3 +1,47 @@
+== 0.9.0 2009-07-21
+* Use Dismax parser for keyword search
+* Field and document boosting
+* Specify which fields to search in keyword search
+* Allow indexing of multiple values in text fields
+* Access keyword relevance score in Hit objects
+* Allow stored fields, retrieve stored values from Hit objects
+* Support more values in shorthand restrictions
+* Disjunctions and conjunctions
+* Random ordering
+* Control all options for field facets
+* Time range facets
+* Get referenced objects from facets on foreign keys
+* Facet by class
+* Batch indexing
+* New Date field type
+* Direct access to data accessors
+* Executable to configure production Solr instances
+* Replace solr-ruby with RSolr
+* Remove accidental ActiveSupport dependency
+
+== 0.8.9 2009-06-23
+* Fix OrderedHash bug in older versions of ActiveSupport
+
+== 0.8.8 2009-06-15
+* Escape type names to support namespaced classes
+* Fix bug with anonymous modules in Ruby 1.9
+
+== 0.8.7 2009-06-10
+* Add --pid-dir option for sunspot-solr executable
+
+== 0.8.5 2009-06-09
+* Added dependencies for sunspot-solr executable to gem dependencies
+* Search for adapters using class ancestors rather than superclasses
+
+== 0.8.3 2009-06-03
+* Index objects passed as a collection in a single HTTP request
+
+== 0.8.2 2009-05-27
+* Allow specification of Solr home when using sunspot-solr
+
+== 0.8.1 2009-05-26
+* Add Search#execute! to public API
+
 == 0.8.0 2009-05-22
 * Access query API directly; instantiate search without running it
 * Dynamic fields

data/TODO

@@ -1,4 +1,9 @@
-=== 0.9 ===
-* Query-based faceting (?)
+=== 0.9.X ===
+* Deal with empty facet queries
+* Passing an integer into the second argument of dynamic_facet() when multiple facets are requested gives the wrong value
 === 0.10 ===
+* Highlighting
+* LocalSolr
+* Text field restrictions
+* Prefixes
 * Intelligently decide whether to instantiate all facet rows at once

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 1
-:major: 0
 :minor: 9
+:patch: 8
+:major: 0

data/lib/sunspot.rb

@@ -11,8 +11,7 @@ require File.join(File.dirname(__FILE__), 'light_config')
 
 %w(util adapters configuration setup composite_setup field field_factory
    data_extractor indexer query search facet facet_row instantiated_facet
-   instantiated_facet_row date_facet date_facet_row query_facet query_facet_row
-   session type dsl).each do |filename|
+   instantiated_facet_row facet_data session type dsl).each do |filename|
   require File.join(File.dirname(__FILE__), 'sunspot', filename)
 end
 

data/lib/sunspot/facet.rb

@@ -1,51 +1,16 @@
-require 'enumerator'
-
 module Sunspot
-  #
-  # The facet class encapsulates the information returned by Solr for a
-  # field facet request.
-  #
-  # See http://wiki.apache.org/solr/SolrFacetingOverview for more information
-  # on Solr's faceting capabilities.
-  #
   class Facet
-    attr_reader :field
-
-    def initialize(facet_values, field) #:nodoc:
-      @facet_values, @field = facet_values, field
+    def initialize(facet_data)
+      @facet_data = facet_data
     end
 
-    # The name of the field that contains this facet's values
-    #
-    # ==== Returns
-    #
-    # Symbol:: The field name
-    # 
-    def field_name
-      @field.name
+    def name
+      @facet_data.name
     end
+    alias_method :field_name, :name
 
-    # The rows returned for this facet.
-    #
-    # ==== Returns
-    #
-    # Array:: Collection of FacetRow objects, in the order returned by Solr
-    # 
     def rows
-      @rows ||=
-        begin
-          rows = []
-          @facet_values.each_slice(2) do |pair|
-            rows << new_row(pair)
-          end
-          rows
-        end
-    end
-
-    private
-
-    def new_row(pair)
-      FacetRow.new(pair, self)
+      @facet_data.rows { |value, count| FacetRow.new(value, count) }
     end
   end
 end

data/lib/sunspot/facet_data.rb

@@ -0,0 +1,120 @@
+require 'enumerator'
+
+module Sunspot
+  module FacetData
+    class Abstract
+      attr_reader :field #:nodoc:
+
+      def reference
+        @field.reference if @field
+      end
+
+      def cast(value)
+        if @field
+          @field.cast(value)
+        else
+          value
+        end
+      end
+
+      def row_value(value)
+        cast(value)
+      end
+    end
+
+    class FieldFacetData < Abstract
+      def initialize(facet_values, field) #:nodoc:
+        @facet_values, @field = facet_values, field
+      end
+
+      # The name of the field that contains this facet's values
+      #
+      # ==== Returns
+      #
+      # Symbol:: The field name
+      # 
+      def name
+        @field.name
+      end
+
+      # The rows returned for this facet.
+      #
+      # ==== Returns
+      #
+      # Array:: Collection of FacetRow objects, in the order returned by Solr
+      # 
+      def rows
+        @rows ||=
+          begin
+            rows = []
+            @facet_values.each_slice(2) do |value, count|
+              rows << yield(row_value(value), count)
+            end
+            rows
+          end
+      end
+    end
+
+    class DateFacetData < FieldFacetData
+      def initialize(facet_values, field) #:nodoc:
+        @gap = facet_values.delete('gap')[/\+(\d+)SECONDS/,1].to_i
+        %w(start end).each { |key| facet_values.delete(key) }
+        super(facet_values.to_a.flatten, field)
+      end
+
+      #
+      # Get the rows of this date facet, which are instances of DateFacetRow.
+      # The rows will always be sorted in chronological order.
+      #
+      #--
+      #
+      # The date facet info comes back from Solr as a hash, so we need to sort
+      # it manually. FIXME this currently assumes we want to do a "lexical"
+      # sort, but we should support count sort as well, even if it's not a
+      # common use case.
+      #
+      def rows(&block)
+        super(&block).sort { |a, b| a.value.first <=> b.value.first }
+      end
+
+      private
+
+      def row_value(value)
+        cast(value)..(cast(value) + @gap)
+      end
+    end
+
+    class QueryFacetData < Abstract
+      def initialize(outgoing_query_facet, row_data) #:nodoc:
+        @outgoing_query_facet, @row_data = outgoing_query_facet, row_data
+        @field = @outgoing_query_facet.field
+      end
+
+      def name
+        outgoing_query_facet.name
+      end
+
+      # 
+      # Get the rows associated with this query facet. Returned rows are always
+      # ordered by count.
+      #
+      # ==== Returns
+      #
+      # Array:: Collection of QueryFacetRow objects, ordered by count
+      #
+      def rows
+        @rows ||=
+          begin
+            rows = []
+            for row in  @outgoing_query_facet.rows
+              row_query = row.to_boolean_phrase
+              if @row_data.has_key?(row_query)
+                rows << yield(row.label, @row_data[row_query])
+              end
+            end
+            rows.sort! { |x, y| y.count <=> x.count }
+          end
+      end
+    end
+  end
+end

data/lib/sunspot/facet_row.rb

@@ -1,34 +1,10 @@
 module Sunspot
   # This class encapsulates a facet row (value) for a facet.
   class FacetRow
-    def initialize(pair, facet) #:nodoc:
-      @pair, @facet = pair, facet
-    end
-
-    # The value associated with the facet. This will be cast according to the
-    # field's type; so, for an integer field, this method will return an
-    # integer, etc.
-    #
-    # Note that <strong>+Time+ fields will always return facet values in
-    # UTC</strong>.
-    #
-    # ==== Returns
-    #
-    # Object:: The value associated with the row, cast to the appropriate type
-    #
-    def value
-      @value ||= @facet.field.cast(@pair[0])
-    end
+    attr_reader :value, :count
 
-    # The number of documents matching the search parameters that have this
-    # value in the facet's field.
-    #
-    # ==== Returns
-    #
-    # Integer:: Document count for this value
-    #
-    def count
-      @count ||= @pair[1]
+    def initialize(value, count) #:nodoc:
+      @value, @count = value, count
     end
   end
 end

data/lib/sunspot/instantiated_facet.rb

@@ -15,7 +15,7 @@ module Sunspot
     #
     def populate_instances! #:nodoc:
       ids = rows.map { |row| row.value }
-      reference_class = Sunspot::Util.full_const_get(@field.reference.to_s)
+      reference_class = Sunspot::Util.full_const_get(@facet_data.reference.to_s)
       accessor = Adapters::DataAccessor.create(reference_class)
       instance_map = accessor.load_all(ids).inject({}) do |map, instance|
         map[Adapters::InstanceAdapter.adapt(instance).id] = instance
@@ -26,6 +26,10 @@ module Sunspot
       end
     end
 
+    def rows
+      @facet_data.rows { |value, count| InstantiatedFacetRow.new(value, count, self) }
+    end
+
     private
 
     # 

data/lib/sunspot/instantiated_facet_row.rb

@@ -2,6 +2,16 @@ module Sunspot
   class InstantiatedFacetRow < FacetRow
     attr_writer :instance
 
+    def initialize(value, count, facet)
+      super(value, count)
+      @facet = facet
+    end
+
+    #
+    # Get the persistent object referenced by this row's value. Instances are
+    # batch-lazy-loaded, which means that for a given facet, all of the
+    # instances are loaded the first time any row's instance is requested.
+    #
     def instance
       unless defined?(@instance)
         @facet.populate_instances!

data/lib/sunspot/query.rb

@@ -1,5 +1,6 @@
 %w(base_query scope field_query connective dynamic_query field_facet query_facet
-   query_facet_row pagination restriction sort sort_composite).each do |file|
+   query_facet_row query_field_facet pagination restriction sort
+   sort_composite).each do |file|
   require File.join(File.dirname(__FILE__), 'query', file)
 end
 
@@ -20,12 +21,12 @@ module Sunspot
     class Query < FieldQuery
       attr_reader :query_facets #:nodoc:
 
-      def initialize(setup, configuration) #:nodoc:
-        @setup, @configuration = setup, configuration
+      def initialize(types, setup, configuration) #:nodoc:
+        @setup = setup
         @components = []
         @query_facets = {}
-        @components << @base_query = BaseQuery.new(setup)
-        @components << @pagination = Pagination.new(@configuration)
+        @components << @base_query = BaseQuery.new(types, setup)
+        @components << @pagination = Pagination.new(configuration)
         @components << @sort = SortComposite.new
       end
 

data/lib/sunspot/query/base_query.rb

@@ -9,8 +9,8 @@ module Sunspot
 
       attr_writer :keywords
 
-      def initialize(setup)
-        @setup = setup
+      def initialize(types, setup)
+        @types, @setup = types, setup
       end
 
       # 
@@ -64,7 +64,7 @@ module Sunspot
       #
       def escaped_types
         @escaped_types ||=
-          @setup.type_names.map { |name| escape(name)}
+          @types.map { |type| escape(type.name)}
       end
 
       # 

data/lib/sunspot/query/connective.rb

@@ -5,8 +5,8 @@ module Sunspot
       # Base class for connectives (conjunctions and disjunctions).
       #
       class Abstract < Scope
-        def initialize(setup) #:nodoc:
-          @setup = setup
+        def initialize(setup, negated = false) #:nodoc:
+          @setup, @negated = setup, negated
           @components = []
         end
 
@@ -21,7 +21,7 @@ module Sunspot
         # Express the connective as a Lucene boolean phrase.
         #
         def to_boolean_phrase #:nodoc:
-          if @components.length == 1
+          phrase = if @components.length == 1
             @components.first.to_boolean_phrase
           else
             component_phrases = @components.map do |component|
@@ -29,6 +29,11 @@ module Sunspot
             end
             "(#{component_phrases.join(" #{connector} ")})"
           end
+          if negated?
+            "-#{phrase}"
+          else
+            phrase
+          end
         end
 
         # 
@@ -38,12 +43,38 @@ module Sunspot
         def add_component(component) #:nodoc:
           @components << component
         end
+
+        def negated?
+          @negated
+        end
+
+        def negate
+          negated = self.class.new(@setup, !negated?)
+          for component in @components
+            negated.add_component(component)
+          end
+          negated
+        end
       end
 
       # 
       # Disjunctions combine their components with an OR operator.
       #
       class Disjunction < Abstract
+        class <<self
+          def inverse
+            Conjunction
+          end
+        end
+
+        def to_boolean_phrase
+          if @components.any? { |component| component.negated? }
+            denormalize.to_boolean_phrase
+          else
+            super
+          end
+        end
+
         # 
         # Add a conjunction to the disjunction. This overrides the method in
         # the Scope class since scopes are implicitly conjunctive and thus
@@ -55,17 +86,35 @@ module Sunspot
           conjunction
         end
 
+        def add_disjunction
+          self
+        end
+
         private
 
         def connector
           'OR'
         end
+
+        def denormalize
+          denormalized = self.class.inverse.new(@setup, !negated?)
+          for component in @components
+            denormalized.add_component(component.negate)
+          end
+          denormalized
+        end
       end
 
       # 
       # Conjunctions combine their components with an AND operator.
       #
       class Conjunction < Abstract
+        class <<self
+          def inverse
+            Disjunction
+          end
+        end
+
         private
 
         def connector