jm81-paginate 0.1.6 → 0.2.0

data/.gitignore

@@ -1,4 +1,10 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
 .project
 .loadpath
 *qt_temp*
 *~
+*.gem

data/Rakefile

@@ -1,10 +1,12 @@
 require 'rubygems'
 require 'rake'
+require File.join(File.dirname(__FILE__), 'lib', 'jm81-paginate', 'version')
 
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "jm81-paginate"
+    gem.version = Paginate::VERSION.dup
     gem.summary = "Pagination for DataMapper, ActiveRecord, and Array"
     gem.description = <<EOF
 This paginate library assists in paginating collections and results of database 

data/{paginate.gemspec → jm81-paginate.gemspec}

@@ -1,19 +1,24 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{paginate}
-  s.version = "0.1.6"
+  s.name = %q{jm81-paginate}
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jared Morgan"]
-  s.date = %q{2009-09-20}
+  s.date = %q{2010-08-11}
+  s.description = %q{This paginate library assists in paginating collections and results of database 
+queries. It is particularly designed for use with DataMapper and ActiveRecord, 
+and for the Merb and Rails frameworks, but can be used in many other situations.
+}
   s.email = %q{jmorgan@morgancreative.net}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.md"
+     "README.md",
+     "TODO"
   ]
   s.files = [
     ".gitignore",
@@ -21,19 +26,21 @@ Gem::Specification.new do |s|
      "README.md",
      "Rakefile",
      "TODO",
-     "VERSION",
+     "jm81-paginate.gemspec",
      "lib/helpers/merb.rb",
+     "lib/helpers/rails.rb",
      "lib/helpers/shared.rb",
-     "lib/paginate.rb",
+     "lib/jm81-paginate.rb",
+     "lib/jm81-paginate/version.rb",
      "lib/paginate/ar.rb",
      "lib/paginate/dm.rb",
      "lib/paginate/simple.rb",
      "lib/paginators/orm.rb",
      "lib/paginators/simple.rb",
-     "paginate.gemspec",
      "spec/fixtures/ar.rb",
      "spec/fixtures/dm.rb",
      "spec/helpers/merb_spec.rb",
+     "spec/helpers/rails_spec.rb",
      "spec/helpers/shared_spec.rb",
      "spec/paginate/ar_spec.rb",
      "spec/paginate/config_spec.rb",
@@ -45,34 +52,35 @@ Gem::Specification.new do |s|
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/jm81/paginate}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Pagination for DataMapper, ActiveRecord, and Array}
   s.test_files = [
-    "spec/fixtures/ar.rb",
-     "spec/fixtures/dm.rb",
-     "spec/helpers/merb_spec.rb",
+    "spec/spec_helper.rb",
+     "spec/shared.rb",
+     "spec/paginators/orm_spec.rb",
+     "spec/paginators/simple_spec.rb",
      "spec/helpers/shared_spec.rb",
-     "spec/paginate/ar_spec.rb",
-     "spec/paginate/config_spec.rb",
+     "spec/helpers/merb_spec.rb",
+     "spec/helpers/rails_spec.rb",
      "spec/paginate/dm_spec.rb",
+     "spec/paginate/config_spec.rb",
      "spec/paginate/simple_spec.rb",
-     "spec/paginators/orm_spec.rb",
-     "spec/paginators/simple_spec.rb",
-     "spec/shared.rb",
-     "spec/spec_helper.rb"
+     "spec/paginate/ar_spec.rb",
+     "spec/fixtures/dm.rb",
+     "spec/fixtures/ar.rb"
   ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else
   end
 end
+

data/lib/helpers/merb.rb

@@ -45,7 +45,7 @@ module Paginate
           if current == 1
             html << tag(:span, '&laquo;', :class => 'pageDisabled pagePrevious')
           else
-            html << tag(:a, '&laquo;', :href => page_url(current - 1), :class => 'pagePrevious')
+            html << tag(:a, '&laquo;', :href => url_for_pagination(current - 1), :class => 'pagePrevious')
           end
           
           page_set(current, pages, padding).each do |page|
@@ -55,32 +55,18 @@ module Paginate
             when current
               html << tag(:span, page, :class => 'pageCurrent')
             else
-              html << tag(:a, page, :href => page_url(page), :class => 'pageNumber')
+              html << tag(:a, page, :href => url_for_pagination(page), :class => 'pageNumber')
             end
           end
         
           if current == pages
             html << tag(:span, '&raquo;', :class => 'pageDisabled pageNext')
           else
-            html << tag(:a, '&raquo;', :href => page_url(current + 1), :class => 'pageNext')
+            html << tag(:a, '&raquo;', :href => url_for_pagination(current + 1), :class => 'pageNext')
           end
           html
         end
       end
-      
-      # +page_url+ generates a URL (for page links), given a page number and
-      # optionally a path and query string. By default, the path is the path
-      # of the current request, and the query_string is also that of the
-      # current request. This allows for order and condition related fields
-      # in the query string to be used in the page link.
-      def page_url(page, path = request.path, q = request.query_string)
-        # Remove any current reference to page in the query string
-        q.to_s.gsub!(/page=(-?[\d]+)(&?)/, '') 
-        # Assemble new link
-        link = "#{path}?page=#{page}&#{q}"
-        link = link[0..-2] if link[-1..-1] == '&' # Strip trailing ampersand
-        link
-      end      
     end
   end
 end

data/lib/helpers/rails.rb

@@ -0,0 +1,72 @@
+module Paginate
+  module Helpers
+    # Pagination helpers for Rails applications. See Paginate::Helpers::Shared
+    # for additional methods
+    module Rails
+      include Shared
+      
+      # A quick method for creating pagination links, using a view partial,
+      # (layouts/_page_links, by default).
+      # Arguments:
+      #
+      # - +collection+: an enumerable collection with #current_page and
+      #   #pages methods.
+      # - +partial_name+: location of the partial to use
+      # - +padding+: Maximum number of page links before and after current_page.
+      def pagination_partial(collection, partial_name = "layout/page_links", padding = 3)
+        padding ||= 3
+        render(:partial => partial_name, :locals => {:current_page => collection.current_page, :pages => collection.pages, :padding => padding})
+      end
+      
+      # Returns links for pages, given a +collection+ and optional
+      # +padding+ (see Shared#page_set). Returned html will be along the lines
+      # of:
+      # 
+      #    <div class="pageLinks">' +
+      #      <span class="pagePrevious"><a href="/list?page=4">&laquo;</a></span>
+      #      <span class="pageSpacer">...</span>
+      #      <span class="pageNumber"><a href="/list?page=3">3</a></span>
+      #      <span class="pageNumber"><a href="/list?page=4">4</a></span>
+      #      <span class="pageCurrent">5</span>
+      #      <span class="pageNumber"><a href="/list?page=6">6</a></span>
+      #      <span class="pageNumber"><a href="/list?page=7">7</a></span>
+      #      <span class="pageSpacer">...</span>
+      #      <span class="pageNext"><a href="/list?page=6">&raquo;</a></span>
+      #    </div>
+      #
+      # CSS classes are pageSpacer, pageNumber, pageDisabled, pageCurrent, 
+      # pagePrevious, and pageNext. pageLinks is the class of the enclosing div.
+      def page_links(collection, padding = 3)
+        current = collection.current_page
+        pages   = collection.pages
+        
+        content_tag(:div, {:class => 'pageLinks'}, false) do
+          html = ''.html_safe
+          if current == 1
+            html << content_tag(:span, :class => 'pageDisabled pagePrevious') { '&laquo;' }
+          else
+            html << content_tag(:a, :href => url_for_pagination(current - 1), :class => 'pagePrevious') { '&laquo;' }
+          end
+          
+          page_set(current, pages, padding).each do |page|
+            case page
+            when 0
+              html << content_tag(:span, :class => 'pageSpacer') { '...' }
+            when current
+              html << content_tag(:span, :class => 'pageCurrent') { page.to_s }
+            else
+              html << content_tag(:a, :href => url_for_pagination(page), :class => 'pageNumber') { page.to_s }
+            end
+          end
+        
+          if current == pages
+            html << content_tag(:span, :class => 'pageDisabled pageNext') { '&raquo;' }
+          else
+            html << content_tag(:a, :href => url_for_pagination(current + 1), :class => 'pageNext') { '&raquo;' }
+          end
+          html
+        end
+      end
+    end
+  end
+end

data/lib/helpers/shared.rb

@@ -38,6 +38,20 @@ module Paginate
         # Join Arrays together
         leader + (first..last).to_a + footer
       end
+
+      # Generate a URL (for page links), given a page number and
+      # optionally a path and query string. By default, the path is the path
+      # of the current request, and the query_string is also that of the
+      # current request. This allows for order and condition related fields
+      # in the query string to be used in the page link.
+      def url_for_pagination(page, path = request.path, q = request.query_string)
+        # Remove any current reference to page in the query string
+        q.to_s.gsub!(/page=(-?[\d]+)(&?)/, '')
+        # Assemble new link
+        link = "#{path}?page=#{page}&#{q}"
+        link = link[0..-2] if link[-1..-1] == '&' # Strip trailing ampersand
+        link
+      end
     end
   end
 end

data/lib/jm81-paginate/version.rb

@@ -0,0 +1,3 @@
+module Paginate
+  VERSION = '0.2.0'.freeze
+end

data/lib/{paginate.rb → jm81-paginate.rb}

@@ -1,6 +1,4 @@
 module Paginate
-  VERSION = '0.1.6'
-  
   DEFAULTS = {
     :default_limit => 10
   }
@@ -29,6 +27,6 @@ end
 end
 
 # Require Helper Modules
-%w{ shared merb }.each do |file|
+%w{ shared merb rails }.each do |file|
   require 'helpers/' + file
 end

data/spec/helpers/merb_spec.rb

@@ -28,38 +28,4 @@ describe Paginate::Helpers::Merb do
       @object.pagination_partial(collection, 'partial_name', 4)
     end
   end
-    
-  describe '#page_url' do
-    it 'should add page query option' do
-      @object.page_url(5, 'path', '').should ==
-        'path?page=5'
-    end
-
-    it 'should leave other query options' do
-      @object.page_url(5, 'path', 'limit=10&something=text').should ==
-        'path?page=5&limit=10&something=text'
-    end
-    
-    it 'should remove existing page option' do
-      # middle
-      @object.page_url(5, 'path', 'limit=10&page=10&something=text').should ==
-        'path?page=5&limit=10&something=text'
-      
-      # start
-      @object.page_url(5, 'path', 'page=10&limit=10&something=text').should ==
-        'path?page=5&limit=10&something=text'
-      
-      # end
-      @object.page_url(5, 'path', 'limit=10&something=text&page=10').should ==
-        'path?page=5&limit=10&something=text'
-    end
-    
-    it 'should remove existing negative page option' do
-      @object.page_url(5, 'path', 'limit=10&page=-10&something=text').should ==
-        'path?page=5&limit=10&something=text'
-      
-      @object.page_url(5, 'path', 'page=-5&limit=10&something=text').should ==
-        'path?page=5&limit=10&something=text'
-    end
-  end
 end

data/spec/helpers/rails_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Paginate::Helpers::Rails do
+  before(:all) do
+    @klass = Class.new
+    @klass.__send__(:include, Paginate::Helpers::Rails)
+    @object = @klass.new
+  end
+  
+  it 'should include #page_set method from Shared' do
+    @object.page_set(5, 10, 2).should ==
+      [1,0,3,4,5,6,7,0,10]
+  end
+
+  # Being lazy and just using a mock here.
+  describe '#pagination_partial' do
+    it 'should call render(:partial)' do
+      collection = (1..50).to_a
+      collection.extend(Paginate::Simple)
+      collection = collection.paginate(:page => 5, :limit => 5)
+      vars = {
+        :current_page => 5,
+        :pages => 10,
+        :padding => 4
+      }
+
+      @object.should_receive(:render).with(:partial => 'partial_name', :locals => vars)
+      @object.pagination_partial(collection, 'partial_name', 4)
+    end
+  end
+end

data/spec/helpers/shared_spec.rb

@@ -58,4 +58,38 @@ describe Paginate::Helpers::Shared do
         [1]
     end
   end
+
+  describe '#url_for_pagination' do
+    it 'should add page query option' do
+      @object.url_for_pagination(5, 'path', '').should ==
+        'path?page=5'
+    end
+
+    it 'should leave other query options' do
+      @object.url_for_pagination(5, 'path', 'limit=10&something=text').should ==
+        'path?page=5&limit=10&something=text'
+    end
+
+    it 'should remove existing page option' do
+      # middle
+      @object.url_for_pagination(5, 'path', 'limit=10&page=10&something=text').should ==
+        'path?page=5&limit=10&something=text'
+
+      # start
+      @object.url_for_pagination(5, 'path', 'page=10&limit=10&something=text').should ==
+        'path?page=5&limit=10&something=text'
+
+      # end
+      @object.url_for_pagination(5, 'path', 'limit=10&something=text&page=10').should ==
+        'path?page=5&limit=10&something=text'
+    end
+
+    it 'should remove existing negative page option' do
+      @object.url_for_pagination(5, 'path', 'limit=10&page=-10&something=text').should ==
+        'path?page=5&limit=10&something=text'
+
+      @object.url_for_pagination(5, 'path', 'page=-5&limit=10&something=text').should ==
+        'path?page=5&limit=10&something=text'
+    end
+  end
 end

data/spec/paginate/ar_spec.rb

@@ -1,3 +1,4 @@
+require 'spec_helper'
 require 'active_record'
 
 # Setup AR connection, schema
@@ -12,7 +13,6 @@ ActiveRecord::Schema.define do
   end
 end
 
-require 'spec_helper'
 require 'fixtures/ar'
 
 describe 'Paginate::AR' do 

data/spec/paginate/dm_spec.rb

@@ -1,6 +1,7 @@
+require 'spec_helper'
 require 'dm-core'
 require 'dm-aggregates'
-require 'spec_helper'
+require 'dm-migrations'
 require 'fixtures/dm'
 
 describe Paginate::DM do

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-require "rubygems"
-require "spec"
+require 'rubygems'
+require 'spec'
 
-require 'paginate'
+require 'jm81-paginate'
 require 'shared'

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jm81-paginate
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jared Morgan
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-11 00:00:00 -05:00
+date: 2010-08-11 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -26,25 +32,28 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README.md
+- TODO
 files: 
 - .gitignore
 - LICENSE
 - README.md
 - Rakefile
 - TODO
-- VERSION
+- jm81-paginate.gemspec
 - lib/helpers/merb.rb
+- lib/helpers/rails.rb
 - lib/helpers/shared.rb
-- lib/paginate.rb
+- lib/jm81-paginate.rb
+- lib/jm81-paginate/version.rb
 - lib/paginate/ar.rb
 - lib/paginate/dm.rb
 - lib/paginate/simple.rb
 - lib/paginators/orm.rb
 - lib/paginators/simple.rb
-- paginate.gemspec
 - spec/fixtures/ar.rb
 - spec/fixtures/dm.rb
 - spec/helpers/merb_spec.rb
+- spec/helpers/rails_spec.rb
 - spec/helpers/shared_spec.rb
 - spec/paginate/ar_spec.rb
 - spec/paginate/config_spec.rb
@@ -65,34 +74,41 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Pagination for DataMapper, ActiveRecord, and Array
 test_files: 
-- spec/fixtures/ar.rb
-- spec/fixtures/dm.rb
-- spec/helpers/merb_spec.rb
+- spec/spec_helper.rb
+- spec/shared.rb
+- spec/paginators/orm_spec.rb
+- spec/paginators/simple_spec.rb
 - spec/helpers/shared_spec.rb
-- spec/paginate/ar_spec.rb
-- spec/paginate/config_spec.rb
+- spec/helpers/merb_spec.rb
+- spec/helpers/rails_spec.rb
 - spec/paginate/dm_spec.rb
+- spec/paginate/config_spec.rb
 - spec/paginate/simple_spec.rb
-- spec/paginators/orm_spec.rb
-- spec/paginators/simple_spec.rb
-- spec/shared.rb
-- spec/spec_helper.rb
+- spec/paginate/ar_spec.rb
+- spec/fixtures/dm.rb
+- spec/fixtures/ar.rb

data/VERSION

@@ -1 +0,0 @@
-0.1.6