paginate 0.1.0

data/README.rdoc

@@ -0,0 +1,78 @@
+= Paginate
+
+Paginate collections using SIZE+1 to determine if there is a next page. Includes ActiveRecord and ActionView support.
+
+== Install
+
+  sudo gem install paginate
+
+== Usage
+
+You can use Paginate with or without ActiveRecord. Let's try a simple array pagination. Imagine that you have something like this in your controller.
+
+  @things = Array.new(11) {|i| "Item #{i}"}
+
+Then on your view:
+
+  <%= paginate @things %>
+
+That's it! This is all you have to do! In this case we're using the default page size (which is 10).
+The url used on page links is taken from the current requested uri.
+
+You can set default values globally:
+
+  Paginate.setup do |config|
+    config.size = 20
+    config.param_name = :p
+  end
+
+More examples:
+
+  Post.paginate(1)                               # page 1 from Post model
+  Post.paginate(:page => 1)                      # page 1 from Post model
+  Post.paginate(:page => 1, :size => 5)          # page 1 from Post model with custom size
+  @user.things.paginate(:page => params[:page])  # paginate association
+
+  <%= paginate @things, :size => 5 %>
+  <%= paginate @things, :url => proc {|page| things_path(:page => page) } %>
+  <%= paginate @things, "/some/path" %>
+  <%= paginate @things, :param_name => :p %>
+
+To iterate the collection, you must use a helper called <tt>iterate</tt>. This is required cause we're always considering SIZE + 1, so if you use the regular +each+ you end up rendering one additional item.
+
+  <% iterate @things do |thing| %>
+  <% end %>
+
+If you want the iteration index, you can expect it as a second block parameter.
+
+  <% iterate @things do |thing, i| %>
+  <% end %>
+
+And if you're using some custom page size, you have to specify it as well.
+
+  <% iterate @things, :size => 5 do |thing| %>
+  <% end %>
+
+== I18n support
+
+If you want to translate links, you have implement the following scopes:
+
+  en:
+    paginate:
+      next: "Older"
+      previous: "Newer"
+      page: "Page {{page}}"
+
+== License
+
+(The MIT License)
+
+Copyright © 2010:
+
+* Nando Vieira - http://simplesideias.com.br
+
+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.

data/Rakefile

@@ -0,0 +1,22 @@
+require "rake/testtask"
+require "jeweler"
+require "lib/paginate/version"
+
+Rake::TestTask.new do |t|
+  t.libs += %w[ test lib ]
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+  t.ruby_opts = %w[ -rubygems ]
+end
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "paginate"
+  gem.version = Paginate::Version::STRING
+  gem.summary = "Paginate collections using SIZE+1 to determine if there is a next page. Includes ActiveRecord and ActionView support."
+  gem.email = "fnando.vieira@gmail.com"
+  gem.homepage = "http://github.com/fnando/paginate"
+  gem.authors = ["Nando Vieira"]
+  gem.files = FileList["lib/**/*", "Rakefile", "README.rdoc"]
+end
+
+Jeweler::GemcutterTasks.new

data/lib/paginate.rb

@@ -0,0 +1,20 @@
+require "i18n"
+require "paginate/base"
+require "paginate/config"
+require "paginate/helper"
+require "paginate/renderer"
+require "paginate/active_record"
+require "paginate/action_controller"
+
+I18n.load_path += Dir[File.dirname(__FILE__) + "/paginate/locales/**/*.yml"]
+
+module Paginate
+  def self.setup(&block)
+    yield Config
+  end
+end
+
+Paginate.setup do |config|
+  config.param_name = :page
+  config.size  = 10
+end

data/lib/paginate/action_controller.rb

@@ -0,0 +1 @@
+ActionController::Base.helper Paginate::Helper if defined?(ActionController::Base)

data/lib/paginate/active_record.rb

@@ -0,0 +1 @@
+require "paginate/active_record/ext" if defined?(ActiveRecord)

data/lib/paginate/active_record/ext.rb

@@ -0,0 +1,17 @@
+class ActiveRecord::Base
+  class << self
+    alias_method :original_inherited, :inherited
+  end
+
+  def self.inherited(child)
+    original_inherited(child)
+
+    child.class_eval do
+      if Rails.version >= "3.0"
+        scope :paginate, proc {|*args| Paginate::Base.new(*args).to_options }
+      else
+        named_scope :paginate, proc {|*args| Paginate::Base.new(*args).to_options }
+      end
+    end
+  end
+end

data/lib/paginate/base.rb

@@ -0,0 +1,43 @@
+module Paginate
+  class Base
+    attr_accessor :options
+
+    def initialize(options = {})
+      if options.kind_of?(Hash)
+        @options = options
+      else
+        @options = {:page => options.to_i}
+      end
+
+      @options.reverse_merge!(Paginate::Config.to_hash)
+    end
+
+    def collection_size
+      @collection_size ||= options[:collection].size
+    end
+
+    def next_page?
+      collection_size > options[:size]
+    end
+
+    def previous_page?
+      options[:page] > 1
+    end
+
+    def page
+      [1, options.fetch(:page, 1).to_i].max
+    end
+
+    def offset
+      (page - 1) * limit
+    end
+
+    def limit
+      [options[:size], 10].compact.first.to_i + 1
+    end
+
+    def to_options
+      { :limit => limit, :offset => offset }
+    end
+  end
+end

data/lib/paginate/config.rb

@@ -0,0 +1,15 @@
+module Paginate
+  class Config
+    class << self
+      attr_accessor :size
+      attr_accessor :param_name
+    end
+
+    def self.to_hash
+      {
+        :size => size,
+        :param_name => param_name
+      }
+    end
+  end
+end

data/lib/paginate/helper.rb

@@ -0,0 +1,70 @@
+module Paginate
+  module Helper
+    # Display pagination based on the collection and current page.
+    #
+    #   <%= paginate @posts %>
+    #   <%= paginate @posts, options %>
+    #   <%= paginate @posts, posts_path, options %>
+    #
+    # The available options are:
+    #
+    # * <tt>:url</tt>: the URL which page numbers will be appended to. Can be proc or string.
+    # * <tt>:id</tt>: the HTML id that will identify the pagination block.
+    # * <tt>:size</tt>: the page size. When not specified will default to <tt>Paginate::Config.size</tt>.
+    # * <tt>:param_name</tt>: the page param name. When not specified will default to <tt>Paginate::Config.param_name</tt>.
+    #
+    #   <%= paginate @posts, proc {|page| posts_path(page) }
+    #   <%= paginate @posts, :url => proc {|page| posts_path(page) }
+    #
+    # You don't have to specify the URL; the current requested URI will be used if you don't provide it.
+    #
+    def paginate(collection, *args)
+      options = args.extract_options!
+      param_name = [options[:param_name], Paginate::Config.param_name, :page].compact.first
+      options.merge!({
+        :collection => collection,
+        :page => params[param_name],
+        :param_name => param_name,
+        :fullpath => request.respond_to?(:fullpath) ? request.fullpath : request.request_uri
+      })
+      options.merge!(:url => args.first) if args.any?
+
+      Paginate::Renderer.new(options).render
+    end
+
+    # In order to iterate the correct items you have to skip the latest collection's item.
+    # We added this helper to automatically skip the latest item only if there's a next page,
+    # which means that we have an extra item.
+    #
+    #   <% iterate @items do |item| %>
+    #   <% end %>
+    #
+    # If you want to grab the iteration index as well just expect it as a block parameter.
+    #
+    #   <% iterate @items do |item, i|
+    #   <% end %>
+    #
+    #
+    # If you set a custom size while fetching items from database, you need to inform it while iterating.
+    #
+    #   @items = Item.paginate(:page => 1, :size => 5)
+    #
+    # Then in your view:
+    #
+    #   <% iterate @items, :size => 5 do |item| %>
+    #   <% end %>
+    #
+    def iterate(collection, options = {}, &block)
+      options.reverse_merge!(:size => Paginate::Config.size)
+      block_arity = block.arity
+
+      collection[0, options[:size]].each_with_index do |item, i|
+        if block_arity == 1
+          yield item
+        else
+          yield item, i
+        end
+      end
+    end
+  end
+end

data/lib/paginate/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  paginate:
+    next: "Next page"
+    previous: "Previous page"
+    page: "Page {{page}}"

data/lib/paginate/locales/pt.yml

@@ -0,0 +1,8 @@
+pt: &pt
+  paginate:
+    next: "Próxima página"
+    previous: "Página anterior"
+    page: "Página {{page}}"
+
+pt-BR:
+  <<: *pt

data/lib/paginate/renderer.rb

@@ -0,0 +1,73 @@
+module Paginate
+  class Renderer
+    attr_accessor :options
+    attr_accessor :current_page
+
+    def initialize(options)
+      @current_page = [options[:page].to_i, 1].max
+      options.reverse_merge!(Paginate::Config.to_hash)
+      @options = options.merge(:page => current_page)
+    end
+
+    def processor
+      @processor ||= Paginate::Base.new(options)
+    end
+
+    def url_for(page)
+      url = options[:url] || options[:fullpath]
+
+      if url.kind_of?(Proc)
+        url[page]
+      else
+        re = Regexp.new("([&?])#{Regexp.escape(options[:param_name].to_s)}=[0-9]+")
+        url.gsub!(re, "\\1")
+        url.gsub!(/\?$/, "")
+        url.gsub!(/\?&/, "?")
+        url = URI.parse(url).to_s
+
+        connector = (url =~ /\?/) ? "&" : "?"
+
+        url + connector + page.to_s.to_query(options[:param_name])
+      end
+    end
+
+    def render
+      html = String.new
+      previous_label = I18n.t("paginate.previous")
+      previous_url = url_for(options[:page] - 1)
+      next_label = I18n.t("paginate.next")
+      next_url = url_for(options[:page] + 1)
+      page_label = I18n.t("paginate.page", options)
+
+      css = %w[ paginate ]
+      css << "disabled" unless processor.previous_page? || processor.next_page?
+
+      html << %[<ul class="#{css.join(" ")}">]
+
+      # Previous page
+      if processor.previous_page?
+        html << %[<li><a class="previous-page" href="#{previous_url}" title="#{previous_label}">#{previous_label}</a></li>]
+      else
+        html << %[<li><span class="previous-page disabled" title="#{previous_label}">#{previous_label}</span></li>]
+      end
+
+      # Current page
+      html << %[<li><span class="page">#{page_label}</span></li>]
+
+      # Next page
+      if processor.next_page?
+        html << %[<li><a class="next-page" href="#{next_url}" title="#{next_label}">#{next_label}</a></li>]
+      else
+        html << %[<li><span class="next-page disabled" title="#{next_label}">#{next_label}</span></li>]
+      end
+
+      html << %[</ul>]
+
+      if html.respond_to?(:html_safe)
+        html.html_safe
+      else
+        html
+      end
+    end
+  end
+end

data/lib/paginate/version.rb

@@ -0,0 +1,8 @@
+module Paginate
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/test/paginate/action_view_test.rb

@@ -0,0 +1,150 @@
+require "test_helper"
+
+class ActionViewTest < Test::Unit::TestCase
+  def setup
+    @request = OpenStruct.new
+    @params = Hash.new
+
+    @controller = ThingsController.new
+    @controller.params = @params
+
+    @view = ActionView::Base.new
+    @view.controller = @controller
+    @view.extend(Paginate::Helper)
+    @view.stubs(:request).returns(@request)
+
+    @helper = Object.new
+    @helper.extend(Paginate::Helper)
+
+    Paginate.setup do |config|
+      config.param_name = :page
+      config.size  = 10
+    end
+
+    I18n.locale = :en
+  end
+
+  def test_display_pagination_list
+    @request.fullpath = "/some/path?page=1"
+    html = render(:default, [])
+
+    assert_equal 1, html.css("ul.paginate").count
+    assert_equal 3, html.css("ul.paginate > li").count
+  end
+
+  def test_disabled
+    @request.fullpath = "/some/path"
+    html = render(:default, [])
+
+    assert_not_nil html.css("ul.paginate.disabled").first
+  end
+
+  def test_display_next_page_link
+    @request.fullpath = "/some/path?page=1"
+    html = render(:default, Array.new(11))
+    link = html.css("li > a.next-page").first
+
+    assert_not_nil link
+    assert_equal "/some/path?page=2", link["href"]
+    assert_equal "Next page", link.text
+  end
+
+  def test_display_next_page_link_from_block
+    @request.fullpath = "/some/path?page=1"
+    html = render(:block_as_url, Array.new(11))
+    link = html.css("li > a.next-page").first
+
+    assert_not_nil link
+    assert_equal "/some/path/2", link["href"]
+    assert_equal "Next page", link.text
+  end
+
+  def test_display_previous_page_link
+    @params[:page] = 2
+    @request.fullpath = "/some/path?page=2"
+    html = render(:default, Array.new(11))
+    link = html.css("li > a.previous-page").first
+
+    assert_not_nil link
+    assert_equal "/some/path?page=1", link["href"]
+    assert_equal "Previous page", link.text
+  end
+
+  def test_display_next_page_as_disabled
+    @request.fullpath = "/some/path?page=1"
+    html = render(:default, Array.new(10))
+    link = html.css("li > a.next-page").first
+    span = html.css("li > span.next-page.disabled").first
+
+    assert_nil link
+    assert_not_nil span
+    assert_equal "Next page", span.text
+  end
+
+  def test_display_previous_page_as_disabled
+    @request.fullpath = "/some/path?page=1"
+    html = render(:default, Array.new(10))
+    link = html.css("li > a.previous-page").first
+    span = html.css("li > span.previous-page.disabled").first
+
+    assert_nil link
+    assert_not_nil span
+    assert_equal "Previous page", span.text
+  end
+
+  def test_display_current_page
+    @params[:page] = 10
+    @request.fullpath = "/some/path?page=10"
+    html = render(:default, [])
+    span = html.css("li > span.page").first
+
+    assert_not_nil span
+    assert_equal "Page 10", span.text
+  end
+
+  def test_translate_strings
+    I18n.locale = :pt
+
+    @params[:page] = 10
+    @request.fullpath = "/some/path?page=10"
+    html = render(:default, Array.new(11))
+
+    assert_equal "Página 10", html.css("span.page").text
+    assert_equal "Próxima página", html.css("a.next-page").text
+    assert_equal "Página anterior", html.css("a.previous-page").text
+  end
+
+  def test_iterate
+    values = []
+    items = Array.new(11) {|i| "User#{i}" }
+
+    @helper.iterate items do |item|
+      values << item
+    end
+
+    assert_equal items[0, 10], values
+  end
+
+  def test_iterate_with_index
+    values = []
+    indices = []
+    items = Array.new(11) {|i| "User#{i}" }
+
+    @helper.iterate items do |item, i|
+      values << item
+      indices << i
+    end
+
+    assert_equal items[0, 10], values
+    assert_equal (0...10).to_a, indices
+  end
+
+  private
+  def render(view_name, items)
+    Nokogiri @view.render(:inline => load_view(view_name), :locals => {:items => items})
+  end
+
+  def load_view(name)
+    File.read(File.dirname(__FILE__) + "/../resources/views/#{name}.erb")
+  end
+end

data/test/paginate/active_record_test.rb

@@ -0,0 +1,28 @@
+require "test_helper"
+
+class ActiveRecordTest < Test::Unit::TestCase
+  def setup
+    15.times {|i| Thing.create(:name => "Thing #{i}") }
+    Paginate::Config.size = 10
+  end
+
+  def test_respond_to_paginate_method
+    assert_respond_to Thing, :paginate
+  end
+
+  def test_paginate_with_defaults
+    things = Thing.all(:limit => 11)
+    assert_equal things, Thing.paginate.all
+
+    things = Thing.all(:limit => 11, :offset => 11)
+    assert_equal things, Thing.paginate(:page => 2).all
+  end
+
+  def test_paginate_with_options
+    things = Thing.all(:limit => 6)
+    assert_equal things, Thing.paginate(:size => 5)
+
+    things = Thing.all(:limit => 6, :offset => 6)
+    assert_equal things, Thing.paginate(:size => 5, :page => 2)
+  end
+end

data/test/paginate/base_test.rb

@@ -0,0 +1,84 @@
+require "test_helper"
+
+class BaseTest < Test::Unit::TestCase
+  def test_page_from_integer
+    @base = Paginate::Base.new(12)
+    assert_equal 12, @base.page
+  end
+
+  def test_page_from_string
+    @base = Paginate::Base.new("12")
+    assert_equal 12, @base.page
+  end
+
+  def test_default_page_value
+    @base = Paginate::Base.new
+    assert_equal 1, @base.page
+  end
+
+  def test_page
+    @base = Paginate::Base.new(:page => 0)
+    assert_equal 1, @base.page
+  end
+
+  def test_limit_from_config
+    Paginate::Config.size = 25
+    @base = Paginate::Base.new
+
+    assert_equal 26, @base.limit
+  end
+
+  def test_limit_from_options
+    Paginate::Config.size = 25
+    @base = Paginate::Base.new(:size => 13)
+
+    assert_equal 14, @base.limit
+  end
+
+  def test_default_limit
+    Paginate::Config.size = nil
+    @base = Paginate::Base.new
+
+    assert_equal 11, @base.limit
+  end
+
+  def test_offset_from_config
+    Paginate::Config.size = 15
+    @base = Paginate::Base.new(:page => 2)
+
+    assert_equal 16, @base.offset
+  end
+
+  def test_offset_from_options
+    @base = Paginate::Base.new(:page => 2, :size => 5)
+
+    assert_equal 6, @base.offset
+  end
+
+  def test_return_finder_options
+    @base = Paginate::Base.new(:page => 3, :size => 5)
+
+    options = {:limit => 6, :offset => 12}
+    assert_equal options, @base.to_options
+  end
+
+  def test_next_page
+    @base = Paginate::Base.new(:page => 1, :size => 5, :collection => Array.new(6))
+    assert @base.next_page?
+  end
+
+  def test_no_next_page
+    @base = Paginate::Base.new(:page => 1, :size => 5, :collection => Array.new(5))
+    assert !@base.next_page?
+  end
+
+  def test_previous_page
+    @base = Paginate::Base.new(:page => 2)
+    assert @base.previous_page?
+  end
+
+  def test_no_previous_page
+    @base = Paginate::Base.new(:page => 1)
+    assert !@base.previous_page?
+  end
+end

data/test/paginate/config_test.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+
+class ConfigTest < Test::Unit::TestCase
+  def test_yield_configuration_class
+    Paginate.setup do |config|
+      config.param_name = :p
+      config.size  = 50
+    end
+
+    assert_equal :p, Paginate::Config.param_name
+    assert_equal 50, Paginate::Config.size
+  end
+
+  def test_return_config_as_hash
+    Paginate.setup do |config|
+      config.param_name = :p
+      config.size = 25
+    end
+
+    options = {:param_name => :p, :size => 25}
+    assert_equal options, Paginate::Config.to_hash
+  end
+end

data/test/paginate/renderer_test.rb

@@ -0,0 +1,36 @@
+require "test_helper"
+
+class RendererTest < Test::Unit::TestCase
+  def setup
+    Paginate.setup do |config|
+      config.param_name = :page
+      config.size  = 10
+    end
+
+    I18n.locale = :en
+
+    @renderer = Paginate::Renderer.new({
+      :collection => Array.new(11),
+      :page => 1,
+      :fullpath => "/some/path"
+    })
+  end
+
+  def test_safe_html
+    string = String.new
+    string.expects(:respond_to?).with(:html_safe).returns(true)
+    string.expects(:html_safe)
+    String.expects(:new).returns(string)
+
+    @renderer.render
+  end
+
+  def test_no_safe_html
+    string = String.new
+    string.expects(:respond_to?).with(:html_safe).returns(false)
+    string.expects(:html_safe).never
+    String.expects(:new).returns(string)
+
+    @renderer.render
+  end
+end

data/test/resources/controller.rb

@@ -0,0 +1,3 @@
+class ThingsController < ActionController::Base
+
+end

data/test/resources/model.rb

@@ -0,0 +1,2 @@
+class Thing < ActiveRecord::Base
+end

data/test/resources/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :things do |t|
+    t.string :name
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+gem "test-unit"
+
+require "test/unit"
+require "mocha"
+require "nokogiri"
+require "ostruct"
+require "active_support/all"
+require "active_record"
+require "action_view"
+require "action_controller"
+require "sqlite3"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+Rails = OpenStruct.new(:version => ActiveRecord::VERSION::STRING)
+
+require "paginate"
+
+load "resources/schema.rb"
+require "resources/model"
+require "resources/controller"

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: paginate
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-04 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: 
+email: fnando.vieira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/paginate.rb
+- lib/paginate/action_controller.rb
+- lib/paginate/active_record.rb
+- lib/paginate/active_record/ext.rb
+- lib/paginate/base.rb
+- lib/paginate/config.rb
+- lib/paginate/helper.rb
+- lib/paginate/locales/en.yml
+- lib/paginate/locales/pt.yml
+- lib/paginate/renderer.rb
+- lib/paginate/version.rb
+has_rdoc: true
+homepage: http://github.com/fnando/paginate
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Paginate collections using SIZE+1 to determine if there is a next page. Includes ActiveRecord and ActionView support.
+test_files: 
+- test/paginate/action_view_test.rb
+- test/paginate/active_record_test.rb
+- test/paginate/base_test.rb
+- test/paginate/config_test.rb
+- test/paginate/renderer_test.rb
+- test/resources/controller.rb
+- test/resources/model.rb
+- test/resources/schema.rb
+- test/test_helper.rb