outoftime-sunspot 0.9.6 → 0.9.7

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 6
-:major: 0
 :minor: 9
+:patch: 7
+: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
 

data/lib/sunspot/query/field_facet.rb

@@ -28,6 +28,8 @@ module Sunspot
               )
             end
             DateFieldFacet.new(field, options)
+          elsif options.has_key?(:only)
+            QueryFieldFacet.new(field, options.delete(:only))
           else
             FieldFacet.new(field, options)
           end

data/lib/sunspot/query/field_query.rb

@@ -18,7 +18,14 @@ module Sunspot
       # FieldFacet:: The field facet object
       #
       def add_field_facet(field_name, options = nil)
-        add_component(FieldFacet.build(build_field(field_name), options || {}))
+        options ||= {}
+        facet =
+          if only = options.delete(:only)
+            query_facets[field_name.to_sym] = QueryFieldFacet.new(@setup.field(field_name), only) 
+          else
+            FieldFacet.build(build_field(field_name), options)
+          end
+        add_component(facet)
       end
 
       # 
@@ -38,7 +45,6 @@ module Sunspot
       def add_query_facet(name)
         add_component(facet = QueryFacet.new(name, setup))
         query_facets[name.to_sym] = facet
-        facet
       end
 
       # 

data/lib/sunspot/query/query_facet.rb

@@ -14,8 +14,9 @@ module Sunspot
     #
     class QueryFacet
       attr_reader :name #:nodoc:
+      attr_reader :field #:nodoc:
 
-      def initialize(name, setup) #:nodoc:
+      def initialize(name, setup = nil) #:nodoc:
         @name = name
         @setup = setup
         @components = []

data/lib/sunspot/query/query_field_facet.rb

@@ -0,0 +1,13 @@
+module Sunspot
+  module Query
+    class QueryFieldFacet < QueryFacet
+      def initialize(field, values)
+        super(field.name)
+        @field = field
+        values.each do |value|
+          add_row(value).add_component(Restriction::EqualTo.new(field, value))
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/search.rb

@@ -90,15 +90,14 @@ module Sunspot
     def facet(field_name)
       (@facets_cache ||= {})[field_name.to_sym] ||=
         begin
-          query_facet(field_name) ||
+          facet_data = query_facet_data(field_name) ||
             begin
               field = field(field_name)
-              date_facet(field) ||
-                begin
-                  facet_class = field.reference ? InstantiatedFacet : Facet
-                  facet_class.new(@solr_result['facet_counts']['facet_fields'][field.indexed_name], field)
-                end
+              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
 
@@ -132,7 +131,7 @@ module Sunspot
       (@dynamic_facets_cache ||= {})[[base_name.to_sym, dynamic_name.to_sym]] ||=
         begin
           field = @setup.dynamic_field_factory(base_name).build(dynamic_name)
-          Facet.new(@solr_result['facet_counts']['facet_fields'][field.indexed_name], field)
+          Facet.new(FacetData::FieldFacetData.new(@solr_result['facet_counts']['facet_fields'][field.indexed_name], field))
         end
     end
 
@@ -192,23 +191,23 @@ module Sunspot
       end || @solr_result['facet_counts']['facet_fields'][field.indexed_name]
     end
 
-    def date_facet(field)
+    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]
-            DateFacet.new(facet_result, field)
+            FacetData::DateFacetData.new(facet_result, field)
           end
         end
       end
     end
 
-    def query_facet(name)
+    def query_facet_data(name)
       if query_facet = @query.query_facet(name.to_sym)
         if @solr_result['facet_counts'].has_key?('facet_queries')
-          QueryFacet.new(
-            query_facet,
-            @solr_result['facet_counts']['facet_queries']
-          )
+            FacetData::QueryFacetData.new(
+              query_facet,
+              @solr_result['facet_counts']['facet_queries']
+            )
         end
       end
     end

data/spec/api/build_search_spec.rb

@@ -860,6 +860,27 @@ describe 'Search' do
     end
   end
 
+  it 'builds query facets when passed :only argument to field facet declaration' do
+    session.search Post do
+      facet :category_ids, :only => [1, 3]
+    end
+    connection.should have_last_search_with(
+      :"facet.query" => ['category_ids_im:1', 'category_ids_im:3']
+    )
+  end
+
+  it 'converts limited query facet values to the correct type' do
+    session.search Post do
+      facet :published_at, :only => [Time.utc(2009, 8, 28, 15, 33), Time.utc(2008,8, 28, 15, 33)]
+    end
+    connection.should have_last_search_with(
+      :"facet.query" => [
+        'published_at_d:2009\-08\-28T15\:33\:00Z',
+        'published_at_d:2008\-08\-28T15\:33\:00Z'
+    ]
+    )
+  end
+
   it 'should allow faceting by dynamic string field' do
     session.search Post do
       dynamic :custom_string do

data/spec/api/search_retrieval_spec.rb

@@ -154,7 +154,7 @@ describe 'retrieving search' do
     end
     facet_values(result, :published_at).should ==
       [Time.gm(2009, 04, 07, 20, 25, 23),
-       Time.gm(2009, 04, 07, 20, 26, 19)]
+        Time.gm(2009, 04, 07, 20, 26, 19)]
   end
 
   it 'should return date facet' do
@@ -168,7 +168,7 @@ describe 'retrieving search' do
     end
     facet_values(result, :expire_date).should ==
       [Date.new(2009, 07, 13),
-       Date.new(2009, 04, 01)]
+        Date.new(2009, 04, 01)]
   end
 
   it 'should return boolean facet' do
@@ -233,6 +233,21 @@ describe 'retrieving search' do
     facet.rows.first.count.should == 3
   end
 
+  it 'returns limited field facet' do
+    stub_query_facet(
+      'category_ids_im:1' => 3,
+      'category_ids_im:3' => 1
+    )
+    search = session.search(Post) do
+      facet :category_ids, :only => [1, 3, 5]
+    end
+    facet = search.facet(:category_ids)
+    facet.rows.first.value.should == 1
+    facet.rows.first.count.should == 3
+    facet.rows.last.value.should == 3
+    facet.rows.last.count.should == 1
+  end
+
   it 'should return dynamic string facet' do
     stub_facet(:"custom_string:test_s", 'two' => 2, 'one' => 1)
     result = session.search(Post) { dynamic(:custom_string) { facet(:test) }}
@@ -246,6 +261,18 @@ describe 'retrieving search' do
     result.facet(:blog_id).rows.map { |row| row.instance }.should == blogs
   end
 
+  it 'returns instantiated facet values for limited field facet' do
+    blogs = Array.new(2) { Blog.new }
+    stub_query_facet(
+      "blog_id_i:#{blogs[0].id}" => 3,
+      "blog_id_i:#{blogs[1].id}" => 1
+    )
+    search = session.search(Post) do
+      facet(:blog_id, :only => blogs.map { |blog| blog.id })
+    end
+    search.facet(:blog_id).rows.map { |row| row.instance }.should == blogs
+  end
+
   it 'should only query the persistent store once for an instantiated facet' do
     query_count = Blog.query_count
     blogs = Array.new(2) { Blog.new }
@@ -268,9 +295,9 @@ describe 'retrieving search' do
     end
     response = {
       'response' => {
-        'docs' => docs,
-        'numFound' => count
-      }
+      'docs' => docs,
+      'numFound' => count
+    }
     }
     connection.stub!(:select).and_return(response)
   end
@@ -278,11 +305,11 @@ describe 'retrieving search' do
   def stub_results(*results)
     stub_full_results(
       *results.map do |result|
-        if result.is_a?(Integer)
-          result
-        else
-          { 'instance' => result }
-        end
+      if result.is_a?(Integer)
+        result
+      else
+        { 'instance' => result }
+      end
       end
     )
   end
@@ -290,20 +317,20 @@ describe 'retrieving search' do
   def stub_facet(name, values)
     connection.stub!(:select).and_return(
       'facet_counts' => {
-        'facet_fields' => {
-          name.to_s => values.to_a.sort_by { |value, count| -count }.flatten
-        }
-      }
+      'facet_fields' => {
+      name.to_s => values.to_a.sort_by { |value, count| -count }.flatten
+    }
+    }
     )
   end
 
   def stub_date_facet(name, gap, values)
     connection.stub!(:select).and_return(
       'facet_counts' => {
-        'facet_dates' => {
-          name.to_s => { 'gap' => "+#{gap}SECONDS" }.merge(values)
-        }
-      }
+      'facet_dates' => {
+      name.to_s => { 'gap' => "+#{gap}SECONDS" }.merge(values)
+    }
+    }
     )
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: outoftime-sunspot
 version: !ruby/object:Gem::Version 
-  version: 0.9.6
+  version: 0.9.7
 platform: ruby
 authors: 
 - Mat Brown
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-21 00:00:00 -07:00
+date: 2009-08-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -99,8 +99,6 @@ files:
 - lib/sunspot/composite_setup.rb
 - lib/sunspot/configuration.rb
 - lib/sunspot/data_extractor.rb
-- lib/sunspot/date_facet.rb
-- lib/sunspot/date_facet_row.rb
 - lib/sunspot/dsl.rb
 - lib/sunspot/dsl/field_query.rb
 - lib/sunspot/dsl/fields.rb
@@ -110,6 +108,7 @@ files:
 - lib/sunspot/dsl/scope.rb
 - lib/sunspot/dsl/search.rb
 - lib/sunspot/facet.rb
+- lib/sunspot/facet_data.rb
 - lib/sunspot/facet_row.rb
 - lib/sunspot/field.rb
 - lib/sunspot/field_factory.rb
@@ -125,12 +124,11 @@ files:
 - lib/sunspot/query/pagination.rb
 - lib/sunspot/query/query_facet.rb
 - lib/sunspot/query/query_facet_row.rb
+- lib/sunspot/query/query_field_facet.rb
 - lib/sunspot/query/restriction.rb
 - lib/sunspot/query/scope.rb
 - lib/sunspot/query/sort.rb
 - lib/sunspot/query/sort_composite.rb
-- lib/sunspot/query_facet.rb
-- lib/sunspot/query_facet_row.rb
 - lib/sunspot/schema.rb
 - lib/sunspot/search.rb
 - lib/sunspot/search/hit.rb
@@ -189,7 +187,6 @@ files:
 - templates/schema.xml.haml
 has_rdoc: true
 homepage: http://github.com/outoftime/sunspot
-licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -215,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: Library for expressive, powerful interaction with the Solr search engine

data/lib/sunspot/date_facet.rb

@@ -1,36 +0,0 @@
-module Sunspot
-  #
-  # Date facets are retrieved by passing a :time_range key into the
-  # DSL::FieldQuery#facet options. They are only available for Date and Time
-  # type fields. The #value for date facet rows is a Range object encapsulating
-  # the time range covered by the row.
-  #
-  class DateFacet < Facet
-    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
-      super.sort { |a, b| a.value.first <=> b.value.first }
-    end
-
-    private
-
-    def new_row(pair)
-      DateFacetRow.new(pair, @gap, self)
-    end
-  end
-end

data/lib/sunspot/date_facet_row.rb

@@ -1,17 +0,0 @@
-module Sunspot
-  #TODO document
-  class DateFacetRow < FacetRow
-    def initialize(pair, gap, facet)
-      @gap = gap
-      super(pair, facet)
-    end
-
-    def value
-      @value ||=
-        begin
-          start_date = @facet.field.cast(@pair[0])
-          Range.new(start_date, start_date + @gap)
-        end
-    end
-  end
-end

data/lib/sunspot/query_facet.rb

@@ -1,33 +0,0 @@
-module Sunspot
-  #
-  # QueryFacet instances encapsulate a set of query facet results. Each facet
-  # corresponds to a group of rows defined inside a DSL::FieldQuery#facet block.
-  #
-  class QueryFacet
-    def initialize(outgoing_query_facet, row_data) #:nodoc:
-      @outgoing_query_facet, @row_data = outgoing_query_facet, row_data
-    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 << QueryFacetRow.new(row.label, @row_data[row_query])
-            end
-          end
-          rows.sort! { |x, y| y.count <=> x.count }
-        end
-    end
-  end
-end

data/lib/sunspot/query_facet_row.rb

@@ -1,21 +0,0 @@
-module Sunspot
-  # 
-  # Objects of this class encapsulate a single query facet row returned for a
-  # query facet.
-  #
-  class QueryFacetRow
-    #
-    # This is the "label" passed into the query facet row when it is defined in
-    # the search.
-    #
-    attr_reader :value
-    # 
-    # Number of documents in the result set that match this facet's scope.
-    #
-    attr_reader :count
-
-    def initialize(value, count) #:nodoc:
-      @value, @count = value, count
-    end
-  end
-end