pagy 4.1.0 → 4.5.1

data/lib/pagy/extras/trim.rb

@@ -1,19 +1,24 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/trim
-# encoding: utf-8
 # frozen_string_literal: true
 
 class Pagy
 
-  module Trim
-    def pagy_link_proc(pagy, link_extra='')
-      link_proc = super(pagy, link_extra)
-      re = /[?&]#{pagy.vars[:page_param]}=1\b(?!&)|\b#{pagy.vars[:page_param]}=1&/
-      lambda do |n, text=n, extra=''|
-        link = link_proc.call(n, text, extra)
-        n == 1 ? link.sub(re, '') : link
+  VARS[:enable_trim_extra] = true
+
+  module UseTrimExtra
+
+    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
+        link.sub!(/[?&]#{pagy.vars[:page_param]}=1\b(?!&)|\b#{pagy.vars[:page_param]}=1&/, '')
       end
     end
+
   end
-  Frontend.prepend Trim
+  Frontend.prepend UseTrimExtra
 
 end

data/lib/pagy/extras/uikit.rb

@@ -1,5 +1,4 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/uikit
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'pagy/extras/shared'
@@ -8,55 +7,86 @@ 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
+    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)
 
-      previous_span = "<span uk-pagination-previous>#{pagy_t('pagy.nav.prev')}</span>"
-      html = (p_prev ? %(<li>#{link.call p_prev, previous_span}</li>)
-                     : %(<li class="uk-disabled"><a href="#">#{previous_span}</a></li>))
+      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 << 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>)
+        html << case    item
+                when Integer then %(<li>#{link.call item}</li>)
+                when String  then %(<li class="uk-active"><span>#{item}</span></li>)
+                when :gap    then %(<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>)
+      html << pagy_uikit_next_html(pagy, link)
+      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>),
+    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'  => 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(pagy, :nav, id, tags, pagy.sequels)})
+               'gap'    => %(<li class="uk-disabled"><span>#{pagy_t 'pagy.nav.gap'}</span></li>),
+               'after'  => pagy_uikit_next_html(pagy, link) }
+
+      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, p_prev, p_next, p_page, p_pages = pagy_link_proc(pagy), pagy.prev, pagy.next, pagy.page, pagy.pages
+    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#{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
+            %(<button class="uk-button uk-button-default" disabled>#{pagy_t 'pagy.nav.prev'}</button>)
+          end
+      }<div class="uk-text-middle uk-margin-left uk-margin-right">#{
+          pagy_t 'pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages
+      }</div>#{
+          if (p_next = pagy.next)
+            link.call p_next, pagy_t('pagy.nav.next'), 'class="uk-button uk-button-default"'
+          else
+            %(<button class="uk-button uk-button-default" disabled>#{pagy_t 'pagy.nav.next'}</button>)
+          end
+      }</div>#{
+          pagy_json_tag pagy, :combo_nav, p_page, pagy_marked_link(link)
+      })
+    end
 
-      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>))
+    private
+
+      def pagy_uikit_prev_html(pagy, link)
+        previous_span = %(<span uk-pagination-previous>#{pagy_t 'pagy.nav.prev'}</span>)
+        if (p_prev = pagy.prev)
+          %(<li>#{link.call p_prev, previous_span}</li>)
+        else
+          %(<li class="uk-disabled"><a href="#">#{previous_span}</a></li>)
+        end
+      end
+
+      def pagy_uikit_next_html(pagy, link)
+        next_span = %(<span uk-pagination-next>#{pagy_t 'pagy.nav.next'}</span>)
+        if (p_next = pagy.next)
+          %(<li>#{link.call p_next, next_span}</li>)
+        else
+          %(<li class="uk-disabled"><a href="#">#{next_span}</a></li>)
+        end
+      end
 
-      html << %(</div>#{pagy_json_tag(pagy, :combo_nav, id, p_page, pagy_marked_link(link))})
-    end
   end
 end

data/lib/pagy/frontend.rb

@@ -1,26 +1,31 @@
 # See Pagy::Frontend API documentation: https://ddnexus.github.io/pagy/api/frontend
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'yaml'
 
 class Pagy
 
-  PAGE_PLACEHOLDER  = '__pagy_page__'  # string used for search and replace, hardcoded also in the pagy.js file
+  PAGE_PLACEHOLDER = '__pagy_page__'  # string used for search and replace, hardcoded also in the pagy.js file
 
   # I18n static hash loaded at startup, used as default alternative to the i18n gem.
   # see https://ddnexus.github.io/pagy/api/frontend#i18n
-  I18n = eval(Pagy.root.join('locales', 'utils', 'i18n.rb').read) #rubocop:disable Security/Eval
+  I18n = eval Pagy.root.join('locales', 'utils', 'i18n.rb').read #rubocop:disable Security/Eval
 
   module Helpers
     # This works with all Rack-based frameworks (Sinatra, Padrino, Rails, ...)
-    def pagy_url_for(page, pagy, url=false)
-      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]}"
+    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
+      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
-    def pagy_get_params(params) params end
+    def pagy_get_params(params) = params
   end
 
   # All the code here has been optimized for performance: it may not look very pretty
@@ -30,43 +35,70 @@ class Pagy
     include Helpers
 
     # Generic pagination: it returns the html with the series of links to the pages
-    def pagy_nav(pagy)
-      link, p_prev, p_next = pagy_link_proc(pagy), pagy.prev, pagy.next
+    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 = (p_prev ? %(<span class="page prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</span> )
-                     : %(<span class="page prev disabled">#{pagy_t('pagy.nav.prev')}</span> ))
+      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
+                %(<span class="page prev disabled">#{pagy_t('pagy.nav.prev')}</span> )
+              end
       pagy.series.each do |item|  # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
-        html << if    item.is_a?(Integer); %(<span class="page">#{link.call item}</span> )               # page link
-                elsif item.is_a?(String) ; %(<span class="page active">#{item}</span> )                  # current page
-                elsif item == :gap       ; %(<span class="page gap">#{pagy_t('pagy.nav.gap')}</span> )   # page gap
+        html << case item
+                when Integer then %(<span class="page">#{link.call item}</span> )               # page link
+                when String  then %(<span class="page active">#{item}</span> )                  # current page
+                when :gap    then %(<span class="page gap">#{pagy_t('pagy.nav.gap')}</span> )   # page gap
                 end
       end
-      html << (p_next ? %(<span class="page next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</span>)
-                      : %(<span class="page next disabled">#{pagy_t('pagy.nav.next')}</span>))
-      %(<nav class="pagy-nav pagination" role="navigation" aria-label="pager">#{html}</nav>)
+      html << if p_next
+                %(<span class="page next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</span>)
+              else
+                %(<span class="page next disabled">#{pagy_t('pagy.nav.next')}</span>)
+              end
+      html << %(</nav>)
     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)
-      key = if (count = pagy.count) == 0 ; 'pagy.info.no_items'
-             else pagy.pages == 1 ? 'pagy.info.single_page' : '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='')
-      p_prev, p_next = pagy.prev, pagy.next
-      a, b = %(<a href="#{pagy_url_for(PAGE_PLACEHOLDER, pagy)}" #{pagy.vars[:link_extra]} #{link_extra}).split(PAGE_PLACEHOLDER, 2)
-      lambda {|n, text=n, extra=''| "#{a}#{n}#{b}#{ if    n == p_prev ; ' rel="prev"'
-                                                    elsif n == p_next ; ' rel="next"'
-                                                    else                           '' end } #{extra}>#{text}</a>"}
+    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 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_attrs}>#{text}</a>)
+      end
     end
 
     # Similar to I18n.t: just ~18x faster using ~10x less memory
-    # (@pagy_locale explicitly initilized in order to avoid warning)
-    def pagy_t(key, **opts) = Pagy::I18n.t(@pagy_locale||=nil, key, **opts)
+    # (@pagy_locale explicitly initialized in order to avoid warning)
+    def pagy_t(key, **opts)
+      Pagy::I18n.t @pagy_locale||=nil, key, **opts
+    end
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.5.1
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2021-05-02 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,
@@ -22,7 +22,6 @@ files:
 - LICENSE.txt
 - lib/config/pagy.rb
 - lib/javascripts/pagy.js
-- lib/locales/README.md
 - lib/locales/bg.yml
 - lib/locales/bs.yml
 - lib/locales/ca.yml
@@ -57,7 +56,9 @@ files:
 - lib/locales/zh-TW.yml
 - lib/pagy.rb
 - lib/pagy/backend.rb
+- lib/pagy/console.rb
 - lib/pagy/countless.rb
+- lib/pagy/deprecation.rb
 - lib/pagy/exceptions.rb
 - lib/pagy/extras/arel.rb
 - lib/pagy/extras/array.rb
@@ -76,6 +77,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
@@ -95,7 +97,6 @@ files:
 - 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:
 - MIT
@@ -115,7 +116,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

data/lib/locales/README.md

@@ -1,35 +0,0 @@
-# Pagy locales
-
-### 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!
-
-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 it is `::RailsI18n::Pluralization::OneOther.with_locale(:en)` for `en.rb`. Note the rule part i.e. `OneOther`. In pagy that translates to the symbol `:one_other`.
-
-    - [ ] If the pluralization rule of your language is not the `:one_other` default, confirm that the [p11n.rb](https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb) file already defines the pluralization rule of your dictionary file:
-
-      - [ ] If the rule is not defined, you can either: a) Add the rule as a new rule/lambda entry in the `p11n` variable hash and relative tests or b) Just create an issue requesting the addition to the rule/lambda entry and tests.
-
-      - [ ] Add your language to the `plurals` hash in the file.
-
-- [ ] 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, a whole sentence might need to be written in different ways for different counts. In that case you should add the different plurals for the sentence and the `count` will trigger the one that applies.
-
-Feel free to ask for help in your Pull Request.
-
-### Useful Links
-
-* [Pagy I18n Documentation](https://ddnexus.github.io/pagy/api/frontend#i18n)
-* [I18n Extra](https://ddnexus.github.io/pagy/extras/i18n)
-

data/pagy.gemspec

@@ -1,16 +0,0 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'pagy'
-
-Gem::Specification.new do |s|
-  s.name          = 'pagy'
-  s.version       = Pagy::VERSION
-  s.authors       = ['Domizio Demichelis']
-  s.email         = ['dd.nexus@gmail.com']
-  s.summary       = 'The Ultimate Pagination Ruby Gem'
-  s.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... Easy, powerful, fast and light.'
-  s.homepage      = 'https://github.com/ddnexus/pagy'
-  s.license       = 'MIT'
-  s.files         = `git ls-files -z`.split("\x0").select{|f| f.start_with?('lib', 'pagy.gemspec', 'LICENSE') }
-  s.required_ruby_version = '>= 3.0'
-end