pagy 4.3.0 → 4.4.0

data/lib/pagy/extras/support.rb

@@ -6,35 +6,39 @@ class Pagy
   module Frontend
 
     def pagy_prev_url(pagy)
-      pagy_url_for(pagy.prev, pagy) if pagy.prev
+      pagy_url_for(pagy, pagy.prev) if pagy.prev
     end
 
     def pagy_next_url(pagy)
-      pagy_url_for(pagy.next, pagy) if pagy.next
+      pagy_url_for(pagy, pagy.next) if pagy.next
     end
 
-    def pagy_prev_link(pagy, text = pagy_t('pagy.nav.prev'), link_extra = '')
+    def pagy_prev_link(pagy, deprecated_text=nil, deprecated_link_extra=nil, text: pagy_t('pagy.nav.prev'), link_extra: '')
+      text       = Pagy.deprecated_arg(:text, deprecated_text, :text, text) if deprecated_text
+      link_extra = Pagy.deprecated_arg(:link_extra, deprecated_link_extra, :link_extra, link_extra) if deprecated_link_extra
       if pagy.prev
-        %(<span class="page prev"><a href="#{pagy_url_for(pagy.prev, pagy)}" rel="prev" aria-label="previous" #{pagy.vars[:link_extra]} #{link_extra}>#{text}</a></span>)
+        %(<span class="page prev"><a href="#{pagy_url_for(pagy, pagy.prev)}" rel="prev" aria-label="previous" #{pagy.vars[:link_extra]} #{link_extra}>#{text}</a></span>)
       else
         %(<span class="page prev disabled">#{text}</span>)
       end
     end
 
-    def pagy_next_link(pagy, text = pagy_t('pagy.nav.next'), link_extra = '')
+    def pagy_next_link(pagy, deprecated_text=nil, deprecated_link_extra=nil, text: pagy_t('pagy.nav.next'), link_extra: '')
+      text       = Pagy.deprecated_arg(:text, deprecated_text, :text, text) if deprecated_text
+      link_extra = Pagy.deprecated_arg(:link_extra, deprecated_link_extra, :link_extra, link_extra) if deprecated_link_extra
       if pagy.next
-        %(<span class="page next"><a href="#{pagy_url_for(pagy.next, pagy)}" rel="next" aria-label="next" #{pagy.vars[:link_extra]} #{link_extra}>#{text}</a></span>)
+        %(<span class="page next"><a href="#{pagy_url_for(pagy, pagy.next)}" rel="next" aria-label="next" #{pagy.vars[:link_extra]} #{link_extra}>#{text}</a></span>)
       else
         %(<span class="page next disabled">#{text}</span>)
       end
     end
 
     def pagy_prev_link_tag(pagy)
-      %(<link href="#{pagy_url_for(pagy.prev, pagy)}" rel="prev"/>) if pagy.prev
+      %(<link href="#{pagy_url_for(pagy, pagy.prev)}" rel="prev"/>) if pagy.prev
     end
 
     def pagy_next_link_tag(pagy)
-      %(<link href="#{pagy_url_for(pagy.next, pagy)}" rel="next"/>) if pagy.next
+      %(<link href="#{pagy_url_for(pagy, pagy.next)}" rel="next"/>) if pagy.next
     end
 
   end

data/lib/pagy/extras/trim.rb

@@ -3,13 +3,14 @@
 
 class Pagy
 
-  VARS[:trim] = true
+  VARS[:enable_trim_extra] = true
 
   module UseTrimExtra
 
-    def pagy_link_proc(pagy, link_extra='')
-      link_proc = super(pagy, link_extra)
-      return link_proc unless pagy.vars[:trim]
+    def pagy_link_proc(pagy, deprecated_link_extra=nil, link_extra: '')
+      link_extra = Pagy.deprecated_arg(:link_extra, deprecated_link_extra, :link_extra, link_extra) if deprecated_link_extra
+      link_proc = super(pagy, link_extra: link_extra)
+      return link_proc unless pagy.vars[:enable_trim_extra]
       lambda do |num, text=num, extra=''|
         link = link_proc.call(num, text, extra)
         return link unless num == 1

data/lib/pagy/extras/uikit.rb

@@ -7,10 +7,11 @@ 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 = pagy_link_proc(pagy)
+    def pagy_uikit_nav(pagy, pagy_id: nil, link_extra: '')
+      p_id = %( id="#{pagy_id}") if pagy_id
+      link = pagy_link_proc(pagy, link_extra: link_extra)
 
-      html = %(<ul class="pagy-uikit-nav uk-pagination uk-flex-center">#{pagy_uikit_prev_html pagy, link})
+      html = %(<ul#{p_id} class="pagy-uikit-nav uk-pagination uk-flex-center">#{pagy_uikit_prev_html pagy, link})
       pagy.series.each do |item|
         html << case    item
                 when Integer then %(<li>#{link.call item}</li>)
@@ -23,26 +24,30 @@ class Pagy
     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 = pagy_link_proc(pagy)
+    def pagy_uikit_nav_js(pagy, deprecated_id=nil, pagy_id: nil, link_extra: '', steps: nil)
+      pagy_id = Pagy.deprecated_arg(:id, deprecated_id, :pagy_id, pagy_id) if deprecated_id
+      p_id = %( id="#{pagy_id}") if pagy_id
+      link = pagy_link_proc(pagy, link_extra: link_extra)
       tags = { 'before' => pagy_uikit_prev_html(pagy, link),
                'link'   => %(<li>#{link.call(PAGE_PLACEHOLDER)}</li>),
                'active' => %(<li class="uk-active"><span>#{PAGE_PLACEHOLDER}</span></li>),
                'gap'    => %(<li class="uk-disabled"><span>#{pagy_t('pagy.nav.gap')}</span></li>),
                'after'  => pagy_uikit_next_html(pagy, link) }
 
-      html = %(<ul id="#{id}" class="pagy-uikit-nav-js uk-pagination uk-flex-center"></ul>)
-      html << pagy_json_tag(pagy, :nav, id, tags, pagy.sequels)
+      html = %(<ul#{p_id} class="pagy-njs pagy-uikit-nav-js uk-pagination uk-flex-center"></ul>)
+      html << pagy_json_tag(pagy, :nav, tags, pagy.sequels(steps))
     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    = pagy_link_proc(pagy)
+    def pagy_uikit_combo_nav_js(pagy, deprecated_id=nil, pagy_id: nil, link_extra: '')
+      pagy_id = Pagy.deprecated_arg(:id, deprecated_id, :pagy_id, pagy_id) if deprecated_id
+      p_id    = %( id="#{pagy_id}") if pagy_id
+      link    = pagy_link_proc(pagy, link_extra: link_extra)
       p_page  = pagy.page
       p_pages = pagy.pages
       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;">)
 
-      %(<div id="#{id}" class="pagy-uikit-combo-nav-js uk-button-group">#{
+      %(<div#{p_id} class="pagy-uikit-combo-nav-js uk-button-group">#{
           if (p_prev = pagy.prev)
             link.call p_prev, pagy_t('pagy.nav.prev'), 'class="uk-button uk-button-default"'
           else
@@ -57,7 +62,7 @@ class Pagy
             %(<button class="uk-button uk-button-default" disabled>#{pagy_t 'pagy.nav.next'}</button>)
           end
       }</div>#{
-          pagy_json_tag pagy, :combo_nav, id, p_page, pagy_marked_link(link)
+          pagy_json_tag pagy, :combo_nav, p_page, pagy_marked_link(link)
       })
     end
 

data/lib/pagy/frontend.rb

@@ -13,11 +13,15 @@ class Pagy
 
   module Helpers
     # This works with all Rack-based frameworks (Sinatra, Padrino, Rails, ...)
-    def pagy_url_for(page, pagy, url=nil)
+    def pagy_url_for(pagy, page, deprecated_url=nil, absolute: nil)
+      absolute = Pagy.deprecated_arg(:url, deprecated_url, :absolute, absolute) if deprecated_url
+      pagy, page = Pagy.deprecated_order(pagy, page) if page.is_a?(Pagy)
       p_vars = pagy.vars
       params = request.GET.merge(p_vars[:params])
-      params[p_vars[:page_param].to_s] = page
-      "#{request.base_url if url}#{request.path}?#{Rack::Utils.build_nested_query(pagy_get_params(params))}#{p_vars[:anchor]}"
+      params[p_vars[:page_param].to_s]  = page
+      params[p_vars[:items_param].to_s] = p_vars[:items] if defined?(UseItemsExtra)
+      query_string = "?#{Rack::Utils.build_nested_query(pagy_get_params(params))}" unless params.empty?
+      "#{request.base_url if absolute}#{request.path}#{query_string}#{p_vars[:fragment]}"
     end
 
     # Sub-method called only by #pagy_url_for: here for easy customization of params by overriding
@@ -31,12 +35,13 @@ class Pagy
     include Helpers
 
     # Generic pagination: it returns the html with the series of links to the pages
-    def pagy_nav(pagy)
-      link   = pagy_link_proc(pagy)
+    def pagy_nav(pagy, pagy_id: nil, link_extra: '')
+      p_id   = %( id="#{pagy_id}") if pagy_id
+      link   = pagy_link_proc(pagy, link_extra: link_extra)
       p_prev = pagy.prev
       p_next = pagy.next
 
-      html  = +%(<nav class="pagy-nav pagination" role="navigation" aria-label="pager">)
+      html  = +%(<nav#{p_id} class="pagy-nav pagination" role="navigation" aria-label="pager">)
       html << if p_prev
                 %(<span class="page prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</span> )
               else
@@ -58,28 +63,34 @@ class Pagy
     end
 
     # Return examples: "Displaying items 41-60 of 324 in total" of "Displaying Products 41-60 of 324 in total"
-    def pagy_info(pagy, item_name=nil)
-      count = pagy.count
-      key   = if    count.zero?     then 'pagy.info.no_items'
-              elsif pagy.pages == 1 then 'pagy.info.single_page'
-              else                       'pagy.info.multiple_pages'
-              end
-      pagy_t key, item_name: item_name || pagy_t(pagy.vars[:i18n_key], count: count),
-                  count: count, from: pagy.from, to: pagy.to
+    def pagy_info(pagy, deprecated_item_name=nil, pagy_id: nil, item_name: nil, i18n_key: nil)
+      p_id      = %( id="#{pagy_id}") if pagy_id
+      item_name = Pagy.deprecated_arg(:item_name, deprecated_item_name, :item_name, item_name) if deprecated_item_name
+      p_count = pagy.count
+      key     = if    p_count.zero?   then 'pagy.info.no_items'
+                elsif pagy.pages == 1 then 'pagy.info.single_page'
+                else                       'pagy.info.multiple_pages'
+                end
+
+      %(<span#{p_id} class="pagy-info">#{
+      pagy_t key, item_name: item_name || pagy_t(i18n_key || pagy.vars[:i18n_key], count: p_count),
+                  count: p_count, from: pagy.from, to: pagy.to
+      }</span>)
     end
 
     # Returns a performance optimized proc to generate the HTML links
     # Benchmarked on a 20 link nav: it is ~22x faster and uses ~18x less memory than rails' link_to
-    def pagy_link_proc(pagy, link_extra='')
+    def pagy_link_proc(pagy, deprecated_link_extra=nil, link_extra: '')
+      link_extra = Pagy.deprecated_arg(:link_extra, deprecated_link_extra, :link_extra, link_extra) if deprecated_link_extra
       p_prev = pagy.prev
       p_next = pagy.next
-      left, right = %(<a href="#{pagy_url_for PAGE_PLACEHOLDER, pagy}" #{pagy.vars[:link_extra]} #{link_extra}).split(PAGE_PLACEHOLDER, 2)
-      lambda do |num, text=num, extra=''|
+      left, right = %(<a href="#{pagy_url_for pagy, PAGE_PLACEHOLDER}" #{pagy.vars[:link_extra]} #{link_extra}).split(PAGE_PLACEHOLDER, 2)
+      lambda do |num, text=num, extra_attrs=''|
         %(#{left}#{num}#{right}#{ case num
                                   when p_prev then ' rel="prev"'
                                   when p_next then ' rel="next"'
                                   else             ''
-                                  end } #{extra}>#{text}</a>)
+                                  end } #{extra_attrs}>#{text}</a>)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-20 00:00:00.000000000 Z
+date: 2021-04-30 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,
@@ -57,6 +57,7 @@ files:
 - lib/pagy.rb
 - lib/pagy/backend.rb
 - lib/pagy/countless.rb
+- lib/pagy/deprecation.rb
 - lib/pagy/exceptions.rb
 - lib/pagy/extras/arel.rb
 - lib/pagy/extras/array.rb
@@ -75,6 +76,7 @@ files:
 - lib/pagy/extras/searchkick.rb
 - lib/pagy/extras/semantic.rb
 - lib/pagy/extras/shared.rb
+- lib/pagy/extras/standalone.rb
 - lib/pagy/extras/support.rb
 - lib/pagy/extras/trim.rb
 - lib/pagy/extras/uikit.rb
@@ -113,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: The Ultimate Pagination Ruby Gem