pagers 3.1.5 → 4.0.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e9f106db75e6002849694e8c7f2e2b814b9f063
-  data.tar.gz: fa92f8db5081d4bda219dfcf771068ee23bf88cc
+  metadata.gz: dfb6743176da1df0ec2e6260bd613767dc1838a5
+  data.tar.gz: 0db4191a5adc4f890dbeaa45c2784d761ff9da4d
 SHA512:
-  metadata.gz: 4595903a76bc0c878c00d3a4630787790f920e46a7c84bdc645f5e2e8f4d919f89b062eb8472b4d901546931ac8684b61ce3ce51a4e071989739d5e132f9dfc8
-  data.tar.gz: 8487cd7c2b2b731683370a526cf5eae50982fc7731717bfb260350ece4bf095b0ebe53e05a04bd497e167704c8cf6b13da031c112149f7e48c59b22373a77e31
+  metadata.gz: 2f07d1fe0b714f634ee628e6a4857c8f54936979c527f44c18c0a3bd07b6a29f615511fdabbeff2286bbd8b78f12cb32212b9ff86f712f18db8f31dac57ca99c
+  data.tar.gz: 5e643b2c86deb135c728b16e459ac0c3d21471a4c26ecf27966b40c081a613d072cc3beca5c11530fc9cd9378e1023766383fa666479ad8ddbc4771ad720ae0d

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 Mathías Montossi
+Copyright 2016 Mathías Montossi
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -5,7 +5,15 @@
 
 # Pagers
 
-Minimalistic pagers inspired in kaminari and will_paginate for rails.
+Scope based pagination engine for rails.
+
+## Why
+
+I did this gem to:
+
+- Simplify code by keep close integration with rails.
+- Have most common used settings set out of the box.
+- Create a compatible pagination for [indexes gem](https://github.com/mmontossi/indexes).
 
 ## Install
 
@@ -23,48 +31,53 @@ $ bundle
 
 Generate the configuration file:
 ```
-rails g pagers:install
+$ bundler exec rails g pagers:install
 ```
 
-The defaults values are:
+Set the global settings:
 ```ruby
 Pagers.configure do |config|
+
   config.length = 20
   config.padding = 0
-  config.parameter = :page
-  config.pages = 5
+  config.links = 5
+
 end
 ```
 
 ## Usage
 
+### Relation
+
 Call the page scope from your models:
 ```ruby
-@collection = Model.page(1, length: 10, padding: 4)
+@products = Product.page(1)
 ```
 
-And in your views just:
+You can override global options by passing a hash:
+```ruby
+@products = Product.page(1, length: 10, padding: 4)
+```
+
+### Views
+
+You can use paginate helper to generate a pager html:
 ```erb
 <%= paginate @collection %>
 ```
 
-NOTE: You can override the parameters in the scope and in the helper.
-
-## SEO
+### SEO
 
-You can add the parameter to paths:
+If you want to remove the page query parameter, add an optional parameter to the route:
 ```ruby
 get 'search/:query/(:page)' => 'products#search'
 ```
 
-To produce routes like:
+That will produce links like this:
 ```
 search/sample
 search/sample/2
 search/sample/3
-.
-.
-.
 ```
 
 ## Credits

data/Rakefile

@@ -4,21 +4,6 @@ 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'
@@ -28,7 +13,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
-
 task default: :test

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

@@ -19,7 +19,7 @@
           link_to(
             page,
             page_path(page, options),
-            rel: (collection.next_page == page ? 'next' : collection.previous_page == page ? 'prev' : nil)
+            rel: (collection.next_page == page ? 'next' : (collection.previous_page == page ? 'prev' : nil))
           )
         %>
       </li>

data/lib/generators/pagers/install/install_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+module Pagers
+  class InstallGenerator < ::Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_initializer_file
+      copy_file 'initializer.rb', 'config/initializers/pagers.rb'
+    end
+
+  end
+end

data/lib/generators/pagers/install/templates/initializer.rb

@@ -0,0 +1,7 @@
+Pagers.configure do |config|
+
+  config.length = 20
+  config.padding = 0
+  config.links = 5
+
+end

data/lib/pagers.rb

@@ -1,25 +1,20 @@
-require 'pagers/action_view/base'
-require 'pagers/active_record/base'
-require 'pagers/active_record/relation'
+require 'pagers/extensions/action_view/base'
+require 'pagers/extensions/active_record/base'
+require 'pagers/extensions/active_record/relation'
+require 'pagers/configuration'
 require 'pagers/engine'
 require 'pagers/railtie'
+require 'pagers/version'
 
 module Pagers
   class << self
 
     def configure
-      yield config
+      yield configuration
     end
 
-    def config
-      @config ||= begin
-        ActiveSupport::OrderedOptions.new.tap do |config|
-          config.length = 20
-          config.padding = 0
-          config.parameter = :page
-          config.pages = 5
-        end
-      end
+    def configuration
+      @configuration ||= Configuration.new
     end
 
   end

data/lib/pagers/configuration.rb

@@ -0,0 +1,7 @@
+module Pagers
+  class Configuration
+
+    attr_accessor :length, :padding, :links
+
+  end
+end

data/lib/pagers/extensions/action_view/base.rb

@@ -0,0 +1,48 @@
+module Pagers
+  module Extensions
+    module ActionView
+      module Base
+        extend ActiveSupport::Concern
+
+        def page_path(number, options={})
+          if number == 1
+            number = nil
+          end
+          url_for request.query_parameters.merge(page: number)
+        end
+
+        def paginate(collection, options={})
+          links = (options[:links] || Pagers.configuration.links)
+          if collection.total_pages >= links
+            middle = (links / 2).ceil
+            if collection.current_page > (collection.total_pages - middle)
+              starts_at = (collection.total_pages - links + 1)
+              ends_at = collection.total_pages
+            elsif collection.current_page <= middle
+              starts_at = 1
+              ends_at = links
+            else
+              starts_at = (collection.current_page - middle)
+              ends_at = (collection.current_page + middle)
+            end
+          else
+            starts_at = 1
+            ends_at = collection.total_pages
+          end
+          pages = Range.new(starts_at, ends_at)
+          less_pages = (starts_at > 1)
+          more_pages = (ends_at < collection.total_pages)
+          render(
+            'pagers/main',
+            collection: collection,
+            pages: pages,
+            less_pages: less_pages,
+            more_pages: more_pages,
+            options: options
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/pagers/extensions/active_record/base.rb

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

data/lib/pagers/extensions/active_record/relation.rb

@@ -0,0 +1,43 @@
+module Pagers
+  module Extensions
+    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)
+            r = r.except(:includes) unless references_eager_loaded_tables?
+            r = r.count
+            (r.respond_to?(:count) ? r.count : r) - padding
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/pagers/railtie.rb

@@ -1,9 +1,13 @@
 module Pagers
   class Railtie < Rails::Railtie
 
-    initializer 'pagers' do
-      ::ActiveRecord::Base.send :include, Pagers::ActiveRecord::Base
-      ::ActionView::Base.send :include, Pagers::ActionView::Base
+    initializer 'pagers.extensions' do
+      ::ActiveRecord::Base.include(
+        Pagers::Extensions::ActiveRecord::Base
+      )
+      ::ActionView::Base.include(
+        Pagers::Extensions::ActionView::Base
+      )
     end
 
   end

data/lib/pagers/version.rb

@@ -1,5 +1,5 @@
 module Pagers
 
-  VERSION = '3.1.5'
+  VERSION = '4.0.0.0'
 
 end

data/test/dummy/Rakefile

@@ -2,5 +2,4 @@
 # 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
+Rails.application.load_tasks

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

@@ -2,12 +2,12 @@
 // 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.
+// or any plugin's vendor/assets/javascripts directory 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
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
 //= require_tree .

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

@@ -3,11 +3,13 @@
  * 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.
+ * or any plugin's vendor/assets/stylesheets directory 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.
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
  *
- *= require_self
  *= require_tree .
+ *= require_self
  */

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

@@ -0,0 +1,8 @@
+class ProductsController < ApplicationController
+
+  def index
+    number = (params[:page] || 1)
+    @products = Product.page(number, length: 1)
+  end
+
+end

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

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

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

@@ -1,14 +1,12 @@
 <!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>
+  <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>