pageable 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 372426615ff7f93835dbc15b7e1da109a69a2455
+  data.tar.gz: c02e4885a4f063e805437986c586d9ca6a8254e1
+SHA512:
+  metadata.gz: a8b5cf8f144ac2c530103345e81e557de578a361c23e84fdc11275953f8734d7b9a95fde5da8a5d6cf97f59eb8706f8af73e696e50ee818269c72f9f73a98d50
+  data.tar.gz: dbe69a97b9ccf8bf1a3340ca6cb6c77aa05138de2ce52ad6c0b0928b00ce166bf432792ce28ca526b2d39f23e5b885f6a18d0995b840ecdff9252a34d497ea0d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 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,45 @@
+{<img src="https://codeclimate.com/github/mattways/pageable.png" />}[https://codeclimate.com/github/mattways/pageable] {<img src="https://secure.travis-ci.org/mattways/pageable.png?branch=master" alt="Build Status" />}[https://travis-ci.org/mattways/pageable] {<img src="https://gemnasium.com/mattways/pageable.png" alt="Dependency Status" />}[https://gemnasium.com/mattways/pageable]
+
+= Pageable
+
+Inspired in kaminari and will_paginate but more minimalistic.
+
+= Install
+
+Put this line in your Gemfile:
+  gem 'pageable'
+  
+Then bundle:
+  $ bundle
+  
+= Usage
+
+The same approach as kaminari:
+  @records = Model.page(1).per(20)
+
+And then just:
+  pager @records
+
+= Configuration
+
+== Default parameter and navigation
+
+If you want to change the default parameter name or the default navigation length call pager:
+  pager @records, navigation: 3, parameter: :p
+
+Or to set it globally put this in your application.rb:
+  config.pagination.default_parameter = :p
+  config.pagination.default_navigation = 3
+
+== 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).padding(-4)

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    = 'Pageable'
+  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/pageable/_pager.html.erb

@@ -0,0 +1,29 @@
+<% if relation.total_pages > 1 %>
+  <div class="pager">
+    <% if first_page = relation.first_page %>
+      <%= link_to t('pager.first'), page_path(first_page, options), class: 'first' %>
+    <% end %>
+    <% if previous_page = relation.previous_page %>
+      <%= link_to t('pager.previous'), page_path(previous_page, options), class: 'previous' %>
+    <% end %>
+    <% if less_pages %>
+      <span class="ellipsis">...</span>
+    <% end %>
+    <% pages.each do |page| %>
+      <% if relation.current_page == page %>
+        <span class="page current"><%= page %></span>
+      <% else %>
+        <%= link_to page, page_path(page, options), class: 'page' %>
+      <% end %>
+    <% end %>
+    <% if more_pages %>
+      <span class="ellipsis">...</span>
+    <% end %>
+    <% if next_page = relation.next_page %>
+      <%= link_to t('pager.next'), page_path(next_page, options), class: 'next' %> 
+    <% end %>
+    <% if last_page = relation.last_page %>
+      <%= link_to t('pager.last'), page_path(last_page, options), class: 'last' %>
+    <% end %>
+  </div>
+<% 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/pageable.rb

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

data/lib/pageable/action_view/base.rb

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

data/lib/pageable/active_record/base.rb

@@ -0,0 +1,32 @@
+module Pageable
+  module ActiveRecord
+    module Base
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        def inherited(subclass)
+          subclass.class_eval do
+            if superclass == ::ActiveRecord::Base
+              scope :page, ->(number) {
+                limit(default_per_page).offset(default_per_page * ([number.to_i, 1].max - 1))
+              } do
+                include Pageable::ActiveRecord::Relation
+              end
+            end
+          end
+          super
+        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
+end

data/lib/pageable/active_record/relation.rb

@@ -0,0 +1,78 @@
+module Pageable
+  module ActiveRecord
+    module Relation
+      extend ActiveSupport::Concern
+
+      def per(value)
+        value = [value.to_i, 1].max
+        limit(value).offset(value * (offset_value / limit_value))
+      end      
+      
+      def padding(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
+          r = except(:offset, :limit, :order, :reorder)
+          r = r.except(:includes) unless eager_loading?
+          r = r.count
+          r.respond_to?(:count) ? r.count : r
+        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?
+        !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/pageable/engine.rb

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

data/lib/pageable/railtie.rb

@@ -0,0 +1,15 @@
+module Pageable
+  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 'pageable' do
+      ::ActiveRecord::Base.send :include, Pageable::ActiveRecord::Base
+      ::ActionView::Base.send :include, Pageable::ActionView::Base
+    end
+
+  end
+end

data/lib/pageable/version.rb

@@ -0,0 +1,5 @@
+module Pageable
+
+  VERSION = '2.1.0'
+
+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
+    @models = Model.page(params[:p] || 1).per(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