will_paginate_couchrest 0.1.0 → 0.1.1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 alex
+Copyright (c) 2009 Sam Lown @ Autofiscal S.L. 
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -27,8 +27,18 @@ Automatically generate views with an extra reduce method used to generate the to
 
   end
 
-  @users = User.paginate_by_nickname :page => 1, :per_page => 10, :key => 'Fred'
+  # Parameter :per_page must be provided or an error will be raised. 
+  # Parameter :page will assume 1 if nil.
+  @users = User.paginate_by_nickname :page => 1, :per_page => 10, :key => 'Lorena'
 
+  # For pagination on all documents
+  @users = User.paginate_all :per_page => 10
+
+  # Standard views are created at the same time
+  @users = User.by_nickname :key => 'Lorena'
+
+
+  # Use standard will_paginate method or redefine as you see fit
   will_paginate @users
 
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/will_paginate_couchrest.rb

@@ -10,10 +10,10 @@ module CouchRest
       end
 
       module ClassMethods
-        # Define a CouchDB paginate view. The name of the view will be the concatenation
+        # Define a CouchDB will paginate view. The name of the view will be the concatenation
         # of <tt>paginate_by</tt> and the keys joined by <tt>_and_</tt>
-        #  
-        # ==== Example views:
+        # 
+        # ==== Example paginated views:
         #  
         #   class Post
         #     # view with default options
@@ -64,7 +64,6 @@ module CouchRest
         #  
         # For further details on <tt>view_by</tt>'s other options, please see the
         # standard documentation.
-        
         def paginated_view_by(*keys)
 
           # Prepare the Traditional view
@@ -101,9 +100,18 @@ module CouchRest
               paginated_view('#{view_name}', options)
             end
           RUBY_EVAL
-
         end
 
+        ##
+        # Generate a Will Paginate collection from all the available
+        # documents stored with a matching couchrest-type.
+        #
+        # Requires no declaration as the 'all' view is built into couchrest
+        # Extended Documents.
+        #
+        def paginate_all(options = {})
+          paginated_view(:all, options)
+        end
 
         protected
 
@@ -117,14 +125,21 @@ module CouchRest
 
             ::WillPaginate::Collection.create( options[:page], options[:per_page] ) do |pager|
               # perform view count first (should create designs if missing)
-              total = view( view_name, options.update(:reduce => true) )['rows'].pop
-              pager.total_entries = total ? total['value'] : 0
-              results = paginate(
-                options.merge(
-                  :design_doc => self.to_s, :view_name => view_name,
-                  :include_docs => true, :reduce => false
-                )
+              if view_name.to_sym == :all
+                pager.total_entries = count()
+              else
+                total = view( view_name, options.update(:reduce => true) )['rows'].pop
+                pager.total_entries = total ? total['value'] : 0
+              end
+              p_options = options.merge(
+                :design_doc => self.to_s, :view_name => view_name,
+                  :include_docs => true
               )
+              # Only provide the reduce parameter when necessary. This is when the view has
+              # been set with a reduce method and requires the reduce boolean parameter
+              # to be either true or false on all requests.
+              p_options[:reduce] = false unless view_name.to_sym == :all
+              results = paginate(p_options)
               pager.replace( results )
             end
           end

data/spec/will_paginate_couchrest_spec.rb

@@ -26,6 +26,22 @@ describe CouchRest::Mixins::WillPaginate do
     # @some_doc.stub(:id).and_return(123)
   end
 
+  it "should accept request when no results" do
+    docs = SomeDoc.paginate_by_name(:per_page => 5)
+    docs.total_entries.should eql(0)    
+  end
+
+  it "should accept request without page" do
+    docs = nil
+    lambda { docs = SomeDoc.paginate_by_name(:per_page => 5) }.should_not raise_error
+    docs.current_page.should eql(1)
+  end
+
+  it "should throw an exception when missing per_page parameter" do
+    lambda { SomeDoc.paginate_by_name() }.should raise_error
+  end
+
+
   describe "performing pagination with lots of documents" do
 
     before(:each) do
@@ -38,7 +54,7 @@ describe CouchRest::Mixins::WillPaginate do
 
     it "should produce a will paginate collection" do
       docs = SomeDoc.paginate_by_name( :page => 1, :per_page => 5 )
-      docs.class.should eql(::WillPaginate::Collection)
+      docs.should be_a_kind_of(::WillPaginate::Collection)
       docs.total_pages.should eql(4)
       docs.first.name.should eql('document 00')
       docs.length.should eql(5)
@@ -52,8 +68,13 @@ describe CouchRest::Mixins::WillPaginate do
       docs.last.name.should eql('document 09')
     end
 
-
-  
+    it "should perform paginate on all entries" do
+      docs = SomeDoc.paginate_all(:page => 1, :per_page => 5)
+      docs.first.class.should eql(SomeDoc)
+      docs.total_pages.should eql(4)
+      docs.total_entries.should eql(20)
+      docs.length.should eql(5)
+    end
 
   end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: will_paginate_couchrest
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - samlown
@@ -9,29 +14,36 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-04 00:00:00 +00:00
+date: 2010-03-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: couchrest
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 35
         version: "0.35"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
         version: 1.2.9
-    version: 
+  type: :development
+  version_requirements: *id002
 description: generate views specifically with support for using will_paginate with them
 email: me@samlown.com
 executables: []
@@ -64,21 +76,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: adds will-paginate support to CouchRest
 test_files: 
-- spec/will_paginate_couchrest_spec.rb
 - spec/spec_helper.rb
+- spec/will_paginate_couchrest_spec.rb