dm-pager 0.0.7

data/History.md

@@ -0,0 +1,42 @@
+
+0.0.7 / 2009-10-10
+==================
+
+  * Renamed to dm-pager (available on gemcutter)
+
+0.0.6 / 2009-10-08
+==================
+
+  * Added #option and specs for overriding defaults with #to_html [#13]
+  * Added "jump" class to first,last,prev,next <li>'s [#17]
+  * Added ability to configure "..." text when more pages are available
+
+0.0.5 / 2009-10-07
+==================
+
+  * #to_f -> #quo
+  * Fixed pager from being rendered when only one page is available
+
+0.0.4 / 2009-10-07
+==================
+
+  * Added DataMapper::Pagination#pager_option 
+  * Fixed :per_page; now may be 'per_page' as well
+  * Fixed :per_page; now allows for numeric strings
+
+0.0.3 / 2009-10-07
+==================
+
+  * Fixed issue caused by indifferent params hash having both :page and 'page' keys
+
+0.0.2 / 2009-10-07
+==================
+
+  * Allowing #page :page param, as alternative to the current_page arg (User.page(params) vs User.page(params[:page]))
+  * Fixed issue when page is a string (from query string); Coerce strings to ints
+  * Fixed issue when page is nil; now considered first page
+
+0.0.1 / 2009-10-07
+===================
+
+  * Initial release

data/Manifest

@@ -0,0 +1,20 @@
+History.md
+Manifest
+Rakefile
+Readme.md
+examples/pager.rb
+lib/dm-pager.rb
+lib/dm-pager/defaults.rb
+lib/dm-pager/helpers.rb
+lib/dm-pager/helpers/rails.rb
+lib/dm-pager/pager.rb
+lib/dm-pager/pagination.rb
+lib/dm-pager/version.rb
+spec/integration/rails_helper_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/unit/pager_spec.rb
+spec/unit/pagination_spec.rb
+tasks/docs.rake
+tasks/gemspec.rake
+tasks/spec.rake

data/Rakefile

@@ -0,0 +1,18 @@
+
+$:.unshift 'lib'
+require 'rubygems'
+require 'dm-pager'
+require 'rake'
+require 'echoe'
+
+Echoe.new "dm-pager", DataMapper::Pagination::VERSION do |p|
+  p.author = "TJ Holowaychuk"
+  p.email = "tj@vision-media.ca"
+  p.summary = "DataMapper Pagination"
+  p.url = "http://github.com/visionmedia/dm-pagination"
+  p.runtime_dependencies = []
+  p.runtime_dependencies << 'dm-core >=0.10.1'
+  p.runtime_dependencies << 'dm-aggregates >=0.10.1'
+end
+
+Dir['tasks/**/*.rake'].sort.each { |f| load f }

data/Readme.md

@@ -0,0 +1,119 @@
+
+# DataMapper::Pager
+
+  Better paging solution for DataMapper for DM >= 0.10.1
+  
+# About
+
+Not to be confused with the dm-pagination gem (a similar gem lacking in functionality) dm-pager
+is a new, fresh, and feature rich pagination implementation for DataMapper. Due to Github's gem builder
+being destroyed, we were forced to rename our gem to 'dm-pager' which is now available on [Gemcutter.org](http://gemcutter.org).
+
+# Installation
+
+Install [Gemcutter](http://gemcutter.org) and execute:
+    $ sudo gem install dm-pager
+  
+# Examples
+
+Page 1 for all items, defaulting to 6 per page:
+    Item.page
+    // => [1, 2, 3, 4, 5, 6]
+    
+Page 2 for all items, 6 per page, with only 3 items remaining
+    Item.page 2
+    // => [7, 8, 9]
+    
+Page 3, 2 per page:
+    Item.page 3, :per_page => 2
+    // => [5, 6]
+    
+Accessing the pager instance:
+    Item.page(1, :per_page => 4).pager
+    // => #<DataMapper::Pager:0x1610f20 @per_page=4, @next_page=2, @total_pages=3, @total=10, @current_page=1>
+    
+Converting to HTML:
+    Item.page(2).pager.to_html('/items')
+    // => "<div class=\"pager\">..."
+    
+Alter the number of intermediate numbered links displayed, defaults to 7
+    Item.page(2).pager.to_html('/items', :size => 3)
+    // => "<div class=\"pager\">..."
+    
+# Output
+
+Output is displayed in a format similar to below, although 
+with CSS you may hide anything you wish to remove. There is
+no need to provide an API for this.
+
+    Item.page(2).pager.to_html('/items', :size => 3)
+    // => First Previous 1 [2] 3 ... Next Last
+    
+    Item.page.pager.to_html '/items'
+    // => [1] 2 3 4 5 6 7 ... Next Last
+
+    Item.page(5).pager.to_html('/items', :size => 5)
+    // => First Previous ... 3 4 [5] 6 7 ... Next Last
+    
+# Markup
+
+Sample query:
+    Item.page(2, :per_page => 2).pager.to_html("/items", :size => 3)
+
+Sample markup:
+
+    <div class="pager">
+      <a href="/items?page=1" class="first">First</a>
+      <a href="/items?page=1" class="previous">Previous</a>
+      <ul>
+        <li class="page-1 first"><a href="/items?page=1" class="">1</a></li>
+        <li class="active page-2"><a href="/items?page=2" class="">2</a></li>
+        <li class="page-3 last"><a href="/items?page=3" class="">3</a></li>
+        <li class="more">...</li>
+      </ul>
+      <a href="/items?page=3" class="next">Next</a>
+      <a href="/items?page=5" class="last">Last</a>
+    </div>
+    
+## Running Specs
+
+Autospec:
+    $ autospec
+  
+Rake:
+    $ rake spec
+    $ rake spec:verbose
+    $ rake spec:select SPEC=spec/unit/pager_spec.rb
+    
+RSpec:
+    $ spec --color spec
+    
+## Authors
+
+ * TJ Holowaychuk <tj@vision-media.ca>
+ * Marco Otte-Witte <http://simplabs.com>
+    
+## License
+
+(The MIT License)
+
+Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, an d/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/dm-pager.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-pager}
+  s.version = "0.0.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["TJ Holowaychuk"]
+  s.date = %q{2009-10-10}
+  s.description = %q{DataMapper Pagination}
+  s.email = %q{tj@vision-media.ca}
+  s.extra_rdoc_files = ["lib/dm-pager.rb", "lib/dm-pager/defaults.rb", "lib/dm-pager/helpers.rb", "lib/dm-pager/helpers/rails.rb", "lib/dm-pager/pager.rb", "lib/dm-pager/pagination.rb", "lib/dm-pager/version.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.files = ["History.md", "Manifest", "Rakefile", "Readme.md", "examples/pager.rb", "lib/dm-pager.rb", "lib/dm-pager/defaults.rb", "lib/dm-pager/helpers.rb", "lib/dm-pager/helpers/rails.rb", "lib/dm-pager/pager.rb", "lib/dm-pager/pagination.rb", "lib/dm-pager/version.rb", "spec/integration/rails_helper_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/unit/pager_spec.rb", "spec/unit/pagination_spec.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "dm-pager.gemspec"]
+  s.homepage = %q{http://github.com/visionmedia/dm-pagination}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Dm-pager", "--main", "Readme.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{dm-pager}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{DataMapper Pagination}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<dm-core>, [">= 0.10.1"])
+      s.add_runtime_dependency(%q<dm-aggregates>, [">= 0.10.1"])
+    else
+      s.add_dependency(%q<dm-core>, [">= 0.10.1"])
+      s.add_dependency(%q<dm-aggregates>, [">= 0.10.1"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, [">= 0.10.1"])
+    s.add_dependency(%q<dm-aggregates>, [">= 0.10.1"])
+  end
+end

data/examples/pager.rb

@@ -0,0 +1,38 @@
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+require 'dm-core'
+require 'dm-pager'
+
+class Item
+  include DataMapper::Resource
+  property :id,   Serial
+end
+
+DataMapper.setup :default, 'sqlite3::memory:'
+DataMapper.auto_migrate!
+(1..10).each { |n| Item.create }
+
+def show example
+  puts example
+  expr = eval example
+  if String === expr
+    puts expr + "\n\n"
+  else
+    puts "# => #{eval(example).inspect}\n\n"
+  end
+end
+
+puts "Items: #{Item.all.count}\n\n"
+show 'Item.page'
+show 'Item.page(2)'
+show 'Item.page(1, :per_page => 4)'
+show 'Item.page(1, :per_page => 4).pager'
+show 'Item.page(1, :per_page => 4).pager.to_html "/items" '
+show 'Item.page(1, :per_page => 4).pager.to_html "/items?foo=bar" '
+show 'Item.page(2, :per_page => 4).pager.to_html "/items?page=2" '
+show 'Item.page(1, :per_page => 2).pager.to_html("/items", :size => 3)'
+show 'Item.page(2, :per_page => 2).pager.to_html("/items", :size => 3)'
+show 'Item.page(3, :per_page => 2).pager.to_html("/items", :size => 3)'
+show 'Item.page(4, :per_page => 2).pager.to_html("/items", :size => 3)'

data/lib/dm-pager/defaults.rb

@@ -0,0 +1,40 @@
+
+module DataMapper
+  module Pagination
+
+    @defaults = {
+      :per_page      => 6,
+      :size          => 7,
+      :pager_class   => 'pager',
+      :previous_text => 'Previous',
+      :next_text     => 'Next',
+      :first_text    => 'First',
+      :last_text     => 'Last',
+      :more_text     => '...'
+    }
+
+    ##
+    # Default pagination values.
+    #
+    # === Options
+    #
+    #   :per_page       Records per page; defaults to 6
+    #   :size           Number of intermediate page number links to be shown; Defaults to 7
+    #   :pager_class    Class for the div that contains the pagination links, defaults to 'pager'
+    #   :previous_text  Text for the 'previous' link, defaults to 'Previous'
+    #   :next_text      Text for the 'next' link, defaults to 'Next'
+    #   :first_text     Text for the 'first' link, defaults to 'First'
+    #   :last_text      Text for the 'last' link, defaults to 'Last'
+    #   :more_text      Text for the 'more' indicator, defaults to '...'
+    #
+    # === Examples
+    #
+    #   DataMapper::Pagination.defaults[:size] = 5
+    #
+    
+    def self.defaults
+      @defaults
+    end
+
+  end
+end

data/lib/dm-pager/helpers/rails.rb

@@ -0,0 +1,17 @@
+
+module DataMapper::Pagination::Helpers::Rails
+
+  ##
+  # Renders the pagination links for the given _collection_.
+  #
+  # === Options
+  #
+  #   :params  Hash of params that is passed to url_for
+  #   :size    Number of intermediate page number links to be shown; Defaults to 7
+  
+  def paginate collection, options = {}
+    uri = @template.url_for @template.params.merge(options[:params] || {})
+    collection.pager.to_html uri, options
+  end
+
+end

data/lib/dm-pager/helpers.rb

@@ -0,0 +1,6 @@
+
+module DataMapper::Pagination
+  module Helpers
+    autoload :Rails, 'dm-pager/helpers/rails'
+  end
+end

data/lib/dm-pager/pager.rb

@@ -0,0 +1,193 @@
+
+module DataMapper
+  class Pager
+    
+    ##
+    # Total number of un-limited records.
+    
+    attr_reader :total 
+    
+    ##
+    # Records per page.
+    
+    attr_reader :per_page 
+    
+    ##
+    # Current page number.
+    
+    attr_reader :current_page
+    
+    ##
+    # Previous page or nil when no previous page is available.
+    
+    attr_reader :previous_page
+    
+    ##
+    # Next page or nil when no more pages are available.
+    
+    attr_reader :next_page
+    
+    ##
+    # Total number of pages.
+    
+    attr_reader :total_pages
+    
+    ##
+    # Initialize with _options_.
+    
+    def initialize options = {}
+      @total = options.delete :total
+      @per_page = options.delete :limit
+      @current_page = options.delete :page
+      @total_pages = total.quo(per_page).ceil
+      @next_page = current_page + 1 unless current_page >= total_pages
+      @previous_page = current_page - 1 unless current_page <= 1
+    end
+    
+    ##
+    # Render the pager with the given _uri_ and _options_.
+    # 
+    # === Examples
+    #
+    #   User.page(2).pager.to_html('/users')
+    #   User.page(2).pager.to_html('/users', :size => 3)
+    #
+    # === Options
+    #
+    #   :size   Number of intermediate page number links to be shown; Defaults to 7
+    #
+    
+    def to_html uri, options = {}
+      return unless total_pages > 1
+      @uri, @options = uri, options
+      @size = option :size
+      raise ArgumentError, 'invalid :size; must be an odd number' if @size % 2 == 0
+      @size /= 2
+      [%(<ul class="#{Pagination.defaults[:pager_class]}">),
+        first_link,
+        previous_link,
+        more(:before),
+        intermediate_links.join("\n"),
+        more(:after),
+        next_link,
+        last_link,
+      '</ul>'].join
+    end
+    
+    private
+    
+    ##
+    # Fetch _key_ from the options passed to #to_html, or
+    # its default value.
+    
+    def option key
+      @options.fetch key, Pagination.defaults[key]
+    end
+    
+    ##
+    # Link to _page_ with optional anchor tag _contents_. 
+    
+    def link_to page, contents = nil
+      %(<a href="#{uri_for(page)}">#{contents || page}</a>)
+    end
+    
+    ##
+    # More pages indicator for _position_.
+    
+    def more position
+      return '' if position == :before && (current_page <= 1 || first <= 1)
+      return '' if position == :after && (current_page >= total_pages || last >= total_pages)
+      li 'more', option(:more_text)
+    end
+    
+    ##
+    # Intermediate page links array.
+    
+    def intermediate_links
+      (first..last).map do |page|
+        classes = ["page-#{page}"]
+        classes << 'active' if current_page == page
+        li classes.join(' '), link_to(page)
+      end
+    end
+    
+    ##
+    # Previous link.
+    
+    def previous_link
+      li 'previous jump', link_to(previous_page, option(:previous_text)) if previous_page
+    end
+    
+    ##
+    # Next link.
+    
+    def next_link
+      li 'next jump', link_to(next_page, option(:next_text)) if next_page
+    end
+    
+    ##
+    # Last link.
+    
+    def last_link
+      li 'last jump', link_to(total_pages, option(:last_text)) if next_page
+    end
+    
+    ##
+    # First link.
+    
+    def first_link
+      li 'first jump', link_to(1, option(:first_text)) if previous_page
+    end
+    
+    ##
+    # Determine first intermediate page.
+
+    def first
+      @first ||= begin
+        first = [current_page - @size, 1].max
+        if (current_page - total_pages).abs < @size
+          first = [first - (@size - (current_page - total_pages).abs), 1].max
+        end
+        first
+      end
+    end
+    
+    ##
+    # Determine last intermediate page.
+
+    def last
+      @last ||= begin
+        last = [current_page + @size, total_pages].min
+        if @size >= current_page
+          last = [last + (@size - current_page) + 1, total_pages].min
+        end
+        last
+      end
+    end
+    
+    ##
+    # Renders a <li> with the given _css_class_ and _contents_.
+    
+    def li css_class = nil, contents = nil
+      "<li#{%( class="#{css_class}") if css_class}>#{contents}</li>\n"
+    end
+    
+    ##
+    # Uri for _page_. The following conversions are made
+    # to the _uri_ previously passed to #to_html:
+    #
+    #   /items          # Appends query string => /items?page=2
+    #   /items?page=1   # Adjusts current page => /items?page=2
+    #   /items?foo=bar  # Appends page pair    => /items?foo=bar&page=1
+    #
+
+    def uri_for page
+      case @uri
+      when /page=/ ; @uri.gsub /page=\d+/, "page=#{page}"
+      when /\?/    ; @uri += "&page=#{page}"
+      else         ; @uri += "?page=#{page}"
+      end
+    end
+    
+  end
+end

data/lib/dm-pager/pagination.rb

@@ -0,0 +1,65 @@
+
+module DataMapper
+  module Pagination
+    
+    ##
+    # DataMapper::Pager instance.
+    
+    attr_accessor :pager
+    
+    ##
+    # Page collection by the _page_ number and _options_ provided.
+    #
+    # Since pagers will commonly be used with query strings, we 
+    # coerce all numeric strings such as '12' to their integer value 12.
+    # This is the case for _page_, :per_page, :page, etc.
+    #
+    # === Options
+    #
+    #   :page       Current page number
+    #   :per_page   Results per page; defaults to 6
+    #   :order      Defaults to [:id.desc]
+    #
+    # === Examples
+    #    
+    #   User.all.page
+    #   User.all.page(2)
+    #   User.all.page(2, :per_page => 5)
+    #   User.all.page(:page => 2, :per_page => 5)
+    #
+    
+    def page page = nil, options = {}
+      options, page = page, nil if page.is_a? Hash
+      page ||= pager_option :page, options
+      options.delete :page
+      page = 1 unless (page = page.to_i) && page > 1
+      per_page = pager_option(:per_page, options).to_i
+      query = options.dup
+      collection = new_collection scoped_query(options = {
+        :limit => per_page,
+        :offset => (page - 1) * per_page,
+        :order => [:id.desc]
+      }.merge(query))
+      options.merge! :total => count(query), :page => page
+      collection.pager = DataMapper::Pager.new options
+      collection
+    end
+    
+    private
+    
+    ##
+    # Return value for _key_ from indifferent hash _options_.
+    # 
+    #  * Checks for sym key
+    #  * Checks for string key
+    #  * Checks DataMapper::Pagination.defaults for the sym key
+    #  * Deletes both keys to prevent them from being part of the query
+    #
+    
+    def pager_option key, options = {}
+      a = options.delete key.to_sym
+      b = options.delete key.to_s
+      a || b || Pagination.defaults[key.to_sym]
+    end
+  end
+end

data/lib/dm-pager/version.rb

@@ -0,0 +1,6 @@
+
+module DataMapper
+  module Pagination
+    VERSION = '0.0.7'
+  end
+end

data/lib/dm-pager.rb

@@ -0,0 +1,47 @@
+#--
+# Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+require 'dm-core'
+require 'dm-aggregates'
+require 'dm-pager/version'
+require 'dm-pager/defaults'
+require 'dm-pager/pagination'
+require 'dm-pager/pager'
+require 'dm-pager/helpers'
+
+#--
+# DataMapper
+#++
+
+DataMapper::Model.send :include, DataMapper::Pagination
+DataMapper::Collection.send :include, DataMapper::Pagination
+DataMapper::Query.send :include, DataMapper::Pagination
+
+#--
+# Rails
+#++
+
+if defined? ActionView::Base
+  ActionView::Base.send :include, DataMapper::Pagination::Helpers::Rails
+end
+

data/spec/integration/rails_helper_spec.rb

@@ -0,0 +1,18 @@
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe DataMapper::Pagination::Helpers::Rails do
+  include DataMapper::Pagination::Helpers::Rails
+
+  describe '#paginate' do
+    before do
+      @collection = stub 'Collection', :pager => stub('Pager')
+      @template = stub 'Template', :path => 'path', :params => { :foo => :bar }, :url_for => '/projects/popular?page=3'
+    end
+
+    it "should invoke the pager's #to_html method'" do
+      @collection.pager.should_receive(:to_html).once.with('/projects/popular?page=3', {})
+      paginate(@collection)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+
+$:.unshift 'lib'
+require 'rubygems'
+require 'dm-core'
+require 'dm-pager'
+
+DataMapper.setup :default, 'sqlite3::memory:'
+
+class Item
+  include DataMapper::Resource
+  property :id,   Serial
+end
+
+def mock_items
+  DataMapper.auto_migrate!
+  1.upto 20 do |n|
+    instance_variable_set :"@item_#{n}", Item.create
+  end
+end
+
+def items from, to
+  (from..to).map do |n|
+    instance_variable_get :"@item_#{n}"
+  end
+end

data/spec/unit/pager_spec.rb

@@ -0,0 +1,220 @@
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe DataMapper::Pager do
+  before(:each) { mock_items }
+  
+  describe "#to_html" do
+    describe "when pages are available" do
+      it "should render a ul.pager wrapper" do
+        Item.page.pager.to_html('/').should match(/ul class="([^"]+)?"/)
+      end
+      
+      it "should render a ul containing intermediate items" do
+        Item.page.pager.to_html('/').should match(/<ul class="[^"]+?"><li/)
+      end
+      
+      it "should add the 'active' class to the current page link <li>" do
+        Item.page.pager.to_html('/').should include('li class="page-1 active"><a href="/?page=1"')
+        Item.page(2).pager.to_html('/').should include('li class="page-2 active"><a href="/?page=2"')
+        Item.page(3).pager.to_html('/').should include('li class="page-3 active"><a href="/?page=3"')
+      end
+      
+      it "should add li.last.jump" do
+        Item.page.pager.to_html('/').should include('<li class="last jump">')
+      end
+      
+      it "should add li.first.jump" do
+        Item.page(2).pager.to_html('/').should include('<li class="first jump"')
+      end
+      
+      it "should add li.next.jump" do
+        Item.page.pager.to_html('/').should include('<li class="next jump">')
+      end
+      
+      it "should add li.previous.jump" do
+        Item.page(2).pager.to_html('/').should include('<li class="previous jump">')
+      end
+    end
+    
+    describe "when one page is available" do
+      it "should render nothing" do
+        Item.all(:id.lt => 2).page.pager.to_html('/').should be_nil
+      end
+    end
+    
+    describe "when no pages are available" do
+      it "should render nothing" do
+        Item.all(:id.lt => 1).page.pager.to_html('/').should be_nil
+      end
+    end
+    
+    describe "when on the first page" do
+      it "should not render the 'Previous' page link" do
+        markup = Item.page.pager.to_html('/')
+        markup.should_not include('Previous')
+      end
+      
+      it "should render some intermediate page links with ... after" do
+        markup = Item.page.pager.to_html('/', :size => 3)
+        markup.should include('>1<')
+        markup.should include('>2<')
+        markup.should include('>3<')
+        markup.should_not include('>4<')
+        markup.should include(%(<li class="more">...</li>\n<li class="next jump"))
+      end
+      
+      it "should not render ... before" do
+        markup = Item.page.pager.to_html('/', :size => 3)
+        markup.should_not include('<a href="/?page=3" class="previous jump">Previous</a><li class="more">...</li>')
+      end
+      
+      it "should not render the 'First' page link" do
+        markup = Item.page.pager.to_html('/')
+        markup.should_not include('First')
+      end
+      
+      it "should render the 'Last' page link" do
+        markup = Item.page.pager.to_html('/')
+        markup.should include('Last')
+      end
+    end
+    
+    describe "with the :size option set" do
+      it "should raise an error when given an even number" do
+        lambda { Item.page.pager.to_html('/', :size => 2) }.should raise_error(ArgumentError, /must be an odd number/)
+      end
+      
+      it "should render only the specified number of intermediate page links" do
+        markup = Item.page.pager.to_html('/', :size => 3)
+        markup.should include('>1<')
+        markup.should include('>2<')
+        markup.should include('>3<')
+        markup.should_not include('>4<')
+      end
+    end
+    
+    [:first, :previous, :next, :last].each do |pos|
+      describe "with the #{pos.inspect} option set" do
+        it "should change the default contents for the '#{pos}' link" do
+          markup = Item.page(2, :per_page => 2).pager.to_html('/', :"#{pos}_text" => 'FOO')
+          markup.should include('>FOO<')
+        end
+      end
+    end
+    
+    describe "when on the last page" do
+      it "should not render the 'Next' page link" do
+        markup = Item.page(4).pager.to_html('/')
+        markup.should_not include('Next')
+      end
+      
+      it "should not render the 'Last' page link" do
+        markup = Item.page(4).pager.to_html('/')
+        markup.should_not include('Last')
+      end
+      
+      it "should render the 'First' page link" do
+        markup = Item.page(4).pager.to_html('/')
+        markup.should include('First')
+      end
+      
+      it "should render some intermediate page links with ... before" do
+        markup = Item.page(4).pager.to_html('/', :size => 3)
+        markup.should include(%(<li class="previous jump"><a href="/?page=3">Previous</a></li>\n<li class="more">...<))
+        markup.should_not include('>1<')
+        markup.should include('>2<')
+        markup.should include('>3<')
+        markup.should include('>4<')
+        markup.should_not include('>5<')
+      end
+      
+      it "should not render ... after" do
+        markup = Item.page(4).pager.to_html('/', :size => 3)
+        markup.should_not include(%(<li class="more">...</li>\n<a href="/?page=6" class="next jump"))
+      end
+    end
+    
+    describe "when on an intermediate page" do
+      it "should render the 'Previous' page link" do
+        markup = Item.page(2).pager.to_html('/')
+        markup.should include('Previous')
+      end
+      
+      it "should render the 'Next' page link" do
+        markup = Item.page(2).pager.to_html('/') 
+        markup.should include('Next')
+      end
+      
+      it "should render some intermediate page links with ... before and after" do
+        markup = Item.page(5, :per_page => 2).pager.to_html('/', :size => 3)
+        markup.should include(%(<li class="previous jump"><a href="/?page=4">Previous</a></li>\n<li class="more">...</li>))
+        markup.should_not include('>3<')
+        markup.should include('>4<')
+        markup.should include('>5<')
+        markup.should include('>6<')
+        markup.should_not include('>7<')
+        markup.should include(%(<li class="more">...</li>\n<li class="next jump"))
+      end
+      
+      it "should render the 'Last' page link" do
+        markup = Item.page(2).pager.to_html('/')
+        markup.should include('Last')
+      end
+      
+      it "should render the 'First' page link" do
+        markup = Item.page(2).pager.to_html('/')
+        markup.should include('First')
+      end
+    end
+    
+    describe "when on the second page" do
+      it "should render 1 through 3 when :size is 3 followed by ..." do
+        markup = Item.page(2, :per_page => 2).pager.to_html('/', :size => 3)
+        markup.should_not include('<ul><li class="more">...<')
+        markup.should include('>1<')
+        markup.should include('>2<')
+        markup.should include('>3<')
+        markup.should_not include('>4<')
+        markup.should include(%(<li class="more">...</li>\n<li class="next jump"))
+      end
+    end
+    
+    describe "when on the second last page" do
+      it "should render 8 through 10 when :size is 3 with preceding ..." do
+        markup = Item.page(9, :per_page => 2).pager.to_html('/', :size => 3)
+        markup.should include(%(<li class="previous jump"><a href="/?page=8">Previous</a></li>\n<li class="more">...<))
+        markup.should_not include('>7<')
+        markup.should include('>8<')
+        markup.should include('>9<')
+        markup.should include('>10<')
+        markup.should_not include('>11<')
+        markup.should_not include(%(<li class="more">...</li>\n<li class="next jump"))
+      end
+    end
+    
+    describe "when passing a uri without a query string" do
+      it "should append a query string to each uri" do
+        markup = Item.page.pager.to_html 'items'
+        markup.should include('items?page=1')
+      end
+    end
+    
+    describe "when passing a uri with a query string" do
+      describe "containing page=N" do
+        it "should alter the page value" do
+          markup = Item.page.pager.to_html 'items?page=2'
+          markup.should include('items?page=1')
+        end
+      end
+      
+      describe "not containing page=N" do
+        it "should append a pair" do
+          markup = Item.page.pager.to_html 'items?foo=bar'
+          markup.should include('items?foo=bar&page=1')
+        end
+      end
+    end
+    
+  end
+end

data/spec/unit/pagination_spec.rb

@@ -0,0 +1,141 @@
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe DataMapper::Pagination do
+  before(:each) { mock_items }
+  
+  describe "#page" do
+    describe "given the page" do
+      it "return the appropriately sized collection" do
+        Item.page(1, :order => [:id.asc]).should == items(1, 6)
+        Item.page(2, :order => [:id.asc]).should == items(7, 12)
+        Item.page(3, :order => [:id.asc]).should == items(13, 18)
+      end
+    
+      describe "number" do
+        it "should default to the first page" do
+          Item.page.pager.current_page.should == 1
+        end
+      end
+      
+      describe "nil" do
+        it "should default to the first page" do
+          Item.page(nil).pager.current_page.should == 1
+        end
+      end
+      
+      describe "number below 1" do
+        it "should default to the first page" do
+          Item.page(0).pager.current_page.should == 1
+          Item.page(-1).pager.current_page.should == 1
+        end
+      end
+      
+      describe "string" do
+        it "should be coerced to ints" do
+          Item.page('5').pager.current_page.should == 5
+          Item.page('5.0').pager.current_page.should == 5
+          Item.page('-1').pager.current_page.should == 1
+        end
+        
+        describe "which is not numeric" do
+          it "should default to the first page" do
+            Item.page('wahoo').pager.current_page.should == 1
+          end
+        end
+      end
+      
+      describe "of an arbitrary object" do
+        it "should raise an error unless responding to #to_i" do
+          lambda { Item.page(true) }.should raise_error
+        end
+      end
+    end
+
+    describe "options hash" do
+      it "should be accepted as first param" do
+        Item.page(:page => 2, :order => [:id.asc]).pager.current_page.should == 2
+      end
+      
+      it "should be accepted as second param" do
+        Item.page(3, :page => 2, :order => [:id.asc]).pager.current_page.should == 3
+      end
+    end
+    
+    describe "option" do
+      describe ":per_page" do
+        it "should default to 6" do
+          Item.page.length.should == 6
+        end
+        
+        it "should be allow an alternate value" do
+          Item.page(1, :per_page => 3, :order => [:id.asc]).should == items(1, 3)
+          Item.page(2, :per_page => 3, :order => [:id.asc]).should == items(4, 6)
+          Item.page(3, :per_page => 3, :order => [:id.asc]).should == items(7, 9)
+        end
+        
+        it "should allow numeric strings" do
+          Item.page(1, :per_page => '3', :order => [:id.asc]).should == items(1, 3)
+          Item.page(2, :per_page => '3', :order => [:id.asc]).should == items(4, 6)
+          Item.page(3, :per_page => '3', :order => [:id.asc]).should == items(7, 9)
+          Item.page(3, :per_page => '3', :order => [:id.asc]).pager.per_page.should == 3
+        end
+        
+        it "should delete keys when an indifferent hash is passed" do
+          Item.page(1, 'per_page' => '3', :order => [:id.asc]).should == items(1, 3)
+          Item.page(2, 'per_page' => '3', :order => [:id.asc]).should == items(4, 6)
+          Item.page(3, 'per_page' => '3', :order => [:id.asc]).should == items(7, 9)
+          Item.page(3, 'per_page' => '3', :order => [:id.asc]).pager.per_page.should == 3
+        end
+      end
+      
+      describe ":order" do
+        it "should default to [:id.desc]" do
+          Item.page.should == items(15, 20).reverse
+        end
+      end
+      
+      describe ":page" do
+        it "should raise an error unless responding to #to_i" do
+          lambda { Item.page(:page => true) }.should raise_error
+          lambda { Item.page('page' => true) }.should raise_error
+        end
+        
+         it "should delete keys when an indifferent hash is passed" do
+           Item.page(:page => '2', 'page' => '2', :order => [:id.asc]).should == items(7, 12)
+           Item.page(:page => '2', 'page' => '2', :order => [:id.asc]).pager.current_page.should == 2
+        end
+      end
+    end
+  end
+  
+  describe "#pager" do
+    describe "#total" do
+      it "should be assigned when paging" do
+        Item.all.page.length.should == 6
+        Item.all.page.pager.total.should == 20
+      end
+    end
+    
+    describe "#per_page" do
+      it "should be assigned when paging" do
+        Item.all.page.pager.per_page.should == 6
+      end
+    end
+    
+    describe "#current_page" do
+      it "should be assigned when paging" do
+        Item.all.page.pager.current_page.should == 1
+        Item.all.page(3).pager.current_page.should == 3
+      end
+    end
+    
+    describe "#total_pages" do
+      it "should be assigned when paging" do
+        Item.all.page.pager.total_pages.should == 4
+        Item.all.page(:per_page => 3).pager.total_pages.should == 7
+        Item.all.page(:per_page => 2).pager.total_pages.should == 10
+      end
+    end
+  end
+end

data/tasks/docs.rake

@@ -0,0 +1,13 @@
+
+namespace :docs do
+  
+  desc 'Remove rdoc products'
+  task :remove => [:clobber_docs]
+  
+  desc 'Build docs, and open in browser for viewing (specify BROWSER)'
+  task :open do
+    browser = ENV["BROWSER"] || "safari"
+    sh "open -a #{browser} doc/index.html"
+  end
+  
+end

data/tasks/gemspec.rake

@@ -0,0 +1,3 @@
+
+desc 'Build gemspec file'
+task :gemspec => [:build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,25 @@
+
+require 'spec/rake/spectask'
+  
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << "lib"
+  t.spec_opts = ["--color", "--require", "spec/spec_helper.rb"]
+end
+  
+namespace :spec do
+
+  desc "Run all specifications verbosely"
+  Spec::Rake::SpecTask.new(:verbose) do |t|
+    t.libs << "lib"
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+  desc "Run specific specification verbosely (specify SPEC)"
+  Spec::Rake::SpecTask.new(:select) do |t|
+    t.libs << "lib"
+    t.spec_files = [ENV["SPEC"]]
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: dm-pager
+version: !ruby/object:Gem::Version 
+  version: 0.0.7
+platform: ruby
+authors: 
+- TJ Holowaychuk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-10 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: dm-aggregates
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.1
+    version: 
+description: DataMapper Pagination
+email: tj@vision-media.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/dm-pager.rb
+- lib/dm-pager/defaults.rb
+- lib/dm-pager/helpers.rb
+- lib/dm-pager/helpers/rails.rb
+- lib/dm-pager/pager.rb
+- lib/dm-pager/pagination.rb
+- lib/dm-pager/version.rb
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+files: 
+- History.md
+- Manifest
+- Rakefile
+- Readme.md
+- examples/pager.rb
+- lib/dm-pager.rb
+- lib/dm-pager/defaults.rb
+- lib/dm-pager/helpers.rb
+- lib/dm-pager/helpers/rails.rb
+- lib/dm-pager/pager.rb
+- lib/dm-pager/pagination.rb
+- lib/dm-pager/version.rb
+- spec/integration/rails_helper_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/unit/pager_spec.rb
+- spec/unit/pagination_spec.rb
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+- dm-pager.gemspec
+has_rdoc: true
+homepage: http://github.com/visionmedia/dm-pagination
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Dm-pager
+- --main
+- Readme.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: dm-pager
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: DataMapper Pagination
+test_files: []
+