pagy 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da9304305299f0be41d53a9d6f13619fd5c625fafe1719b7d2606dc4d41689c2
-  data.tar.gz: 860fd52099ad641fc92ae5a0a1139a2eb93e041aa314071916f80b968dcb27fd
+  metadata.gz: 6c29e24c7c57ca390d1d7b1418a29db73e6b60449dd0149147247ddbd9e9468c
+  data.tar.gz: 5971ae0908e0b570f3288036f94fb2039c5286de5bfae23a99412c5c9a7854bc
 SHA512:
-  metadata.gz: 1092d3a3c662c9e88ceafd7a5062ca157b1115129878bdb8751de0609422360d07607eb60d4b277a2c18b1253acaf6d39552d314fdd0b679326b445874af00a6
-  data.tar.gz: 2ade9847094373264920036d0ce2fa9eaebcc7d912115f6614799a3f5b078d3b32317db627e2ec23c8dee8df119cc6c976dce1371781e16b1631aac7798b543e
+  metadata.gz: 48390fcfb1c9a03ecf3f5c722c016545af0ab107aebf3f380704535319f46b330caa81fd2347428dd1f87dacf9b2e4e0ca40a61ed32f66d290a92b00cbd8ac8f
+  data.tar.gz: 7c39db7c431d6072267128bb0c7af080b63bb0ae32aab803c7c5aff2fd269660b70611eb256a74228e97c9a7bc2cc5cb59182522386f1195c8bf974f625bfcaf

data/lib/locales/pagy.yml

@@ -6,6 +6,7 @@ en:
       prev: "‹ Prev"
       next: "Next ›"
       gap: "…"
+      current: "You're on page"
     info:
       single_page:
         zero: "No %{item_name} found"

data/lib/pagy.rb

@@ -3,7 +3,7 @@
 
 require 'pathname'
 
-class Pagy ; VERSION = '0.16.0'
+class Pagy ; VERSION = '0.17.0'
 
   class OutOfRangeError < StandardError; attr_reader :pagy; def initialize(pagy) @pagy = pagy end; end
 

data/lib/pagy/extras/compact.rb

@@ -58,6 +58,24 @@ class Pagy
       html << %(</div></nav><script type="application/json" class="pagy-compact-json">["#{id}", "#{MARKER}", "#{p_page}", #{!!defined?(TRIM)}]</script>)
     end
 
+    # Compact pagination for foundation: it returns the html with the series of links to the pages
+    # we use a numeric input tag to set the page and the Pagy.compact javascript to navigate
+    def pagy_nav_compact_foundation(pagy, id=caller(1,1)[0].hash)
+      html, link, p_prev, p_next, p_page, p_pages = +'', pagy_link_proc(pagy), pagy.prev, pagy.next, pagy.page, pagy.pages
+
+      html << %(<nav id="pagy-nav-#{id}" class="pagy-nav-compact-foundation" role="navigation" aria-label="Pagination">)
+        html << link.call(MARKER, '', %(style="display: none;" ))
+        (html << link.call(1, '', %(style="display: none;" ))) if defined?(TRIM)
+      html << %(<div class="input-group">)
+        html << (p_prev ? link.call(p_prev, pagy_t('pagy.nav.prev'), 'style="margin-bottom: 0px;" aria-label="previous" class="prev button primary"')
+                        : %(<a style="margin-bottom: 0px;" class="prev button primary disabled" href="#">#{pagy_t('pagy.nav.prev')}</a>))
+        input = %(<input class="input-group-field cell shrink" type="number" min="1" max="#{p_pages}" value="#{p_page}" style="width: #{p_pages.to_s.length+1.5}rem;">)
+        html << %(<span class="input-group-label">#{pagy_t('pagy.compact.page')}</span> #{input} <span class="input-group-label">#{pagy_t('pagy.compact.of')} #{p_pages}</span>)
+        html << (p_next ? link.call(p_next, pagy_t('pagy.nav.next'), 'style="margin-bottom: 0px;" aria-label="next" class="next button primary"')
+                        : %(<a style="margin-bottom: 0px;" class="next button primary disabled" href="#">#{pagy_t('pagy.nav.next')}</a>))
+      html << %(</div></nav><script type="application/json" class="pagy-compact-json">["#{id}", "#{MARKER}", "#{p_page}", #{!!defined?(TRIM)}]</script>)
+    end
+
     # Compact pagination for materialize: it returns the html with the series of links to the pages
     # we use a numeric input tag to set the page and the Pagy.compact javascript to navigate
     def pagy_nav_compact_materialize(pagy, id=caller(1,1)[0].hash)

data/lib/pagy/extras/foundation.rb

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

data/lib/pagy/extras/initializer_example.rb

@@ -5,10 +5,33 @@
 # Extras
 # See https://ddnexus.github.io/pagy/extras
 
-# Array: Paginate arrays efficiently avoiding expensive array-wrapping and without overriding
+
+# Component Extras
+
+# 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'
+
+# Responsive: On resize, the number of page links will adapt in real-time to the available window/container width
+# See https://ddnexus.github.io/pagy/extras/responsive
+# require 'pagy/extras/responsive'
+# 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
+
+
+# Backend Extras
+
+# Array: Paginate arrays efficiently, avoiding expensive array-wrapping and without overriding
 # See https://ddnexus.github.io/pagy/extras/array
 # require 'pagy/extras/array'
 
+# Searchkick: Paginate `Searchkick::Results` objects efficiently, avoiding expensive oject-wrapping and without overriding.
+# See https://ddnexus.github.io/pagy/extras/searchkick
+# require 'pagy/extras/searchkick'
+
+
+# Frontend Extras
+
 # Bootstrap: Nav helper and templates for Bootstrap pagination
 # See https://ddnexus.github.io/pagy/extras/bootstrap
 # require 'pagy/extras/bootstrap'
@@ -17,9 +40,16 @@
 # See https://ddnexus.github.io/pagy/extras/bulma
 # require 'pagy/extras/bulma'
 
-# 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'
+# Foundation: Nav helper and templates for Foundation pagination
+# See https://ddnexus.github.io/pagy/extras/foundation
+# require 'pagy/extras/foundation'
+
+# Materialize: Nav helper for Materialize pagination
+# See https://ddnexus.github.io/pagy/extras/materialize
+# require 'pagy/extras/materialize'
+
+
+# Feature Extras
 
 # Items: Allow the client to request a custom number of items per page with a ready to use selector UI
 # See https://ddnexus.github.io/pagy/extras/items
@@ -27,38 +57,27 @@
 # Pagy::VARS[:items_param] = :items    # default
 # Pagy::VARS[:max_items]   = 100       # default
 
-# Materialize: Nav helper for Materialize pagination
-# See https://ddnexus.github.io/pagy/extras/materialize
-# require 'pagy/extras/materialize'
-
 # Out Of Range: Allow for easy handling of out of range pages
 # See https://ddnexus.github.io/pagy/extras/out_of_range
 # Pagy::VARS[:out_of_range_mode] = :last_page    # default  (other options: :empty_page and :exception)
 
-# Responsive: On resize, the number of page links will adapt in real-time to the available window/container width
-# See https://ddnexus.github.io/pagy/extras/responsive
-# require 'pagy/extras/responsive'
-# 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
-
-# Searchkick: Paginate `Searchkick::Results` objects efficiently avoiding expensive oject-wrapping and without overriding.
-# See https://ddnexus.github.io/pagy/extras/searchkick
-# require 'pagy/extras/searchkick'
-
 # Trim: Remove the page=1 param from links
 # See https://ddnexus.github.io/pagy/extras/trim
 # require 'pagy/extras/trim'
 
 
+
 # Pagy Variables
 # See https://ddnexus.github.io/pagy/api/pagy#variables
 # All the Pagy::VARS are set for all the Pagy instances but can be overridden
 # per instance by just passing them to Pagy.new or the #pagy controller method
 
+
 # Instance variables
 # See https://ddnexus.github.io/pagy/api/pagy#instance-variables
 # Pagy::VARS[:items] = 20                                   # default
 
+
 # Other Variables
 # See https://ddnexus.github.io/pagy/api/pagy#other-variables
 # Pagy::VARS[:size]       = [1,4,4,1]                       # default
@@ -69,11 +88,15 @@
 # Pagy::VARS[:item_path]  = 'activerecord.models.product'   # example
 
 
+# Rails
+
 # Rails: extras assets path required by compact, items and responsive extras
 # See https://ddnexus.github.io/pagy/extras
 # Rails.application.config.assets.paths << Pagy.root.join('pagy', 'extras', 'javascripts')
 
 
+# I18n
+
 # I18n: faster internal pagy implementation (does not use the I18n gem)
 # Use only for single language apps that don't need dynamic translation between multiple languages
 # See https://ddnexus.github.io/pagy/api/frontend#i18n

data/lib/pagy/extras/responsive.rb

@@ -57,7 +57,7 @@ class Pagy
 
       tags['before'] = +'<ul class="pagination">'
       tags['before'] << (p_prev ? %(<li class="page-item prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</li>)
-                               : %(<li class="page-item prev disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.prev')}</a></li>))
+                                : %(<li class="page-item prev disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.prev')}</a></li>))
       responsive[:items].each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
         tags[item.to_s] = 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
@@ -92,6 +92,27 @@ class Pagy
       %(<nav id="pagy-nav-#{id}" class="pagy-nav-bulma pagination is-centered" role="navigation" aria-label="pagination"></nav>#{script})
     end
 
+    # Responsive pagination for Foundation: it returns the html with the series of links to the pages
+    # rendered by the Pagy.responsive javascript
+    def pagy_nav_responsive_foundation(pagy, id=caller(1,1)[0].hash)
+      tags, link, p_prev, p_next, responsive = {}, pagy_link_proc(pagy), pagy.prev, pagy.next, pagy.responsive
+
+      tags['before'] = +'<ul class="pagination">'
+      tags['before'] << (p_prev ? %(<li class="prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</li>)
+                                : %(<li class="prev disabled">#{pagy_t('pagy.nav.prev')}</li>))
+      responsive[:items].each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
+        tags[item.to_s] = if    item.is_a?(Integer); %(<li>#{link.call item}</li>)                              # page link
+                          elsif item.is_a?(String) ; %(<li class="current"><span class="show-for-sr">#{pagy_t('pagy.nav.current')}</span> #{item}</li>)                        # active page
+                          elsif item == :gap       ; %(<li class="gap disabled">#{pagy_t('pagy.nav.gap')}</li>) # page gap
+                          end
+      end
+      tags['after'] = +(p_next ? %(<li class="next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</li>)
+                               : %(<li class="next disabled">#{pagy_t('pagy.nav.next')}</li>))
+      tags['after'] << '</ul>'
+      script = %(<script type="application/json" class="pagy-responsive-json">["#{id}", #{tags.to_json},  #{responsive[:widths].to_json}, #{responsive[:series].to_json}]</script>)
+      %(<nav id="pagy-nav-#{id}" class="pagy-nav-responsive-foundation" aria-label="Pagination"></nav>#{script})
+    end
+
     # Responsive pagination for Materialize: it returns the html with the series of links to the pages
     # rendered by the Pagy.responsive javascript
     def pagy_nav_responsive_materialize(pagy, id=caller(1,1)[0].hash)

data/lib/pagy/extras/templates/nav_foundation.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) -%>
+<%#                            -%><nav class="pagy-nav-foundation" role="navigation" aria-label="Pagination">
+<%#                            -%>  <ul class="pagination">
+<% if pagy.prev                -%>    <li class="prev"><%== link.call(pagy.prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"') %></li>
+<% else                        -%>    <li class="prev disabled"><%== pagy_t('pagy.nav.prev') %></li>
+<% end                         -%>
+<% pagy.series.each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36] -%>
+<%   if    item.is_a?(Integer) -%>    <li><%== link.call(item) %></li>
+<%   elsif item.is_a?(String)  -%>    <li class="current"><span class="show-for-sr"><%== pagy_t('pagy.nav.current')%></span> <%= item %></li>
+<%   elsif item == :gap        -%>    <li class="disabled gap"><%== pagy_t('pagy.nav.gap') %></li>
+<%   end                       -%>
+<% end                         -%>
+<% if pagy.next                -%>    <li class="next"><%== link.call(pagy.next, pagy_t('pagy.nav.next'), 'aria-label="next"') %></li>
+<% else                        -%>    <li class="next disabled"><%== pagy_t('pagy.nav.next') %></li>
+<% end                         -%>
+<%#                            -%>  </ul>
+<%#                            -%></nav>

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

@@ -0,0 +1,37 @@
+-# 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)
+
+%nav.pagy-nav-foundation{"role" => "navigation", "aria-label" => "Pagination"}
+
+  %ul.pagination
+
+    - if pagy.prev
+      %li.prev!= link.call(pagy.prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"')
+    - else
+      %li.prev.disabled
+        != 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!= link.call(item)
+
+      - elsif item.is_a?(String)                      # current page
+        %li.current
+          %span.show-for-sr
+            != pagy_t('pagy.nav.current')
+          != item
+
+      - elsif item == :gap                            # page gap
+        %li.disabled.gap
+          != pagy_t('pagy.nav.gap')
+
+    - if pagy.next
+      %li.next!= link.call(pagy.next, pagy_t('pagy.nav.next'), 'aria-label="next"')
+    - else
+      %li.next.disabled
+        != pagy_t('pagy.nav.next')

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

@@ -0,0 +1,37 @@
+/ 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)
+
+nav.pagy-nav-foundation role="navigation" aria-label="Pagination"
+
+  ul.pagination
+
+    - if pagy.prev
+      li.prev == link.call(pagy.prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"')
+    - else
+      li.prev.disabled
+        == 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 == link.call(item)
+
+      - elsif item.is_a?(String)                 # current page
+        li.current
+          span.show-for-sr
+            == pagy_t('pagy.nav.current')
+          = item
+
+      - elsif item == :gap                       # page gap
+        li.disabled.gap
+          == pagy_t('pagy.nav.gap')
+
+    - if pagy.next
+      li.next == link.call(pagy.next, pagy_t('pagy.nav.next'), 'aria-label="next"')
+    - else
+      li.next.disabled
+        == pagy_t('pagy.nav.next')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-05 00:00:00.000000000 Z
+date: 2018-08-18 00:00:00.000000000 Z
 dependencies: []
 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,
@@ -29,6 +29,7 @@ files:
 - lib/pagy/extras/bootstrap.rb
 - lib/pagy/extras/bulma.rb
 - lib/pagy/extras/compact.rb
+- lib/pagy/extras/foundation.rb
 - lib/pagy/extras/i18n.rb
 - lib/pagy/extras/initializer_example.rb
 - lib/pagy/extras/items.rb
@@ -46,6 +47,9 @@ files:
 - lib/pagy/extras/templates/nav_bulma.html.erb
 - lib/pagy/extras/templates/nav_bulma.html.haml
 - lib/pagy/extras/templates/nav_bulma.html.slim
+- lib/pagy/extras/templates/nav_foundation.html.erb
+- lib/pagy/extras/templates/nav_foundation.html.haml
+- lib/pagy/extras/templates/nav_foundation.html.slim
 - lib/pagy/extras/trim.rb
 - lib/pagy/frontend.rb
 - pagy.gemspec