pagy 8.6.0 → 9.0.2

data/lib/pagy/extras/items.rb

@@ -1,64 +0,0 @@
-# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/items
-# frozen_string_literal: true
-
-require_relative 'js_tools'
-
-class Pagy # :nodoc:
-  DEFAULT[:items_param] = :items
-  DEFAULT[:max_items]   = 100
-  DEFAULT[:items_extra] = true   # extra enabled by default
-
-  # Allow the client to request a custom number of items per page with an optional selector UI
-  module ItemsExtra
-    # Additions for the Backend module
-    module BackendAddOn
-      private
-
-      # Set the items variable considering the params and other pagy variables
-      def pagy_set_items_from_params(vars)
-        return if vars[:items]                                                             # :items explicitly set
-        return unless vars.key?(:items_extra) ? vars[:items_extra] : DEFAULT[:items_extra] # :items_extra is false
-        return unless (items_count = pagy_get_items_size(vars))                            # no items from request params
-
-        vars[:items] = [items_count.to_i, vars.key?(:max_items) ? vars[:max_items] : DEFAULT[:max_items]].compact.min
-      end
-
-      # Get the items count from the params
-      # Overridable by the jsonapi extra
-      def pagy_get_items_size(vars)
-        params[vars[:items_param] || DEFAULT[:items_param]]
-      end
-    end
-    Backend.prepend ItemsExtra::BackendAddOn
-
-    # Additions for the Frontend module
-    module FrontendAddOn
-      ITEMS_TOKEN = '__pagy_items__'
-
-      # Return the items selector HTML. For example "Show [20] items per page"
-      def pagy_items_selector_js(pagy, id: nil, item_name: nil)
-        return '' unless pagy.vars[:items_extra]
-
-        id           = %( id="#{id}") if id
-        vars         = pagy.vars
-        items        = vars[:items]
-        vars[:items] = ITEMS_TOKEN
-        url_token    = pagy_url_for(pagy, PAGE_TOKEN)
-        vars[:items] = items # restore the items
-
-        items_input = %(<input name="items" type="number" min="1" max="#{vars[:max_items]}" value="#{
-                          items}" style="padding: 0; text-align: center; width: #{items.to_s.length + 1}rem;">#{JSTools::A_TAG})
-
-        %(<span#{id} class="pagy items-selector-js" #{
-            pagy_data(pagy, :selector, pagy.from, url_token)
-          }><label>#{
-            pagy_t('pagy.items_selector_js',
-                   item_name: item_name || pagy_t('pagy.item_name', count: items),
-                   items_input:,
-                   count: items)
-          }</label></span>)
-      end
-    end
-    Frontend.prepend ItemsExtra::FrontendAddOn
-  end
-end

data/lib/pagy/extras/materialize.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-warn '[PAGY WARNING] The materialize extra has been discontinued and it will be removed in v9 ' \
-     '(https://github.com/ddnexus/pagy/discussions/672#discussioncomment-9212328)'
-
-require_relative 'js_tools'
-
-class Pagy # :nodoc:
-  # Frontend modules are specially optimized for performance.
-  # The resulting code may not look very elegant, but produces the best benchmarks
-  module MaterializeExtra
-    # Pagination for materialize: it returns the html with the series of links to the pages
-    def pagy_materialize_nav(pagy, id: nil, aria_label: nil, **vars)
-      id = %( id="#{id}") if id
-      a  = pagy_anchor(pagy)
-
-      html = +%(<div#{id} class="pagy-materialize nav pagination" role="navigation" #{
-                  nav_aria_label(pagy, aria_label:)}><ul class="pagination">#{
-                  materialize_prev_html(pagy, a)})
-      pagy.series(**vars).each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
-        html << case item
-                when Integer
-                  %(<li class="waves-effect">#{a.(item)}</li>)
-                when String
-                  %(<li class="active"><a role="link" aria-current="page" aria-disabled="true">#{pagy.label_for(item)}</a></li>)
-                when :gap
-                  %(<li class="gap disabled"><a role="link" aria-disabled="true">#{pagy_t 'pagy.gap'}</a></li>)
-                else
-                  raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
-                end
-      end
-      html << %(#{materialize_next_html(pagy, a)}</ul></div>)
-    end
-
-    # Javascript pagination for materialize: it returns a nav with a data-pagy attribute used by the pagy.js file
-    def pagy_materialize_nav_js(pagy, id: nil, aria_label: nil, **vars)
-      sequels = pagy.sequels(**vars)
-      id      = %( id="#{id}") if id
-      a = pagy_anchor(pagy)
-
-      tokens = { 'before' => %(<ul class="pagination">#{materialize_prev_html pagy, a}),
-                 'a'      => %(<li class="waves-effect">#{a.(PAGE_TOKEN, LABEL_TOKEN)}</li>),
-                 'current' => %(<li class="active"><a role="link" aria-current="page" aria-disabled="true">#{
-                                  LABEL_TOKEN}</a></li>),
-                 'gap'    => %(<li class="gap disabled"><a role="link" aria-disabled="true">#{pagy_t 'pagy.gap'}</a></li>),
-                 'after'  => %(#{materialize_next_html pagy, a}</ul>) }
-
-      %(<div#{id} class="#{'pagy-rjs ' if sequels.size > 1}pagy-materialize nav-js" role="navigation" #{
-          nav_aria_label(pagy, aria_label:)} #{
-          pagy_data(pagy, :nav, tokens, sequels, pagy.label_sequels(sequels))
-        }></div>)
-    end
-
-    # Javascript combo pagination for materialize: it returns a nav with a data-pagy attribute used by the pagy.js file
-    def pagy_materialize_combo_nav_js(pagy, id: nil, aria_label: nil)
-      id    = %( id="#{id}") if id
-      a     = pagy_anchor(pagy)
-      pages = pagy.pages
-
-      page_input = %(<input name="page" type="number" min="1" max="#{pages}" value="#{pagy.page}" aria-current="page" ) <<
-                   %(style="text-align: center; width: #{pages.to_s.length + 1}rem; height: 1.5rem; font-size: 1.2rem; ) <<
-                   %(border: none; border-radius: 2px; color: white; background-color: #ee6e73;" class="browser-default"> ) <<
-                   JSTools::A_TAG
-
-      %(<ul#{id} class="pagy-materialize combo-nav-js pagination" role="navigation" style="padding-right: 0;" #{
-          nav_aria_label(pagy, aria_label:)} #{
-          pagy_data(pagy, :combo, pagy_url_for(pagy, PAGE_TOKEN))
-        }>#{
-          materialize_prev_html(pagy, a)
-        }<li style="vertical-align: -webkit-baseline-middle;"><label style="font-size: 1.2rem;">#{
-          pagy_t('pagy.combo_nav_js', page_input:, pages:)
-        }</label></li>#{
-          materialize_next_html(pagy, a)
-        }</ul>)
-    end
-
-    private
-
-    def materialize_prev_html(pagy, a)
-      if (p_prev = pagy.prev)
-        %(<li class="waves-effect prev">#{
-        a.(p_prev, '<i class="material-icons">chevron_left</i>', aria_label: pagy_t('pagy.aria_label.prev'))}</li>)
-      else
-        %(<li class="prev disabled"><a role="link" aria-disabled="true" aria-label="#{
-            pagy_t('pagy.aria_label.prev')}"><i class="material-icons">chevron_left</i></a></li>)
-      end
-    end
-
-    def materialize_next_html(pagy, a)
-      if (p_next = pagy.next)
-        %(<li class="waves-effect next">#{
-            a.(p_next, '<i class="material-icons">chevron_right</i>', aria_label: pagy_t('pagy.aria_label.next'))}</li>)
-      else
-        %(<li class="next disabled"#><a role="link" aria-disabled="true" aria-label="#{
-            pagy_t('pagy.aria_label.next')}><i class="material-icons">chevron_right</i></a></li>)
-      end
-    end
-  end
-  Frontend.prepend MaterializeExtra
-end

data/lib/pagy/extras/semantic.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-
-warn '[PAGY WARNING] The semantic extra has been discontinued and it will be removed in v9 ' \
-     '(https://github.com/ddnexus/pagy/discussions/672#discussioncomment-9212328)'
-
-require_relative 'js_tools'
-
-class Pagy # :nodoc:
-  # Frontend modules are specially optimized for performance.
-  # The resulting code may not look very elegant, but produces the best benchmarks
-  module SemanticExtra
-    # Pagination for semantic: it returns the html with the series of links to the pages
-    def pagy_semantic_nav(pagy, id: nil, aria_label: nil, **vars)
-      id = %( id="#{id}") if id
-      a  = pagy_anchor(pagy)
-
-      html = %(<div#{id} role="navigation" class="pagy-semantic nav ui pagination menu" #{
-                 nav_aria_label(pagy, aria_label:)}>#{semantic_prev_html(pagy, a)})
-      pagy.series(**vars).each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
-        html << case item
-                when Integer
-                  a.(item, pagy.label_for(item), classes: 'item')
-                when String
-                  %(<a role="link" class="item active" aria-current="page" aria-disabled="true">#{pagy.label_for(item)}</a>)
-                when :gap
-                  %(<div class="disabled item">#{pagy_t 'pagy.gap'}</div>)
-                else
-                  raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
-                end
-      end
-      html << %(#{semantic_next_html(pagy, a)}</div>)
-    end
-
-    # Javascript pagination for semantic: it returns a nav with a data-pagy attribute used by the pagy.js file
-    def pagy_semantic_nav_js(pagy, id: nil, aria_label: nil, **vars)
-      sequels = pagy.sequels(**vars)
-      id      = %( id="#{id}") if id
-      a       = pagy_anchor(pagy)
-      tokens  = { 'before'  => semantic_prev_html(pagy, a),
-                  'a'       => a.(PAGE_TOKEN, LABEL_TOKEN, classes: 'item'),
-                  'current' => %(<a role="link" class="item active" aria-current="page" aria-disabled="true">#{LABEL_TOKEN}</a>),
-                  'gap'     => %(<div class="disabled item">#{pagy_t('pagy.gap')}</div>),
-                  'after'   => semantic_next_html(pagy, a) }
-
-      %(<div#{id} class="#{'pagy-rjs ' if sequels.size > 1}pagy-semantic nav-js ui pagination menu" role="navigation" #{
-          nav_aria_label(pagy, aria_label:)} #{
-          pagy_data(pagy, :nav, tokens, sequels, pagy.label_sequels(sequels))
-        }></div>)
-    end
-
-    # Combo pagination for semantic: it returns a nav with a data-pagy attribute used by the pagy.js file
-    def pagy_semantic_combo_nav_js(pagy, id: nil, aria_label: nil)
-      id    = %( id="#{id}") if id
-      a     = pagy_anchor(pagy)
-      pages = pagy.pages
-
-      page_input = %(<input name="page" type="number" min="1" max="#{pages}" value="#{pagy.page}" aria-current="page") <<
-                   %(style="text-align: center; width: #{pages.to_s.length + 1}rem; padding: 0; margin: 0 0.3rem">) <<
-                   JSTools::A_TAG
-
-      %(<div#{id} class="pagy-semantic combo-nav-js ui compact menu" role="navigation" #{
-          nav_aria_label(pagy, aria_label:)} #{
-          pagy_data(pagy, :combo, pagy_url_for(pagy, PAGE_TOKEN))
-        }>#{
-          semantic_prev_html(pagy, a)
-        }<div class="item"><label>#{
-          pagy_t('pagy.combo_nav_js', page_input:, pages:)
-        }</label></div> #{
-          semantic_next_html(pagy, a)
-        }</div>)
-    end
-
-    private
-
-    def semantic_prev_html(pagy, a)
-      if (p_prev = pagy.prev)
-        a.(p_prev, pagy_t('pagy.prev'), classes: 'item', aria_label: pagy_t('pagy.aria_label.prev'))
-      else
-        %(<div class="item disabled" role="a" aria-disabled="true" aria-label="#{
-            pagy_t('pagy.aria_label.prev')}">#{pagy_t('pagy.prev')}</div>)
-      end
-    end
-
-    def semantic_next_html(pagy, a)
-      if (p_next = pagy.next)
-        a.(p_next, pagy_t('pagy.next'), classes: 'item', aria_label: pagy_t('pagy.aria_label.next'))
-      else
-        %(<div class="item disabled" role="link" aria-disabled="true" aria=label="#{
-            pagy_t('pagy.aria_label.prev')}">#{pagy_t('pagy.next')}</div>)
-      end
-    end
-  end
-  Frontend.prepend SemanticExtra
-end

data/lib/pagy/extras/uikit.rb

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-
-warn '[PAGY WARNING] The uikit extra has been discontinued and it will be removed in v9 ' \
-     '(https://github.com/ddnexus/pagy/discussions/672#discussioncomment-9212328)'
-
-require_relative 'js_tools'
-
-class Pagy # :nodoc:
-  # Frontend modules are specially optimized for performance.
-  # The resulting code may not look very elegant, but produces the best benchmarks
-  module UikitExtra
-    # Pagination for uikit: it returns the html with the series of links to the pages
-    def pagy_uikit_nav(pagy, id: nil, aria_label: nil, **vars)
-      id = %( id="#{id}") if id
-      a  = pagy_anchor(pagy)
-
-      html = %(<ul#{id} class="pagy-uikit nav uk-pagination uk-flex-center" role="navigation" #{
-                nav_aria_label(pagy, aria_label:)}>#{
-                uikit_prev_html(pagy, a)})
-      pagy.series(**vars).each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
-        html << case item
-                when Integer
-                  %(<li>#{a.(item)}</li>)
-                when String
-                  %(<li class="uk-active"><span role="link" aria-current="page" aria-disabled="true">#{
-                      pagy.label_for(item)}</span></li>)
-                when :gap
-                  %(<li class="uk-disabled"><span>#{pagy_t 'pagy.gap'}</span></li>)
-                else
-                  raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
-                end
-      end
-      html << %(#{uikit_next_html(pagy, a)}</ul>)
-    end
-
-    # Javascript pagination for uikit: it returns a nav with a data-pagy attribute used by the pagy.js file
-    def pagy_uikit_nav_js(pagy, id: nil, aria_label: nil, **vars)
-      sequels = pagy.sequels(**vars)
-      id      = %( id="#{id}") if id
-      a       = pagy_anchor(pagy)
-      tokens  = { 'before'  => uikit_prev_html(pagy, a),
-                  'a'       => %(<li>#{a.(PAGE_TOKEN, LABEL_TOKEN)}</li>),
-                  'current' => %(<li class="uk-active"><span role="link" aria-current="page" aria-disabled="true">#{
-                                   LABEL_TOKEN}</span></li>),
-                  'gap'     => %(<li class="uk-disabled"><span>#{pagy_t 'pagy.gap'}</span></li>),
-                  'after'   => uikit_next_html(pagy, a) }
-
-      %(<ul#{id} class="#{'pagy-rjs ' if sequels.size > 1}pagy-uikit nav-js uk-pagination uk-flex-center" role="navigation" #{
-          nav_aria_label(pagy, aria_label:)} #{
-          pagy_data(pagy, :nav, tokens, sequels, pagy.label_sequels(sequels))
-        }></ul>)
-    end
-
-    # Javascript combo pagination for uikit: it returns a nav with a data-pagy attribute used by the pagy.js file
-    def pagy_uikit_combo_nav_js(pagy, id: nil, aria_label: nil)
-      id    = %( id="#{id}") if id
-      a     = pagy_anchor(pagy)
-      pages = pagy.pages
-
-      page_input = %(<input name="page" type="number" min="1" max="#{pages}" value="#{pagy.page}" aria-current="page" ) <<
-                   %(style="text-align: center; width: #{pages.to_s.length + 1}rem;">#{JSTools::A_TAG})
-
-      %(<ul#{id} class="pagy-uikit combo-nav-js uk-button-group uk-pagination uk-flex-center" role="navigation" #{
-          nav_aria_label(pagy, aria_label:)} #{
-          pagy_data(pagy, :combo, pagy_url_for(pagy, PAGE_TOKEN))
-        }>#{
-          uikit_prev_html(pagy, a)
-        }<li><label>#{
-          pagy_t('pagy.combo_nav_js', page_input:, pages:)
-        }</label></li>#{
-          uikit_next_html(pagy, a)
-        }</ul>)
-    end
-
-    private
-
-    def uikit_prev_html(pagy, a)
-      span = %(<span uk-pagination-previous></span>)
-      if (p_prev = pagy.prev)
-        %(<li>#{a.(p_prev, span, aria_label: pagy_t('pagy.aria_label.prev'))}</li>)
-      else
-        %(<li class="uk-disabled"><a role="link" aria-disabled="true" aria-label="#{
-            pagy_t('pagy.aria_label.prev')}">#{span}</a></li>)
-      end
-    end
-
-    def uikit_next_html(pagy, a)
-      span = %(<span uk-pagination-next></span>)
-      if (p_next = pagy.next)
-        %(<li>#{a.(p_next, span, aria_label: pagy_t('pagy.aria_label.prev'))}</li>)
-      else
-        %(<li class="uk-disabled"><a role="link" aria-disabled="true" aria-label="#{
-            pagy_t('pagy.aria_label.next')}">#{span}</a></li>)
-      end
-    end
-  end
-  Frontend.include UikitExtra
-end