rsolr-ext 0.10.1 → 0.11.0

data/README.rdoc

@@ -25,6 +25,13 @@ The #luke method returns a Hash/Mash result of a /admin/luke?numTerms=0 request:
 ===#find
 The #find method listens for certain keys. All other keys are ignored, allowing the ability to mix-and-match special keys with normal Solr param keys. The recognized keys are describe below.
 
+
+:page - This maps to the Solr "start" param. The current "page" in the results set. RSolr::Ext handles the page-to-rows math for you.
+
+
+:per_page - This maps to the Solr "rows" param. How many "pages" in the result.
+
+
 :queries - This key maps to the Solr "q" param. Accepts a string, array or hash. When an array is used, each value is joined by a space. When a hash is used, the keys are used as Solr fields.
 
 * :queries => 'normal' BECOMES ?q=normal
@@ -66,6 +73,8 @@ The #find method listens for certain keys. All other keys are ignored, allowing
 ==Request Example
   solr = RSolr::Ext.connect
   solr_params = {
+    :page=>2,
+    :per_page=>10,
     :phrases=>{:name=>'This is a phrase'},
     :filters=>['test', {:price=>(1..10)}],
     :phrase_filters=>{:manu=>['Apple']},
@@ -85,6 +94,8 @@ RSolr::Ext decorates the normal output hash from RSolr and adds some helpful met
   response.ok?
   response.params
   response.docs
+  response.docs.previous_page
+  response.docs.next_page
   response.facets.each do |facet|
     puts facet.name
     facet.items.each do |item|
@@ -94,6 +105,10 @@ RSolr::Ext decorates the normal output hash from RSolr and adds some helpful met
 
 You can access values in the response hash using symbols or strings.
 
+===Documents/Pagination
+If you wanna paginate, just throw the collection into the WillPaginate view helper.
+  <%= will_paginate response.docs %>
+
 ==The "Model" Module
 You can create your own <read-only> "models" using RSolr::Ext::Model
   

data/lib/rsolr-ext/request.rb

@@ -4,6 +4,18 @@ module RSolr::Ext::Request
     
     def map input
       output = {}
+      
+      if input[:per_page]
+        output[:rows] = input.delete(:per_page).to_i
+      end
+      
+      if page = input.delete(:page)
+        raise ':per_page must be set when using :page' unless output[:rows]
+        page = page.to_s.to_i-1
+        page = page < 1 ? 0 : page
+        output[:start] = page * output[:rows]
+      end
+      
       if queries = input.delete(:queries)
         output[:q] = append_to_param output[:q], build_query(queries, false)
       end

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

@@ -1,8 +1,52 @@
 module RSolr::Ext::Response::Docs
   
+  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.each{|doc| doc.extend RSolr::Ext::Doc }
+    d.extend Pageable
+    d.per_page = base['responseHeader']['params']['rows'].to_s.to_i
+    d.start = base['response']['start'].to_s.to_i
+    d.total = base['response']['numFound'].to_s.to_i
   end
   
   def docs

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

@@ -1,11 +1,19 @@
 module RSolr::Ext::Response::Facets
   
   # represents a facet value; which is a field value and its hit count
-  FacetItem = Struct.new :value,:hits
+  class FacetItem
+    attr_reader :value, :hits
+    def initialize value, hits
+      @value, @hits = value, hits
+    end
+  end
   
   # represents a facet; which is a field and its values
-  FacetField = Struct.new :name, :items do
-    def items; @items ||= [] end
+  class FacetField
+    attr_reader :name, :items
+    def initialize name, items
+      @name, @items = name, items
+    end
   end
   
   # @response.facets.each do |facet|
@@ -16,11 +24,10 @@ module RSolr::Ext::Response::Facets
   def facets
     @facets ||= (
       facet_fields.map do |(facet_field_name,values_and_hits)|
-        facet = FacetField.new(facet_field_name)
-        (values_and_hits.size/2).times do |index|
-          facet.items << FacetItem.new(values_and_hits[index*2], values_and_hits[index*2+1])
+        items = (values_and_hits.size/2).times.map do |index|
+          FacetItem.new(values_and_hits[index*2], values_and_hits[index*2+1])
         end
-        facet
+        FacetField.new(facet_field_name, items)
       end
     )
   end

data/lib/rsolr-ext.rb

@@ -21,7 +21,7 @@ module RSolr
   
   module Ext
     
-    VERSION = '0.10.1'
+    VERSION = '0.11.0'
     
     autoload :Connection, 'rsolr-ext/connection.rb'
     autoload :Doc, 'rsolr-ext/doc.rb'

data/rsolr-ext.gemspec

@@ -1,7 +1,8 @@
 Gem::Specification.new do |s|
+  
   s.name = "rsolr-ext"
-  s.version = "0.10.1"
-  s.date = "2009-11-13"
+  s.version = "0.11.0"
+  s.date = "2009-11-17"
   
   s.summary = "An extension lib for RSolr"
   s.email = "goodieboy@gmail.com"
@@ -34,6 +35,6 @@ Gem::Specification.new do |s|
 	
 	s.extra_rdoc_files = %w(LICENSE README.rdoc)
 	
-	s.add_dependency("rsolr", ["=0.10.1"])
+	s.add_dependency("rsolr", ["=0.11.0"])
 	
 end

data/test/connection_test.rb

@@ -11,8 +11,10 @@ class RSolrExtConnectionTest < Test::Unit::TestCase
   
   test 'the #find method' do
     connection = RSolr::Ext.connect
-    response = connection.find :q=>'*:*'
+    response = connection.find 3, 10, :q=>'*:*'#, :page=>1, :per_page=>10
     assert response.kind_of?(Mash)
+    #r = connection.find 3, 5, :q=>'*:*', :phrase_queries=>'rose'
+    #assert ! r.header[:params].include?(:phrase_queries)
   end
   
   test 'the #find method with a custom request handler' do

data/test/request_test.rb

@@ -5,8 +5,8 @@ class RSolrExtRequestTest < Test::Unit::TestCase
   
   test 'standard request' do
     solr_params = RSolr::Ext::Request.map(
-      :start=>10,
-      :rows=>10,
+      :page=>'2',
+      :per_page=>'10',
       :phrases=>{:name=>'This is a phrase'},
       :filters=>['test', {:price=>(1..10)}],
       :phrase_filters=>{:manu=>['Apple']},

data/test/response_test.rb

@@ -18,6 +18,8 @@ class RSolrExtResponseTest < Test::Unit::TestCase
     assert r.ok?
     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.kind_of?(RSolr::Ext::Response::Docs)
     assert r.kind_of?(RSolr::Ext::Response::Facets)
@@ -47,6 +49,7 @@ class RSolrExtResponseTest < Test::Unit::TestCase
     
     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|
@@ -71,4 +74,33 @@ class RSolrExtResponseTest < Test::Unit::TestCase
     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: rsolr-ext
 version: !ruby/object:Gem::Version 
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-13 00:00:00 -05:00
+date: 2009-11-17 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 0.10.1
+        version: 0.11.0
     version: 
 description: An extension lib for RSolr
 email: goodieboy@gmail.com