pagy 3.13.0 → 4.8.0

data/lib/pagy/extras/metadata.rb

@@ -1,36 +1,42 @@
 # 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}")
-      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
+    def pagy_metadata(pagy, deprecated_url=nil, absolute: nil)
+      absolute = Pagy.deprecated_arg(:url, deprecated_url, :absolute, absolute) if deprecated_url
+      names   = pagy.vars[:metadata]
+      unknown = names - METADATA
+      raise VariableError.new(pagy), "unknown metadata #{unknown.inspect}" \
+            unless unknown.empty?
+
+      scaffold_url = pagy_url_for(pagy, PAGE_PLACEHOLDER, absolute: absolute)
+      {}.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'
@@ -8,31 +7,56 @@ class Pagy
   module Frontend
 
     # 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> ),
+    def pagy_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_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(:nav, id, tags, pagy.sequels, defined?(TRIM) && pagy.vars[:page_param])})
+               'gap'    => %(<span class="page gap">#{pagy_t 'pagy.nav.gap'}</span> ),
+               'after'  => pagy_nav_next_html(pagy, link) }
+
+      %(<nav#{p_id} class="pagy-njs pagy-nav-js pagination" aria-label="pager" #{pagy_json_attr(pagy, :nav, tags, pagy.sequels(steps))}></nav>)
     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 = EMPTY + %(<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(:combo_nav, id, p_page, pagy_marked_link(link), defined?(TRIM) && pagy.vars[:page_param])})
+    def pagy_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}" style="padding: 0; text-align: center; width: #{p_pages.to_s.length+1}rem;">)
+
+      %(<nav#{p_id} class="pagy-combo-nav-js pagination" aria-label="pager" #{
+          pagy_json_attr pagy, :combo_nav, p_page, pagy_marked_link(link)
+      }>#{
+          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>)
     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,71 +1,75 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/overflow
-# encoding: utf-8
 # frozen_string_literal: true
 
 class Pagy
 
-  OVERFLOW = true
+  module UseOverflowExtra
+    VARS[:overflow] = :empty_page
 
-  VARS[:overflow] = :empty_page
-
-  def overflow?; @overflow end
+    def overflow?
+      @overflow
+    end
 
-  alias_method :initialize_without_overflow, :initialize
-  def initialize_with_overflow(vars)
-    @overflow ||= false                         # don't override if :last_page re-run the method after an overflow
-    initialize_without_overflow(vars)
-  rescue OverflowError
-    @overflow = true                            # add the overflow flag
-    case @vars[:overflow]
-    when :exception
-      raise                                     # same as without the extra
-    when :last_page
-      initial_page = @vars[:page]               # save the very initial page (even after re-run)
-      initialize(vars.merge!(page: @last))      # re-run with the last page
-      @vars[:page] = initial_page               # restore the inital page
-    when :empty_page
-      @offset = @items = @from = @to = 0        # vars relative to the actual page
-      @prev = @last                             # prev relative to the actual page
-      extend(Series)                            # special series for :empty_page
-    else
-      raise VariableError.new(self), "expected :overflow variable in [:last_page, :empty_page, :exception]; got #{@vars[:overflow].inspect}"
+    def initialize(vars)
+      @overflow ||= false                         # don't override if :last_page re-run the method after an overflow
+      super
+    rescue OverflowError
+      @overflow = true                            # add the overflow flag
+      case @vars[:overflow]
+      when :exception
+        raise                                     # same as without the extra
+      when :last_page
+        initial_page = @vars[:page]               # save the very initial page (even after re-run)
+        initialize vars.merge!(page: @last)       # re-run with the last page
+        @vars[:page] = initial_page               # restore the inital page
+      when :empty_page
+        @offset = @items = @from = @to = 0        # vars relative to the actual page
+        @prev = @last                             # prev relative to the actual page
+        extend Series                             # special series for :empty_page
+      else
+        raise VariableError.new(self), "expected :overflow variable in [:last_page, :empty_page, :exception]; got #{@vars[:overflow].inspect}"
+      end
     end
-  end
-  alias_method :initialize, :initialize_with_overflow
 
-  module Series
-    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
+    module Series
+      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
+        end
       end
     end
+
   end
+  prepend UseOverflowExtra
 
 
   # support for Pagy::Countless
   if defined?(Pagy::Countless)
     class Countless
 
-      alias_method :finalize_without_overflow, :finalize
-      def finalize_with_overflow(items)
-        @overflow = false
-        finalize_without_overflow(items)
-      rescue OverflowError
-        @overflow = true                            # add the overflow flag
-        case @vars[:overflow]
-        when :exception
-          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
-          self
-        else
-          raise VariableError.new(self), "expected :overflow variable in [:empty_page, :exception]; got #{@vars[:overflow].inspect}"
+      module UseOverflowExtra
+
+        def finalize(items)
+          @overflow = false
+          super
+        rescue OverflowError
+          @overflow = true                        # add the overflow flag
+          case @vars[:overflow]
+          when :exception
+            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
+            self
+          else
+            raise VariableError.new(self), "expected :overflow variable in [:empty_page, :exception]; got #{@vars[:overflow].inspect}"
+          end
         end
+
       end
-      alias_method :finalize, :finalize_with_overflow
+      prepend UseOverflowExtra
 
     end
   end

data/lib/pagy/extras/searchkick.rb

@@ -1,13 +1,21 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/searchkick
-# encoding: utf-8
 # frozen_string_literal: true
 
-require 'pagy/extras/pagy_search'
-
 class Pagy
 
-  # used by the items extra
-  SEARCHKICK = true
+  VARS[:searchkick_search_method] ||= :pagy_search
+
+  module Searchkick
+    # 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)
+      [self, term, options, block].tap do |args|
+        args.define_singleton_method(:method_missing){|*a| args += a}
+      end
+    end
+    alias_method VARS[:searchkick_search_method], :pagy_searchkick
+  end
 
   # create a Pagy object from a Searchkick::Results object
   def self.new_from_searchkick(results, vars={})
@@ -18,27 +26,30 @@ 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={})
-      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
+      model, term, options, block, *called = pagy_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
+
       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(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
     # the _collection argument is not available when the method is called
     def pagy_searchkick_get_vars(_collection, vars)
+      pagy_set_items_from_params(vars) if defined?(UseItemsExtra)
       vars[:items] ||= VARS[:items]
       vars[:page]  ||= (params[ vars[:page_param] || VARS[:page_param] ] || 1).to_i
       vars

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'
@@ -8,48 +7,74 @@ class Pagy
   module Frontend
 
     # 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
+    def pagy_semantic_nav(pagy, pagy_id: nil, link_extra: '')
+      p_id = %( id="#{pagy_id}") if pagy_id
+      link = pagy_link_proc(pagy, link_extra: %(class="item" #{link_extra}))
 
-      html = EMPTY + (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#{p_id} class="pagy-semantic-nav ui pagination menu">)
+      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">#{pagy_t 'pagy.nav.gap'}</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)}),
+    def pagy_semantic_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: %(class="item" #{link_extra}))
+      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(:nav, id, tags, pagy.sequels, defined?(TRIM) && pagy.vars[:page_param])})
+               'after'  => pagy_semantic_next_html(pagy, link) }
+
+      %(<div#{p_id} class="pagy-njs pagy-semantic-nav-js ui pagination menu" role="navigation" #{pagy_json_attr(pagy, :nav, tags, pagy.sequels(steps))}></div>)
     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 = EMPTY + %(<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(:combo_nav, id, p_page, pagy_marked_link(link), defined?(TRIM) && pagy.vars[:page_param])})
+    def pagy_semantic_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: %(class="item" #{link_extra}))
+      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#{p_id} class="pagy-semantic-combo-nav-js ui compact menu" role="navigation" #{
+          pagy_json_attr pagy, :combo_nav, p_page, pagy_marked_link(link)
+      }>#{
+         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>)
     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