mwmitchell-solr 0.5.5 → 0.5.6

data/CHANGES.txt

@@ -1,27 +1,28 @@
+0.5.6 - December 30, 2008
+	solr.gemspec cleanedup thanks to shairontoledo on github! :)
+	Added Solr::Response::Query::Facet module with helpers from the delsolr project
+		Also added test stub in test/connection/search_ext_test_methods.rb
+	Fixed pagination math errors
+	Added new SearchExt helper field: :phrase_filters
+		This will add quoted values to the :filters (fq solr param) hash for doing easier facet requests
+	
+	Be sure to check out the new demo app: http://github.com/mwmitchell/consuminator/tree/master
+	
 0.5.5 - December 29, 2008
-
 	Fixed bug where accessing a field by method name failed:
-		
 		docs.each do |doc|
 			doc.timestamp
 		end
-	
 	Fixed bug where using the #has? method on a doc failed:
-		
 		docs.each do |doc|
 			doc.has?('timestamp')
 		end
-	
 	Removed invalid autoload in Solr module
-	
 	Fixed spelling error in Solr::Connection::SearchExt (thanks to matthewrudy)
 	
 0.5.4 - December 29, 2008
-	
 	Re-organized the main Solr adapters, they're now in Solr::Connection::Adapter instead of Solr::Adapter
-	
 	All responses from HTTPClient and Connection::Adapter::Direct return a hash with the following keys:
-		
 		:status_code
 		:body
 		:params
@@ -29,18 +30,12 @@
 		:path
 		:headers
 		:data
-	
 	This hash is now available in the solr response objects as #source - this will be useful in testing and debugging by allowing you to see the generated params and queries... example:
-		
 		response = Solr.query(:q=>'*:*')
 		response.source[:params]
 		response.source[:body]
 		response.source[:url]
-	
 	Added MultiValue field support in Solr::Message, thanks to Fouad Mardini
-	
 	Bug in Solr::Connection::SearchExt where the :q params was not getting generated - fixed by Fouad Mardini
-	
 	Organized tests a bit, moved connection tests into test/connection
-	
 	Fixed a bug in Solr::Connection::Adapter::HTTP where invalid HTTP POST headers were being generated

data/lib/solr.rb

@@ -7,7 +7,7 @@ proc {|base, files|
 
 module Solr
   
-  VERSION = '0.5.5'
+  VERSION = '0.5.6'
   
   autoload :Message, 'solr/message'
   autoload :Response, 'solr/response'

data/lib/solr/connection/base.rb

@@ -103,10 +103,11 @@ class Solr::Connection::Base
     Solr::Message
   end
   
-  def modify_params_for_pagination(params)
-    return params unless params[:page]
-    params = params.dup # be nice
-    params[:per_page]||=10
+  def modify_params_for_pagination(orig_params)
+    return orig_params unless orig_params[:page] || orig_params[:per_page]
+    params = orig_params.dup # be nice
+    params[:page] ||= 1
+    params[:per_page] ||= 10
     params[:rows] = params.delete(:per_page).to_i
     params[:start] = calculate_start(params.delete(:page).to_i, params[:rows])
     params

data/lib/solr/connection/search_ext.rb

@@ -6,6 +6,18 @@ module Solr::Connection::SearchExt
       params[:fl] = fields.is_a?(Array) ? fields.join(' ') : fields
     end
     
+    # adds quoted values to the :filters hash
+    if params[:phrase_filters]
+      phrase_filters = params.delete(:phrase_filters)
+      params[:filters] ||= {}
+      phrase_filters.each do |filter,values|
+        params[:filters][filter] ||= []
+        values.each do |v|
+          params[:filters][filter] << "\"#{v}\""
+        end
+      end
+    end
+    
     params[:fq] = build_filters(params.delete(:filters)) if params[:filters]
     facets = params.delete(:facets) if params[:facets]
     

data/lib/solr/mapper.rb

@@ -19,11 +19,15 @@ module Solr::Mapper
     # returns an array with one or more mapped hashes
     def map(source, override_mapping=nil)
       source = [source] if source.is_a?(Hash)
-      m = override_mapping || @mapping
+      mapping = override_mapping || @mapping
+      index = -1
+      # collect a bunch of hashes...
       source.collect do |src|
-        m.inject({}) do |mapped_data, (field_name, mapped_value)|
-          value = mapped_field_value(src, mapped_value)
-          value.to_s.empty? ? mapped_data : mapped_data.merge!({field_name=>value})
+        index += 1
+        # for each mapping item, inject data into a new hash
+        mapping.inject({}) do |a_new_hash, (map_key, map_value)|
+          value = mapped_field_value(src, map_value, index)
+          value.to_s.empty? ? a_new_hash : a_new_hash.merge!({map_key=>value})
         end
       end
     end
@@ -31,20 +35,20 @@ module Solr::Mapper
     protected
   
     # This is a hook method useful for subclassing
-    def source_field_value(source, field_name)
+    def source_field_value(source, field_name, index)
       source[field_name]
     end
   
-    def mapped_field_value(source, mapped_value)
+    def mapped_field_value(source, mapped_value, index)
       case mapped_value
         when String
           mapped_value
         when Symbol
-          source_field_value(source, mapped_value)
+          source_field_value(source, mapped_value, index)
         when Proc
-          mapped_value.call(source, self)
+          mapped_value.call(source, index)
         when Enumerable
-          mapped_value.collect {|key| source_field_value(source, key)}.flatten
+          mapped_value.collect {|key| source_field_value(source, key, index)}.flatten
         else
           # try to turn it into a string, else raise UnkownMappingValue
           mapped_value.respond_to?(:to_s) ? mapped_value.to_s : raise(UnkownMappingValue.new(mapped_value))

data/lib/solr/mapper/rss.rb

@@ -20,9 +20,9 @@ class Solr::Mapper::RSS < Solr::Mapper::Base
   # sends methods chain down into the @rss object
   # example: :'channel.title' == @rss.channel.title
   # if the method chain doesn't exist, the super #source_field_value method is called
-  def source_field_value(source, method_path)
+  def source_field_value(source, method_path, index)
     method_path.to_s.split('.').inject(@rss) do |rss, m|
-      rss.respond_to?(m) ? rss.send(m.to_sym) : super(source, method_path)
+      rss.respond_to?(m) ? rss.send(m.to_sym) : super(source, method_path, index)
     end
   end
   

data/lib/solr/message.rb

@@ -28,7 +28,7 @@ class Solr::Message
             sorted_items = item.inject({}) {|acc,(k,v)| acc.merge({k.to_s=>v})}
             sorted_items.keys.sort.each do |k|
               doc_attrs = {:name=>k}
-              yield doc_attrs if block_given?
+              yield item, doc_attrs if block_given?
               [sorted_items[k]].flatten.each do |v| # multiValued attributes
                 doc_xml.field(v, doc_attrs)
               end

data/lib/solr/response/query.rb

@@ -33,36 +33,109 @@ module Solr::Response::Query
 
   end
   
+  # 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'] || {}
+    end
+
+    # Returns all of the facet queries
+    def facet_queries
+      @facet_queries ||= facets['facet_queries'] || {}
+    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
+          end
+        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
+    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]
+    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]
+    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
+    end
+    
+  end
+  
+  #
+  #
+  #
   module Pagination
     
     # alias to the Solr param, 'rows'
     def per_page
-      @per_page = params['rows'].to_s.to_i
+      @per_page ||= params['rows'].to_s.to_i
     end
     
     # Returns the current page calculated from 'rows' and 'start'
     # WillPaginate hook
     def current_page
-      @current_page = self.per_page > 0 ? ((self.start / self.per_page).ceil) : 1
-      @current_page == 0 ? 1 : @current_page
+      @current_page ||= (self.start / self.per_page).ceil + 1
     end
     
     # Calcuates the total pages from 'numFound' and 'rows'
     # WillPaginate hook
     def total_pages
-      self.per_page > 0 ? (self.total / self.per_page.to_f).ceil : 1
+      @total_pages ||= self.per_page > 0 ? (self.total / self.per_page.to_f).ceil : 1
     end
     
     # returns the previous page number or 1
     # WillPaginate hook
     def previous_page
-      (current_page > 1) ? current_page - 1 : 1
+      @previous_page ||= (current_page > 1) ? current_page - 1 : 1
     end
     
     # returns the next page number or the last
     # WillPaginate hook
     def next_page
-      (current_page < total_pages) ? current_page + 1 : total_pages
+      @next_page ||= (current_page < total_pages) ? current_page + 1 : total_pages
     end
     
   end
@@ -74,6 +147,7 @@ module Solr::Response::Query
   class Base < Solr::Response::Base
     
     include Solr::Response::Query::Pagination
+    include Solr::Response::Query::Facets
     
     attr_reader :response, :docs, :num_found, :start
   

data/test/connection/search_ext_test_methods.rb

@@ -0,0 +1,17 @@
+raise 'Not yet implemented!'
+
+module SearchExtTestMethods
+  
+  def test_facet_response_methods
+    @response.facets
+    @response.facet_fields
+    @response.facet_queries
+    @response.facet_fields_by_hash
+    @response.facet_field(:feed_language_facet)
+    @response.facet_field_values(:feed_language_facet)
+    @response.facet_field_by_hash(:feed_language_facet)
+    @response.facet_field_by_hash(:feed_language_facet)
+    @response.facet_field_count(:feed_title_facet, 'ScienceDaily: Latest Science News')
+  end
+  
+end

data/test/mapper_test.rb

@@ -18,6 +18,11 @@ class MapperTest < Test::Unit::TestCase
     assert_equal expected, mapper.map(data)
   end
   
+  # TODO
+  def test_add_and_set_doc_attributes
+    assert false
+  end
+  
   # test enumerable/array mappings
   def test_array_multi_value
     data = {
@@ -40,8 +45,8 @@ class MapperTest < Test::Unit::TestCase
   def test_proc
     data = [{:name=>'-bach;'}]
     mapping = {
-      :name=>proc{|d,mapper|
-        assert_equal Solr::Mapper::Base, mapper.class
+      :name=>proc{|d,index|
+        assert_equal Fixnum, index.class
         d[:name].gsub(/\W+/, '')
       }
     }
@@ -63,10 +68,10 @@ class MapperTest < Test::Unit::TestCase
       :channel=>rss.channel.title,
       :url=>rss.channel.link,
       :total=>rss.items.size,
-      :title=>proc {|item,m| item.title },
-      :link=>proc{|item,m| item.link },
-      :published=>proc{|item,m| item.date },
-      :description=>proc{|item,m| item.description }
+      :title=>proc {|item,index| item.title },
+      :link=>proc{|item,index| item.link },
+      :published=>proc{|item,index| item.date },
+      :description=>proc{|item,index| item.description }
     }
     mapper = Solr::Mapper::Base.new(mapping)
     mapper.map(rss.items)
@@ -81,10 +86,10 @@ class MapperTest < Test::Unit::TestCase
       :channel=>:'channel.title',
       :url=>:'channel.link',
       :total=>:'items.size',
-      :title=>proc {|item,m| item.title },
-      :link=>proc {|item,m| item.link },
-      :published=>proc {|item,m| item.date },
-      :description=>proc {|item,m| item.description }
+      :title=>proc {|item,index| item.title },
+      :link=>proc {|item,index| item.link },
+      :published=>proc {|item,index| item.date },
+      :description=>proc {|item,index| item.description }
     }
     m.map(rss_file, mapping)
   end

data/test/pagination_test.rb

@@ -51,7 +51,7 @@ class PaginationTest < Test::Unit::TestCase
     assert_equal response.params['rows'], response.per_page
     assert_equal 26, response.total
     # 2 per page, currently on the 10th item
-    assert_equal 1, response.current_page
+    assert_equal 2, response.current_page
     assert_equal 9, response.total_pages
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-solr
 version: !ruby/object:Gem::Version 
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-29 00:00:00 -08:00
+date: 2008-12-30 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -27,8 +27,11 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- LICENSE
+- Rakefile
+- README.rdoc
+- CHANGES.txt
 files: 
 - examples/http.rb
 - examples/direct.rb
@@ -89,6 +92,7 @@ test_files:
 - test/connection/direct_test.rb
 - test/connection/http_test.rb
 - test/connection/test_methods.rb
+- test/connection/search_ext_test_methods.rb
 - test/core_ext_test
 - test/http_client/curb_test.rb
 - test/http_client/net_http_test.rb