pagers 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0045ecc04a429c56771d9dce706949fc3836c9b5
+  data.tar.gz: 6fdd2abf723af68ecb4f4fecb88eb8eb6c5b7945
+SHA512:
+  metadata.gz: 92da1eeafdfabaf9a2389e7e49941f13cbd6c53c9a83d1c2be30243a667fdd33ee865685b1f24c4717e2c990abe77a8c5b4fc002321e95d13c121e3099644680
+  data.tar.gz: 64fd9a84bbc9f6659276bb697ac70f749aafecbf768b0a1eeee73100ce1994c9e1ea34f22c7efe835e36440c655a9d533b2d282f0d64f6f293c000329f292059

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Museways
+
+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,34 @@
+{<img src="https://badge.fury.io/rb/pagers.png" alt="Gem Version" />}[http://badge.fury.io/rb/pagers] {<img src="https://codeclimate.com/github/museways/pagers.png" />}[https://codeclimate.com/github/museways/pagers] {<img src="https://travis-ci.org/museways/pagers.png?branch=master" alt="Build Status" />}[https://travis-ci.org/museways/pagers] {<img src="https://gemnasium.com/museways/pagers.png" alt="Dependency Status" />}[https://gemnasium.com/museways/pagers]
+
+= Pagers
+
+Inspired in kaminari and will_paginate but more minimalistic.
+
+= Install
+
+Put this line in your Gemfile:
+  gem 'pagers'
+ 
+Then bundle:
+  $ bundle
+ 
+= Usage
+
+Call the page scope:
+  @collection = Model.page(1, length: 10)
+
+And in your views just:
+  <%= paginate @collection %>
+
+= Configuration
+
+== Defaults
+
+If you want to change defaults you can override the values in the helper:
+  <%= paginate @collection, parameter: :p, pages: 3 %>
+
+Or to set them globally in your application.rb:
+  config.pagers.parameter = :p
+  config.pagers.pages = 3
+  config.pagers.length = 5
+  config.pagers.padding = 0

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Pagers'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+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/app/views/pagers/_main.html.erb

@@ -0,0 +1,35 @@
+<% if collection.total_pages > 1 %>
+  <ul class="pager">
+    <% if collection.previous_page %>
+      <li class="first">
+        <%= link_to t('pager.first'), page_path(collection.first_page, options) %>
+      </li>
+      <li class="previous">
+        <%= link_to t('pager.previous'), page_path(collection.previous_page, options) %>
+      </li>
+    <% end %>
+    <% if less_pages %>
+      <li class="ellipsis">
+        &hellip;
+      </li>
+    <% end %>
+    <% pages.each do |page| %>
+      <li class="page<%= ' current' if collection.current_page == page %>">
+        <%= link_to page, page_path(page, options) %>
+      </li>
+    <% end %>
+    <% if more_pages %>
+      <li class="ellipsis">
+        &hellip;
+      </li>
+    <% end %>
+    <% if collection.next_page %>
+      <li class="next">
+        <%= link_to t('pager.next'), page_path(collection.next_page, options) %>
+      </li>
+      <li class="last">
+        <%= link_to t('pager.last'), page_path(collection.last_page, options) %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>

data/app/views/pagers/main.html.erb

@@ -0,0 +1,35 @@
+<% if collection.total_pages > 1 %>
+  <ul class="pager">
+    <% if collection.previous_page %>
+      <li class="first">
+        <%= link_to t('pager.first'), page_path(collection.first_page, options) %>
+      </li>
+      <li class="previous">
+        <%= link_to t('pager.previous'), page_path(collection.previous_page, options) %>
+      </li>
+    <% end %>
+    <% if less_pages %>
+      <li class="ellipsis">
+        &hellip;
+      </li>
+    <% end %>
+    <% pages.each do |page| %>
+      <li class="page<%= ' current' if collection.current_page == page %>">
+        <%= link_to page, page_path(page, options) %>
+      </li>
+    <% end %>
+    <% if more_pages %>
+      <li class="ellipsis">
+        &hellip;
+      </li>
+    <% end %>
+    <% if collection.next_page %>
+      <li class="next">
+        <%= link_to t('pager.next'), page_path(collection.next_page, options) %>
+      </li>
+      <li class="last">
+        <%= link_to t('pager.last'), page_path(collection.last_page, options) %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  pager:
+    first: "First"
+    previous: "Previous"
+    next: "Next"
+    last: "Last"

data/config/locales/es.yml

@@ -0,0 +1,6 @@
+es:
+  pager:
+    first: "Primero"
+    previous: "Anterior"
+    next: "Siguiente"
+    last: "Último"

data/lib/pagers/action_view/base.rb

@@ -0,0 +1,40 @@
+module Pagers
+  module ActionView
+    module Base
+      extend ActiveSupport::Concern
+
+      def page_path(page, options={})
+        parameter = options[:parameter] || Rails.application.config.pagers.parameter
+        request.path + '?' + request.query_parameters.merge(parameter => page).to_query
+      end
+
+      def paginate(collection, options={})
+        pages = options[:pages] || Rails.application.config.pagers.pages
+        if collection.total_pages >= pages
+          middle = (pages / 2).ceil
+          if collection.current_page > (collection.total_pages - middle)
+            starts_at = collection.total_pages - pages + 1
+            ends_at = collection.total_pages
+          elsif collection.current_page <= middle
+            starts_at = 1
+            ends_at = pages
+          else
+            starts_at = collection.current_page - middle
+            ends_at = collection.current_page + middle
+          end
+        else
+          starts_at = 1
+          ends_at = collection.total_pages
+        end
+        render partial: 'pagers/main', locals: {
+          collection: collection,
+          options: options,
+          pages: Range.new(starts_at, ends_at),
+          less_pages: starts_at > 1,
+          more_pages: ends_at < collection.total_pages
+        }
+      end
+
+    end
+  end
+end

data/lib/pagers/active_record/base.rb

@@ -0,0 +1,35 @@
+module Pagers
+  module ActiveRecord
+    module Base
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        def inherited(subclass)
+          subclass.class_eval do
+            if superclass == ::ActiveRecord::Base
+              scope :page, ->(number, options={}) {
+                length = options[:length] || Rails.application.config.pagers.length
+                padding = options[:padding] || Rails.application.config.pagers.padding
+                current_page = [number.to_i, 1].max
+                offset_value = (length * (current_page - 1)) + (current_page == 1 ? padding : 0)
+                limit_value = length - (current_page == 1 ? padding : 0)
+                values = Module.new do
+                  define_method :page_length do
+                    length
+                  end
+                  define_method :current_page do
+                    current_page
+                  end
+                end
+                limit(limit_value).offset(offset_value).extending(Pagers::ActiveRecord::Relation, values)
+              }
+            end
+          end
+          super
+        end
+
+      end
+    end
+  end
+end

data/lib/pagers/active_record/relation.rb

@@ -0,0 +1,41 @@
+module Pagers
+  module ActiveRecord
+    module Relation
+      extend ActiveSupport::Concern
+
+      def total_pages
+        @total_pages ||= [(total_count.to_f / page_length).ceil, 1].max
+      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 || current_page < first_page)
+      end
+ 
+      def total_count
+        @total_count ||= begin
+          r = except(:limit, :offset, :order, :reorder)
+          r = r.except(:includes) unless references_eager_loaded_tables?
+          r = r.count
+          r.respond_to?(:count) ? r.count : r
+        end
+      end
+
+    end
+  end
+end

data/lib/pagers/engine.rb

@@ -0,0 +1,7 @@
+module Pagers
+  class Engine < Rails::Engine
+
+    isolate_namespace Pagers
+
+  end
+end

data/lib/pagers/railtie.rb

@@ -0,0 +1,16 @@
+module Pagers
+  class Railtie < Rails::Railtie
+
+    config.pagers = ActiveSupport::OrderedOptions.new
+    config.pagers.length = 20
+    config.pagers.padding = 0
+    config.pagers.parameter = :p
+    config.pagers.pages = 5
+
+    initializer 'pagers' do
+      ::ActiveRecord::Base.send :include, Pagers::ActiveRecord::Base
+      ::ActionView::Base.send :include, Pagers::ActionView::Base
+    end
+
+  end
+end

data/lib/pagers/version.rb

@@ -0,0 +1,5 @@
+module Pagers
+
+  VERSION = '3.0.0'
+
+end

data/lib/pagers.rb

@@ -0,0 +1,9 @@
+require 'pagers/action_view/base'
+require 'pagers/active_record/base'
+require 'pagers/active_record/relation'
+require 'pagers/engine'
+require 'pagers/railtie'
+require 'pagers/version'
+
+module Pagers
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

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

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

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

@@ -0,0 +1,7 @@
+class PagesController < ApplicationController
+
+  def index
+    @collection = Model.page((params[:p] || 1), length: 1)
+  end
+
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

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

@@ -0,0 +1,2 @@
+class Model < 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    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

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

@@ -0,0 +1 @@
+<%= paginate @collection %>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require 'pagers'
+
+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.
+
+    # 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
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

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/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

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

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end