mwmitchell-rsolr-ext 0.5.8 → 0.5.9

data/README.rdoc

@@ -1,7 +1,7 @@
 =RSolr::Ext
 A set of helper methods/modules to assist in building Solr queries and handling responses when using the RSolr library.
 
-NOTE: The API for RSolr::Ext is pre 1.0. Things are be changing!
+NOTE: The API for RSolr::Ext is pre 1.0. Things are changing quickly...
 
 ==Request Example
   std = RSolr::Ext::Request::Standard.new
@@ -22,17 +22,21 @@ NOTE: The API for RSolr::Ext is pre 1.0. Things are be changing!
 
 ==Response Example
   rsolr = RSolr.connect
+  
   raw_response = rsolr.select(:q=>'*:*)
   r = RSolr::Ext::Response::Standard.new(raw_response)
   
-  r.header[:params]
-  r.response[:docs]
-  r.response[:docs].previous_page
-
+  r.ok?
+  r.params
+  r.docs
+  r.docs.previous_page
+  r.docs.next_page
+  r.facets
+  
 ===Doc Pagination
 After creating a RSolr::Ext::Response object, pass-in the response.docs to the will_paginate view helper:
   rsolr = RSolr.connect
   raw_response = rsolr.select(:q=>'*:*)
   @response = RSolr::Ext::Response::Standard.new(raw_response)
   # in view:
-  <%= will_paginate @response.response[:docs] %>
+  <%= will_paginate @response.docs %>

data/lib/rsolr-ext.rb

@@ -15,7 +15,7 @@ module RSolr
   
   module Ext
     
-    VERSION = '0.5.8'
+    VERSION = '0.5.9'
     
     autoload :Request, 'rsolr-ext/request.rb'
     autoload :Response, 'rsolr-ext/response.rb'

data/lib/rsolr-ext/request/queryable.rb

@@ -23,7 +23,7 @@ module RSolr::Ext::Request::Queryable
   def build_query(value, quote_string=false)
     case value
     when String,Symbol
-      return quote_string ? quote(value.to_s) : value.to_s
+      quote_string ? quote(value.to_s) : value.to_s
     when Array
       value.collect do |v|
         build_query(v, quote_string)

data/lib/rsolr-ext/response.rb

@@ -1,8 +1,7 @@
 module RSolr::Ext::Response
   
-  autoload :Facetable, 'rsolr-ext/response/facetable'
-  autoload :Pageable, 'rsolr-ext/response/pageable'
-  autoload :DocExt, 'rsolr-ext/response/doc_ext'
+  autoload :Facets, 'rsolr-ext/response/facets'
+  autoload :Docs, 'rsolr-ext/response/docs'
   
   class Base < Mash
     
@@ -10,6 +9,10 @@ module RSolr::Ext::Response
       self[:responseHeader]
     end
     
+    def params
+      header[:params]
+    end
+    
     def ok?
       header[:status] == 0
     end
@@ -19,32 +22,16 @@ module RSolr::Ext::Response
   # 
   class Standard < Base
     
-    include Facetable
-    
-    def initialize(*a)
-      super(*a)
-      activate_pagination!
+    def initialize(*args)
+      super(*args)
+      extend Docs
+      extend Facets
     end
     
     def response
       self[:response]
     end
     
-    def docs
-      response[:docs]
-    end
-    
-    private
-    
-    def activate_pagination!
-      d = self[:response][:docs]
-      d.each{|dhash| dhash.extend DocExt }
-      d.extend Pageable
-      d.start = self[:responseHeader][:params][:start].to_s.to_i
-      d.per_page = self[:responseHeader][:params][:rows].to_s.to_i
-      d.total = self[:response][:numFound]
-    end
-    
   end
   
   class Dismax < Standard
@@ -58,10 +45,14 @@ module RSolr::Ext::Response
     # An optional rule can be used for "grepping" field names:
     # field_list(/_facet$/)
     def field_list(rule=nil)
-      self[:fields].select do |k,v|
+      fields.select do |k,v|
         rule ? k =~ rule : true
       end.collect{|k,v|k}
     end
+    
+    def fields
+      self[:fields]
+    end
 
   end# end Luke
   

data/lib/rsolr-ext/response/docs.rb

@@ -0,0 +1,96 @@
+module RSolr::Ext::Response::Docs
+  
+  module Accessable
+    
+    # Helper method to check if value/multi-values exist for a given key.
+    # The value can be a string, or a RegExp
+    # Multiple "values" can be given; only one needs to match.
+    # 
+    # Example:
+    # doc.has?(:location_facet)
+    # doc.has?(:location_facet, 'Clemons')
+    # doc.has?(:id, 'h009', /^u/i)
+    def has?(k, *values)
+      return if self[k].nil?
+      return true if self.key?(k) and values.empty?
+      target = self[k]
+      if target.is_a?(Array)
+        values.each do |val|
+          return target.any?{|tv| val.is_a?(Regexp) ? (tv =~ val) : (tv==val)}
+        end
+      else
+        return values.any? {|val| val.is_a?(Regexp) ? (target =~ val) : (target == val)}
+      end
+    end
+
+    # helper
+    # key is the name of the field
+    # opts is a hash with the following valid keys:
+    #  - :sep - a string used for joining multivalued field values
+    #  - :default - a value to return when the key doesn't exist
+    # if :sep is nil and the field is a multivalued field, the array is returned
+    def get(key, opts={:sep=>', ', :default=>nil})
+      if self.key? key
+        val = self[key]
+        (val.is_a?(Array) and opts[:sep]) ? val.join(opts[:sep]) : val
+      else
+        opts[:default]
+      end
+    end
+
+  end
+  
+  module Pageable
+    
+    attr_accessor :start, :per_page, :total
+    
+    # Returns the current page calculated from 'rows' and 'start'
+    # WillPaginate hook
+    def current_page
+      return 1 if start < 1
+      per_page_normalized = per_page < 1 ? 1 : per_page
+      @current_page ||= (start / per_page_normalized).ceil + 1
+    end
+    
+    # Calcuates the total pages from 'numFound' and 'rows'
+    # WillPaginate hook
+    def total_pages
+      @total_pages ||= per_page > 0 ? (total / per_page.to_f).ceil : 1
+    end
+    
+    # returns the previous page number or 1
+    # WillPaginate hook
+    def previous_page
+      @previous_page ||= (current_page > 1) ? current_page - 1 : 1
+    end
+    
+    # returns the next page number or the last
+    # WillPaginate hook
+    def next_page
+      @next_page ||= (current_page == total_pages) ? total_pages : current_page+1
+    end
+    
+    def has_next?
+      current_page < total_pages
+    end
+    
+    def has_previous?
+      current_page > 1
+    end
+    
+  end
+  
+  def self.extended(base)
+    d = base.response[:docs]
+    d.extend Pageable
+    d.each{|item|item.extend Accessable}
+    d.start = base.header[:params][:start].to_s.to_i
+    d.per_page = base.header[:params][:rows].to_s.to_i
+    d.total = base.response[:numFound].to_s.to_i
+  end
+  
+  def docs
+    response[:docs]
+  end
+  
+end

data/lib/rsolr-ext/response/{facetable.rb → facets.rb}

@@ -1,7 +1,7 @@
-module RSolr::Ext::Response::Facetable
+module RSolr::Ext::Response::Facets
   
   # represents a facet value; which is a field value and its hit count
-  class FacetValue
+  class FacetItem
     attr_reader :value,:hits
     def initialize(value,hits)
       @value,@hits=value,hits
@@ -9,12 +9,12 @@ module RSolr::Ext::Response::Facetable
   end
   
   # represents a facet; which is a field and its values
-  class Facet
-    attr_reader :field
-    attr_accessor :values
-    def initialize(field)
-      @field=field
-      @values=[]
+  class FacetField
+    attr_reader :name
+    attr_accessor :items
+    def initialize(name)
+      @name=name
+      @items=[]
     end
   end
 
@@ -25,25 +25,33 @@ module RSolr::Ext::Response::Facetable
   def facets
     # memoize!
     @facets ||= (
-      facet_fields.inject([]) do |acc,(facet_field_name,values_and_hits_list)|
-        acc << facet = Facet.new(facet_field_name)
+      all = facet_fields.collect do |(facet_field_name,values_and_hits_list)|
+        facet = FacetField.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)
+          facet.items << FacetItem.new(value, values_and_hits_list.shift)
           # repeat until there are no more pairs in the values_and_hits_list array
         end
-        acc
+        facet
       end
+      #all.extend RSolr::Ext::Response::Docs::Pageable
+      #all.start = header['params']['facet.offset'].to_s.to_i
+      #all.per_page = header['params']['facet.limit'].to_s.to_i - 1
+      #all.total = -1
+      ## override the has_next? method -- when paging through facets,
+      ## it's not possible to know how many "pages" there are
+      #all.instance_eval "def has_next?; #{all.size == all.per_page+1} end"
+      all
     )
   end
-
+  
   # pass in a facet field name and get back a Facet instance
   def facet_by_field_name(name)
     @facets_by_field_name ||= {}
     @facets_by_field_name[name] ||= (
-      facets.detect{|facet|facet.field.to_s == name.to_s}
+      facets.detect{|facet|facet.name.to_s == name.to_s}
     )
   end
   

data/rsolr-ext.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 	s.name = "rsolr-ext"
-	s.version = "0.5.8"
-	s.date = "2009-03-18"
+	s.version = "0.5.9"
+	s.date = "2009-03-20"
 	s.summary = "An extension lib for RSolr"
 	s.email = "goodieboy@gmail.com"
 	s.homepage = "http://github.com/mwmitchell/rsolr_ext"
@@ -18,10 +18,8 @@ Gem::Specification.new do |s|
     "lib/rsolr-ext/request/queryable.rb",
     "lib/rsolr-ext/request.rb",
     
-    "lib/rsolr-ext/response/doc_ext.rb",
-    "lib/rsolr-ext/response/facet_paginator.rb",
-    "lib/rsolr-ext/response/facetable.rb",
-    "lib/rsolr-ext/response/pageable.rb",
+    "lib/rsolr-ext/response/docs.rb",
+    "lib/rsolr-ext/response/facets.rb",
     "lib/rsolr-ext/response.rb",
     
     "lib/rsolr-ext.rb",

data/test/helper.rb

@@ -1,21 +1,3 @@
 def mock_query_response
-  %({'responseHeader'=>{
-    'status'=>0,'QTime'=>43,'params'=>{
-      'q'=>'*:*','wt'=>'ruby','echoParams'=>'EXPLICIT'
-    }
-  },
-  'response'=>{
-    'numFound'=>26,'start'=>0,'docs'=>[
-      {'id'=>'SP2514N','inStock'=>true,'manu'=>'Samsung Electronics Co. Ltd.','name'=>'Samsung SpinPoint P120 SP2514N - hard drive - 250 GB - ATA-133','popularity'=>6,'price'=>92.0,'sku'=>'SP2514N','timestamp'=>'2008-11-21T17:21:55.601Z','cat'=>['electronics','hard drive'],'spell'=>['Samsung SpinPoint P120 SP2514N - hard drive - 250 GB - ATA-133'],'features'=>['7200RPM, 8MB cache, IDE Ultra ATA-133','NoiseGuard, SilentSeek technology, Fluid Dynamic Bearing (FDB) motor']},
-      {'id'=>'6H500F0','inStock'=>true,'manu'=>'Maxtor Corp.','name'=>'Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300','popularity'=>6,'price'=>350.0,'sku'=>'6H500F0','timestamp'=>'2008-11-21T17:21:55.617Z','cat'=>['electronics','hard drive'],'spell'=>['Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300'],'features'=>['SATA 3.0Gb/s, NCQ','8.5ms seek','16MB cache']},
-      {'id'=>'F8V7067-APL-KIT','inStock'=>false,'manu'=>'Belkin','name'=>'Belkin Mobile Power Cord for iPod w/ Dock','popularity'=>1,'price'=>19.95,'sku'=>'F8V7067-APL-KIT','timestamp'=>'2008-11-21T17:21:55.652Z','weight'=>4.0,'cat'=>['electronics','connector'],'spell'=>['Belkin Mobile Power Cord for iPod w/ Dock'],'features'=>['car power adapter, white']},
-      {'id'=>'IW-02','inStock'=>false,'manu'=>'Belkin','name'=>'iPod & iPod Mini USB 2.0 Cable','popularity'=>1,'price'=>11.5,'sku'=>'IW-02','timestamp'=>'2008-11-21T17:21:55.657Z','weight'=>2.0,'cat'=>['electronics','connector'],'spell'=>['iPod & iPod Mini USB 2.0 Cable'],'features'=>['car power adapter for iPod, white']},
-      {'id'=>'MA147LL/A','inStock'=>true,'includes'=>'earbud headphones, USB cable','manu'=>'Apple Computer Inc.','name'=>'Apple 60 GB iPod with Video Playback Black','popularity'=>10,'price'=>399.0,'sku'=>'MA147LL/A','timestamp'=>'2008-11-21T17:21:55.681Z','weight'=>5.5,'cat'=>['electronics','music'],'spell'=>['Apple 60 GB iPod with Video Playback Black'],'features'=>['iTunes, Podcasts, Audiobooks','Stores up to 15,000 songs, 25,000 photos, or 150 hours of video','2.5-inch, 320x240 color TFT LCD display with LED backlight','Up to 20 hours of battery life','Plays AAC, MP3, WAV, AIFF, Audible, Apple Lossless, H.264 video','Notes, Calendar, Phone book, Hold button, Date display, Photo wallet, Built-in games, JPEG photo playback, Upgradeable firmware, USB 2.0 compatibility, Playback speed control, Rechargeable capability, Battery level indication']},
-      {'id'=>'TWINX2048-3200PRO','inStock'=>true,'manu'=>'Corsair Microsystems Inc.','name'=>'CORSAIR  XMS 2GB (2 x 1GB) 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) Dual Channel Kit System Memory - Retail','popularity'=>5,'price'=>185.0,'sku'=>'TWINX2048-3200PRO','timestamp'=>'2008-11-21T17:21:55.706Z','cat'=>['electronics','memory'],'spell'=>['CORSAIR  XMS 2GB (2 x 1GB) 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) Dual Channel Kit System Memory - Retail'],'features'=>['CAS latency 2,	2-3-3-6 timing, 2.75v, unbuffered, heat-spreader']},
-      {'id'=>'VS1GB400C3','inStock'=>true,'manu'=>'Corsair Microsystems Inc.','name'=>'CORSAIR ValueSelect 1GB 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) System Memory - Retail','popularity'=>7,'price'=>74.99,'sku'=>'VS1GB400C3','timestamp'=>'2008-11-21T17:21:55.71Z','cat'=>['electronics','memory'],'spell'=>['CORSAIR ValueSelect 1GB 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) System Memory - Retail']},
-      {'id'=>'VDBDB1A16','inStock'=>true,'manu'=>'A-DATA Technology Inc.','name'=>'A-DATA V-Series 1GB 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) System Memory - OEM','popularity'=>5,'sku'=>'VDBDB1A16','timestamp'=>'2008-11-21T17:21:55.712Z','cat'=>['electronics','memory'],'spell'=>['A-DATA V-Series 1GB 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) System Memory - OEM'],'features'=>['CAS latency 3,	 2.7v']},
-      {'id'=>'3007WFP','inStock'=>true,'includes'=>'USB cable','manu'=>'Dell, Inc.','name'=>'Dell Widescreen UltraSharp 3007WFP','popularity'=>6,'price'=>2199.0,'sku'=>'3007WFP','timestamp'=>'2008-11-21T17:21:55.724Z','weight'=>401.6,'cat'=>['electronics','monitor'],'spell'=>['Dell Widescreen UltraSharp 3007WFP'],'features'=>['30" TFT active matrix LCD, 2560 x 1600, .25mm dot pitch, 700:1 contrast']},
-      {'id'=>'VA902B','inStock'=>true,'manu'=>'ViewSonic Corp.','name'=>'ViewSonic VA902B - flat panel display - TFT - 19"','popularity'=>6,'price'=>279.95,'sku'=>'VA902B','timestamp'=>'2008-11-21T17:21:55.734Z','weight'=>190.4,'cat'=>['electronics','monitor'],'spell'=>['ViewSonic VA902B - flat panel display - TFT - 19"'],'features'=>['19" TFT active matrix LCD, 8ms response time, 1280 x 1024 native resolution']}]
-    }
-  })
+  %({'responseHeader'=>{'status'=>0,'QTime'=>5,'params'=>{'facet.limit'=>'10','wt'=>'ruby','rows'=>'11','facet'=>'true','facet.field'=>['manu','cat'],'echoParams'=>'EXPLICIT','q'=>'*:*','facet.sort'=>'true'}},'response'=>{'numFound'=>26,'start'=>0,'docs'=>[{'id'=>'SP2514N','inStock'=>true,'manu'=>'Samsung Electronics Co. Ltd.','name'=>'Samsung SpinPoint P120 SP2514N - hard drive - 250 GB - ATA-133','popularity'=>6,'price'=>92.0,'sku'=>'SP2514N','timestamp'=>'2009-03-20T14:42:49.795Z','cat'=>['electronics','hard drive'],'spell'=>['Samsung SpinPoint P120 SP2514N - hard drive - 250 GB - ATA-133'],'features'=>['7200RPM, 8MB cache, IDE Ultra ATA-133','NoiseGuard, SilentSeek technology, Fluid Dynamic Bearing (FDB) motor']},{'id'=>'6H500F0','inStock'=>true,'manu'=>'Maxtor Corp.','name'=>'Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300','popularity'=>6,'price'=>350.0,'sku'=>'6H500F0','timestamp'=>'2009-03-20T14:42:49.877Z','cat'=>['electronics','hard drive'],'spell'=>['Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300'],'features'=>['SATA 3.0Gb/s, NCQ','8.5ms seek','16MB cache']},{'id'=>'F8V7067-APL-KIT','inStock'=>false,'manu'=>'Belkin','name'=>'Belkin Mobile Power Cord for iPod w/ Dock','popularity'=>1,'price'=>19.95,'sku'=>'F8V7067-APL-KIT','timestamp'=>'2009-03-20T14:42:49.937Z','weight'=>4.0,'cat'=>['electronics','connector'],'spell'=>['Belkin Mobile Power Cord for iPod w/ Dock'],'features'=>['car power adapter, white']},{'id'=>'IW-02','inStock'=>false,'manu'=>'Belkin','name'=>'iPod & iPod Mini USB 2.0 Cable','popularity'=>1,'price'=>11.5,'sku'=>'IW-02','timestamp'=>'2009-03-20T14:42:49.944Z','weight'=>2.0,'cat'=>['electronics','connector'],'spell'=>['iPod & iPod Mini USB 2.0 Cable'],'features'=>['car power adapter for iPod, white']},{'id'=>'MA147LL/A','inStock'=>true,'includes'=>'earbud headphones, USB cable','manu'=>'Apple Computer Inc.','name'=>'Apple 60 GB iPod with Video Playback Black','popularity'=>10,'price'=>399.0,'sku'=>'MA147LL/A','timestamp'=>'2009-03-20T14:42:49.962Z','weight'=>5.5,'cat'=>['electronics','music'],'spell'=>['Apple 60 GB iPod with Video Playback Black'],'features'=>['iTunes, Podcasts, Audiobooks','Stores up to 15,000 songs, 25,000 photos, or 150 hours of video','2.5-inch, 320x240 color TFT LCD display with LED backlight','Up to 20 hours of battery life','Plays AAC, MP3, WAV, AIFF, Audible, Apple Lossless, H.264 video','Notes, Calendar, Phone book, Hold button, Date display, Photo wallet, Built-in games, JPEG photo playback, Upgradeable firmware, USB 2.0 compatibility, Playback speed control, Rechargeable capability, Battery level indication']},{'id'=>'TWINX2048-3200PRO','inStock'=>true,'manu'=>'Corsair Microsystems Inc.','name'=>'CORSAIR  XMS 2GB (2 x 1GB) 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) Dual Channel Kit System Memory - Retail','popularity'=>5,'price'=>185.0,'sku'=>'TWINX2048-3200PRO','timestamp'=>'2009-03-20T14:42:49.99Z','cat'=>['electronics','memory'],'spell'=>['CORSAIR  XMS 2GB (2 x 1GB) 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) Dual Channel Kit System Memory - Retail'],'features'=>['CAS latency 2,	2-3-3-6 timing, 2.75v, unbuffered, heat-spreader']},{'id'=>'VS1GB400C3','inStock'=>true,'manu'=>'Corsair Microsystems Inc.','name'=>'CORSAIR ValueSelect 1GB 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) System Memory - Retail','popularity'=>7,'price'=>74.99,'sku'=>'VS1GB400C3','timestamp'=>'2009-03-20T14:42:50Z','cat'=>['electronics','memory'],'spell'=>['CORSAIR ValueSelect 1GB 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) System Memory - Retail']},{'id'=>'VDBDB1A16','inStock'=>true,'manu'=>'A-DATA Technology Inc.','name'=>'A-DATA V-Series 1GB 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) System Memory - OEM','popularity'=>5,'sku'=>'VDBDB1A16','timestamp'=>'2009-03-20T14:42:50.004Z','cat'=>['electronics','memory'],'spell'=>['A-DATA V-Series 1GB 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) System Memory - OEM'],'features'=>['CAS latency 3,	 2.7v']},{'id'=>'3007WFP','inStock'=>true,'includes'=>'USB cable','manu'=>'Dell, Inc.','name'=>'Dell Widescreen UltraSharp 3007WFP','popularity'=>6,'price'=>2199.0,'sku'=>'3007WFP','timestamp'=>'2009-03-20T14:42:50.017Z','weight'=>401.6,'cat'=>['electronics','monitor'],'spell'=>['Dell Widescreen UltraSharp 3007WFP'],'features'=>['30" TFT active matrix LCD, 2560 x 1600, .25mm dot pitch, 700:1 contrast']},{'id'=>'VA902B','inStock'=>true,'manu'=>'ViewSonic Corp.','name'=>'ViewSonic VA902B - flat panel display - TFT - 19"','popularity'=>6,'price'=>279.95,'sku'=>'VA902B','timestamp'=>'2009-03-20T14:42:50.034Z','weight'=>190.4,'cat'=>['electronics','monitor'],'spell'=>['ViewSonic VA902B - flat panel display - TFT - 19"'],'features'=>['19" TFT active matrix LCD, 8ms response time, 1280 x 1024 native resolution']},{'id'=>'0579B002','inStock'=>true,'manu'=>'Canon Inc.','name'=>'Canon PIXMA MP500 All-In-One Photo Printer','popularity'=>6,'price'=>179.99,'sku'=>'0579B002','timestamp'=>'2009-03-20T14:42:50.062Z','weight'=>352.0,'cat'=>['electronics','multifunction printer','printer','scanner','copier'],'spell'=>['Canon PIXMA MP500 All-In-One Photo Printer'],'features'=>['Multifunction ink-jet color photo printer','Flatbed scanner, optical scan resolution of 1,200 x 2,400 dpi','2.5" color LCD preview screen','Duplex Copying','Printing speed up to 29ppm black, 19ppm color','Hi-Speed USB','memory card: CompactFlash, Micro Drive, SmartMedia, Memory Stick, Memory Stick Pro, SD Card, and MultiMediaCard']}]},'facet_counts'=>{'facet_queries'=>{},'facet_fields'=>{'manu'=>['inc',8,'apach',2,'belkin',2,'canon',2,'comput',2,'corp',2,'corsair',2,'foundat',2,'microsystem',2,'softwar',2],'cat'=>['electronics',14,'memory',3,'card',2,'connector',2,'drive',2,'graphics',2,'hard',2,'monitor',2,'search',2,'software',2]},'facet_dates'=>{}}})
 end

data/test/response_test.rb

@@ -16,13 +16,13 @@ class RSolrExtResponseTest < Test::Unit::TestCase
     r = RSolr::Ext::Response::Standard.new(raw_response)
     assert r.respond_to?(:response)
     assert r.ok?
-    assert_equal 10, r[:response][:docs].size
-    assert_equal 'EXPLICIT', r[:responseHeader][:params][:echoParams]
-    assert_equal 1, r[:response][:docs].previous_page
-    assert_equal 1, r[:response][:docs].next_page
+    assert_equal 11, r.docs.size
+    assert_equal 'EXPLICIT', r.params[:echoParams]
+    assert_equal 1, r.docs.previous_page
+    assert_equal 2, r.docs.next_page
     #
-    assert r[:response][:docs].kind_of?(RSolr::Ext::Response::Pageable)
-    assert r.kind_of?(RSolr::Ext::Response::Facetable)
+    assert r.kind_of?(RSolr::Ext::Response::Docs)
+    assert r.kind_of?(RSolr::Ext::Response::Facets)
   end
   
   test 'standard response doc ext methods' do
@@ -38,4 +38,68 @@ class RSolrExtResponseTest < Test::Unit::TestCase
     assert_equal 'def', doc.get(:xyz, :default=>'def')
   end
   
+  test 'Response::Standard facets' do
+    raw_response = eval(mock_query_response)
+    r = RSolr::Ext::Response::Standard.new(raw_response)
+    assert_equal 2, r.facets.size
+    
+    field_names = r.facets.collect{|facet|facet.name}
+    assert field_names.include?('cat')
+    assert field_names.include?('manu')
+    
+    first_facet = r.facets.first
+    assert_equal 'cat', first_facet.name
+    assert_equal 10, first_facet.items.size
+    
+    expected = first_facet.items.collect do |item|
+      item.value + ' - ' + item.hits.to_s
+    end.join(', ')
+    assert_equal "electronics - 14, memory - 3, card - 2, connector - 2, drive - 2, graphics - 2, hard - 2, monitor - 2, search - 2, software - 2", expected
+    
+    r.facets.each do |facet|
+      assert facet.respond_to?(:name)
+      facet.items.each do |item|
+        assert item.respond_to?(:value)
+        assert item.respond_to?(:hits)
+      end
+    end
+    
+  end
+  
+  test 'response::standard facet_by_field_name' do
+    raw_response = eval(mock_query_response)
+    r = RSolr::Ext::Response::Standard.new(raw_response)
+    facet = r.facet_by_field_name('cat')
+    assert_equal 'cat', facet.name
+  end
+  
+=begin
+  
+  # pagination for facets has been commented out in the response/facets module.
+  # ...need to think more about how this can be handled
+  
+  test 'response::standard facets.paginate' do
+    raw_response = eval(mock_query_response)
+    raw_response['responseHeader']['params']['facet.offset'] = 1
+    raw_response['responseHeader']['params']['facet.limit'] = 2
+    
+    r = RSolr::Ext::Response::Standard.new(raw_response)
+    
+    assert_equal 2, r.facets.current_page
+    
+    # always 1 less than facet.limit
+    assert_equal 1, r.facets.per_page
+    
+    assert_equal 3, r.facets.next_page
+    
+    assert_equal 1, r.facets.previous_page
+    
+    # can't know how many pages there are with facets.... so we set it to -1
+    assert_equal -1, r.facets.total_pages
+    
+    assert r.facets.has_next?
+    assert r.facets.has_previous?
+  end
+=end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr-ext
 version: !ruby/object:Gem::Version 
-  version: 0.5.8
+  version: 0.5.9
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-18 00:00:00 -07:00
+date: 2009-03-20 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -28,10 +28,8 @@ files:
 - lib/rsolr-ext/mapable.rb
 - lib/rsolr-ext/request/queryable.rb
 - lib/rsolr-ext/request.rb
-- lib/rsolr-ext/response/doc_ext.rb
-- lib/rsolr-ext/response/facet_paginator.rb
-- lib/rsolr-ext/response/facetable.rb
-- lib/rsolr-ext/response/pageable.rb
+- lib/rsolr-ext/response/docs.rb
+- lib/rsolr-ext/response/facets.rb
 - lib/rsolr-ext/response.rb
 - lib/rsolr-ext.rb
 - LICENSE

data/lib/rsolr-ext/response/doc_ext.rb

@@ -1,38 +0,0 @@
-# module for adding helper methods to each solr response[:docs] object
-module RSolr::Ext::Response::DocExt
-
-  # Helper method to check if value/multi-values exist for a given key.
-  # The value can be a string, or a RegExp
-  # Example:
-  # doc.has?(:location_facet)
-  # doc.has?(:location_facet, 'Clemons')
-  # doc.has?(:id, 'h009', /^u/i)
-  def has?(k, *values)
-    return if self[k].nil?
-    return true if self.key?(k) and values.empty?
-    target = self[k]
-    if target.is_a?(Array)
-      values.each do |val|
-        return target.any?{|tv| val.is_a?(Regexp) ? (tv =~ val) : (tv==val)}
-      end
-    else
-      return values.any? {|val| val.is_a?(Regexp) ? (target =~ val) : (target == val)}
-    end
-  end
-
-  # helper
-  # key is the name of the field
-  # opts is a hash with the following valid keys:
-  #  - :sep - a string used for joining multivalued field values
-  #  - :default - a value to return when the key doesn't exist
-  # if :sep is nil and the field is a multivalued field, the array is returned
-  def get(key, opts={:sep=>', ', :default=>nil})
-    if self.key? key
-      val = self[key]
-      (val.is_a?(Array) and opts[:sep]) ? val.join(opts[:sep]) : val
-    else
-      opts[:default]
-    end
-  end
-
-end

data/lib/rsolr-ext/response/facet_paginator.rb

@@ -1,24 +0,0 @@
-class RSolr::Ext::Response::FacetPaginator
-  
-  attr_reader :total, :items, :previous_offset, :next_offset
-  
-  def initialize(all_facet_values, offset, limit)
-    offset = offset.to_s.to_i
-    limit = limit.to_s.to_i
-    total = all_facet_values.size
-    @items = all_facet_values.slice(0, limit-1)
-    @has_next = total == limit
-    @has_previous = offset > 0
-    @next_offset = offset + (limit-1)
-    @previous_offset = offset - (limit-1)
-  end
-
-  def has_next?
-    @has_next
-  end
-
-  def has_previous?
-    @has_previous
-  end
-
-end

data/lib/rsolr-ext/response/pageable.rb

@@ -1,30 +0,0 @@
-module RSolr::Ext::Response::Pageable
-  
-  attr_accessor :start, :per_page, :total
-  
-  # Returns the current page calculated from 'rows' and 'start'
-  # WillPaginate hook
-  def current_page
-    return 1 if start < 1
-    @current_page ||= (start / per_page).ceil + 1
-  end
-
-  # Calcuates the total pages from 'numFound' and 'rows'
-  # WillPaginate hook
-  def total_pages
-    @total_pages ||= per_page > 0 ? (total / per_page.to_f).ceil : 1
-  end
-
-  # returns the previous page number or 1
-  # WillPaginate hook
-  def previous_page
-    @previous_page ||= (current_page > 1) ? current_page - 1 : 1
-  end
-  
-  # returns the next page number or the last
-  # WillPaginate hook
-  def next_page
-    @next_page ||= (current_page < total_pages) ? current_page + 1 : total_pages
-  end
-  
-end