mwmitchell-rsolr 0.6.8 → 0.6.9

data/CHANGES.txt

@@ -1,3 +1,15 @@
+0.6.9 - January 29, 2009
+	Simplified facet response methods
+	Main facet method is called #facets
+	  - returns an array of Response::Facet instances
+	  - each Facet instance has field and values attributes
+	  -- the values attribute is an array with FacetValue instances which have @value and @hits
+	Added ability to set Connection::Base @param_adapters using :dismax or :standard
+	  instead of full class constant
+	  updated comments for #search method
+	Updated tests
+	Bumped up version
+ 
 0.6.8 - January 28, 2009
 	New method added to RSolr::Connection::Base - #find_values_for_facet
 	This method searches for facet values only, and sets the :rows param to 0

data/lib/rsolr/connection/base.rb

@@ -45,10 +45,26 @@ class RSolr::Connection::Base
     p[:wt]==:ruby ? RSolr::Response::Query::Base.new(response) : response
   end
   
-  # register your own mapper if you want?
+  # The #search method uses a param mapper to prepare the request for solr.
+  # For example, instead of doing your fq params by hand,
+  # you can use the simplified :filters param instead.
+  # The 2 built in mappers are for dismax and standard: RSolr::Connection::ParamMapping::*
+  # The default is :dismax
+  # If you create your own request handler in solrconfig.xml,
+  # you can use it by setting the :qt=>:my_handler
+  # You'll need to set the correct param mapper class (when using the search method)
+  # To take advantage of the param mapping
+  # If your request handler uses the solr dismax class, then do nothing
+  # if it uses the standard, you'll need to set it like:
+  # solr.param_mappers[:my_search_handler] = :standard
+  # The value can also be a custom class constant that must have a #map method
+  # The initialize method must accept a hash of input params
+  # The #map method must handle a block being passed in and return a new hash of raw solr params
   def search(params,&blk)
     qt = params[:qt] ? params[:qt].to_sym : :dismax
     mapper_class = @param_mappers[qt]
+    mapper_class = RSolr::Connection::ParamMapping::Dismax if mapper_class==:dismax
+    mapper_class = RSolr::Connection::ParamMapping::Standard if mapper_class==:standard
     mapper = mapper_class.new(params)
     query(mapper.map(&blk))
   end

data/lib/rsolr/response/query.rb

@@ -43,70 +43,59 @@ module RSolr::Response::Query
   # from the delsolr project -> http://github.com/avvo/delsolr/tree/master/lib/delsolr/response.rb
   module Facets
     
-    def facets
-      @facets ||= data['facet_counts'] || {}
-    end
-
-    # Returns the hash of all the facet_fields (ie: {'instock_b' => ['true', 123, 'false', 20]}
-    def facet_fields
-      @facet_fields ||= facets['facet_fields'] || {}
+    class FacetValue
+      attr_reader :value,:hits
+      def initialize(value,hits)
+        @value,@hits=value,hits
+      end
     end
-
-    # Returns all of the facet queries
-    def facet_queries
-      @facet_queries ||= facets['facet_queries'] || {}
+    
+    class Facet
+      attr_reader :field
+      attr_accessor :values
+      def initialize(field)
+        @field=field
+        @values=[]
+      end
     end
-
-    # Returns a hash of hashs rather than a hash of arrays (ie: {'instock_b' => {'true' => 123', 'false', => 20} })
-    def facet_fields_by_hash
-      @facet_fields_by_hash ||= begin
-        f = {}
-        if facet_fields
-          facet_fields.each do |field,value_and_counts|
-            f[field] = {}
-            value_and_counts.each_with_index do |v, i|
-              if i % 2 == 0
-                f[field][v] = value_and_counts[i+1]
-              end
-            end
+    
+    # @response.facet_fields.each do |facet|
+    #   facet.field
+    # end
+    # "caches" the result in the @facets instance var
+    def facets
+      @facets ||= (
+        facet_fields.inject([]) do |acc,(facet_field_name,values_and_hits_list)|
+          acc << facet = Facet.new(facet_field_name)
+          # the values_and_hits_list is an array where a value is immediately followed by it's hit count
+          # so we shift off an item (the value)
+          while value = values_and_hits_list.shift
+            # and then shift off the next to get the hit value
+            facet.values << FacetValue.new(value, values_and_hits_list.shift)
+            # repeat until there are no more pairs in the values_and_hits_list array
           end
+          acc
         end
-        f
-      end
+      )
     end
-
-    # Returns an array of value/counts for a given field (ie: ['true', 123, 'false', 20]
-    def facet_field(field)
-      facet_fields[field.to_s]
-    end
-
-    # Returns the array of field values for the given field in the order they were returned from solr
-    def facet_field_values(field)
-      facet_field_values ||= {}
-      facet_field_values[field.to_s] ||= begin
-        a = []
-        return unless facet_field(field)
-        facet_field(field).each_with_index do |val_or_count, i|
-          a << val_or_count if i % 2 == 0 && facet_field(field)[i+1] > 0
-        end
-        a
-      end
+    
+    # pass in a facet field name and get back a Facet instance
+    def facet_by_field_name(name)
+      facets.detect{|facet|facet.field.to_s == name.to_s}
     end
-
-    # Returns a hash of value/counts for a given field (ie: {'true' => 123, 'false' => 20}
-    def facet_field_by_hash(field)
-      facet_fields_by_hash[field.to_s]
+    
+    def facet_counts
+      @facets ||= data['facet_counts'] || {}
     end
-
-    # Returns the count for the given field/value pair
-    def facet_field_count(field, value)
-      facet_fields_by_hash[field.to_s][value.to_s] if facet_fields_by_hash[field.to_s]
+    
+    # Returns the hash of all the facet_fields (ie: {'instock_b' => ['true', 123, 'false', 20]}
+    def facet_fields
+      @facet_fields ||= facet_counts['facet_fields'] || {}
     end
-
-    # Returns the counts for a given facet_query_name
-    def facet_query_count_by_name(facet_query_name)
-      query_string = query_builder.facet_query_by_name(facet_query_name)
-      facet_queries[query_string] if query_string
+    
+    # Returns all of the facet queries
+    def facet_queries
+      @facet_queries ||= facet_counts['facet_queries'] || {}
     end
     
   end

data/lib/rsolr.rb

@@ -7,7 +7,7 @@ proc {|base, files|
 
 module RSolr
   
-  VERSION = '0.6.8'
+  VERSION = '0.6.9'
   
   autoload :Message, 'rsolr/message'
   autoload :Response, 'rsolr/response'

data/test/connection/test_methods.rb

@@ -119,7 +119,17 @@ module ConnectionTestMethods
   def test_search_facet_by_name
     @solr.add([{:id=>1, :cat=>'eletronics'}, {:id=>2, :cat=>'software'}]) and @solr.commit
     response = @solr.search_facet_by_name('cat', {:q=>'*:*'})
-    assert_equal 2, response.facet_field_values(:cat).size
+    
+    response.facets.each do |facet|
+      puts facet.field
+      puts facet.values.inspect
+      facet.values.each do |value|
+        puts value.value
+        puts value.hits
+      end
+    end
+    
+    assert_equal 2, response.facet_by_field_name(:cat).values.size
     #
     response = @solr.search_facet_by_name('cat', {:q=>'*:*'})
     assert_equal 0, response.docs.size

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr
 version: !ruby/object:Gem::Version 
-  version: 0.6.8
+  version: 0.6.9
 platform: ruby
 authors: 
 - Matt Mitchell