pagy 2.1.5 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b070d610f896a8b61e0f100c733e83d8eed0bfce6976ff24ed6e533f329c1ad2
-  data.tar.gz: 6c3654d072aea0dede29f6bf15069cc82ee3d6869ef812db6b78b0dda401013d
+  metadata.gz: 447cda63901d2154f660b143ad95fdc1033bdf8a2f4df8daa1cc3458af6a3b3c
+  data.tar.gz: 325d74734f50dc0b486ec94870b91c73890ea6d63f2ccf12d8b940ceacc864b0
 SHA512:
-  metadata.gz: c4172ff22491bc6506fe9041e71ef6e7abf92c3bee1dbf17f7f067e7a25fd9fa0124f3e5c54dbf30807f2d3df9b49fc432d8683cc8fde0d8434aa4c1686823a6
-  data.tar.gz: 87f78b815480fa7bd1392b4b2991d4af65783acf55ada2dea2724546a1b7c2e0e046e0c5ea838b6c200c8a655d3850f1db9360ae7ee514419e667980759d61f4
+  metadata.gz: 37a5279f51672130fe868a903564584f270ceb952f25cd9d7b2290a4a2c3d9801ad759a7312f9edf97ad5bbe74440326025d7f774017b46ce46bfb99c3b9aaa8
+  data.tar.gz: 61045baceee37a1d1d21e0f2d51303386bc3055afff72f745c6e42d2a6a1b2a34ef373c5058078824dac3a2c841fb952eebba2363e19c6e785ce5edbe1a3ddc2

data/lib/config/pagy.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 # frozen_string_literal: true
 
-# Pagy initializer file (2.1.5)
+# Pagy initializer file (3.0.0)
 # Customize only what you really need and notice that Pagy works also without any of the following lines.
 # Should you just cherry pick part of this file, please maintain the require-order of the extras
 
@@ -32,35 +32,35 @@
 
 # Frontend Extras
 
-# Bootstrap extra: Add nav, responsive and compact helpers and templates for Bootstrap pagination
+# Bootstrap extra: Add nav, nav_js and combo_nav_js helpers and templates for Bootstrap pagination
 # See https://ddnexus.github.io/pagy/extras/bootstrap
 # require 'pagy/extras/bootstrap'
 
-# Bulma extra: Add nav, responsive and compact helpers and templates for Bulma pagination
+# Bulma extra: Add nav, nav_js and combo_nav_js helpers and templates for Bulma pagination
 # See https://ddnexus.github.io/pagy/extras/bulma
 # require 'pagy/extras/bulma'
 
-# Foundation extra: Add nav, responsive and compact helpers and templates for Foundation pagination
+# Foundation extra: Add nav, nav_js and combo_nav_js helpers and templates for Foundation pagination
 # See https://ddnexus.github.io/pagy/extras/foundation
 # require 'pagy/extras/foundation'
 
-# Materialize extra: Nav, responsive and compact helpers for Materialize pagination
+# Materialize extra: Add nav, nav_js and combo_nav_js helpers for Materialize pagination
 # See https://ddnexus.github.io/pagy/extras/materialize
 # require 'pagy/extras/materialize'
 
-# Plain extra: Add responsive and compact nav plain helpers
+# Navs extra: Add nav_js and combo_nav_js javascript helpers
 # Notice: the other frontend extras add their own framework-styled versions,
-# so require this extra only if you need the plain unstyled version
-# See https://ddnexus.github.io/pagy/extras/plain
-# require 'pagy/extras/plain'
+# so require this extra only if you need the unstyled version
+# See https://ddnexus.github.io/pagy/extras/navs
+# require 'pagy/extras/navs'
 
-# Semantic extra: Nav, responsive and compact helpers for Semantic UI pagination
+# Semantic extra: Add nav, nav_js and combo_nav_js helpers for Semantic UI pagination
 # See https://ddnexus.github.io/pagy/extras/semantic
 # require 'pagy/extras/semantic'
 
-# Breakpoints var used by the responsive nav helpers
-# See https://ddnexus.github.io/pagy/extras/plain#breakpoints
-# Pagy::VARS[:breakpoints] = { 0 => [2,3,3,2], 540 => [3,5,5,3], 720 => [5,7,7,5] }
+# Multi size var used by the *_nav_js helpers
+# See https://ddnexus.github.io/pagy/extras/navs#steps
+# Pagy::VARS[:steps] = { 0 => [2,3,3,2], 540 => [3,5,5,3], 720 => [5,7,7,5] }   # example
 
 
 # Feature Extras
@@ -109,12 +109,12 @@
 # Pagy::VARS[:params]     = {}                              # default
 # Pagy::VARS[:anchor]     = '#anchor'                       # example
 # Pagy::VARS[:link_extra] = 'data-remote="true"'            # example
-# Pagy::VARS[:item_path]  = 'activerecord.models.product'   # example
 
 
 # Rails
 
-# Rails: extras assets path required by the compact and responsive navs, and the items extra
+# Rails: extras assets path required by the helpers that use javascript
+# (pagy*_nav_js, pagy*_combo_nav_js, and pagy_items_selector_js)
 # See https://ddnexus.github.io/pagy/extras#javascript
 # Rails.application.config.assets.paths << Pagy.root.join('javascripts')
 
@@ -153,3 +153,6 @@
 # than the default pagy internal i18n (see above)
 # See https://ddnexus.github.io/pagy/extras/i18n
 # require 'pagy/extras/i18n'
+
+# Default i18n key
+# Pagy::VARS[:i18n_key] = 'pagy.item_name'   # default

data/lib/javascripts/pagy.js

@@ -1,8 +1,94 @@
 // See the Pagy documentation: https://ddnexus.github.io/pagy/extras#javascript
 
-// Pagy namespace
 function Pagy(){}
 
+Pagy.init = function(arg){
+              var target   = arg instanceof Event || arg === undefined ? document : arg,
+                  jsonTags = target.getElementsByClassName('pagy-json');
+              for (var i = 0, len = jsonTags.length; i < len; i++) {
+                var args = JSON.parse(jsonTags[i].innerHTML);
+                Pagy[args.shift()].apply(null, args);
+              }
+            };
+
+Pagy.nav = function(id, marker, tags, sequels){
+             var pagyEl    = document.getElementById(id),
+                 container = pagyEl.parentElement,
+                 lastWidth = undefined,
+                 timeoutId = 0,
+                 marker_re = new RegExp(marker, 'g'),
+                 widths    = [];
+             for (var width in sequels) { widths.push(parseInt(width)) } // fine with sequels structure
+             widths.sort(function(a, b){return b-a});
+
+             var render    = function(){
+                               if (container.clientWidth === 0) { rendering() }
+                               var width, i, len;
+                               for (i = 0, len = widths.length; i < len; i++) {
+                                 if (container.clientWidth > widths[i]) { width = widths[i]; break }
+                               }
+                               if (width !== lastWidth) {
+                                 while (pagyEl.firstChild) { pagyEl.removeChild(pagyEl.firstChild) }
+                                 var html   = tags.before,
+                                     series = sequels[width];
+                                 for (i = 0, len = series.length; i < len; i++) {
+                                   var item = series[i];
+                                   if      (typeof(item) === 'number') { html += tags.link.replace(marker_re, item) }
+                                   else if (item === 'gap')            { html += tags.gap }
+                                   else if (typeof(item) === 'string') { html += tags.active.replace(marker_re, item) }
+                                 }
+                                 html += tags.after;
+                                 pagyEl.insertAdjacentHTML('beforeend', html);
+                                 lastWidth = width;
+                               }
+                             },
+                 // suppress rapid firing rendering
+                 rendering = function(){ clearTimeout(timeoutId); timeoutId = setTimeout(render, 150) };
+
+             if (widths.length > 1) {
+               // refresh the window resize listener (avoiding rendering multiple times)
+               window.removeEventListener('resize', Pagy.windowListeners[id], true);
+               window.addEventListener('resize', rendering, true);
+               Pagy.windowListeners[id] = rendering;
+             }
+             render();
+           };
+
+Pagy.combo_nav = function(id, marker, page, trim){
+                   var pagyEl = document.getElementById(id),
+                       input  = pagyEl.getElementsByTagName('input')[0],
+                       link   = pagyEl.getElementsByTagName('a')[0],
+                       linkP1 = pagyEl.getElementsByTagName('a')[1],
+                       go     = function(){
+                                  if (page !== input.value) {
+                                    if (trim === true && input.value === '1') { linkP1.click() }
+                                    else {
+                                      var href = link.getAttribute('href').replace(marker, input.value);
+                                      link.setAttribute('href', href);
+                                      link.click();
+                                    }
+                                  }
+                                };
+                   Pagy.addInputEventListeners(input, go);
+                 };
+
+Pagy.items_selector = function(id, marker, from){
+                        var pagyEl  = document.getElementById(id),
+                            input   = pagyEl.getElementsByTagName('input')[0],
+                            current = input.value,
+                            link    = pagyEl.getElementsByTagName('a')[0],
+                            go      = function(){
+                                        var items = input.value;
+                                        if (current !== items) {
+                                          var page = Math.max(Math.ceil(from / items),1);
+                                          var href = link.getAttribute('href').replace(marker+'-page-', page).replace(marker+'-items-', items);
+                                          link.setAttribute('href', href);
+                                          link.click();
+                                        }
+                                      };
+                        Pagy.addInputEventListeners(input, go);
+                      };
+
 Pagy.windowListeners = {};
 
 Pagy.addInputEventListeners = function(input, handler){
@@ -14,81 +100,3 @@ Pagy.addInputEventListeners = function(input, handler){
                                 input.addEventListener('keyup', function(e){ if (e.which === 13) handler() }.bind(this));
                               };
 
-Pagy.compact = function(id, marker, page, trim){
-                 var pagyEl = document.getElementById(id),
-                     input  = pagyEl.getElementsByTagName('input')[0],
-                     link   = pagyEl.getElementsByTagName('a')[0],
-                     linkP1 = pagyEl.getElementsByTagName('a')[1],
-                     go     = function(){
-                                if (page !== input.value) {
-                                  if (trim === true && input.value === '1') { linkP1.click() }
-                                  else {
-                                    var href = link.getAttribute('href').replace(marker, input.value);
-                                    link.setAttribute('href', href);
-                                    link.click();
-                                  }
-                                }
-                              };
-                 Pagy.addInputEventListeners(input, go);
-               };
-
-Pagy.items = function(id, marker, from){
-               var pagyEl  = document.getElementById(id),
-                   input   = pagyEl.getElementsByTagName('input')[0],
-                   current = input.value,
-                   link    = pagyEl.getElementsByTagName('a')[0],
-                   go      = function(){
-                               var items = input.value;
-                               if (current !== items) {
-                                 var page = Math.max(Math.ceil(from / items),1);
-                                 var href = link.getAttribute('href').replace(marker+'-page-', page).replace(marker+'-items-', items);
-                                 link.setAttribute('href', href);
-                                 link.click();
-                               }
-                             };
-               Pagy.addInputEventListeners(input, go);
-             };
-
-Pagy.responsive = function(id, tags, widths, series){
-                    var pagyEl    = document.getElementById(id),
-                        container = pagyEl.parentElement,
-                        lastWidth = undefined,
-                        timeoutId = 0,
-                        render    = function(){
-                                      if (container.clientWidth === 0) { rendering() }
-                                      var width, i, len;
-                                      for (i = 0, len = widths.length; i < len; i++) {
-                                        if (container.clientWidth > widths[i]) { width = widths[i]; break }
-                                      }
-                                      if (width !== lastWidth) {
-                                        while (pagyEl.firstChild) { pagyEl.removeChild(pagyEl.firstChild) }
-                                        var html  = tags['before'],
-                                            items = series[width];
-                                        for (i = 0, len = items.length; i < len; i++) { html += tags[items[i]] }
-                                        html += tags['after'];
-                                        pagyEl.insertAdjacentHTML('beforeend', html);
-                                        lastWidth = width;
-                                      }
-                                    },
-                        // suppress rapid firing rendering
-                        rendering = function(){ clearTimeout(timeoutId); timeoutId = setTimeout(render, 150) };
-                    // refresh the window resize listener (avoiding rendering multiple times)
-                    window.removeEventListener('resize', Pagy.windowListeners[id], true);
-                    window.addEventListener('resize', rendering, true);
-                    Pagy.windowListeners[id] = rendering;
-                    render();
-                  };
-
-Pagy.init = function(arg){
-              var target   = arg instanceof Event || arg === undefined ? document : arg,
-                  jsonTags = target.getElementsByClassName('pagy-json');
-              for (var i = 0, len = jsonTags.length; i < len; i++) {
-                var args = JSON.parse(jsonTags[i].innerHTML);
-                Pagy[args.shift()].apply(null, args);
-              }
-            };
-
-// namespace for custom init functions
-function PagyInit(){}
-
-Pagy.applyInit = function(name, payload){ PagyInit[name].apply(null, [payload]) };

data/lib/locales/README.md

@@ -2,11 +2,24 @@
 
 ### Please, submit your translation!
 
+If you find that some translation could be improved, please, create an issue.
+
 If you are using pagy with some language missing from the dictionary files, please, submit your translation!
 
-The `pagy.info.single_page`, `pagy.info.item_name` and `pagy.items` keys of the yaml file are pluralized according to the plural rules of the language.
+You can create a Pull Request for your language, and get all the help you need to correctly complete it. Here is a check list.
+
+### Check list for a new dictionary file:
+
+- [ ] Find the pluralization rule for your language
+    - find the locale file you need in the [list of pluralizations](https://github.com/svenfuchs/rails-i18n/tree/master/rails/pluralization) and check the pluralization rule in it. For example for `en.rb` it is`::RailsI18n::Pluralization::OneOther.with_locale(:en)`. Note the rule part i.e. `OneOther`. In pagy that translates to the symbol `:one_other`.
+
+- [ ] add/edit the first line comment in the language rule in your dictionary file (e.g. `# :one_other pluralization ...`
+
+- [ ] The mandatory pluralized entry in the dictionary file is the `item_name`. Please, provide all the plurals needed by your language. E.g. if your language uses the `:east_slavic` you should provide the plurals for `one`, `few`, `many` and `other`, if it uses `:one_other`, you should provide `one` and `other` plurals. If it uses `:other` you should only provide a single value. Look into other dictionary files to get some example. Ask if in doubt.
+
+- [ ] The other entries in the dictionary file don't need any plural variant in most languages since the pluralization of the `item_name` in the sentence is enough. However, in some language, the whole sentence needs to be written in a different way for different plurals. In that case you should add the different plurals for the sentence and they will get triggered by the `count`.
 
-If you are going to submit a dictionary, please check wether the pluralization type of your language exists in the [lib/locales/utils/p11n.rb](utils/p11n.rb) file. If it is missing, please, report it. Thanks.
+Feel free to ask for help in your Pull Request.
 
 ### Useful Links
 

data/lib/locales/de.yml

@@ -1,20 +1,22 @@
+# :one_other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
+
 de:
   pagy:
+
+    item_name:
+      one: "Eintrag"
+      other: "Einträge"
+
     nav:
       prev: "‹ Zurück"
       next: "Weiter ›"
       gap: "…"
+
     info:
-      single_page:
-        zero: "Kein %{item_name} gefunden"
-        one: "Zeige <b>1</b> %{item_name}"
-        other: "Zeige <b>alle %{count}</b> %{item_name}"
+      no_items: "Kein %{item_name} gefunden"
+      single_page: "Zeige <b>%{count}</b> %{item_name}"
       multiple_pages: "Zeige %{item_name} <b>%{from}-%{to}</b> von <b>%{count}</b> gesamt"
-      item_name:
-        zero: "Eintrag"
-        one: "Eintrag"
-        other: "Einträge"
-    compact: "Seite %{page_input} von %{pages}"
-    items:
-      one: "Zeige %{items_input} Eintrag pro Seite"
-      other: "Zeige %{items_input} Einträge pro Seite"
+
+    combo_nav_js: "Seite %{page_input} von %{pages}"
+
+    items_selector_js: "Zeige %{items_input} %{item_name} pro Seite"

data/lib/locales/en.yml

@@ -1,20 +1,22 @@
+# :one_other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
+
 en:
   pagy:
+
+    item_name:
+      one: "item"
+      other: "items"
+
     nav:
       prev: "‹ Prev"
       next: "Next ›"
       gap: "…"
+
     info:
-      single_page:
-        zero: "No %{item_name} found"
-        one: "Displaying <b>1</b> %{item_name}"
-        other: "Displaying <b>all %{count}</b> %{item_name}"
+      no_items: "No %{item_name} found"
+      single_page: "Displaying <b>%{count}</b> %{item_name}"
       multiple_pages: "Displaying %{item_name} <b>%{from}-%{to}</b> of <b>%{count}</b> in total"
-      item_name:
-        zero: "items"
-        one: "item"
-        other: "items"
-    compact: "Page %{page_input} of %{pages}"
-    items:
-      one: "Show %{items_input} item per page"
-      other: "Show %{items_input} items per page"
+
+    combo_nav_js: "Page %{page_input} of %{pages}"
+
+    items_selector_js: "Show %{items_input} %{item_name} per page"

data/lib/locales/es.yml

@@ -1,20 +1,22 @@
+# :one_other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
+
 es:
   pagy:
+
+    item_name:
+      one: "ítem"
+      other: "ítems"
+
     nav:
       prev: "‹ Prev"
       next: "Siguiente ›"
       gap: "…"
+
     info:
-      single_page:
-        zero: "Sin resultados"
-        one: "Mostrando 1 %{item_name}"
-        other: "Mostrando %{count} %{item_name}"
+      no_items: "Sin resultados"
+      single_page: "Mostrando %{count} %{item_name}"
       multiple_pages: "Mostrando %{item_name} %{from}-%{to} de %{count} en total"
-      item_name:
-        zero: "ítems"
-        one: "ítem"
-        other: "ítems"
-    compact: "Página %{page_input} de %{pages}"
-    items:
-      one: "Mostrar %{items_input} ítem por página"
-      other: "Mostrar %{items_input} ítems por página"
+
+    combo_nav_js: "Página %{page_input} de %{pages}"
+
+    items_selector_js: "Mostrar %{items_input} %{item_name} por página"

data/lib/locales/fr.yml

@@ -0,0 +1,22 @@
+# :one_upto_two_other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
+
+fr:
+  pagy:
+
+    item_name:
+      one: "élement"
+      other: "élements"
+
+    nav:
+      prev: "‹ Précédent"
+      next: "Suivant ›"
+      gap: "…"
+
+    info:
+      no_items: "Aucun %{item_name} trouvé"
+      single_page: "Affichage de <b>%{count}</b> %{item_name}"
+      multiple_pages: "Affichage des %{item_name} <b>%{from} à %{to}</b> sur <b>%{count}</b> au total"
+
+    combo_nav_js: "Page %{page_input} sur %{pages}"
+
+    items_selector_js: "Afficher %{items_input} %{item_name} par page"

data/lib/locales/id.yml

@@ -1,20 +1,20 @@
+# :other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
+
 id:
   pagy:
+
+    item_name: "item"
+
     nav:
-      prev: "‹ Balik"
-      next: "Lanjut ›"
+      prev: "‹ Sebelumnya"
+      next: "Selanjutnya ›"
       gap: "…"
+
     info:
-      single_page:
-        zero: "Tidak ditemukan %{item_name}"
-        one: "Menampilkan <b>1</b> %{item_name}"
-        other: "Menampilkan <b>semua %{count}</b> %{item_name}"
+      no_items: "Tidak ditemukan %{item_name}"
+      single_page: "Menampilkan <b>%{count}</b> %{item_name}"
       multiple_pages: "Menampilkan %{item_name} <b>%{from}-%{to}</b> dari total <b>%{count}</b>"
-      item_name:
-        zero: "item"
-        one: "item"
-        other: "item"
-    compact: "Halaman %{page_input} dari %{pages}"
-    items:
-      one: "Tampilkan %{items_input} item per halaman"
-      other: "Tampilkan %{items_input} item per halaman"
+
+    combo_nav_js: "Halaman %{page_input} dari %{pages}"
+
+    items_selector_js: "Tampilkan %{items_input} %{item_name} per halaman"