pagy 3.3.2 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10ba8b6d06ab5a7b5a8200742565f8193484e664eaecd342102ff001a03c9dd5
-  data.tar.gz: 273c70974fafb3b8c01392254ba45a86af6654a2442229afb403ec29407b76ad
+  metadata.gz: d1414283eb3f96c82e975d0436ebf6dee87cdc037d91c152ed13dd97a3a2cc58
+  data.tar.gz: 907bc851219c314bbdfe95a373b77c562de51c81495ada5686d6c57b61be826c
 SHA512:
-  metadata.gz: e8f98ade89e75ce830bd933a2a21c8075c9b00e1f08de5e0797a1178d058707931956b16d5cd2cc818427bbb24464a398c4ebc114b92fde6d671667aedf79d6b
-  data.tar.gz: f70784721380571f8286379cf70e34badd30cea3d57ac89f70b5c99704d1b4719192f2cca0e59b7aa34f0cc0f32b22175752d224f187dbba7aadd1eb7b404320
+  metadata.gz: 9a3c417007ffa03a904714ac4d807adc215645e5518429a14490a3430426374a9bac45d55882e5a0c4e3969bdd258c5a78dad2c04f7ed6f775c9d8aa43abc798
+  data.tar.gz: 653e0bbd6b8b8c0b71b16f9983d3c7e5d2c14b33b176a5100a2cd7e63aaca41c565dbae0589bafcc2ee6c9e5b56939047a40668b2615e4db6f53fbeaf3cbc9d0

data/lib/config/pagy.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 # frozen_string_literal: true
 
-# Pagy initializer file (3.3.2)
+# Pagy initializer file (3.6.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
 
@@ -58,6 +58,10 @@
 # See https://ddnexus.github.io/pagy/extras/semantic
 # require 'pagy/extras/semantic'
 
+# UIkit extra: Add nav helper and templates for UIkit pagination
+# See https://ddnexus.github.io/pagy/extras/uikit
+# require 'pagy/extras/uikit'
+
 # 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
@@ -85,6 +89,14 @@
 # require 'pagy/extras/overflow'
 # Pagy::VARS[:overflow] = :empty_page    # default  (other options: :last_page and :exception)
 
+# Metadata extra: Provides the pagination metadata to Javascript frameworks like Vue.js, react.js, etc.
+# See https://ddnexus.github.io/pagy/extras/metadata
+# you must require the shared internal extra (BEFORE the metadata extra) ONLY if you need also the :sequels
+# require 'pagy/extras/shared'
+# require 'pagy/extras/metadata'
+# For performance reason, you should explicitly set ONLY the metadata you use in the frontend
+# Pagy::VARS[:metadata] = [:scaffold_url, :count, :page, :prev, :next, :last]    # example
+
 # Trim extra: Remove the page=1 param from links
 # See https://ddnexus.github.io/pagy/extras/trim
 # require 'pagy/extras/trim'

data/lib/javascripts/pagy.js

@@ -2,6 +2,8 @@
 
 function Pagy(){}
 
+Pagy.version = '3.6.0';
+
 Pagy.init = function(arg){
               var target   = arg instanceof Event || arg === undefined ? document : arg,
                   jsonTags = target.getElementsByClassName('pagy-json');

data/lib/locales/ca.yml

@@ -0,0 +1,22 @@
+# :one_other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
+
+ca:
+  pagy:
+
+    item_name:
+      one: "element"
+      other: "elements"
+
+    nav:
+      prev: "‹ Anterior"
+      next: "Següent ›"
+      gap: "…"
+
+    info:
+      no_items: "No s'ha trobat cap resultat"
+      single_page: "Mostrant <b>%{count}</b> %{item_name}"
+      multiple_pages: "Mostrant %{item_name} <b>%{from}-%{to}</b> de <b>%{count}</b> en total"
+
+    combo_nav_js: "Pàgina %{page_input} de %{pages}"
+
+    items_selector_js: "Mostra %{items_input} %{item_name} per pàgina"

data/lib/locales/ko.yml

@@ -0,0 +1,20 @@
+# :other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
+
+ko:
+  pagy:
+
+    item_name: "항목"
+
+    nav:
+      prev: "‹ 이전"
+      next: "이후 ›"
+      gap: "…"
+
+    info:
+      no_items: "%{item_name} 없음"
+      single_page: "<b>%{count}</b>개의 %{item_name} 표시됨"
+      multiple_pages: "총 <b>%{count}</b>개의 %{item_name} 중 <b>%{from}-%{to}</b>"
+
+    combo_nav_js: "총 %{pages} 중 %{page_input} 페이지"
+
+    items_selector_js: "페이지 당 %{items_input}개 표시%"

data/lib/locales/utils/p11n.rb

@@ -63,6 +63,7 @@ plurals = Hash.new(p11n[:one_other]).tap do |hash|
   hash['id'] = p11n[:other]
   hash['fr'] = p11n[:one_upto_two_other]
   hash['ja'] = p11n[:other]
+  hash['ko'] = p11n[:other]
   hash['pl'] = p11n[:polish]
   hash['ru'] = p11n[:east_slavic]
   hash['se'] = p11n[:one_two_other]

data/lib/pagy.rb

@@ -4,7 +4,7 @@
 
 require 'pathname'
 
-class Pagy ; VERSION = '3.3.2'
+class Pagy ; VERSION = '3.6.0'
 
   # Root pathname to get the path of Pagy files like templates or dictionaries
   def self.root; @root ||= Pathname.new(__FILE__).dirname.freeze end

data/lib/pagy/extras/arel.rb

@@ -0,0 +1,31 @@
+# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/arel
+# encoding: utf-8
+# frozen_string_literal: true
+
+class Pagy
+  module Backend ; private
+
+    def pagy_arel(collection, vars={})
+      pagy = Pagy.new(pagy_arel_get_vars(collection, vars))
+      return pagy, pagy_get_items(collection, pagy)
+    end
+
+    def pagy_arel_get_vars(collection, vars)
+      vars[:count] ||= pagy_arel_count(collection)
+      vars[:page]  ||= params[ vars[:page_param] || VARS[:page_param] ]
+      vars
+    end
+
+    def pagy_arel_count(collection)
+      if collection.group_values.empty?
+        # COUNT(*)
+        collection.count(:all)
+      else
+        # COUNT(*) OVER ()
+        sql = Arel.star.count.over(Arel::Nodes::Grouping.new([]))
+        collection.unscope(:order).limit(1).pluck(sql).first
+      end
+    end
+
+  end
+end

data/lib/pagy/extras/elasticsearch_rails.rb

@@ -13,7 +13,8 @@ class Pagy
   def self.new_from_elasticsearch_rails(response, vars={})
     vars[:items] = response.search.options[:size] || 10
     vars[:page]  = (response.search.options[:from] || 0) / vars[:items] + 1
-    vars[:count] = response.raw_response['hits']['total']
+    total        = response.raw_response['hits']['total']
+    vars[:count] = total.is_a?(Hash) ? total['value'] : total
     new(vars)
   end
 
@@ -21,17 +22,18 @@ class Pagy
   module Backend ; private
 
     # Return Pagy object and items
-    def pagy_elasticsearch_rails(search_args, vars={})
-      model, query_or_payload, options, _block, *called = search_args
-      vars           = pagy_elasticsearch_rails_get_vars(nil, vars)
-      options[:size] = vars[:items]
-      options[:from] = vars[:items] * (vars[:page] - 1)
-      response       = model.search(query_or_payload, options)
-      vars[:count]   = response.raw_response['hits']['total']
+    def pagy_elasticsearch_rails(pagy_search_args, vars={})
+      model, search_args, _block, *called = pagy_search_args
+      vars                   = pagy_elasticsearch_rails_get_vars(nil, vars)
+      search_args[-1][:size] = vars[:items]
+      search_args[-1][:from] = vars[:items] * (vars[:page] - 1)
+      response               = model.search(*search_args)
+      total                  = response.raw_response['hits']['total']
+      vars[:count]           = total.is_a?(Hash) ? total['value'] : total
       pagy = Pagy.new(vars)
       # with :last_page overflow we need to re-run the method in order to get the hits
       if defined?(OVERFLOW) && pagy.overflow? && pagy.vars[:overflow] == :last_page
-        return pagy_elasticsearch_rails(search_args, vars.merge(page: pagy.page))
+        return pagy_elasticsearch_rails(pagy_search_args, vars.merge(page: pagy.page))
       end
       return pagy, called.empty? ? response : response.send(*called)
     end

data/lib/pagy/extras/metadata.rb

@@ -0,0 +1,37 @@
+# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/metadata
+# encoding: utf-8
+# frozen_string_literal: true
+
+class Pagy
+  # Add a specialized backend method for pagination metadata
+  module Backend ; private
+
+    METADATA = [ :scaffold_url, :first_url, :prev_url, :page_url, :next_url, :last_url,
+                 :count, :page, :items, :vars, :pages, :last, :from, :to, :prev, :next, :series ]
+    METADATA << :sequels if VARS.key?(:steps)  # :steps gets defined along with the #sequels method
+
+    VARS[:metadata] = METADATA.dup
+
+    include Helpers
+
+    def pagy_metadata(pagy, url=false)
+      names = pagy.vars[:metadata]
+      (unknown = names - METADATA).empty? or raise(VariableError.new(pagy), "unknown metadata #{unknown.inspect}")
+      scaffold_url = pagy_url_for(Frontend::MARK, pagy, url)
+      metadata = {}
+      names.each do |key|
+        metadata[key] = case key
+                        when :scaffold_url ; scaffold_url
+                        when :first_url    ; scaffold_url.sub(Frontend::MARK, 1.to_s)
+                        when :prev_url     ; scaffold_url.sub(Frontend::MARK, pagy.prev.to_s)
+                        when :page_url     ; scaffold_url.sub(Frontend::MARK, pagy.page.to_s)
+                        when :next_url     ; scaffold_url.sub(Frontend::MARK, pagy.next.to_s)
+                        when :last_url     ; scaffold_url.sub(Frontend::MARK, pagy.last.to_s)
+                        else pagy.send(key)
+                        end
+      end
+      metadata
+    end
+
+  end
+end

data/lib/pagy/extras/pagy_search.rb

@@ -7,8 +7,10 @@ class Pagy
     # returns an array used to delay the call of #search
     # after the pagination variables are merged to the options
     # it also pushes to the same array an eventually called method and arguments
-    def pagy_search(arg, options={}, &block)
-      [self, arg, options, block].tap do |args|
+    # the last search argument must be a hash option
+    def pagy_search(*search_args, &block)
+      search_args << {} unless search_args[-1].is_a?(Hash)
+      [self, search_args, block].tap do |args|
         args.define_singleton_method(:method_missing){|*a| args += a}
       end
     end

data/lib/pagy/extras/searchkick.rb

@@ -21,17 +21,17 @@ class Pagy
   module Backend ; private
 
     # Return Pagy object and results
-    def pagy_searchkick(search_args, vars={})
-      model, term, options, block, *called = search_args
-      vars               = pagy_searchkick_get_vars(nil, vars)
-      options[:per_page] = vars[:items]
-      options[:page]     = vars[:page]
-      results            = model.search(term, options, &block)
-      vars[:count]       = results.total_count
+    def pagy_searchkick(pagy_search_args, vars={})
+      model, search_args, block, *called = pagy_search_args
+      vars                       = pagy_searchkick_get_vars(nil, vars)
+      search_args[-1][:per_page] = vars[:items]
+      search_args[-1][:page]     = vars[:page]
+      results                    = model.search(*search_args, &block)
+      vars[:count]               = results.total_count
       pagy = Pagy.new(vars)
       # with :last_page overflow we need to re-run the method in order to get the hits
       if defined?(OVERFLOW) && pagy.overflow? && pagy.vars[:overflow] == :last_page
-        return pagy_searchkick(search_args, vars.merge(page: pagy.page))
+        return pagy_searchkick(pagy_search_args, vars.merge(page: pagy.page))
       end
       return pagy, called.empty? ? results : results.send(*called)
     end

data/lib/pagy/extras/uikit.rb

@@ -0,0 +1,62 @@
+# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/uikit
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'pagy/extras/shared'
+
+class Pagy
+  module Frontend
+
+    # Pagination for uikit: it returns the html with the series of links to the pages
+    def pagy_uikit_nav(pagy)
+      link, p_prev, p_next = pagy_link_proc(pagy), pagy.prev, pagy.next
+
+      previous_span = "<span uk-pagination-previous>#{pagy_t('pagy.nav.prev')}</span>"
+      html = EMPTY + (p_prev ? %(<li>#{link.call p_prev, previous_span}</li>)
+                             : %(<li class="uk-disabled"><a href="#">#{previous_span}</a></li>))
+      pagy.series.each do |item|
+        html << if    item.is_a?(Integer); %(<li>#{link.call item}</li>)
+                elsif item.is_a?(String) ; %(<li class="uk-active"><span>#{item}</span></li>)
+                elsif item == :gap       ; %(<li class="uk-disabled"><span>#{pagy_t('pagy.nav.gap')}</span></li>)
+                end
+      end
+      next_span = "<span uk-pagination-next>#{pagy_t('pagy.nav.next')}</span>"
+      html << (p_next ? %(<li>#{link.call p_next, next_span}</li>)
+                      : %(<li class="uk-disabled"><a href="#">#{next_span}</a></li>))
+      %(<ul class="pagy-uikit-nav uk-pagination uk-flex-center">#{html}</ul>)
+    end
+
+    # Javascript pagination for uikit: it returns a nav and a JSON tag used by the Pagy.nav javascript
+    def pagy_uikit_nav_js(pagy, id=pagy_id)
+      link, p_prev, p_next = pagy_link_proc(pagy), pagy.prev, pagy.next
+      previous_span = "<span uk-pagination-previous>#{pagy_t('pagy.nav.prev')}</span>"
+      next_span     = "<span uk-pagination-next>#{pagy_t('pagy.nav.next')}</span>"
+      tags = { 'before' => p_prev ? %(<li>#{link.call p_prev, previous_span}</li>)
+                                  : %(<li class="uk-disabled"><a href="#">#{previous_span}</a></li>),
+               'link'   => %(<li>#{link.call(MARK)}</li>),
+               'active' => %(<li class="uk-active"><span>#{MARK}</span></li>),
+               'gap'    => %(<li class="uk-disabled"><span>#{pagy_t('pagy.nav.gap')}</span></li>),
+               'after'  => p_next ? %(<li>#{link.call p_next, next_span}</li>)
+                                  : %(<li class="uk-disabled"><a href="#">#{next_span}</a></li>) }
+      %(<ul id="#{id}" class="pagy-uikit-nav-js uk-pagination uk-flex-center"></ul>#{pagy_json_tag(:nav, id, tags, pagy.sequels, defined?(TRIM) && pagy.vars[:page_param])})
+    end
+
+    # Javascript combo pagination for uikit: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript
+    def pagy_uikit_combo_nav_js(pagy, id=pagy_id)
+      link, p_prev, p_next, p_page, p_pages = pagy_link_proc(pagy), pagy.prev, pagy.next, pagy.page, pagy.pages
+
+      html = %(<div id="#{id}" class="pagy-uikit-combo-nav-js uk-button-group">)
+      html = html + (p_prev ? link.call(p_prev, pagy_t('pagy.nav.prev'), 'class="uk-button uk-button-default"')
+                            : %(<button class="uk-button uk-button-default" disabled>#{pagy_t('pagy.nav.prev')}</button>))
+
+      html << %(<div class="uk-text-middle uk-margin-left uk-margin-right">)
+      input = %(<input type="number" min="1" max="#{p_pages}" value="#{p_page}" class="uk-input" style="padding: 0; text-align: center; width: #{p_pages.to_s.length+1}rem;">)
+      html << pagy_t('pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages) + '</div>'
+
+      html << (p_next ? link.call(p_next, pagy_t('pagy.nav.next'), 'class="uk-button uk-button-default"')
+                      : %(<button class="uk-button uk-button-default" disabled>#{pagy_t('pagy.nav.next')}</button>))
+
+      html << %(</div>#{pagy_json_tag(:combo_nav, id, p_page, pagy_marked_link(link), defined?(TRIM) && pagy.vars[:page_param])})
+    end
+  end
+end

data/lib/templates/uikit_nav.html.erb

@@ -0,0 +1,15 @@
+<% link = pagy_link_proc(pagy) -%>
+<%#                            -%> <ul class="uk-pagination uk-flex-center">
+<% if page.prev                -%>   <li><%== link.call(pagy.prev, "<span uk-pagination-previous>#{pagy_t('pagy.nav.prev')}</span>") %></li>
+<% else                        -%>   <li class="uk-disabled"><a href="#"><span uk-pagination-previous><%== pagy_t('pagy.nav.prev') %></span></a></li>
+<% end                         -%>
+<% pagy.series.each do |item|  -%>
+<%   if    item.is_a?(Integer) -%>   <li><%== link.call(item) %></li>
+<%   elsif item.is_a?(String)  -%>   <li class="uk-active"><span><%== item %></span></li>
+<%   elsif item == :gap        -%>   <li class="uk-disabled"><span><%== pagy_t('pagy.nav.gap') %></span></li>
+<%   end                       -%>
+<% end                         -%>
+<% if pagy.next                -%>   <li><%== link.call(p_next, "<span uk-pagination-next>#{pagy_t('pagy.nav.next')}</span>") %></li>
+<% else                        -%>   <li class="uk-disabled"><a href="#"><span uk-pagination-next><%== pagy_t('pagy.nav.next') %></span></a></li>
+<% end                         -%>
+<%#                            -%> </ul>

data/lib/templates/uikit_nav.html.haml

@@ -0,0 +1,28 @@
+- link = pagy_link_proc(pagy)
+
+%ul.uk-pagination.uk-flex-center
+  - if page.prev
+    %li!= link.call(pagy.prev, "<span uk-pagination-previous>#{pagy_t('pagy.nav.prev')}</span>")
+  - else
+    %li.uk-disabled
+      %a{href: "#"}
+        %span{"uk-pagination-previous" => ""}!= pagy_t('pagy.nav.prev')
+
+  - pagy.series.each do |item|
+    - if    item.is_a?(Integer)
+      %li!= link.call(item)
+
+    - elsif item.is_a?(String)
+      %li.uk-active
+        %span!= item
+
+    - elsif item == :gap
+      %li.uk-disabled
+        %span!= pagy_t('pagy.nav.gap')
+
+  - if pagy.next
+    %li!= link.call(p_next, "<span uk-pagination-next>#{pagy_t('pagy.nav.next')}</span>")
+  - else
+    %li.uk-disabled
+      %a{href: "#"}
+        %span{"uk-pagination-next" => ""}!= pagy_t('pagy.nav.next')

data/lib/templates/uikit_nav.html.slim

@@ -0,0 +1,28 @@
+- link = pagy_link_proc(pagy)
+
+ul.uk-pagination.uk-flex-center
+  - if page.prev
+    li== link.call(pagy.prev, "<span uk-pagination-previous>#{pagy_t('pagy.nav.prev')}</span>")
+  - else
+    li.uk-disabled
+      a href="#"
+        span uk-pagination-previous="" == pagy_t('pagy.nav.prev')
+
+  - pagy.series.each do |item|
+    - if    item.is_a?(Integer)
+      li== link.call(item)
+
+    - elsif item.is_a?(String)
+      li.uk-active
+        span== item
+
+    - elsif item == :gap
+      li.uk-disabled
+        span== pagy_t('pagy.nav.gap')
+
+  - if pagy.next
+    li== link.call(p_next, "<span uk-pagination-next>#{pagy_t('pagy.nav.next')}</span>")
+  - else
+    li.uk-disabled
+      a href="#"
+        span uk-pagination-next="" == pagy_t('pagy.nav.next')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 3.6.0
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-06 00:00:00.000000000 Z
+date: 2019-10-06 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,
@@ -24,12 +24,14 @@ files:
 - lib/javascripts/pagy.js
 - lib/locales/README.md
 - lib/locales/bg.yml
+- lib/locales/ca.yml
 - lib/locales/de.yml
 - lib/locales/en.yml
 - lib/locales/es.yml
 - lib/locales/fr.yml
 - lib/locales/id.yml
 - lib/locales/ja.yml
+- lib/locales/ko.yml
 - lib/locales/nb.yml
 - lib/locales/nl.yml
 - lib/locales/pl.yml
@@ -47,6 +49,7 @@ files:
 - lib/pagy/backend.rb
 - lib/pagy/countless.rb
 - lib/pagy/exceptions.rb
+- lib/pagy/extras/arel.rb
 - lib/pagy/extras/array.rb
 - lib/pagy/extras/bootstrap.rb
 - lib/pagy/extras/bulma.rb
@@ -57,6 +60,7 @@ files:
 - lib/pagy/extras/i18n.rb
 - lib/pagy/extras/items.rb
 - lib/pagy/extras/materialize.rb
+- lib/pagy/extras/metadata.rb
 - lib/pagy/extras/navs.rb
 - lib/pagy/extras/overflow.rb
 - lib/pagy/extras/pagy_search.rb
@@ -65,6 +69,7 @@ files:
 - lib/pagy/extras/shared.rb
 - lib/pagy/extras/support.rb
 - lib/pagy/extras/trim.rb
+- lib/pagy/extras/uikit.rb
 - lib/pagy/frontend.rb
 - lib/templates/bootstrap_nav.html.erb
 - lib/templates/bootstrap_nav.html.haml
@@ -78,6 +83,9 @@ files:
 - lib/templates/nav.html.erb
 - lib/templates/nav.html.haml
 - lib/templates/nav.html.slim
+- lib/templates/uikit_nav.html.erb
+- lib/templates/uikit_nav.html.haml
+- lib/templates/uikit_nav.html.slim
 - pagy.gemspec
 homepage: https://github.com/ddnexus/pagy
 licenses:
@@ -98,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: The Ultimate Pagination Ruby Gem