rails_pagination 2.0.5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Mattways
+
+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.rdoc

@@ -0,0 +1,62 @@
+{<img src="https://codeclimate.com/github/mattways/rails_pagination.png" />}[https://codeclimate.com/github/mattways/rails_pagination] {<img src="https://secure.travis-ci.org/mattways/rails_pagination.png?branch=master" alt="Build Status" />}[https://travis-ci.org/mattways/rails_pagination] {<img src="https://gemnasium.com/mattways/rails_pagination.png" alt="Dependency Status" />}[https://gemnasium.com/mattways/rails_pagination]
+
+= Rails Pagination
+
+Inspired in kaminari and will_paginate but more minimalistic
+
+= Install
+
+Put this line in your Gemfile:
+  gem 'rails_pagination'
+  
+Then bundle:
+  $ bundle
+  
+= Usage
+
+The same approach as kaminari:
+  Model.page(1).per(20)
+  
+But doesn't force you to use any markup, just use the methods of the pager object in your views:
+  - pager = paginate(@collection)
+  - if pager.has_multiple_pages?
+    #pager
+      - if pager.has_first_page?
+        %a.first{:href => pager.first_page_path}= t('pager.first')
+      - if pager.has_previous_page?
+        %a.previous{:href => pager.previous_page_path}= t('pager.previous')
+      - if pager.navigation.has_less_pages?
+        %span.ellipsis ...
+      - for page in pager.navigation.pages
+        - if pager.is_current_page? page
+          %span.page.current= page     
+        - else
+          %a.page{:href => pager.page_path(page)}= page 
+      - if pager.navigation.has_more_pages?
+        %span.ellipsis ...  
+      - if pager.has_next_page?
+        %a.next{:href => pager.next_page_path}= t('pager.next')    
+      - if pager.has_last_page?
+        %a.last{:href => pager.last_page_path}= t('pager.last')
+
+= Configuration
+
+== Default param name
+
+If you want to change the default parameter name or the default navigation length call paginate method this way:
+  paginate(@collection, :navigation => 3, :parameter => :p)
+Or to set it globally put this in your application.rb:
+  config.pagination.default_parameter = :p
+  config.pagination.default_navigation = 5
+
+== Default per page
+
+If you want to change the default per_page put this in your model:
+  default_per_page 5
+Or to set it globally put this in your application.rb:
+  config.pagination.default_per_page = 5
+
+== Padding
+
+You can use positive and negative padding:
+  Model.page(1).per(10).pad(-4)

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsPagination'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/rails_pagination/action_view/base.rb

@@ -0,0 +1,11 @@
+module RailsPagination
+  module ActionView
+    module Base
+
+      def paginate(*args)
+        Pager.new *args.unshift(self)
+      end
+
+    end
+  end
+end

data/lib/rails_pagination/active_record/base.rb

@@ -0,0 +1,25 @@
+module RailsPagination
+  module ActiveRecord
+    module Base
+
+      def inherited(subclass)
+        if subclass.superclass == ::ActiveRecord::Base
+          subclass.scope :page, Proc.new {|number|
+            subclass.limit(subclass.default_per_page).offset(subclass.default_per_page * ([number.to_i, 1].max - 1))
+          } do
+            include RailsPagination::ActiveRecord::Relation
+          end
+        end       
+      end
+
+      def default_per_page(value=nil)
+        unless value.nil?
+          value = [value.to_i, 1].max
+          @default_per_page = value
+        end
+        defined?(@default_per_page).nil? ? Rails.application.config.pagination.default_per_page : @default_per_page 
+      end
+
+    end
+  end
+end

data/lib/rails_pagination/active_record/relation.rb

@@ -0,0 +1,82 @@
+module RailsPagination
+  module ActiveRecord
+    module Relation
+
+      def per(value)
+        value = [value.to_i, 1].max
+        limit(value).offset(value * (offset_value / limit_value))
+      end      
+      
+      def pad(value)
+        @padding = value
+        r = (offset_value + value) < 0 ? self : offset(offset_value + value)
+        decrease_limit? ? r.limit(limit_value + value) : r
+      end
+      
+      def total_count
+        @total_count ||= begin
+          c = except(:offset, :limit, :order)
+          c = c.except(:includes) unless references_eager_loaded_tables?
+          uses_distinct_sql_statement = c.to_sql =~ /DISTINCT/i
+          if uses_distinct_sql_statement
+            c.length
+          else
+            c = c.count
+            c.respond_to?(:count) ? c.count : c
+          end
+        end
+      end            
+      
+      def total_pages
+        @total_pages ||= [(fixed_total_count.to_f / fixed_limit_value).ceil, 1].max
+      end
+
+      def current_page
+        @current_page ||= (offset_value.to_f / fixed_limit_value).ceil + 1
+      end
+
+      def previous_page
+        @previous_page ||= current_page > 1 ? (current_page - 1) : nil
+      end
+      
+      def next_page
+        @next_page ||= current_page < total_pages ? (current_page + 1) : nil
+      end
+      
+      def first_page
+        1
+      end
+      
+      def last_page
+        total_pages
+      end      
+      
+      def out_of_bounds?
+        @out_of_bounds ||= current_page > total_pages or current_page < first_page
+      end
+      
+      protected
+      
+      def has_padding?
+        not defined?(@padding).nil?
+      end
+      
+      def padding_negative?
+        has_padding? and @padding < 0
+      end
+      
+      def decrease_limit?
+        padding_negative? and offset_value == 0
+      end
+      
+      def fixed_total_count
+        total_count - (padding_negative? ? @padding : 0)
+      end
+      
+      def fixed_limit_value
+        limit_value - (decrease_limit? ? @padding : 0)
+      end
+
+    end
+  end
+end

data/lib/rails_pagination/navigation.rb

@@ -0,0 +1,39 @@
+module RailsPagination
+  class Navigation
+
+    def initialize(collection, length)
+      if collection.total_pages >= length
+        middle = (length / 2).ceil
+        if collection.current_page > collection.total_pages - middle
+          starts_at = collection.total_pages - length + 1
+          ends_at = collection.total_pages
+        elsif collection.current_page <= middle
+          starts_at = 1
+          ends_at = length
+        else
+          starts_at = collection.current_page - middle
+          ends_at = collection.current_page + middle
+        end
+      else
+        starts_at = 1
+        ends_at = collection.total_pages
+      end
+      @has_less_pages = starts_at > 1
+      @has_more_pages = ends_at < collection.total_pages
+      @pages = Range.new(starts_at, ends_at) 
+    end 
+
+    def has_less_pages?
+      @has_less_pages
+    end
+
+    def has_more_pages?
+      @has_more_pages
+    end
+
+    def pages
+      @pages
+    end
+
+  end
+end

data/lib/rails_pagination/pager.rb

@@ -0,0 +1,97 @@
+module RailsPagination
+  class Pager
+    
+    def initialize(*args)
+      options = args.extract_options!
+      @template = args[0]
+      @collection = args[1]
+      @parameter = options[:parameter] || Rails.application.config.pagination.default_parameter 
+      @navigation = Navigation.new(args[1], options[:navigation] || Rails.application.config.pagination.default_navigation)
+    end
+
+    def has_multiple_pages?
+      @has_multiple_pages ||= @collection.total_pages > 1
+    end
+
+    def is_current_page?(page)
+      @collection.current_page == page
+    end
+
+    def has_previous_page?
+      @has_previous_page ||= @collection.previous_page != nil
+    end         
+    
+    def has_next_page?
+      @has_next_page ||= @collection.next_page != nil
+    end
+    
+    def has_first_page?
+      @collection.current_page > 1 and @collection.total_pages > 1
+    end
+    
+    def is_first_page?
+      @is_first_page ||= @collection.current_page == 1
+    end
+
+    def has_last_page?
+      @collection.current_page != @collection.last_page and @collection.total_pages > 1
+    end
+
+    def is_last_page?
+      @is_last_page ||= @collection.current_page == total_pages
+    end
+
+    def navigation
+      @navigation
+    end
+
+    def page_path(page)
+      @template.url_for(@template.request.query_parameters.merge(@parameter => page))
+    end
+
+    def page_url(page)
+      @template.url_for(@template.request.query_parameters.merge(@parameter => page, :only_path => false))
+    end
+
+    def current_page_path
+      page_path @collection.current_page
+    end
+
+    def current_page_url
+      page_url @collection.current_page
+    end
+
+    def first_page_path
+      page_path @collection.first_page
+    end
+
+    def first_page_url
+      page_url @collection.first_page
+    end
+
+    def previous_page_path
+      page_path @collection.previous_page
+    end
+
+    def previous_page_url
+      page_url @collection.previous_page
+    end
+
+    def next_page_path
+      page_path @collection.next_page
+    end
+
+    def next_page_url
+      page_url @collection.next_page
+    end
+
+    def last_page_path
+      page_path @collection.last_page
+    end
+
+    def last_page_url
+      page_url @collection.last_page
+    end
+
+  end
+end

data/lib/rails_pagination/railtie.rb

@@ -0,0 +1,15 @@
+module RailsPagination
+  class Railtie < Rails::Railtie
+
+    config.pagination = ::ActiveSupport::OrderedOptions.new
+    config.pagination.default_per_page = 30
+    config.pagination.default_parameter = :p
+    config.pagination.default_navigation = 5
+
+    initializer 'rails_pagination' do
+      ::ActiveRecord::Base.send :extend, RailsPagination::ActiveRecord::Base
+      ::ActionView::Base.send :include, RailsPagination::ActionView::Base
+    end
+
+  end
+end

data/lib/rails_pagination/version.rb

@@ -0,0 +1,5 @@
+module RailsPagination
+
+  VERSION = '2.0.5'
+
+end

data/lib/rails_pagination.rb

@@ -0,0 +1,10 @@
+require 'rails_pagination/action_view/base'
+require 'rails_pagination/active_record/base'
+require 'rails_pagination/active_record/relation'
+require 'rails_pagination/navigation'
+require 'rails_pagination/pager'
+require 'rails_pagination/railtie'
+require 'rails_pagination/version'
+
+module RailsPagination
+end

data/test/collection_empty_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+class CollectionEmptyTest < ActiveSupport::TestCase
+
+  setup :create_records
+
+  test "should have 1 page" do
+    assert_equal @collection.total_pages, 1
+  end
+
+  test "current page should be 1" do
+    assert_equal @collection.current_page, 1
+  end
+
+  test "first page should be 1" do
+    assert_equal @collection.first_page, 1
+  end
+
+  test "should have no previous page" do
+    assert_nil @collection.previous_page
+  end
+
+  test "should have no next page" do
+    assert_nil @collection.next_page
+  end
+  
+  test "last page should be 1" do
+    assert_equal @collection.last_page, 1
+  end
+
+  test "should not be out of bounds" do
+    assert !@collection.out_of_bounds?
+  end
+
+  protected
+
+  def create_records
+    @collection = Model.page(1).per(2)
+  end
+
+end

data/test/collection_first_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+class CollectionFirstTest < ActiveSupport::TestCase
+
+  setup :create_records
+
+  test "should have 5 pages" do
+    assert_equal @collection.total_pages, 5
+  end
+
+  test "current page should be 1" do
+    assert_equal @collection.current_page, 1
+  end
+
+  test "first page should be 1" do
+    assert_equal @collection.first_page, 1
+  end
+
+  test "should have no previous page" do
+    assert_nil @collection.previous_page
+  end
+
+  test "next page should be 2" do
+    assert_equal @collection.next_page, 2
+  end
+  
+  test "last page shuold be 5" do
+    assert_equal @collection.last_page, 5
+  end
+
+  test "should not be out of bounds" do
+    assert !@collection.out_of_bounds?
+  end
+
+  protected
+
+  def create_records
+    10.times.each { |id| Model.create :title => "Record #{id}" }
+    @collection = Model.page(1).per(2)
+  end
+
+end

data/test/collection_last_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+class CollectionLastTest < ActiveSupport::TestCase
+
+  setup :create_records
+
+  test "should have 5 pages" do
+    assert_equal @collection.total_pages, 5
+  end
+
+  test "current page should be 5" do
+    assert_equal @collection.current_page, 5
+  end
+
+  test "first page should be 1" do
+    assert_equal @collection.first_page, 1
+  end
+
+  test "should have previous page 4" do
+    assert_equal @collection.previous_page, 4
+  end
+
+  test "should not have next page" do
+    assert_nil @collection.next_page
+  end
+  
+  test "last page shuold be 5" do
+    assert_equal @collection.last_page, 5
+  end
+
+  test "should not be out of bounds" do
+    assert !@collection.out_of_bounds?
+  end
+
+  protected
+
+  def create_records
+    10.times.each { |id| Model.create :title => "Record #{id}" }
+    @collection = Model.page(5).per(2)
+  end
+
+end

data/test/collection_middle_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+class CollectionMiddleTest < ActiveSupport::TestCase
+
+  setup :create_records
+
+  test "should have 5 pages" do
+    assert_equal @collection.total_pages, 5
+  end
+
+  test "current page should be 3" do
+    assert_equal @collection.current_page, 3
+  end
+
+  test "first page should be 1" do
+    assert_equal @collection.first_page, 1
+  end
+
+  test "should have previous page 2" do
+    assert_equal @collection.previous_page, 2
+  end
+
+  test "should have next page 4" do
+    assert_equal @collection.next_page, 4
+  end
+  
+  test "last page shuold be 5" do
+    assert_equal @collection.last_page, 5
+  end
+
+  test "should not be out of bounds" do
+    assert !@collection.out_of_bounds?
+  end
+
+  protected
+
+  def create_records
+    10.times.each { |id| Model.create :title => "Record #{id}" }
+    @collection = Model.page(3).per(2)
+  end
+
+end

data/test/collection_padding_test.rb

@@ -0,0 +1,83 @@
+require 'test_helper'
+
+class CollectionPaddingTest < ActiveSupport::TestCase
+  
+  test "negative padding should have 1 page" do
+    11.times.each { |id| Model.create :title => "Record #{id}" }
+    
+    @collection = Model.page(1).per(15).pad(-4)
+    assert_equal @collection.total_pages, 1
+    
+    @collection = Model.page(2).per(15).pad(-4)
+    assert_equal @collection.total_pages, 1
+    
+    @collection = Model.page(3).per(15).pad(-4)
+    assert_equal @collection.total_pages, 1
+  end
+
+  test "negative padding should have 2 pages" do
+    12.times.each { |id| Model.create :title => "Record #{id}" }
+    
+    @collection = Model.page(1).per(15).pad(-4)
+    assert_equal @collection.total_pages, 2
+    
+    @collection = Model.page(2).per(15).pad(-4)
+    assert_equal @collection.total_pages, 2
+    
+    @collection = Model.page(3).per(15).pad(-4)
+    assert_equal @collection.total_pages, 2
+  end
+  
+  test "negative padding should have 3 pages" do
+    27.times.each { |id| Model.create :title => "Record #{id}" }
+    
+    @collection = Model.page(1).per(15).pad(-4)
+    assert_equal @collection.total_pages, 3
+    
+    @collection = Model.page(2).per(15).pad(-4)
+    assert_equal @collection.total_pages, 3
+    
+    @collection = Model.page(3).per(15).pad(-4)
+    assert_equal @collection.total_pages, 3
+  end
+  
+  test "positive padding should have 1 page" do
+    15.times.each { |id| Model.create :title => "Record #{id}" }
+    
+    @collection = Model.page(1).per(15).pad(4)
+    assert_equal @collection.total_pages, 1
+    
+    @collection = Model.page(2).per(15).pad(4)
+    assert_equal @collection.total_pages, 1
+    
+    @collection = Model.page(3).per(15).pad(4)
+    assert_equal @collection.total_pages, 1
+  end
+
+  test "positive padding should have 2 pages" do
+    16.times.each { |id| Model.create :title => "Record #{id}" }
+    
+    @collection = Model.page(1).per(15).pad(4)
+    assert_equal @collection.total_pages, 2
+    
+    @collection = Model.page(2).per(15).pad(4)
+    assert_equal @collection.total_pages, 2
+    
+    @collection = Model.page(3).per(15).pad(4)
+    assert_equal @collection.total_pages, 2
+  end
+  
+  test "positive padding should have 3 pages" do
+    31.times.each { |id| Model.create :title => "Record #{id}" }
+    
+    @collection = Model.page(1).per(15).pad(4)
+    assert_equal @collection.total_pages, 3
+    
+    @collection = Model.page(2).per(15).pad(4)
+    assert_equal @collection.total_pages, 3
+    
+    @collection = Model.page(3).per(15).pad(4)
+    assert_equal @collection.total_pages, 3
+  end
+
+end