pagy 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e51d75e2660aa59d031c00483240f184f15d2776d4c37470bfbee7ed1dd57a2
-  data.tar.gz: faa522eceb7a6ace73224dc9a24ff29256a82d54d6ed249a331e8deefbe56382
+  metadata.gz: ae2667539ba0f1f518150c750faee613c5a47a3dc2154d9fc5ccbdd243891fbf
+  data.tar.gz: 4eea6d2bfaf058897bcc233f93ee7c8c43d29f139c374ed9e6fb5685f6e03258
 SHA512:
-  metadata.gz: 06a931a110d4622351585b05577b2dd269b88b7b4337b40da887b1b7b9fec4b83d8d06f9333ab1fea315db23111424b1b83d54964867a57750c117ab776c1ed2
-  data.tar.gz: c711d71396894e99138bac013c7cc9a9972566b5e4f0e0f1f27473cbca028a15c6660690c893fb793bb25fb9e56d14afe4ffcd2e9d0da08cbc9df4410f04fab0
+  metadata.gz: 241dc6c9f6b1bcb69edf5294112f915866709ed338947f30ab96ff3be79d0ed677f4a0d41fd08d9ed05495cf661d054b52effaaa948120aa8fe9ffbc6b638ae6
+  data.tar.gz: f90c99e9c32cc9e27314555f8f531eb598be43b4c26bb3038506127b73b918f95132b84fa3db688e85003e8addae6314cd55a274743a8f95d85cf6349e670f99

data/lib/pagy.rb

@@ -2,10 +2,7 @@
 
 require 'pathname'
 
-class Pagy ; VERSION = '0.7.2'
-
-  autoload :Backend,  'pagy/backend'
-  autoload :Frontend, 'pagy/frontend'
+class Pagy ; VERSION = '0.8.0'
 
   class OutOfRangeError < StandardError; end
 
@@ -13,7 +10,7 @@ class Pagy ; VERSION = '0.7.2'
   def self.root; Pathname.new(__FILE__).dirname end
 
   # default core vars
-  VARS = { page:1, items:20, outset:0, size:[1,4,4,1] }
+  VARS = { page:1, items:20, outset:0, size:[1,4,4,1], page_param: :page }
 
   # default I18n vars
   zero_one = [:zero, :one] ; I18N = { file: Pagy.root.join('locales', 'pagy.yml').to_s, plurals: -> (c) {(zero_one[c] || :other).to_s.freeze} }
@@ -22,7 +19,7 @@ class Pagy ; VERSION = '0.7.2'
 
   # merge and validate the options, do some simple aritmetic and set the instance variables
   def initialize(vars)
-    @vars = VARS.merge(vars.delete_if{|k,v| v.nil? || v == '' })          # default vars + cleaned instance vars
+    @vars = VARS.merge(vars.delete_if{|_,v| v.nil? || v == '' })          # default vars + cleaned instance vars
     { count:0, items:1, outset:0, page:1 }.each do |k,min|                # validate core variables
       (@vars[k] && instance_variable_set(:"@#{k}", @vars.delete(k).to_i) >= min) \
          or raise(ArgumentError, "expected :#{k} >= #{min}; got #{instance_variable_get(:"@#{k}").inspect}")
@@ -52,3 +49,6 @@ class Pagy ; VERSION = '0.7.2'
   end
 
 end
+
+require 'pagy/backend'
+require 'pagy/frontend'

data/lib/pagy/backend.rb

@@ -4,21 +4,22 @@ class Pagy
   # Defines a few generic methods to paginate a ORM collection out of the box,
   # or any collection by overriding pagy_get_items in your controller
 
-  # See also the pagy-extras gem if you need specialized methods to paginate
+  # See also the extras if you need specialized methods to paginate
   # Arrays, ORM, and other TBD collections
 
   module Backend ; private         # the whole module is private so no problem with including it in a controller
 
     # return pagy object and items
-    def pagy(collection, vars=nil)
-      pagy = Pagy.new(vars ? pagy_get_vars(collection).merge!(vars) : pagy_get_vars(collection))   # conditional merge is faster and saves memory
+    def pagy(collection, vars={})
+      pagy = Pagy.new(pagy_get_vars(collection, vars))
       return pagy, pagy_get_items(collection, pagy)
     end
 
     # sub-method called only by #pagy: here for easy customization of variables by overriding
-    def pagy_get_vars(collection)
-      # return the variables to initialize the pagy object
-      { count: collection.count, page: params[:page] }
+    def pagy_get_vars(collection, vars)
+      # return the merged variables to initialize the pagy object
+      { count: collection.count,
+        page:  params[vars[:page_param]||VARS[:page_param]] }.merge!(vars)
     end
 
     # sub-method called only by #pagy: here for easy customization of record-extraction by overriding

data/lib/pagy/extras/array.rb

@@ -0,0 +1,20 @@
+# See the Pagy Extras documentation: https://ddnexus.github.io/pagy/extras
+
+class Pagy
+  # Add specialized backend methods to paginate array collections
+  module Backend ; private
+
+    # return pagy object and items
+    def pagy_array(array, vars={})
+      pagy = Pagy.new(pagy_array_get_vars(array, vars))
+      return pagy, array[pagy.offset, pagy.items]
+    end
+
+    def pagy_array_get_vars(array, vars)
+      # return the merged variables to initialize the pagy object
+      { count: array.count,
+        page:  params[vars[:page_param]||VARS[:page_param]] }.merge!(vars)
+    end
+
+  end
+end

data/lib/pagy/extras/bootstrap.rb

@@ -0,0 +1,26 @@
+# See the Pagy Extras documentation: https://ddnexus.github.io/pagy/extras
+
+class Pagy
+  # Add nav helper for bootstrap pagination
+  module Frontend
+
+    # Pagination for bootstrap: it returns the html with the series of links to the pages
+    def pagy_nav_bootstrap(pagy)
+      tags = ''; link = pagy_link_proc(pagy, 'class="page-link"'.freeze)
+
+      tags << (pagy.prev ? %(<li class="page-item prev">#{link.call pagy.prev, pagy_t('pagy.nav.prev'.freeze), 'aria-label="previous"'.freeze}</li>)
+                         : %(<li class="page-item prev disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.prev'.freeze)}</a></li>))
+      pagy.series.each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
+        tags << if    item.is_a?(Integer); %(<li class="page-item">#{link.call item}</li>)                                                               # page link
+                elsif item.is_a?(String) ; %(<li class="page-item active">#{link.call item}</li>)                                                        # active page
+                elsif item == :gap       ; %(<li class="page-item gap disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.gap'.freeze)}</a></li>) # page gap
+                end
+      end
+      tags << (pagy.next ? %(<li class="page-item next">#{link.call pagy.next, pagy_t('pagy.nav.next'.freeze), 'aria-label="next"'.freeze}</li>)
+                         : %(<li class="page-item next disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.next'.freeze)}</a></li>))
+      %(<nav class="pagy-nav-boostrap pagination" role="navigation" aria-label="pager"><ul class="pagination">#{tags}</ul></nav>)
+    end
+
+  end
+end
+

data/lib/pagy/extras/compact.rb

@@ -0,0 +1,51 @@
+# See the Pagy Extras documentation: https://ddnexus.github.io/pagy/extras
+
+class Pagy
+  # Add nav helpers for compact pagination
+  module Frontend
+
+    # Generic compact pagination: it returns the html with the series of links to the pages
+    # we use a numeric input tag to set the page and the PagyCompact javascript to navigate
+    def pagy_nav_compact(pagy, id=caller(1,1)[0].hash)
+      tags = ''; link = pagy_link_proc(pagy)
+
+      tags << %(<nav id="pagy-nav-#{id}" class="pagy-nav-compact pagination" role="navigation" aria-label="pager">)
+
+        tags << link.call(MARKER, '', %(style="display: none;" ))
+        tags << (pagy.prev ? %(<span class="page prev">#{link.call pagy.prev, pagy_t('pagy.nav.prev'.freeze), 'aria-label="previous"'.freeze}</span> )
+                           : %(<span class="page prev disabled">#{pagy_t('pagy.nav.prev'.freeze)}</span> ))
+
+        input = %(<input type="number" min="1" max="#{pagy.last}" value="#{pagy.page}" style="padding: 0; text-align: center; width: #{pagy.pages.to_s.length+1}rem;">)
+        tags << %(<span class="pagy-compact-input" style="margin: 0 0.6rem;">#{pagy_t('pagy.compact.page'.freeze)} #{input} #{pagy_t('pagy.compact.of'.freeze)} #{pagy.pages}</span> )
+
+        tags << (pagy.next ? %(<span class="page next">#{link.call pagy.next, pagy_t('pagy.nav.next'.freeze), 'aria-label="next"'.freeze}</span>)
+                           : %(<span class="page next disabled">#{pagy_t('pagy.nav.next'.freeze)}</span>))
+
+      tags << %(</nav><script>PagyCompact('#{id}', '#{MARKER}', '#{pagy.page}');</script>)
+    end
+
+    # Compact pagination for bootstrap: it returns the html with the series of links to the pages
+    # we use a numeric input tag to set the page and the PagyCompact javascript to navigate
+    def pagy_nav_bootstrap_compact(pagy, id=caller(1,1)[0].hash)
+      tags = ''; link = pagy_link_proc(pagy)
+
+      tags << %(<nav id="pagy-nav-#{id}" class="pagy-nav-bootstrap-compact pagination" role="navigation" aria-label="pager">)
+
+        tags << link.call(MARKER, '', %(style="display: none;" ))
+
+        tags << %(<div class="btn-group" role="group">)
+        tags << (pagy.prev ? link.call(pagy.prev, pagy_t('pagy.nav.prev'.freeze), 'aria-label="previous" class="prev btn btn-primary"'.freeze)
+                           : %(<a class="prev btn btn-primary disabled" href="#">#{pagy_t('pagy.nav.prev'.freeze)}</a>))
+
+        input = %(<input type="number" min="1" max="#{pagy.last}" value="#{pagy.page}" style="padding: 0; border: none; text-align: center; width: #{pagy.pages.to_s.length+1}rem;">)
+        tags << %(<div class="pagy-compact-input btn btn-primary disabled">#{pagy_t('pagy.compact.page'.freeze)} #{input} #{pagy_t('pagy.compact.of'.freeze)} #{pagy.pages}</div>)
+
+        tags << (pagy.next ? link.call(pagy.next, pagy_t('pagy.nav.next'.freeze), 'aria-label="next" class="next btn btn-primary"'.freeze)
+                           : %(<a class="next btn btn-primary disabled" href="#">#{pagy_t('pagy.nav.next'.freeze)}</a>))
+
+      tags << %(</div></nav><script>PagyCompact('#{id}', '#{MARKER}', '#{pagy.page}');</script>)
+    end
+
+  end
+end
+

data/lib/pagy/extras/i18n.rb

@@ -0,0 +1,16 @@
+# See the Pagy Extras documentation: https://ddnexus.github.io/pagy/extras
+
+class Pagy
+  # Use ::I18n gem
+  module Frontend
+
+    ::I18n.load_path << I18N[:file]
+
+    # overrides the built-in pagy_t
+    def pagy_t(*args)
+      I18n.t(*args)
+    end
+
+  end
+end
+

data/lib/pagy/extras/initializer_example.rb

@@ -0,0 +1,55 @@
+# Example of initializer file
+# Customize only what you really need but notice that Pagy works also without any of the following lines.
+
+
+# Extras
+# See https://ddnexus.github.io/pagy/extras
+
+# Array: Paginate arrays efficiently avoiding expensive array-wrapping and wihout overriding
+# See https://ddnexus.github.io/pagy/extras/array
+# require 'pagy/extras/array'
+
+# Bootstrap: Nav helper and templates for Bootstrap pagination
+# See https://ddnexus.github.io/pagy/extras/bootstrap
+# require 'pagy/extras/bootstrap'
+
+# Compact: An alternative UI that combines the pagination with the nav info in one compact element
+# See https://ddnexus.github.io/pagy/extras/compact
+# require 'pagy/extras/compact'
+
+# I18n: Uses the `I18n` gem instead of the pagy implementation
+# See https://ddnexus.github.io/pagy/extras/i18n
+# require 'pagy/extras/i18n'
+
+# Responsive: On resize, the number of page links will adapt in real-time to the available window or container width
+# See https://ddnexus.github.io/pagy/extras/responsive
+# require 'pagy/extras/responsive'
+
+
+# Pagy Variables
+# All the Pagy::VARS here are set for all the pagy instances but can be
+# overridden by just passing them to Pagy.new or the pagy controller method
+
+# Core variables (See https://ddnexus.github.io/pagy/api/pagy#core-variables)
+# Pagy::VARS[:items] = 20                                   # default
+
+# Non Core Variables (See https://ddnexus.github.io/pagy/api/pagy#non-core-variables)
+# Pagy::VARS[:size]       = [1,4,4,1]                       # default
+# Pagy::Vars[:page_param] = :page                           # default
+# Pagy::VARS[:link_extra] = 'data-remote="true"'            # example
+# Pagy::VARS[:item_path]  = 'activerecord.models.product'   # example
+
+# Extras Non Core Variables
+# See https://ddnexus.github.io/pagy/extras/responsive#breakpoints
+# Pagy::VARS[:breakpoints] = { 0 => [1,2,2,1], 350 => [2,3,3,2], 550 => [3,4,4,3] }    # example of width/size pairs
+
+
+# I18n Variables
+# See https://ddnexus.github.io/pagy/api/frontend#pagy_tpath-vars
+# Pagy::I18N[:file]    = Pagy.root.join('locales', 'pagy.yml').to_s      # default
+# Pagy::I18N[:plurals] = -> (c) {([:zero, :one][c] || :other).to_s       # default
+
+
+# Rails: extras assets path required by compact or responsive extras
+# See https://ddnexus.github.io/pagy/extras/compact and https://ddnexus.github.io/pagy/extras/responsive
+# Rails.application.config.assets.paths << Pagy.root.join('pagy', 'extras', 'javascripts')

data/lib/pagy/extras/javascripts/pagy-compact.js

@@ -0,0 +1,15 @@
+function PagyCompact(id, marker, page){
+  var pagyNav = document.getElementById('pagy-nav-'+id),
+      input   = pagyNav.getElementsByTagName('input')[0],
+      link    = pagyNav.getElementsByTagName('a')[0];
+
+  this.go = function(){
+    if (page !== input.value) {
+      var href = link.getAttribute('href').replace(marker, input.value);
+      link.setAttribute('href', href);
+      link.click();
+    }
+  };
+
+  input.addEventListener("focusout", this.go);
+}

data/lib/pagy/extras/javascripts/pagy-responsive.js

@@ -0,0 +1,24 @@
+function PagyResponsive(id, items, widths, series){
+  var pagyNav    = document.getElementById('pagy-nav-'+id),
+      pagyBox    = pagyNav.firstChild || pagyNav,
+      pagyParent = pagyNav.parentElement,
+      lastWidth  = undefined;
+
+  this.render = function(){
+                  var parentWidth = parseInt(pagyParent.clientWidth),
+                      width       = widths.find(function(w){return parentWidth > w});
+                  if (width !== lastWidth) {
+                    while (pagyBox.firstChild) { pagyBox.removeChild(pagyBox.firstChild) }
+                    var tags = items['prev'];
+                    series[width].forEach(function(item){tags += items[item]});
+                    tags += items['next'];
+                    pagyBox.insertAdjacentHTML('beforeend', tags);
+                    lastWidth = width;
+                  }
+                };
+
+  if (window.attachEvent) { window.attachEvent('onresize', this.render) }
+  else if (window.addEventListener) { window.addEventListener('resize', this.render, true) }
+
+  this.render();
+};

data/lib/pagy/extras/responsive.rb

@@ -0,0 +1,73 @@
+# See the Pagy Extras documentation: https://ddnexus.github.io/pagy/extras
+
+require 'json'
+
+class Pagy
+
+  # default :breakpoints
+  VARS[:breakpoints] = { 0 => [1,4,4,1] }
+
+  # Helper for building the page_nav with javascript. For example:
+  # with an object like:
+  #   Pagy.new count:1000, page: 20, breakpoints: {0 => [1,2,2,1], 350 => [2,3,3,2], 550 => [3,4,4,3]}
+  # it returns something like:
+  #   { :items  => [1, :gap, 18, 19, "20", 21, 22, 50, 2, 17, 23, 49, 3, 16, 24, 48],
+  #     :series => { 0   =>[1, :gap, 18, 19, "20", 21, 22, :gap, 50],
+  #                  350 =>[1, 2, :gap, 17, 18, 19, "20", 21, 22, 23, :gap, 49, 50],
+  #                  550 =>[1, 2, 3, :gap, 16, 17, 18, 19, "20", 21, 22, 23, 24, :gap, 48, 49, 50] },
+  #     :widths => [550, 350, 0] }
+  # where :items  is the unordered array union of all the page numbers for all sizes (passed to the PagyResponsive javascript function)
+  #       :series is the hash of the series keyed by width (used by the *_responsive helpers to create the JSON string)
+  #       :widths is the desc-ordered array of widths (passed to the PagyResponsive javascript function)
+  def responsive
+    @responsive ||= {items: [], series: {}, widths:[]}.tap do |r|
+      @vars[:breakpoints].key?(0) || raise(ArgumentError, "expected :breakpoints to contain the 0 size; got #{@vars[:breakpoint].inspect}")
+      @vars[:breakpoints].each {|width, size| r[:items] |= r[:series][width] = series(size)}
+      r[:widths] = r[:series].keys.sort!{|a,b| b <=> a}
+    end
+  end
+
+  # Add nav helpers for responsive pagination
+  module Frontend
+
+    # Generic responsive pagination: it returns the html with the series of links to the pages
+    # we build the tags as a json object string and render them with the PagyResponsive javascript
+    def pagy_nav_responsive(pagy, id=caller(1,1)[0].hash)
+      tags = '{'; link = pagy_link_proc(pagy); responsive = pagy.responsive
+
+      tags << (pagy.prev ? %('prev':'<span class="page prev">#{link.call pagy.prev, pagy_t('pagy.nav.prev'.freeze), 'aria-label="previous"'.freeze}</span> ',)
+                         : %('prev':'<span class="page prev disabled">#{pagy_t('pagy.nav.prev'.freeze)}</span> ',))
+      responsive[:items].each do |item|  # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
+        tags << if    item.is_a?(Integer); %('#{item}':'<span class="page">#{link.call item}</span> ',)                    # page link
+                elsif item.is_a?(String) ; %('#{item}':'<span class="page active">#{item}</span> ',)                       # current page
+                elsif item == :gap       ; %('#{item}':'<span class="page gap">#{pagy_t('pagy.nav.gap'.freeze)}</span> ',) # page gap
+                end
+      end
+      tags << (pagy.next ? %('next':'<span class="page next">#{link.call pagy.next, pagy_t('pagy.nav.next'.freeze), 'aria-label="next"'.freeze}</span>'})
+                         : %('next':'<span class="page next disabled">#{pagy_t('pagy.nav.next'.freeze)}</span>'}))
+      script = %(<script>PagyResponsive('#{id}', #{tags}, #{responsive[:widths].to_json}, #{responsive[:series].to_json});</script>)
+      %(<nav id="pagy-nav-#{id}" class="pagy-nav-responsive pagination" role="navigation" aria-label="pager"></nav>#{script})
+    end
+
+
+    # Responsive pagination for bootstrap: it returns the html with the series of links to the pages
+    # we build the tags as a json object string and render them with the PagyResponsive javascript
+    def pagy_nav_bootstrap_responsive(pagy, id=caller(1,1)[0].hash)
+      tags = '{'; link = pagy_link_proc(pagy, 'class="page-link"'.freeze); responsive = pagy.responsive
+
+      tags << (pagy.prev ? %('prev':'<li class="page-item prev">#{link.call pagy.prev, pagy_t('pagy.nav.prev'.freeze), 'aria-label="previous"'.freeze}</li>',)
+                         : %('prev':'<li class="page-item prev disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.prev'.freeze)}</a></li>',))
+      responsive[:items].each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
+        tags << if    item.is_a?(Integer); %('#{item}':'<li class="page-item">#{link.call item}</li>',)                                                               # page link
+                elsif item.is_a?(String) ; %('#{item}':'<li class="page-item active">#{link.call item}</li>',)                                                        # active page
+                elsif item == :gap       ; %('#{item}':'<li class="page-item gap disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.gap'.freeze)}</a></li>',) # page gap
+                end
+      end
+      tags << (pagy.next ? %('next':'<li class="page-item next">#{link.call pagy.next, pagy_t('pagy.nav.next'.freeze), 'aria-label="next"'.freeze}</li>'})
+                         : %('next':'<li class="page-item next disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.next'.freeze)}</a></li>'}))
+      script = %(<script>PagyResponsive('#{id}', #{tags}, #{responsive[:widths].to_json}, #{responsive[:series].to_json});</script>)
+      %(<nav id="pagy-nav-#{id}" class="pagy-nav-bootstrap-responsive pagination" role="navigation" aria-label="pager"><ul class="pagination"></ul></nav>#{script})
+    end
+
+  end
+end

data/lib/pagy/extras/templates/nav_bootstrap.html.erb

@@ -0,0 +1,24 @@
+<%#
+  This template is i18n-ready: if you don't use i18n, then you can replace the pagy_t
+  calls with the actual strings ("&lsaquo; Prev", "Next &rsaquo;", "&hellip;").
+
+  The link variable is set to a proc that returns the link tag.
+  Usage: link.call( page_number [, text [, extra_attributes_string ]])
+-%>
+<% link = pagy_link_proc(pagy, 'class="page-link"') -%>
+<%#                            -%><nav aria-label="pager"  class="pagy-nav-bootstrap pagination" role="navigation">
+<%#                            -%>  <ul class="pagination">
+<% if pagy.prev                -%>    <li class="page-item prev"><%== link.call(pagy.prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"') %></li>
+<% else                        -%>    <li class="page-item prev disabled"><a href="#" class="page-link"><%== pagy_t('pagy.nav.prev') %></a></li>
+<% end                         -%>
+<% pagy.series.each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36] -%>
+<%   if    item.is_a?(Integer) -%>    <li class="page-item"><%== link.call(item) %></li>
+<%   elsif item.is_a?(String)  -%>    <li class="page-item active"><%== link.call(item) %></li>
+<%   elsif item == :gap        -%>    <li class="page-item disabled gap"><a href="#" class="page-link"><%== pagy_t('pagy.nav.gap') %></a></li>
+<%   end                       -%>
+<% end                         -%>
+<% if pagy.next                -%>    <li class="page-item next"><%== link.call(pagy.next, pagy_t('pagy.nav.next'), 'aria-label="next"') %></li>
+<% else                        -%>    <li class="page-item next disabled"><a href="#" class="page-link"><%== pagy_t('pagy.nav.next') %></a></li>
+<% end                         -%>
+<%#                            -%>  </ul>
+<%#                            -%></nav>

data/lib/pagy/extras/templates/nav_bootstrap.html.haml

@@ -0,0 +1,34 @@
+-# This template is i18n-ready: if you don't use i18n, then you can replace the pagy_t
+-# calls with the actual strings ("‹ Prev", "Next ›", "…").
+
+-# The link variable is set to a proc that returns the link tag.
+-# Usage: link.call( page_number [, text [, extra_attributes_string ]])
+
+- link = pagy_link_proc(pagy, 'class="page-link"')
+
+%nav.pagy-nav-bootstrap.pagination{"aria-label" => "pager", :role => "navigation"}
+
+  %ul.pagination
+
+    - if pagy.prev
+      %li.page-item.prev!= link.call(pagy.prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"')
+    - else
+      %li.page-item.prev.disabled
+        %a.page-link{:href => '#'}!= pagy_t('pagy.nav.prev')
+
+    - pagy.series.each do |item|                      # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
+      - if item.is_a?(Integer)                        # page link
+        %li.page-item!= link.call(item)
+
+      - elsif item.is_a?(String)                      # current page
+        %li.page-item.active!= link.call(item)
+
+      - elsif item == :gap                            # page gap
+        %li.page-item.disabled.gap
+          %a.page-link{:href => "#"}!= pagy_t('pagy.nav.gap')
+
+    - if pagy.next
+      %li.page-item.next!= link.call(pagy.next, pagy_t('pagy.nav.next'), 'aria-label="next"')
+    - else
+      %li.page-item.next.disabled
+        %a.page-link{:href => '#'}!= pagy_t('pagy.nav.next')

data/lib/pagy/extras/templates/nav_bootstrap.html.slim

@@ -0,0 +1,34 @@
+/ This template is i18n-ready: if you don't use i18n, then you can replace the pagy_t
+/ calls with the actual strings ("‹ Prev", "Next ›", "…").
+
+/ The link variable is set to a proc that returns the link tag.
+/ Usage: link.call( page_number [, text [, extra_attributes_string ]])
+
+- link = pagy_link_proc(pagy, 'class="page-link"')
+
+nav.pagy-nav-bootstrap.pagination role="navigation" aria-label="pager"
+
+  ul.pagination
+
+    - if pagy.prev
+      li.page-item.prev == link.call(pagy.prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"')
+    - else
+      li.page-item.prev.disabled
+        a.page-link href="#" == pagy_t('pagy.nav.prev')
+
+    - pagy.series.each do |item|                 # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
+      - if item.is_a?(Integer)                   # page link
+        li.page-item == link.call(item)
+
+      - elsif item.is_a?(String)                 # current page
+        li.page-item.active == link.call(item)
+
+      - elsif item == :gap                       # page gap
+        li.page-item.disabled.gap
+          a.page-link href="#" == pagy_t('pagy.nav.gap')
+
+    - if pagy.next
+      li.page-item.next == link.call(pagy.next, pagy_t('pagy.nav.next'), 'aria-label="next"')
+    - else
+      li.page-item.next.disabled
+        a.page-link href="#" == pagy_t('pagy.nav.next')

data/lib/pagy/frontend.rb

@@ -1,5 +1,7 @@
 # See Pagy::Frontend API documentation: https://ddnexus.github.io/pagy/api/frontend
 
+require 'yaml'
+
 class Pagy
 
   # All the code here has been optimized for performance: it may not look very pretty
@@ -33,14 +35,14 @@ class Pagy
 
 
     # this works with all Rack-based frameworks (Sinatra, Padrino, Rails, ...)
-    def pagy_url_for(n)
-      params = request.GET.merge('page'.freeze => n.to_s)
+    def pagy_url_for(page, page_param)
+      params = request.GET.merge(page_param => page)
       "#{request.path}?#{Rack::Utils.build_nested_query(pagy_get_params(params))}"
     end
 
 
     # sub-method called only by #pagy_url_for: here for easy customization of params by overriding
-    def pagy_get_params(p) p end
+    def pagy_get_params(params) params end
 
 
     MARKER = "-pagy-#{'pagy'.hash}-".freeze
@@ -48,34 +50,28 @@ class Pagy
     # returns a specialized proc to generate the HTML links
     def pagy_link_proc(pagy, lx=''.freeze)  # "lx" means "link extra"
       p_prev, p_next, p_lx = pagy.prev, pagy.next, pagy.vars[:link_extra]
-      a, b = %(<a href="#{pagy_url_for(MARKER)}"#{p_lx ? %( #{p_lx}) : ''.freeze}#{lx.empty? ? lx : %( #{lx})}).split(MARKER)
+      a, b = %(<a href="#{pagy_url_for(MARKER, pagy.vars[:page_param])}"#{p_lx ? %( #{p_lx}) : ''.freeze}#{lx.empty? ? lx : %( #{lx})}).split(MARKER)
       -> (n, text=n, x=''.freeze) { "#{a}#{n}#{b}#{ if    n == p_prev ; ' rel="prev"'.freeze
                                                     elsif n == p_next ; ' rel="next"'.freeze
                                                     else                           ''.freeze end }#{x.empty? ? x : %( #{x})}>#{text}</a>" }
     end
 
 
-    # define #pagy_t depending on I18N[:gem] and I18n
-    # this file will get autoloaded, so environment constants like ::I18n will be already set
-    if I18N[:gem] || I18N[:gem].nil? && defined?(I18n)
-      I18n.load_path << I18N[:file]
-      def pagy_t(*a) I18n.t(*a) end
-    else
-      require 'yaml'
-      # load data from the first locale in the file
-      I18N_DATA = YAML.load_file(I18N[:file]).first[1].freeze
-      # Similar to I18n.t for interpolation and pluralization but without translation
-      # Use only for single-language apps: it is specialized for pagy and 5x faster than I18n.t
-      def pagy_t(path, vars={})
-        value = I18N_DATA.dig(*path.to_s.split('.'.freeze)) or return %(translation missing: "#{path}")
-        if value.is_a?(Hash)
-          vars.key?(:count) or return value
-          plural = I18N[:plurals].call(vars[:count])
-          value.key?(plural) or return %(invalid pluralization data: "#{path}" cannot be used with count: #{vars[:count]}; key "#{plural}" is missing.)
-          value = value[plural] or return %(translation missing: "#{path}")
-        end
-        sprintf value, Hash.new{|h,k| "%{#{k}}"}.merge!(vars)    # interpolation
+    # load data from the first locale in the file
+    I18N_DATA = YAML.load_file(I18N[:file]).first[1].freeze
+
+    # Similar to I18n.t for interpolation and pluralization but without translation
+    # Use only for single-language apps: it is specialized for pagy and 5x faster than I18n.t
+    # See also https://ddnexus.github.io/pagy/extras/i18n to use the standard I18n gem instead
+    def pagy_t(path, vars={})
+      value = I18N_DATA.dig(*path.to_s.split('.'.freeze)) or return %(translation missing: "#{path}")
+      if value.is_a?(Hash)
+        vars.key?(:count) or return value
+        plural = I18N[:plurals].call(vars[:count])
+        value.key?(plural) or return %(invalid pluralization data: "#{path}" cannot be used with count: #{vars[:count]}; key "#{plural}" is missing.)
+        value = value[plural] or return %(translation missing: "#{path}")
       end
+      sprintf value, Hash.new{|_,k| "%{#{k}}"}.merge!(vars)    # interpolation
     end
 
   end

data/pagy.gemspec

@@ -29,5 +29,13 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'benchmark-ips'
   s.add_development_dependency 'kalibera'
   s.add_development_dependency 'memory_profiler'
+  s.add_development_dependency 'rubocop', '~> 0.55.0' # needs to be fixed since it constantly adds new cops
+
+
+  s.post_install_message = <<EOM
+******************************************************************************
+   Pagy CHANGELOG: https://github.com/ddnexus/pagy/blob/master/CHANGELOG.md
+******************************************************************************
+EOM
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-28 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
 description: 'Agnostic pagination in plain ruby: it works with any framework, ORM
   and DB type, with all kinds of collections, even pre-paginated, scopes, Arrays,
   JSON data... and just whatever you can count. Easy to use and customize, very fast
@@ -150,16 +164,30 @@ files:
 - lib/locales/pagy.yml
 - lib/pagy.rb
 - lib/pagy/backend.rb
+- lib/pagy/extras/array.rb
+- lib/pagy/extras/bootstrap.rb
+- lib/pagy/extras/compact.rb
+- lib/pagy/extras/i18n.rb
+- lib/pagy/extras/initializer_example.rb
+- lib/pagy/extras/javascripts/pagy-compact.js
+- lib/pagy/extras/javascripts/pagy-responsive.js
+- lib/pagy/extras/responsive.rb
+- lib/pagy/extras/templates/nav.html.erb
+- lib/pagy/extras/templates/nav.html.haml
+- lib/pagy/extras/templates/nav.html.slim
+- lib/pagy/extras/templates/nav_bootstrap.html.erb
+- lib/pagy/extras/templates/nav_bootstrap.html.haml
+- lib/pagy/extras/templates/nav_bootstrap.html.slim
 - lib/pagy/frontend.rb
-- lib/templates/nav.html.erb
-- lib/templates/nav.html.haml
-- lib/templates/nav.html.slim
 - pagy.gemspec
 homepage: https://github.com/ddnexus/pagy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |
+  ******************************************************************************
+     Pagy CHANGELOG: https://github.com/ddnexus/pagy/blob/master/CHANGELOG.md
+  ******************************************************************************
 rdoc_options: []
 require_paths:
 - lib