paginary 0.0.1.pre1

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+*.sqlite3
+*.log
+test/dummy/tmp/**/*

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+gem "paginary", :path => File.dirname(__FILE__)
+gem "rails", "3.0.1"
+gem "rake"
+gem "jeweler"
+
+platforms :ruby do
+  gem "sqlite3-ruby"
+end
+
+platforms :jruby do
+  gem "jdbc-sqlite3", :require => "jdbc/sqlite3"
+  gem "activerecord-jdbc-adapter", "1.0.0.beta2"
+  gem "jruby-openssl", :require => false # Silence openssl warnings.
+end

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    paginary (0.0.1.pre1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.1)
+      actionpack (= 3.0.1)
+      mail (~> 2.2.5)
+    actionpack (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+    activesupport (3.0.1)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    i18n (0.4.1)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    mail (2.2.7)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.1)
+      actionmailer (= 3.0.1)
+      actionpack (= 3.0.1)
+      activerecord (= 3.0.1)
+      activeresource (= 3.0.1)
+      activesupport (= 3.0.1)
+      bundler (~> 1.0.0)
+      railties (= 3.0.1)
+    railties (3.0.1)
+      actionpack (= 3.0.1)
+      activesupport (= 3.0.1)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    sqlite3-ruby (1.3.1)
+    thor (0.14.3)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-jdbc-adapter (= 1.0.0.beta2)
+  jdbc-sqlite3
+  jeweler
+  jruby-openssl
+  paginary!
+  rails (= 3.0.1)
+  rake
+  sqlite3-ruby

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Voormedia B.V.
+
+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/README.md

@@ -0,0 +1,7 @@
+Paginary – View-based pagination for Rails
+==========================================
+
+Paginary is a simple plugin for Rails 3 that allows you to paginate in your
+views only. No need to touch your models or controllers.
+
+Paginary is currently in alpha status.

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require "jeweler"
+require "rake/testtask"
+
+Jeweler::Tasks.new do |spec|
+  spec.name = "paginary"
+  spec.rubyforge_project = "paginary"
+  spec.summary = "View-based pagination for Rails."
+  spec.description = "Simple, view-based pagination for Rails, built on top of Active Record 3 awesomeness."
+
+  spec.authors = ["Rolf Timmermans"]
+  spec.email = "r.timmermans@voormedia.com"
+  spec.homepage = "http://rails-erd.rubyforge.org/"
+
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "sqlite3-ruby"
+end
+
+Jeweler::GemcutterTasks.new
+
+Jeweler::RubyforgeTasks.new do |rubyforge|
+  rubyforge.doc_task = "rdoc"
+  rubyforge.remote_doc_path = "doc"
+end
+
+Rake::TestTask.new do |test|
+  test.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test
+
+begin
+  require "hanna/rdoctask"
+  Rake::RDocTask.new do |rdoc|
+  end
+rescue LoadError
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1.pre1

data/lib/paginary.rb

@@ -0,0 +1,7 @@
+require "paginary/helpers/page_builder"
+require "paginary/helpers/pagination_helper"
+
+require "paginary/relation/paginated"
+require "paginary/relation/query_methods"
+
+require "paginary/railtie"

data/lib/paginary/helpers/page_builder.rb

@@ -0,0 +1,57 @@
+module Paginary
+  module Helpers
+    class PageBuilder
+      attr_reader :template, :relation
+      alias_method :items, :relation
+      
+      delegate :content_tag, :link_to, :params, :translate, :to => :template
+      
+      def initialize(template, relation, options = {})
+        @template = template
+        @param_name = options.delete(:param) || :page
+        @relation = relation.paginated? ? relation : relation.paginate(params[@param_name], options)
+      end
+      
+      def page_url(page)
+        template.url_for params.merge(@param_name => page)
+      end
+
+      def previous_url
+        page_url @relation.current_page - 1
+      end
+      
+      def next_url
+        page_url @relation.current_page + 1
+      end
+      
+      def links
+        return unless @relation.paginated?
+        content_tag :div, previous_link + page_links + next_link, :class => "pagination"
+      end
+
+      def page_links
+        (1..@relation.page_count).collect do |page|
+          link_to content_tag(:span, page), page_url(page), :class => "page#{@relation.current_page == page ? " selected" : ""}"
+        end.inject(:+)
+      end
+
+      def previous_link
+        text = content_tag(:span, translate("previous", :default => "< Previous"))
+        unless @relation.first_page?
+          link_to text, previous_url, :class => "previous"
+        else
+          content_tag :span, text, :class => "previous disabled"
+        end
+      end
+
+      def next_link
+        text = content_tag(:span, translate("previous", :default => "Next >"))
+        unless @relation.last_page?
+          link_to text, next_url, :class => "next"
+        else
+          content_tag :span, text, :class => "next disabled"
+        end
+      end
+    end
+  end
+end

data/lib/paginary/helpers/pagination_helper.rb

@@ -0,0 +1,9 @@
+module Paginary
+  module Helpers
+    module PaginationHelper
+      def paginate(relation, *args, &block)
+        capture(PageBuilder.new(self, relation, *args), &block)
+      end
+    end
+  end
+end

data/lib/paginary/railtie.rb

@@ -0,0 +1,16 @@
+module Paginary
+  class Railtie < Rails::Railtie
+    initializer "paginary.query_methods" do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Relation.send :include, Paginary::Relation::QueryMethods
+        ActiveRecord::Base.singleton_class.delegate :paginate, :paginated?, :to => :scoped
+      end
+    end
+    
+    initializer "paginary.pagination_helper" do
+      ActiveSupport.on_load(:action_view) do
+        ActionView::Base.send :include, Paginary::Helpers::PaginationHelper
+      end
+    end
+  end
+end

data/lib/paginary/relation/paginated.rb

@@ -0,0 +1,43 @@
+require "active_support/core_ext/array/extract_options"
+
+module Paginary
+  module Relation
+    module Paginated
+      attr_accessor :items_per_page, :current_page
+    
+      def paginate!(*args)
+        options = args.extract_options!
+        self.items_per_page = options[:per_page] || 50
+        self.current_page   = args.first ? args.first.to_i : 1
+        self.limit_value    = items_per_page
+        self.offset_value   = items_per_page * (current_page - 1)
+      end
+      
+      def current_page=(page)
+        raise ActiveRecord::RecordNotFound, "page #{page} out of bounds, expected 1..#{page_count}" unless page.between?(1, page_count)
+        @current_page = page
+      end
+
+      def paginated?
+        page_count > 1
+      end
+    
+      def page_count
+        # Integer arithmetic is simpler and faster.
+        @page_count ||= item_count > 0 ? (item_count - 1) / items_per_page + 1 : 1
+      end
+
+      def item_count
+        @item_count ||= except(:includes, :limit, :offset).count
+      end
+      
+      def first_page?
+        current_page == 1
+      end
+      
+      def last_page?
+        current_page == page_count
+      end
+    end
+  end
+end

data/lib/paginary/relation/query_methods.rb

@@ -0,0 +1,15 @@
+module Paginary
+  module Relation
+    module QueryMethods
+      def paginate(*args)
+        clone.extending(Paginated).tap do |relation|
+          relation.paginate!(*args)
+        end
+      end
+
+      def paginated?
+        false
+      end
+    end
+  end
+end

data/paginary.gemspec

@@ -0,0 +1,96 @@
+# Generated by jeweler
+# 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{paginary}
+  s.version = "0.0.1.pre1"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rolf Timmermans"]
+  s.date = %q{2010-10-20}
+  s.description = %q{Simple, view-based pagination for Rails, built on top of Active Record 3 awesomeness.}
+  s.email = %q{r.timmermans@voormedia.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/paginary.rb",
+     "lib/paginary/helpers/page_builder.rb",
+     "lib/paginary/helpers/pagination_helper.rb",
+     "lib/paginary/railtie.rb",
+     "lib/paginary/relation/paginated.rb",
+     "lib/paginary/relation/query_methods.rb",
+     "paginary.gemspec",
+     "test/dummy/app/controllers/application_controller.rb",
+     "test/dummy/app/controllers/widgets_controller.rb",
+     "test/dummy/app/models/widget.rb",
+     "test/dummy/app/views/layouts/application.html.erb",
+     "test/dummy/app/views/widgets/_form.html.erb",
+     "test/dummy/app/views/widgets/edit.html.erb",
+     "test/dummy/app/views/widgets/index.html.erb",
+     "test/dummy/app/views/widgets/new.html.erb",
+     "test/dummy/app/views/widgets/show.html.erb",
+     "test/dummy/config.ru",
+     "test/dummy/config/application.rb",
+     "test/dummy/config/boot.rb",
+     "test/dummy/config/database.yml",
+     "test/dummy/config/environment.rb",
+     "test/dummy/config/environments/test.rb",
+     "test/dummy/config/routes.rb",
+     "test/dummy/db/schema.rb",
+     "test/test_helper.rb",
+     "test/unit/helpers/page_builder_test.rb",
+     "test/unit/helpers/pagination_helper_test.rb",
+     "test/unit/relation/paginated_test.rb",
+     "test/unit/relation/query_methods_test.rb"
+  ]
+  s.homepage = %q{http://rails-erd.rubyforge.org/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{paginary}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{View-based pagination for Rails.}
+  s.test_files = [
+    "test/dummy/app/controllers/application_controller.rb",
+     "test/dummy/app/controllers/widgets_controller.rb",
+     "test/dummy/app/models/widget.rb",
+     "test/dummy/config/application.rb",
+     "test/dummy/config/boot.rb",
+     "test/dummy/config/environment.rb",
+     "test/dummy/config/environments/test.rb",
+     "test/dummy/config/routes.rb",
+     "test/dummy/db/schema.rb",
+     "test/test_helper.rb",
+     "test/unit/helpers/page_builder_test.rb",
+     "test/unit/helpers/pagination_helper_test.rb",
+     "test/unit/relation/paginated_test.rb",
+     "test/unit/relation/query_methods_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rails>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+  end
+end
+

data/test/dummy/app/controllers/application_controller.rb

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

data/test/dummy/app/controllers/widgets_controller.rb

@@ -0,0 +1,83 @@
+class WidgetsController < ApplicationController
+  # GET /widgets
+  # GET /widgets.xml
+  def index
+    @widgets = Widget.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @widgets }
+    end
+  end
+
+  # GET /widgets/1
+  # GET /widgets/1.xml
+  def show
+    @widget = Widget.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @widget }
+    end
+  end
+
+  # GET /widgets/new
+  # GET /widgets/new.xml
+  def new
+    @widget = Widget.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @widget }
+    end
+  end
+
+  # GET /widgets/1/edit
+  def edit
+    @widget = Widget.find(params[:id])
+  end
+
+  # POST /widgets
+  # POST /widgets.xml
+  def create
+    @widget = Widget.new(params[:widget])
+
+    respond_to do |format|
+      if @widget.save
+        format.html { redirect_to(@widget, :notice => 'Widget was successfully created.') }
+        format.xml  { render :xml => @widget, :status => :created, :location => @widget }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @widget.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /widgets/1
+  # PUT /widgets/1.xml
+  def update
+    @widget = Widget.find(params[:id])
+
+    respond_to do |format|
+      if @widget.update_attributes(params[:widget])
+        format.html { redirect_to(@widget, :notice => 'Widget was successfully updated.') }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @widget.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /widgets/1
+  # DELETE /widgets/1.xml
+  def destroy
+    @widget = Widget.find(params[:id])
+    @widget.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(widgets_url) }
+      format.xml  { head :ok }
+    end
+  end
+end

data/test/dummy/app/models/widget.rb

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

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/app/views/widgets/_form.html.erb

@@ -0,0 +1,17 @@
+<%= form_for(@widget) do |f| %>
+  <% if @widget.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@widget.errors.count, "error") %> prohibited this widget from being saved:</h2>
+
+      <ul>
+      <% @widget.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/test/dummy/app/views/widgets/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing widget</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Show', @widget %> |
+<%= link_to 'Back', widgets_path %>

data/test/dummy/app/views/widgets/index.html.erb

@@ -0,0 +1,21 @@
+<h1>Listing widgets</h1>
+
+<table>
+  <tr>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+
+<% @widgets.each do |widget| %>
+  <tr>
+    <td><%= link_to 'Show', widget %></td>
+    <td><%= link_to 'Edit', edit_widget_path(widget) %></td>
+    <td><%= link_to 'Destroy', widget, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New Widget', new_widget_path %>

data/test/dummy/app/views/widgets/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New widget</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', widgets_path %>

data/test/dummy/app/views/widgets/show.html.erb

@@ -0,0 +1,5 @@
+<p id="notice"><%= notice %></p>
+
+
+<%= link_to 'Edit', edit_widget_path(@widget) %> |
+<%= link_to 'Back', widgets_path %>

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+# If you have a Gemfile, require the gems listed there, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(:default, Rails.env) if defined?(Bundler)
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    config.action_view.javascript_expansions[:defaults] = %w()
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+gemfile = File.expand_path('../../Gemfile', __FILE__)
+begin
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+rescue Bundler::GemNotFound => e
+  STDERR.puts e.message
+  STDERR.puts "Try running `bundle install`."
+  exit!
+end if File.exist?(gemfile)

data/test/dummy/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,35 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/test/dummy/config/routes.rb

@@ -0,0 +1,60 @@
+Dummy::Application.routes.draw do
+  resources :widgets
+
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  # root :to => "welcome#index"
+
+  # See how all your routes lay out with "rake routes"
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  # match ':controller(/:action(/:id(.:format)))'
+end

data/test/dummy/db/schema.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Schema.suppress_messages do
+  ActiveRecord::Schema.define do
+    create_table :widgets do |t|
+      t.boolean :deleted, :default => false
+      t.timestamps
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,39 @@
+require "rubygems"
+require "bundler/setup"
+
+ENV["RAILS_ENV"] = "test"
+require File.expand_path("dummy/config/environment", File.dirname(__FILE__))
+require File.expand_path("dummy/db/schema", File.dirname(__FILE__))
+require "test/unit"
+
+ActiveRecord::Base.connection.class.class_eval do
+  def execute_with_query_record(sql, name = nil, &block)
+    ($queries_executed ||= []) << sql
+    execute_without_query_record(sql, name, &block)
+  end
+  alias_method_chain :execute, :query_record
+end
+
+class ActiveSupport::TestCase
+  setup :create_widgets
+  teardown :destroy_widgets
+  
+  def count_queries
+    $queries_executed = []
+    yield
+    $queries_executed.size
+  end
+  
+  def assert_equal_relation(expected, actual)
+    assert_kind_of ActiveRecord::Relation, actual
+    assert_equal expected.to_a, actual.to_a
+  end
+  
+  def create_widgets
+    177.times { Widget.connection.insert "INSERT INTO widgets (deleted) VALUES (0)" }
+  end
+  
+  def destroy_widgets
+    Widget.delete_all
+  end
+end

data/test/unit/helpers/page_builder_test.rb

@@ -0,0 +1,68 @@
+require File.expand_path("../../test_helper", File.dirname(__FILE__))
+
+class PaginationHelperTest < ActionView::TestCase
+  include Paginary::Helpers::PaginationHelper
+
+  delegate :params, :to => :controller
+  
+  def url_options
+    { :controller => "widgets", :action => "index" }
+  end
+  
+  def setup
+    @klass = Widget
+    @relation = @klass.unscoped
+  end
+  
+  def builder(*args)
+    builder = nil
+    paginate(*args) { |b| builder = b }
+    builder
+  end
+  
+  # Items ====================================================================
+  test "items should return paginated relation" do
+    assert_equal_relation @relation.paginate, builder(@relation).items
+  end
+
+  # Decorated links ==========================================================
+  test "links should return nil if there is only one page" do
+    assert_nil builder(@relation.paginate(:per_page => 12345)).links
+  end
+  
+  test "links should return complete page links" do
+    assert_dom_equal %Q{<div class="pagination">} +
+      %Q{<span class="previous disabled"><span>&lt; Previous</span></span>} +
+      %Q{<a href="/widgets?page=1" class="page selected"><span>1</span></a>} +
+      %Q{<a href="/widgets?page=2" class="page"><span>2</span></a>} +
+      %Q{<a href="/widgets?page=3" class="page"><span>3</span></a>} +
+      %Q{<a href="/widgets?page=4" class="page"><span>4</span></a>} +
+      %Q{<a href="/widgets?page=2" class="next"><span>Next &gt;</span></a>} +
+      %Q{</div>}, builder(@relation).links
+  end
+
+  test "page_links should return page links" do
+    assert_dom_equal %Q{<a href="/widgets?page=1" class="page selected"><span>1</span></a>} +
+      %Q{<a href="/widgets?page=2" class="page"><span>2</span></a>} +
+      %Q{<a href="/widgets?page=3" class="page"><span>3</span></a>} +
+      %Q{<a href="/widgets?page=4" class="page"><span>4</span></a>}, builder(@relation).page_links
+  end
+  
+  test "next_link should return link to next page" do
+    assert_dom_equal %Q{<a href="/widgets?page=2" class="next"><span>Next &gt;</span></a>}, builder(@relation).next_link
+  end
+
+  test "next_link should return disabled link to next page if current page is last" do
+    params[:page] = (@relation.count.to_f / 50).ceil
+    assert_dom_equal %Q{<span class="next disabled"><span>Next &gt;</span></span>}, builder(@relation).next_link
+  end
+
+  test "previous_link should return link to previous page" do
+    params[:page] = (@relation.count.to_f / 50).ceil
+    assert_dom_equal %Q{<a href="/widgets?page=#{params[:page] - 1}" class="previous"><span>&lt; Previous</span></a>}, builder(@relation).previous_link
+  end
+
+  test "previous_link should return disabled link to previous page if current page is first" do
+    assert_dom_equal %Q{<span class="previous disabled"><span>&lt; Previous</span></span>}, builder(@relation).previous_link
+  end
+end

data/test/unit/helpers/pagination_helper_test.rb

@@ -0,0 +1,30 @@
+require File.expand_path("../../test_helper", File.dirname(__FILE__))
+
+class PaginationHelperTest < ActionView::TestCase
+  include Paginary::Helpers::PaginationHelper
+
+  delegate :params, :to => :controller
+  
+  def url_options
+    { :controller => "widgets", :action => "index" }
+  end
+  
+  def setup
+    @klass = Widget
+    @relation = @klass.unscoped
+  end
+
+  # Pagination ===============================================================
+  test "paginate should yield page builder" do
+    builder = nil
+    paginate(@relation) { |b| builder = b }
+    assert_kind_of Paginary::Helpers::PageBuilder, builder
+  end
+  
+  test "paginate should query database for total number of items only once" do
+    num = count_queries do
+      paginate(@relation) { |page| page.links; page.items.to_a }
+    end
+    assert_equal 2, num
+  end
+end

data/test/unit/relation/paginated_test.rb

@@ -0,0 +1,74 @@
+require File.expand_path("../../test_helper", File.dirname(__FILE__))
+
+class PaginatedTest < ActiveRecord::TestCase
+  def setup
+    @klass = Widget
+    @relation = @klass.scoped
+  end
+  
+  # Relation methods =========================================================
+  test "item_count should return number of items without pagination" do
+    assert_equal @klass.count, @relation.paginate.item_count
+  end
+
+  test "page_count should return number of pages" do
+    assert_equal (@klass.count.to_f / 17).ceil, @relation.paginate(:per_page => 17).page_count
+  end
+
+  test "current_page should return one by default" do
+    assert_equal 1, @relation.paginate.current_page
+  end
+
+  test "current_page should return given page" do
+    assert_equal 3, @relation.paginate(3).current_page
+  end
+
+  test "last_page? should return false if there is a next page" do
+    assert_equal false, @relation.paginate(1).last_page?
+  end
+
+  test "last_page? should return true if there is no next page" do
+    assert_equal true, @relation.paginate((@klass.count.to_f / 50).ceil).last_page?
+  end
+
+  test "first_page? should return false if there is a previous page" do
+    assert_equal false, @relation.paginate(2).first_page?
+  end
+
+  test "first_page? should return true if there is no previous page" do
+    assert_equal true, @relation.paginate(1).first_page?
+  end
+  
+  # Page validation ==========================================================
+  test "paginate should raise error if given page is less than one" do
+    assert_raises ActiveRecord::RecordNotFound do
+      @relation.paginate(0)
+    end
+  end
+
+  test "paginate should raise error if given page does not exist" do
+    assert_raises ActiveRecord::RecordNotFound do
+      @relation.paginate(1239)
+    end
+  end
+  
+  # Page calculation =========================================================
+  test "page_count should return 1 if there are no items" do
+    assert_equal 1, @relation.where(:deleted => true).paginate.page_count
+  end
+  
+  test "page_count should return 1 if number of items is within number of items per page" do
+    16.times { Widget.create! :deleted => true }
+    assert_equal 1, @relation.where(:deleted => true).paginate(:per_page => 17).page_count
+  end
+
+  test "page_count should return 1 if number of items is equal to number of items per page" do
+    17.times { Widget.create! :deleted => true }
+    assert_equal 1, @relation.where(:deleted => true).paginate(:per_page => 17).page_count
+  end
+
+  test "page_count should return 2 if number of items is larger than number of items per page" do
+    18.times { Widget.create! :deleted => true }
+    assert_equal 2, @relation.where(:deleted => true).paginate(:per_page => 17).page_count
+  end
+end

data/test/unit/relation/query_methods_test.rb

@@ -0,0 +1,42 @@
+require File.expand_path("../../test_helper", File.dirname(__FILE__))
+
+class QueryMethodsTest < ActiveRecord::TestCase
+  def setup
+    @klass = Widget
+    @relation = @klass.scoped
+  end
+  
+  # Relation methods =========================================================
+  test "paginate should return first fifty items by default" do
+    assert_equal_relation @relation.limit(50), @relation.paginate
+  end
+
+  test "paginate should return second fifty items if page number is two" do
+    assert_equal_relation @relation.offset(50).limit(50), @relation.paginate(2)
+  end
+  
+  test "paginate should return first n items as specified by per_page" do
+    assert_equal_relation @relation.limit(37), @relation.paginate(:per_page => 37)
+  end
+  
+  test "paginated? should return true if paginate has been called" do
+    assert_equal true, @relation.paginate.paginated?
+  end
+
+  test "paginated? should return false if paginate has not been called" do
+    assert_equal false, @relation.paginated?
+  end
+  
+  test "paginated? should return false if everything fits on one page" do
+    assert_equal false, @relation.paginate(:per_page => 1234).paginated?
+  end
+  
+  # Class methods ============================================================
+  test "paginate on class should return first fifty items by default" do
+    assert_equal_relation @relation.limit(50), @klass.paginate
+  end
+  
+  test "paginated? on class should return false" do
+    assert_equal false, @klass.paginated?
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: paginary
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 0
+  - 0
+  - 1
+  - pre1
+  version: 0.0.1.pre1
+platform: ruby
+authors: 
+- Rolf Timmermans
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-20 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Simple, view-based pagination for Rails, built on top of Active Record 3 awesomeness.
+email: r.timmermans@voormedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/paginary.rb
+- lib/paginary/helpers/page_builder.rb
+- lib/paginary/helpers/pagination_helper.rb
+- lib/paginary/railtie.rb
+- lib/paginary/relation/paginated.rb
+- lib/paginary/relation/query_methods.rb
+- paginary.gemspec
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/widgets_controller.rb
+- test/dummy/app/models/widget.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/widgets/_form.html.erb
+- test/dummy/app/views/widgets/edit.html.erb
+- test/dummy/app/views/widgets/index.html.erb
+- test/dummy/app/views/widgets/new.html.erb
+- test/dummy/app/views/widgets/show.html.erb
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/routes.rb
+- test/dummy/db/schema.rb
+- test/test_helper.rb
+- test/unit/helpers/page_builder_test.rb
+- test/unit/helpers/pagination_helper_test.rb
+- test/unit/relation/paginated_test.rb
+- test/unit/relation/query_methods_test.rb
+has_rdoc: true
+homepage: http://rails-erd.rubyforge.org/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: paginary
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: View-based pagination for Rails.
+test_files: 
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/widgets_controller.rb
+- test/dummy/app/models/widget.rb
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/routes.rb
+- test/dummy/db/schema.rb
+- test/test_helper.rb
+- test/unit/helpers/page_builder_test.rb
+- test/unit/helpers/pagination_helper_test.rb
+- test/unit/relation/paginated_test.rb
+- test/unit/relation/query_methods_test.rb