freelancing-god-thinking-sphinx 1.1.8 → 1.1.9

data/README

@@ -126,3 +126,4 @@ Since I first released this library, there's been quite a few people who have su
 - László Bácsi
 - Peter Wagenet
 - Max Lapshin
+- Martin Emde

data/lib/thinking_sphinx.rb

@@ -36,7 +36,7 @@ module ThinkingSphinx
   module Version #:nodoc:
     Major = 1
     Minor = 1
-    Tiny  = 8
+    Tiny  = 9
     
     String = [Major, Minor, Tiny].join('.')
   end

data/lib/thinking_sphinx/facet.rb

@@ -9,10 +9,23 @@ module ThinkingSphinx
         raise "Can't translate Facets on multiple-column field or attribute"
       end
     end
+
+    def self.name_for(facet)
+      case facet
+      when Facet
+        facet.name
+      when String, Symbol
+        facet.to_s.gsub(/(_facet|_crc)$/,'').to_sym
+      end
+    end
     
     def name
       reference.unique_name
     end
+
+    def self.attribute_name_for(name)
+      name.to_s == 'class' ? 'class_crc' : "#{name}_facet"
+    end
     
     def attribute_name
       # @attribute_name ||= case @reference
@@ -55,4 +68,4 @@ module ThinkingSphinx
       @reference.columns.first
     end
   end
-end
+end

data/lib/thinking_sphinx/facet_collection.rb

@@ -5,22 +5,26 @@ module ThinkingSphinx
     def initialize(arguments)
       @arguments        = arguments.clone
       @attribute_values = {}
-      @facets           = []
+      @facet_names           = []
     end
     
     def add_from_results(facet, results)
+      name = ThinkingSphinx::Facet.name_for(facet)
+
+      self[name]              ||= {}
+      @attribute_values[name] ||= {}
+      @facet_names << name
+
+      return if results.empty?
+
       facet = facet_from_object(results.first, facet) if facet.is_a?(String)
       
-      self[facet.name]              ||= {}
-      @attribute_values[facet.name] ||= {}
-      @facets << facet
-      
       results.each_with_groupby_and_count { |result, group, count|
         facet_value = facet.value(result, group)
         
-        self[facet.name][facet_value]              ||= 0
-        self[facet.name][facet_value]              += count
-        @attribute_values[facet.name][facet_value]  = group
+        self[name][facet_value]              ||= 0
+        self[name][facet_value]              += count
+        @attribute_values[name][facet_value]  = group
       }
     end
     
@@ -30,7 +34,7 @@ module ThinkingSphinx
       options[:with] ||= {}
       
       hash.each do |key, value|
-        attrib = facet_for_key(key).attribute_name
+        attrib = ThinkingSphinx::Facet.attribute_name_for(key)
         options[:with][attrib] = underlying_value key, value
       end
       
@@ -49,12 +53,8 @@ module ThinkingSphinx
       end
     end
     
-    def facet_for_key(key)
-      @facets.detect { |facet| facet.name == key }
-    end
-    
     def facet_from_object(object, name)
       object.sphinx_facets.detect { |facet| facet.attribute_name == name }
     end
   end
-end
+end

data/lib/thinking_sphinx/search.rb

@@ -720,11 +720,11 @@ module ThinkingSphinx
       
       def facets_for_model(klass, args, options)
         hash    = ThinkingSphinx::FacetCollection.new args + [options]
-        options = options.clone.merge! :group_function => :attr
+        options = options.clone.merge! facet_query_options
         
         klass.sphinx_facets.inject(hash) do |hash, facet|
           unless facet.name == :class && !options[:class_facet]
-            options[:group_by] = facet.attribute_name
+            options[:group_by]    = facet.attribute_name
             hash.add_from_results facet, search(*(args + [options]))
           end
           
@@ -735,7 +735,7 @@ module ThinkingSphinx
       def facets_for_all_models(args, options)
         options = GlobalFacetOptions.merge(options)
         hash    = ThinkingSphinx::FacetCollection.new args + [options]
-        options = options.merge! :group_function => :attr
+        options = options.merge! facet_query_options
         
         facet_names(options).inject(hash) do |hash, name|
           options[:group_by] = name
@@ -744,6 +744,17 @@ module ThinkingSphinx
         end
       end
       
+      def facet_query_options
+        config = ThinkingSphinx::Configuration.instance
+        max    = config.configuration.searchd.max_matches || 1000
+        
+        {
+          :group_function => :attr,
+          :limit          => max,
+          :max_matches    => max
+        }
+      end
+      
       def facet_classes(options)
         options[:classes] || ThinkingSphinx.indexed_models.collect { |model|
           model.constantize

data/spec/unit/thinking_sphinx/facet_collection_spec.rb

@@ -0,0 +1,64 @@
+require 'spec/spec_helper'
+
+describe ThinkingSphinx::FacetCollection do
+  before do
+    @facet_collection = ThinkingSphinx::FacetCollection.new([])
+  end
+
+  # TODO fix nasty hack when we have internet!
+  def mock_results
+    return @results if defined? @results
+    @result = Person.find(:first)
+    @results = [@result]
+    @results.stub!(:each_with_groupby_and_count).and_yield(@result, @result.city.to_crc32, 1)
+    @results
+  end
+
+  describe "#add_from_results" do
+    describe "with empty result set" do
+      before do
+        @facet_collection.add_from_results('attribute_facet', [])
+      end
+
+      it "should add key as attribute" do
+        @facet_collection.should have_key(:attribute)
+      end
+
+      it "should return an empty hash for the facet results" do
+        @facet_collection[:attribute].should be_empty
+      end
+    end
+
+    describe "with non-empty result set" do
+      before do
+        @facet_collection.add_from_results('city_facet', mock_results)
+      end
+
+      it "should return a hash" do
+        @facet_collection.should be_a_kind_of(Hash)
+      end
+
+      it "should add key as attribute" do
+        @facet_collection.keys.should include(:city)
+      end
+
+      it "should return a hash" do
+        @facet_collection[:city].should == {@result.city => 1}
+      end
+    end
+  end
+
+  describe "#for" do
+    before do
+      @facet_collection.add_from_results('city_facet', mock_results)
+    end
+
+    it "should return the search results for the attribute and key pair" do
+      ThinkingSphinx::Search.should_receive(:search) do |options|
+        options[:with].should have_key('city_facet')
+        options[:with]['city_facet'].should == @result.city.to_crc32
+      end
+      @facet_collection.for(:city => @result.city)
+    end
+  end
+end

data/spec/unit/thinking_sphinx/facet_spec.rb

@@ -0,0 +1,46 @@
+require 'spec/spec_helper'
+
+describe ThinkingSphinx::Facet do
+  describe ".name_for" do
+    it "should remove '_facet' from provided string and return a symbol" do
+      ThinkingSphinx::Facet.name_for('attribute_facet').should == :attribute
+    end
+
+    it "should remove '_facet' from provided symbol" do
+      ThinkingSphinx::Facet.name_for(:attribute_facet).should == :attribute
+    end
+
+    it "should return the name of the facet if a Facet is passed" do
+      facet = ThinkingSphinx::Facet.new(
+        ThinkingSphinx::Attribute.stub_instance(:unique_name => :attribute, :columns => ['attribute'])
+      )
+      ThinkingSphinx::Facet.name_for(facet).should == :attribute
+    end
+
+    it "should return 'class' for special case name 'class_crc'" do
+      ThinkingSphinx::Facet.name_for(:class_crc).should == :class
+    end
+
+    it "should cycle" do
+      ThinkingSphinx::Facet.name_for(ThinkingSphinx::Facet.attribute_name_for(:attribute)).should == :attribute
+    end
+  end
+
+  describe ".attribute_name_for" do
+    it "should append '_facet' to provided string" do
+      ThinkingSphinx::Facet.attribute_name_for('attribute').should == 'attribute_facet'
+    end
+
+    it "should append '_facet' to provided symbol and return a string" do
+      ThinkingSphinx::Facet.attribute_name_for(:attribute).should == 'attribute_facet'
+    end
+
+    it "should return 'class_crc' for special case attribute 'class'" do
+      ThinkingSphinx::Facet.attribute_name_for(:class).should == 'class_crc'
+    end
+
+    it "should cycle" do
+      ThinkingSphinx::Facet.attribute_name_for(ThinkingSphinx::Facet.name_for('attribute_facet')).should == 'attribute_facet'
+    end
+  end
+end

data/spec/unit/thinking_sphinx/search_spec.rb

@@ -50,6 +50,50 @@ describe ThinkingSphinx::Search do
 
     end
   end
+  
+  describe "facets method" do
+    before :each do
+      @results = [Person.find(:first)]
+      @results.stub!(:each_with_groupby_and_count).
+        and_yield(@results.first, @results.first.city.to_crc32, 1)
+      ThinkingSphinx::Search.stub!(:search => @results)
+      
+      @config = ThinkingSphinx::Configuration.instance
+      @config.configuration.searchd.max_matches = 10_000
+    end
+    
+    it "should use the system-set max_matches for limit on facet calls" do
+      ThinkingSphinx::Search.should_receive(:search) do |options|
+        options[:max_matches].should  == 10_000
+        options[:limit].should        == 10_000
+      end
+      
+      ThinkingSphinx::Search.facets :all_attributes => true
+    end
+    
+    it "should use the default max-matches if there is no explicit setting" do
+      @config.configuration.searchd.max_matches = nil
+      ThinkingSphinx::Search.should_receive(:search) do |options|
+        options[:max_matches].should  == 1000
+        options[:limit].should        == 1000
+      end
+      
+      ThinkingSphinx::Search.facets :all_attributes => true
+    end
+    
+    it "should ignore user-provided max_matches and limit on facet calls" do
+      ThinkingSphinx::Search.should_receive(:search) do |options|
+        options[:max_matches].should  == 10_000
+        options[:limit].should        == 10_000
+      end
+      
+      ThinkingSphinx::Search.facets(
+        :all_attributes => true,
+        :max_matches    => 500,
+        :limit          => 200
+      )
+    end
+  end
 end
 
 describe ThinkingSphinx::Search, "playing nice with Search model" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: freelancing-god-thinking-sphinx
 version: !ruby/object:Gem::Version 
-  version: 1.1.8
+  version: 1.1.9
 platform: ruby
 authors: 
 - Pat Allan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-06 00:00:00 -07:00
+date: 2009-05-07 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -109,6 +109,8 @@ files:
 - spec/unit/thinking_sphinx/collection_spec.rb
 - spec/unit/thinking_sphinx/configuration_spec.rb
 - spec/unit/thinking_sphinx/core/string_spec.rb
+- spec/unit/thinking_sphinx/facet_collection_spec.rb
+- spec/unit/thinking_sphinx/facet_spec.rb
 - spec/unit/thinking_sphinx/field_spec.rb
 - spec/unit/thinking_sphinx/index/builder_spec.rb
 - spec/unit/thinking_sphinx/index/faux_column_spec.rb
@@ -154,6 +156,8 @@ test_files:
 - spec/unit/thinking_sphinx/collection_spec.rb
 - spec/unit/thinking_sphinx/configuration_spec.rb
 - spec/unit/thinking_sphinx/core/string_spec.rb
+- spec/unit/thinking_sphinx/facet_collection_spec.rb
+- spec/unit/thinking_sphinx/facet_spec.rb
 - spec/unit/thinking_sphinx/field_spec.rb
 - spec/unit/thinking_sphinx/index/builder_spec.rb
 - spec/unit/thinking_sphinx/index/faux_column_spec.rb