pagy 4.1.0 → 4.2.0

data/lib/pagy/extras/metadata.rb

@@ -1,36 +1,41 @@
 # 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
+  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
+    METADATA = %i[ scaffold_url first_url prev_url page_url next_url last_url
+                   count page items vars pages last from to prev next series
+               ].tap do |metadata|
+                 metadata << :sequels if VARS.key?(:steps)  # :steps gets defined along with the #sequels method
+               end.freeze
 
     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}")
+    def pagy_metadata(pagy, url=nil)
+      names   = pagy.vars[:metadata]
+      unknown = names - METADATA
+      raise VariableError.new(pagy), "unknown metadata #{unknown.inspect}" \
+            unless unknown.empty?
+
       scaffold_url = pagy_url_for(PAGE_PLACEHOLDER, pagy, url)
-      metadata = {}
-      names.each do |key|
-        metadata[key] = case key
-                        when :scaffold_url ; scaffold_url
-                        when :first_url    ; scaffold_url.sub(PAGE_PLACEHOLDER, 1.to_s)
-                        when :prev_url     ; scaffold_url.sub(PAGE_PLACEHOLDER, pagy.prev.to_s)
-                        when :page_url     ; scaffold_url.sub(PAGE_PLACEHOLDER, pagy.page.to_s)
-                        when :next_url     ; scaffold_url.sub(PAGE_PLACEHOLDER, pagy.next.to_s)
-                        when :last_url     ; scaffold_url.sub(PAGE_PLACEHOLDER, pagy.last.to_s)
-                        else pagy.send(key)
-                        end
+      {}.tap do |metadata|
+        names.each do |key|
+          metadata[key] = case key
+                          when :scaffold_url then scaffold_url
+                          when :first_url    then scaffold_url.sub(PAGE_PLACEHOLDER, 1.to_s)
+                          when :prev_url     then scaffold_url.sub(PAGE_PLACEHOLDER, pagy.prev.to_s)
+                          when :page_url     then scaffold_url.sub(PAGE_PLACEHOLDER, pagy.page.to_s)
+                          when :next_url     then scaffold_url.sub(PAGE_PLACEHOLDER, pagy.next.to_s)
+                          when :last_url     then scaffold_url.sub(PAGE_PLACEHOLDER, pagy.last.to_s)
+                          else pagy.send(key)
+                          end
+        end
       end
-      metadata
     end
 
   end

data/lib/pagy/extras/navs.rb

@@ -1,5 +1,4 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/navs
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'pagy/extras/shared'
@@ -9,30 +8,52 @@ class Pagy
 
     # Javascript pagination: it returns a nav and a JSON tag used by the Pagy.nav javascript
     def pagy_nav_js(pagy, id=pagy_id)
-      link, p_prev, p_next = pagy_link_proc(pagy), pagy.prev, pagy.next
-      tags = { 'before' => 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> ),
+      link = pagy_link_proc(pagy)
+      tags = { 'before' => pagy_nav_prev_html(pagy, link),
                'link'   => %(<span class="page">#{link.call(PAGE_PLACEHOLDER)}</span> ),
                'active' => %(<span class="page active">#{pagy.page}</span> ),
                'gap'    => %(<span class="page gap">#{pagy_t('pagy.nav.gap')}</span> ),
-               'after'  => 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 id="#{id}" class="pagy-nav-js pagination" role="navigation" aria-label="pager"></nav>#{pagy_json_tag(pagy, :nav, id, tags, pagy.sequels)})
+               'after'  => pagy_nav_next_html(pagy, link) }
+
+      html = %(<nav id="#{id}" class="pagy-nav-js pagination" role="navigation" aria-label="pager"></nav>)
+      html << pagy_json_tag(pagy, :nav, id, tags, pagy.sequels)
     end
 
     # Javascript combo pagination: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript
     def pagy_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 = %(<nav id="#{id}" class="pagy-combo-nav-js pagination" role="navigation" aria-label="pager">)
-      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> ))
-      input = %(<input type="number" min="1" max="#{p_pages}" value="#{p_page}" style="padding: 0; text-align: center; width: #{p_pages.to_s.length+1}rem;">)
-      html << %(<span class="pagy-combo-input" style="margin: 0 0.6rem;">#{pagy_t('pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages)}</span> )
-      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>))
-      html << %(</nav>#{pagy_json_tag(pagy, :combo_nav, id, p_page, pagy_marked_link(link))})
+      link    = pagy_link_proc(pagy)
+      p_page  = pagy.page
+      p_pages = pagy.pages
+      input   = %(<input type="number" min="1" max="#{p_pages}" value="#{p_page}" style="padding: 0; text-align: center; width: #{p_pages.to_s.length+1}rem;">)
+
+      %(<nav id="#{id}" class="pagy-combo-nav-js pagination" role="navigation" aria-label="pager">#{
+          pagy_nav_prev_html(pagy, link)
+      }<span class="pagy-combo-input" style="margin: 0 0.6rem;">#{
+          pagy_t('pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages)
+      }</span> #{
+          pagy_nav_next_html(pagy, link)
+      }</nav>#{
+          pagy_json_tag(pagy, :combo_nav, id, p_page, pagy_marked_link(link))
+      })
     end
 
+    private
+
+      def pagy_nav_prev_html(pagy, link)
+        if (p_prev = pagy.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
+      end
+
+      def pagy_nav_next_html(pagy, link)
+        if (p_next = pagy.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
+      end
+
   end
 end

data/lib/pagy/extras/overflow.rb

@@ -1,10 +1,9 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/overflow
-# encoding: utf-8
 # frozen_string_literal: true
 
 class Pagy
 
-  module Overflow
+  module UseOverflowExtra
     VARS[:overflow] = :empty_page
 
     def overflow? = @overflow
@@ -34,33 +33,33 @@ class Pagy
       def series(size=@vars[:size])
         @page = @last                             # series for last page
         super(size).tap do |s|                    # call original series
-        s[s.index(@page.to_s)] = @page            # string to integer (i.e. no current page)
-        @page = @vars[:page]                      # restore the actual page
+          s[s.index(@page.to_s)] = @page          # string to integer (i.e. no current page)
+          @page = @vars[:page]                    # restore the actual page
         end
       end
     end
 
   end
-  prepend Overflow
+  prepend UseOverflowExtra
 
 
   # support for Pagy::Countless
   if defined?(Pagy::Countless)
     class Countless
 
-      module Overflow
+      module UseOverflowExtra
 
         def finalize(items)
           @overflow = false
           super
         rescue OverflowError
-          @overflow = true                            # add the overflow flag
+          @overflow = true                        # add the overflow flag
           case @vars[:overflow]
           when :exception
-            raise                                     # same as without the extra
+            raise                                 # same as without the extra
           when :empty_page
-            @offset = @items = @from = @to = 0        # vars relative to the actual page
-            @vars[:size] = []                         # no page in the series
+            @offset = @items = @from = @to = 0    # vars relative to the actual page
+            @vars[:size] = []                     # no page in the series
             self
           else
             raise VariableError.new(self), "expected :overflow variable in [:empty_page, :exception]; got #{@vars[:overflow].inspect}"
@@ -68,7 +67,7 @@ class Pagy
         end
 
       end
-      prepend Overflow
+      prepend UseOverflowExtra
 
     end
   end

data/lib/pagy/extras/searchkick.rb

@@ -1,5 +1,4 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/searchkick
-# encoding: utf-8
 # frozen_string_literal: true
 
 class Pagy
@@ -10,7 +9,7 @@ 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
-    def pagy_searchkick(term = "*", **options, &block)
+    def pagy_searchkick(term = '*', **options, &block)
       [self, term, options, block].tap do |args|
         args.define_singleton_method(:method_missing){|*a| args += a}
       end
@@ -27,7 +26,8 @@ class Pagy
   end
 
   # Add specialized backend methods to paginate Searchkick::Results
-  module Backend ; private
+  module Backend
+    private
 
     # Return Pagy object and results
     def pagy_searchkick(pagy_search_args, vars={})
@@ -37,12 +37,13 @@ class Pagy
       options[:page]     = vars[:page]
       results            = model.search(term, **options, &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?(Pagy::Overflow) && pagy.overflow? && pagy.vars[:overflow] == :last_page
-        return pagy_searchkick(pagy_search_args, vars.merge(page: pagy.page))
-      end
-      return pagy, called.empty? ? results : results.send(*called)
+      return pagy_searchkick(pagy_search_args, vars.merge(page: pagy.page)) \
+             if defined?(Pagy::UseOverflowExtra) && pagy.overflow? && pagy.vars[:overflow] == :last_page
+
+      [ pagy, called.empty? ? results : results.send(*called) ]
     end
 
     # Sub-method called only by #pagy_searchkick: here for easy customization of variables by overriding

data/lib/pagy/extras/semantic.rb

@@ -1,5 +1,4 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/semantic
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'pagy/extras/shared'
@@ -9,47 +8,69 @@ class Pagy
 
     # Pagination for semantic: it returns the html with the series of links to the pages
     def pagy_semantic_nav(pagy)
-      link, p_prev, p_next = pagy_link_proc(pagy, 'class="item"'), pagy.prev, pagy.next
+      link = pagy_link_proc(pagy, 'class="item"')
 
-      html = (p_prev ? %(#{link.call p_prev, '<i class="left small chevron icon"></i>', 'aria-label="previous"'})
-                     : +%(<div class="item disabled"><i class="left small chevron icon"></i></div>))
+      html = +%(<div class="pagy-semantic-nav ui pagination menu" aria-label="pager">)
+      html << pagy_semantic_prev_html(pagy, link)
       pagy.series.each do |item|  # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
-        html << if    item.is_a?(Integer); %(#{link.call item})                      # page link
-                elsif item.is_a?(String) ; %(<a class="item active">#{item}</a>)     # current page
-                elsif item == :gap       ; %(<div class="disabled item">...</div>)   # page gap
+        html << case item
+                when Integer then link.call item                            # page link
+                when String  then %(<a class="item active">#{item}</a>)     # current page
+                when :gap    then %(<div class="disabled item">...</div>)   # page gap
                 end
       end
-      html << (p_next ? %(#{link.call p_next, '<i class="right small chevron icon"></i>', 'aria-label="next"'})
-                      : %(<div class="item disabled"><i class="right small chevron icon"></i></div>))
-      %(<div class="pagy-semantic-nav ui pagination menu" aria-label="pager">#{html}</div>)
+      html << pagy_semantic_next_html(pagy, link)
+      html << %(</div>)
     end
 
     # Javascript pagination for semantic: it returns a nav and a JSON tag used by the Pagy.nav javascript
     def pagy_semantic_nav_js(pagy, id=pagy_id)
-      link, p_prev, p_next = pagy_link_proc(pagy, 'class="item"'), pagy.prev, pagy.next
-      tags = { 'before' => (p_prev ? %(#{link.call(p_prev, '<i class="left small chevron icon"></i>', 'aria-label="previous"')})
-                                   : %(<div class="item disabled"><i class="left small chevron icon"></i></div>)),
-               'link'   => %(#{link.call(PAGE_PLACEHOLDER)}),
+      link = pagy_link_proc(pagy, 'class="item"')
+      tags = { 'before' => pagy_semantic_prev_html(pagy, link),
+               'link'   => link.call(PAGE_PLACEHOLDER),
                'active' => %(<a class="item active">#{pagy.page}</a>),
                'gap'    => %(<div class="disabled item">#{pagy_t('pagy.nav.gap')}</div>),
-               'after'  => (p_next ? %(#{link.call(p_next, '<i class="right small chevron icon"></i>', 'aria-label="next"')})
-                                   : %(<div class="item disabled"><i class="right small chevron icon"></i></div>)) }
-      %(<div id="#{id}" class="pagy-semantic-nav-js ui pagination menu" role="navigation" aria-label="pager"></div>#{pagy_json_tag(pagy, :nav, id, tags, pagy.sequels)})
+               'after'  => pagy_semantic_next_html(pagy, link) }
+
+      html = %(<div id="#{id}" class="pagy-semantic-nav-js ui pagination menu" role="navigation" aria-label="pager"></div>)
+      html << pagy_json_tag(pagy, :nav, id, tags, pagy.sequels)
     end
 
     # Combo pagination for semantic: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript
     def pagy_semantic_combo_nav_js(pagy, id=pagy_id)
-      link, p_prev, p_next, p_page, p_pages = pagy_link_proc(pagy, 'class="item"'), pagy.prev, pagy.next, pagy.page, pagy.pages
-
-      html = %(<div id="#{id}" class="pagy-semantic-combo-nav-js ui compact menu" role="navigation" aria-label="pager">)
-      html << (p_prev ? %(#{link.call p_prev, '<i class="left small chevron icon"></i>', 'aria-label="previous"'})
-                      : %(<div class="item disabled"><i class="left small chevron icon"></i></div>))
-      input = %(<input type="number" min="1" max="#{p_pages}" value="#{p_page}" style="padding: 0; text-align: center; width: #{p_pages.to_s.length+1}rem; margin: 0 0.3rem">)
-      html << %(<div class="pagy-combo-input item">#{pagy_t('pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages)}</div> )
-      html << (p_next ? %(#{link.call p_next, '<i class="right small chevron icon"></i>', 'aria-label="next"'})
-                      : %(<div class="item disabled"><i class="right small chevron icon"></i></div>))
-      html << %(</div>#{pagy_json_tag(pagy, :combo_nav, id, p_page, pagy_marked_link(link))})
+      link    = pagy_link_proc(pagy, 'class="item"')
+      p_page  = pagy.page
+      p_pages = pagy.pages
+      input   = %(<input type="number" min="1" max="#{p_pages}" value="#{p_page}" style="padding: 0; text-align: center; width: #{p_pages.to_s.length+1}rem; margin: 0 0.3rem">)
+
+      %(<div id="#{id}" class="pagy-semantic-combo-nav-js ui compact menu" role="navigation" aria-label="pager">#{
+         pagy_semantic_prev_html(pagy, link)
+      }<div class="pagy-combo-input item">#{
+         pagy_t('pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages)
+      }</div> #{
+         pagy_semantic_next_html(pagy, link)
+      }</div>#{
+         pagy_json_tag(pagy, :combo_nav, id, p_page, pagy_marked_link(link))
+      })
     end
 
+    private
+
+      def pagy_semantic_prev_html(pagy, link)
+        if (p_prev = pagy.prev)
+          link.call p_prev, '<i class="left small chevron icon"></i>', 'aria-label="previous"'
+        else
+          %(<div class="item disabled"><i class="left small chevron icon"></i></div>)
+        end
+      end
+
+      def pagy_semantic_next_html(pagy, link)
+        if (p_next = pagy.next)
+          link.call p_next, '<i class="right small chevron icon"></i>', 'aria-label="next"'
+        else
+          %(<div class="item disabled"><i class="right small chevron icon"></i></div>)
+        end
+      end
+
   end
 end

data/lib/pagy/extras/shared.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'digest'
@@ -19,8 +18,11 @@ class Pagy
   # Notice: if :steps is false it will use the single {0 => @vars[:size]} size
   def sequels
     steps = @vars[:steps] || {0 => @vars[:size]}
-    steps.key?(0) or raise(VariableError.new(self), "expected :steps to define the 0 width; got #{steps.inspect}")
-    sequels = {}; steps.each {|width, size| sequels[width.to_s] = series(size)}; sequels
+    raise VariableError.new(self), "expected :steps to define the 0 width; got #{steps.inspect}" \
+          unless steps.key?(0)
+    {}.tap do |sequels|
+      steps.each {|width, size| sequels[width.to_s] = series(size)}
+    end
   end
 
   module Frontend
@@ -28,23 +30,27 @@ class Pagy
     if defined?(Oj)
       # it returns a script tag with the JSON-serialized args generated with the faster oj gem
       def pagy_json_tag(pagy, *args)
-        args << ( defined?(Trim) && pagy.vars[:page_param] )
+        args << ( defined?(UseTrimExtra) && pagy.vars[:page_param] )
         %(<script type="application/json" class="pagy-json">#{Oj.dump(args, mode: :strict)}</script>)
       end
     else
       require 'json'
       # it returns a script tag with the JSON-serialized args generated with the slower to_json
       def pagy_json_tag(pagy, *args)
-        args << ( defined?(Trim) && pagy.vars[:page_param] )
+        args << ( defined?(UseTrimExtra) && pagy.vars[:page_param] )
         %(<script type="application/json" class="pagy-json">#{args.to_json}</script>)
       end
     end
 
     # it returns the SHA1 (fastest on modern ruby) string used as default `id` attribute by all the `*_js` tags
-    def pagy_id = "pagy-#{Digest::SHA1.hexdigest(caller(2..2)[0].split(':in')[0])}"
+    def pagy_id
+      "pagy-#{Digest::SHA1.hexdigest(caller(2..2)[0].split(':in')[0])}"
+    end
 
     # it returns the marked link to used by pagy.js
-    def pagy_marked_link(link) = link.call(PAGE_PLACEHOLDER, '', 'style="display: none;"')
+    def pagy_marked_link(link)
+      link.call PAGE_PLACEHOLDER, '', 'style="display: none;"'
+    end
 
   end
 

data/lib/pagy/extras/support.rb

@@ -1,5 +1,4 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/support
-# encoding: utf-8
 # frozen_string_literal: true
 
 class Pagy
@@ -15,13 +14,19 @@ class Pagy
     end
 
     def pagy_prev_link(pagy, text = pagy_t('pagy.nav.prev'), link_extra = '')
-      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 disabled">#{text}</span>)
+      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>)
+      else
+        %(<span class="page prev disabled">#{text}</span>)
+      end
     end
 
     def pagy_next_link(pagy, text = pagy_t('pagy.nav.next'), link_extra = '')
-      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 disabled">#{text}</span>)
+      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>)
+      else
+        %(<span class="page next disabled">#{text}</span>)
+      end
     end
 
     def pagy_prev_link_tag(pagy)

data/lib/pagy/extras/trim.rb

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