pagy 7.0.10 → 8.0.0

data/lib/pagy/frontend.rb

@@ -15,60 +15,53 @@ class Pagy
     include UrlHelpers
 
     # Generic pagination: it returns the html with the series of links to the pages
-    def pagy_nav(pagy, pagy_id: nil, link_extra: '',
-                 nav_aria_label: nil, nav_i18n_key: nil, **vars)
-      p_id = %( id="#{pagy_id}") if pagy_id
-      link = pagy_link_proc(pagy, link_extra:)
+    def pagy_nav(pagy, id: nil, aria_label: nil, **vars)
+      id = %( id="#{id}") if id
+      a  = pagy_anchor(pagy)
 
-      html = +%(<nav#{p_id} class="pagy pagy-nav pagination" #{nav_aria_label_attr(pagy, nav_aria_label, nav_i18n_key)}>)
-      html << prev_html(pagy, link)
+      html = %(<nav#{id} class="pagy nav" #{nav_aria_label(pagy, aria_label:)}>#{
+                prev_a(pagy, a)})
       pagy.series(**vars).each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
         html << case item
                 when Integer
-                  %(<span class="page">#{link.call(item)}</span>)
+                  a.(item)
                 when String
-                  %(<span class="page active">) +
-                  %(<a role="link" aria-disabled="true" aria-current="page">#{pagy.label_for(item)}</a></span>)
+                  %(<a role="link" aria-disabled="true" aria-current="page" class="current">#{pagy.label_for(item)}</a>)
                 when :gap
-                  %(<span class="page gap">#{pagy_t('pagy.gap')}</span>)
+                  %(<a role="link" aria-disabled="true" class="gap">#{pagy_t('pagy.gap')}</a>)
                 else
                   raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
       end
-      html << %(#{next_html(pagy, link)}</nav>)
+      html << %(#{next_a(pagy, a)}</nav>)
     end
 
     # Return examples: "Displaying items 41-60 of 324 in total" or "Displaying Products 41-60 of 324 in total"
-    def pagy_info(pagy, pagy_id: nil, item_name: nil, item_i18n_key: nil)
-      p_id    = %( id="#{pagy_id}") if pagy_id
+    def pagy_info(pagy, id: nil, item_name: nil)
+      id      = %( id="#{id}") if id
       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' # rubocop:disable Lint/ElseLayout
                 end
 
-      %(<span#{p_id} class="pagy-info">#{
-          pagy_t key, item_name: item_name || pagy_t(item_i18n_key || pagy.vars[:item_i18n_key], count: p_count),
+      %(<span#{id} class="pagy info">#{
+          pagy_t key, item_name: item_name || pagy_t('pagy.item_name', count: p_count),
                       count: p_count, from: pagy.from, to: pagy.to
         }</span>)
     end
 
-    # Return a performance optimized lambda to generate the HTML links
+    # Return a performance optimized lambda to generate the HtML anchor element (a tag)
     # 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      = pagy.prev
-      p_next      = pagy.next
-      p_page      = pagy.page.to_s
-      left, right = %(<a href="#{pagy_url_for(pagy, PAGE_TOKEN)}" #{
-                        pagy.vars[:link_extra]} #{link_extra}).split(PAGE_TOKEN, 2)
+    def pagy_anchor(pagy)
+      a_string    = pagy.vars[:anchor_string]
+      a_string    = %( #{a_string}) if a_string
+      left, right = %(<a#{a_string} href="#{pagy_url_for(pagy, PAGE_TOKEN)}").split(PAGE_TOKEN, 2)
       # lambda used by all the helpers
-      lambda do |page, text = pagy.label_for(page), extra_attrs = ''|
-        %(#{left}#{page}#{right}#{ case page
-                                   when p_prev then ' rel="prev"'
-                                   when p_next then ' rel="next"'
-                                   when p_page then ' aria-disabled="true" aria-current="page"'
-                                   else             ''
-                                   end } #{extra_attrs}>#{text}</a>)
+      lambda do |page, text = pagy.label_for(page), classes: nil, aria_label: nil|
+        classes    = %( class="#{classes}") if classes
+        aria_label = %( aria-label="#{aria_label}") if aria_label
+        %(#{left}#{page}#{right}#{classes}#{aria_label}>#{text}</a>)
       end
     end
 
@@ -80,34 +73,24 @@ class Pagy
 
     private
 
-    def nav_aria_label_attr(pagy, nav_aria_label, nav_i18n_key, count: pagy.pages)
-      nav_aria_label ||= pagy_t(nav_i18n_key || pagy.vars[:nav_i18n_key], count:)
-      %(aria-label="#{nav_aria_label}")
+    def nav_aria_label(pagy, aria_label: nil)
+      aria_label ||= pagy_t('pagy.aria_label.nav', count: pagy.pages)
+      %(aria-label="#{aria_label}")
     end
 
-    def prev_aria_label_attr
-      %(aria-label="#{pagy_t('pagy.aria_label.prev')}")
-    end
-
-    def next_aria_label_attr
-      %(aria-label="#{pagy_t('pagy.aria_label.next')}")
-    end
-
-    def prev_html(pagy, link, text: pagy_t('pagy.prev'))
+    def prev_a(pagy, a, text: pagy_t('pagy.prev'), aria_label: pagy_t('pagy.aria_label.prev'))
       if (p_prev = pagy.prev)
-        %(<span class="page prev">#{link.call(p_prev, text, prev_aria_label_attr)}</span>)
+        a.(p_prev, text, aria_label:)
       else
-        %(<span class="page prev disabled"><a role="link" aria-disabled="true" #{
-             prev_aria_label_attr}>#{text}</a></span>)
+        %(<a role="link" aria-disabled="true" aria-label="#{aria_label}">#{text}</a>)
       end
     end
 
-    def next_html(pagy, link, text: pagy_t('pagy.next'))
+    def next_a(pagy, a, text: pagy_t('pagy.next'), aria_label: pagy_t('pagy.aria_label.next'))
       if (p_next = pagy.next)
-        %(<span class="page next">#{link.call(p_next, text, next_aria_label_attr)}</span>)
+        a.(p_next, text, aria_label:)
       else
-        %(<span class="page next disabled"><a role="link" aria-disabled="true" #{
-            next_aria_label_attr}>#{text}</a></span>)
+        %(<a role="link" aria-disabled="true" aria-label=#{aria_label}>#{text}</a>)
       end
     end
   end

data/lib/pagy/url_helpers.rb

@@ -8,13 +8,12 @@ class Pagy
     # For non-rack environments you can use the standalone extra
     def pagy_url_for(pagy, page, absolute: false, **_)
       vars         = pagy.vars
-      request_path = vars[:request_path].to_s.empty? ? request.path : vars[:request_path]
       pagy_params  = pagy.params.is_a?(Hash) ? pagy.params.transform_keys(&:to_s) : {}
       params       = request.GET.merge(pagy_params)
       pagy_set_query_params(page, vars, params)
       params       = pagy.params.call(params) if pagy.params.is_a?(Proc)
       query_string = "?#{Rack::Utils.build_nested_query(params)}"
-      "#{request.base_url if absolute}#{request_path}#{query_string}#{vars[:fragment]}"
+      "#{request.base_url if absolute}#{vars[:request_path] || request.path}#{query_string}#{vars[:fragment]}"
     end
 
     # Add the page and items params

data/lib/pagy.rb

@@ -5,27 +5,28 @@ require 'pathname'
 
 # Core class
 class Pagy
-  VERSION = '7.0.10'
+  VERSION = '8.0.0'
 
   # Root pathname to get the path of Pagy files like templates or dictionaries
   def self.root
     @root ||= Pathname.new(__dir__).freeze
   end
 
-  # Default core vars: constant for easy access, but mutable for customizable defaults
+  # Core defult: constant for easy access, but mutable for customizable defaults
   DEFAULT = { page:          1, # rubocop:disable Style/MutableConstant
               items:         20,
               outset:        0,
               size:          7,
-              page_param:    :page,
+              cycle:         false,
+              # backend/collection
+              count_args:    [:all],  # AR friendly
+              # backend/url
               params:        {},
+              page_param:    :page,
               fragment:      '',
-              link_extra:    '',
-              item_i18n_key: 'pagy.item_name',
-              nav_i18n_key: 'pagy.aria_label.nav',
-              cycle:         false,
-              request_path:  '',
-              count_args:    [:all] } # AR friendly
+              request_path:  nil,
+              # frontend/helpers
+              anchor_string: nil }
 
   attr_reader :count, :page, :items, :vars, :pages, :last, :offset, :in, :from, :to, :prev, :next, :params, :request_path
 

data/lib/stylesheets/pagy.css

@@ -1,61 +1,46 @@
 .pagy {
   display: flex;
-}
-
-.pagy > :not([hidden]) ~ :not([hidden]) {
-  --space-reverse: 0;
-  margin-right: calc(0.25rem * var(--space-reverse));
-  margin-left: calc(0.25rem * calc(1 - var(--space-reverse)));
-}
-
-.pagy {
   font-family: sans-serif;
   font-size: 0.875rem;
   line-height: 1.25rem;
   font-weight: 600;
-  color: rgb(107 114 128);
+  color: #6b7280;
 }
-
-.pagy .page.gap {
-  /* if you need to customize it */
+.pagy > :not([hidden]) ~ :not([hidden]) {
+  --space-reverse: 0;
+  margin-right: calc(0.25rem * var(--space-reverse));
+  margin-left: calc(0.25rem * calc(1 - var(--space-reverse)));
 }
-
-.pagy .page a {
+.pagy a:not(.gap) {
   display: block;
   text-decoration: none;
   border-radius: 0.5rem;
-  background-color: rgb(229 231 235);
+  background-color: #e5e7eb;
   padding: 0.25rem 0.75rem;
   color: inherit;
 }
-
-.pagy .page a:hover {
-  background-color: rgb(209 213 219);
+.pagy a:not(.gap):hover {
+  background-color: #d1d5db;
 }
-
-.pagy .page.active a {
+.pagy a:not(.gap):not([href]) { /* disabled links */
   cursor: default;
-  background-color: rgb(156 163 175);
-  color: rgb(255 255 255);
+  background-color: #f3f4f6;
+  color: #d1d5db;
 }
-
-.pagy .page.disabled a {
-  cursor: default;
-  background-color: rgb(243 244 246);
-  color: rgb(209 213 219);
+.pagy a:not(.gap).current {
+  background-color: #9ca3af;
+  color: white;
 }
-
-.pagy .pagy-combo-input, .pagy.pagy-items-selector-js {
+.pagy label {
   white-space: nowrap;
   display: inline-block;
   border-radius: 0.5rem;
-  background-color: rgb(229 231 235);
+  background-color: #e5e7eb;
   padding: 0.125rem 0.75rem;
 }
-
-.pagy .pagy-combo-input input, .pagy.pagy-items-selector-js input {
+.pagy label input {
   line-height: 1.5rem;
   border-radius: 0.375rem;
   border-style: none;
-  background-color: rgb(243 244 246);
+  background-color: #f3f4f6;
 }

data/lib/stylesheets/pagy.scss

@@ -10,31 +10,29 @@
     margin-right: calc(0.25rem * var(--space-reverse));
     margin-left: calc(0.25rem * calc(1 - var(--space-reverse)));
   }
-  .page {
-    a {
-      display: block;
-      text-decoration: none;
-      border-radius: 0.5rem;
-      background-color: rgb(229 231 235);
-      padding: 0.25rem 0.75rem;
-      color: inherit;
-      &:hover {
-        background-color: rgb(209 213 219);
-      }
-    }
-    &.active a {
-      cursor: default;
-      background-color: rgb(156 163 175);
-      color: rgb(255 255 255);
+
+  a:not(.gap) {
+    display: block;
+    text-decoration: none;
+    border-radius: 0.5rem;
+    background-color: rgb(229 231 235);
+    padding: 0.25rem 0.75rem;
+    color: inherit;
+    &:hover {
+      background-color: rgb(209 213 219);
     }
-    &.disabled a {
+    &:not([href]) { /* disabled links */
       cursor: default;
       background-color: rgb(243 244 246);
       color: rgb(209 213 219);
     }
-    &.gap { }  /* if you need to customize it */
+    &.current {
+      background-color: rgb(156 163 175);
+      color: rgb(255 255 255);
+    }
   }
-  .pagy-combo-input, &.pagy-items-selector-js {
+
+  label {
     white-space: nowrap;
     display: inline-block;
     border-radius: 0.5rem;

data/lib/stylesheets/pagy.tailwind.css

@@ -0,0 +1,21 @@
+.pagy {
+  @apply flex space-x-1 font-semibold text-sm text-gray-500;
+  a:not(.gap) {
+    @apply block rounded-lg px-3 py-1 bg-gray-200;
+    &:hover {
+      @apply bg-gray-300;
+    }
+    &:not([href]) { /* disabled links */
+      @apply text-gray-300 bg-gray-100 cursor-default;
+    }
+    &.current {
+      @apply text-white bg-gray-400;
+    }
+  }
+  label {
+    @apply inline-block whitespace-nowrap bg-gray-200 rounded-lg px-3 py-0.5;
+    input {
+      @apply bg-gray-100 border-none rounded-md;
+    }
+  }
+}

metadata

@@ -1,23 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 7.0.10
+  version: 8.0.0
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire:
-bindir: bin
+bindir: lib/bin
 cert_chain: []
-date: 2024-03-08 00:00:00.000000000 Z
+date: 2024-04-02 00:00:00.000000000 Z
 dependencies: []
 description: Agnostic pagination in plain ruby. It does it all. Better.
 email:
 - dd.nexus@gmail.com
-executables: []
+executables:
+- pagy
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
+- lib/apps/calendar.ru
+- lib/apps/demo.ru
+- lib/apps/rails.ru
+- lib/apps/repro.ru
+- lib/bin/pagy
 - lib/config/pagy.rb
 - lib/javascripts/pagy-dev.js
 - lib/javascripts/pagy-module.d.ts
@@ -59,6 +65,7 @@ files:
 - lib/locales/zh-CN.yml
 - lib/locales/zh-HK.yml
 - lib/locales/zh-TW.yml
+- lib/optimist.rb
 - lib/pagy.rb
 - lib/pagy/backend.rb
 - lib/pagy/calendar.rb
@@ -79,21 +86,20 @@ files:
 - lib/pagy/extras/countless.rb
 - lib/pagy/extras/elasticsearch_rails.rb
 - lib/pagy/extras/foundation.rb
-- lib/pagy/extras/frontend_helpers.rb
 - lib/pagy/extras/gearbox.rb
 - lib/pagy/extras/headers.rb
 - lib/pagy/extras/i18n.rb
 - lib/pagy/extras/items.rb
+- lib/pagy/extras/js_tools.rb
 - lib/pagy/extras/jsonapi.rb
 - lib/pagy/extras/materialize.rb
 - lib/pagy/extras/meilisearch.rb
 - lib/pagy/extras/metadata.rb
-- lib/pagy/extras/navs.rb
 - lib/pagy/extras/overflow.rb
+- lib/pagy/extras/pagy.rb
 - lib/pagy/extras/searchkick.rb
 - lib/pagy/extras/semantic.rb
 - lib/pagy/extras/standalone.rb
-- lib/pagy/extras/support.rb
 - lib/pagy/extras/trim.rb
 - lib/pagy/extras/uikit.rb
 - lib/pagy/frontend.rb
@@ -101,7 +107,7 @@ files:
 - lib/pagy/url_helpers.rb
 - lib/stylesheets/pagy.css
 - lib/stylesheets/pagy.scss
-- lib/stylesheets/pagy.tailwind.scss
+- lib/stylesheets/pagy.tailwind.css
 homepage: https://github.com/ddnexus/pagy
 licenses:
 - MIT
@@ -112,7 +118,16 @@ metadata:
   bug_tracker_uri: https://github.com/ddnexus/pagy/issues
   changelog_uri: https://github.com/ddnexus/pagy/blob/master/CHANGELOG.md
   support: https://github.com/ddnexus/pagy/discussions/categories/q-a
-post_install_message:
+post_install_message: |2+
+
+  *********************** PAGY WARNING! ***********************
+             We may drop pagy's less used CSS extras.
+
+        If you wish to keep them alive, please, vote here:
+
+  https://github.com/ddnexus/pagy/discussions/categories/survey
+  *************************************************************
+
 rdoc_options: []
 require_paths:
 - lib
@@ -132,3 +147,4 @@ signing_key:
 specification_version: 4
 summary: The best pagination ruby gem
 test_files: []
+...

data/lib/pagy/extras/navs.rb

@@ -1,51 +0,0 @@
-# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/navs
-# frozen_string_literal: true
-
-require 'pagy/extras/frontend_helpers'
-
-class Pagy # :nodoc:
-  # Frontend modules are specially optimized for performance.
-  # The resulting code may not look very elegant, but produces the best benchmarks
-  module NavsExtra
-    # Javascript pagination: it returns a nav and a JSON tag used by the pagy.js file
-    def pagy_nav_js(pagy, pagy_id: nil, link_extra: '',
-                    nav_aria_label: nil, nav_i18n_key: nil, **vars)
-      sequels = pagy.sequels(**vars)
-      p_id = %( id="#{pagy_id}") if pagy_id
-      link = pagy_link_proc(pagy, link_extra:)
-      tags = { 'before' => prev_html(pagy, link),
-               'link'   => %(<span class="page">#{link.call(PAGE_TOKEN, LABEL_TOKEN)}</span>),
-               'active' => %(<span class="page active">) +
-                           %(<a role="link" aria-current="page" aria-disabled="true">#{LABEL_TOKEN}</a></span>),
-               'gap'    => %(<span class="page gap">#{pagy_t 'pagy.gap'}</span>),
-               'after'  => next_html(pagy, link) }
-
-      %(<nav#{p_id} class="#{'pagy-rjs ' if sequels.size > 1}pagy pagy-nav-js pagination" #{
-          nav_aria_label_attr(pagy, nav_aria_label, nav_i18n_key)} #{
-          pagy_data(pagy, :nav, tags, sequels, pagy.label_sequels(sequels))
-        }></nav>)
-    end
-
-    # Javascript combo pagination: it returns a nav and a JSON tag used by the pagy.js file
-    def pagy_combo_nav_js(pagy, pagy_id: nil, link_extra: '',
-                          nav_aria_label: nil, nav_i18n_key: nil)
-      p_id    = %( id="#{pagy_id}") if pagy_id
-      link    = pagy_link_proc(pagy, link_extra:)
-      p_page  = pagy.page
-      p_pages = pagy.pages
-      input   = %(<input name="page" type="number" min="1" max="#{p_pages}" value="#{p_page}" ) +
-                %(style="padding: 0; text-align: center; width: #{p_pages.to_s.length + 1}rem;" aria-current="page">)
-
-      %(<nav#{p_id} class="pagy pagy-combo-nav-js pagination" #{
-          nav_aria_label_attr(pagy, nav_aria_label, nav_i18n_key)} #{
-          pagy_data(pagy, :combo, pagy_url_for(pagy, PAGE_TOKEN))}>#{
-          prev_html(pagy, link)
-      }<span class="pagy-combo-input">#{
-          pagy_t('pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages)
-        }</span>#{
-          next_html(pagy, link)
-        }</nav>)
-    end
-  end
-  Frontend.prepend NavsExtra
-end

data/lib/pagy/extras/support.rb

@@ -1,40 +0,0 @@
-# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/support
-# frozen_string_literal: true
-
-class Pagy # :nodoc:
-  # Extra support for features like: incremental, auto-incremental and infinite pagination
-  module SupportExtra
-    # Return the previous page URL string or nil
-    def pagy_prev_url(pagy, absolute: false)
-      pagy_url_for(pagy, pagy.prev, absolute:) if pagy.prev
-    end
-
-    # Return the next page URL string or nil
-    def pagy_next_url(pagy, absolute: false)
-      pagy_url_for(pagy, pagy.next, absolute:) if pagy.next
-    end
-
-    # Return the HTML string for the enabled/disabled previous page link
-    def pagy_prev_html(pagy, text: pagy_t('pagy.prev'), link_extra: '')
-      link = pagy_link_proc(pagy, link_extra:)
-      prev_html(pagy, link, text:)
-    end
-
-    # Return the HTML string for the enabled/disabled next page link
-    def pagy_next_html(pagy, text: pagy_t('pagy.next'), link_extra: '')
-      link = pagy_link_proc(pagy, link_extra:)
-      next_html(pagy, link, text:)
-    end
-
-    # Conditionally return the HTML link tag string for the previous page
-    def pagy_prev_link_tag(pagy, absolute: false)
-      %(<link href="#{pagy_url_for(pagy, pagy.prev, absolute:)}" rel="prev"/>) if pagy.prev
-    end
-
-    # Conditionally return the HTML link tag string for the next page
-    def pagy_next_link_tag(pagy, absolute: false)
-      %(<link href="#{pagy_url_for(pagy, pagy.next, absolute:)}" rel="next"/>) if pagy.next
-    end
-  end
-  Frontend.prepend SupportExtra
-end

data/lib/stylesheets/pagy.tailwind.scss

@@ -1,24 +0,0 @@
-.pagy {
-  @apply flex space-x-1 font-semibold text-sm text-gray-500;
-  .page {
-    a {
-      @apply block rounded-lg px-3 py-1 bg-gray-200;
-      &:hover {
-        @apply bg-gray-300;
-      }
-    }
-    &.active a {
-      @apply text-white bg-gray-400 cursor-default;
-    }
-    &.disabled a {
-      @apply text-gray-300 bg-gray-100 cursor-default;
-    }
-    &.gap { }  /* if you need to customize it */
-  }
-  .pagy-combo-input, &.pagy-items-selector-js {
-    @apply inline-block whitespace-nowrap bg-gray-200 rounded-lg px-3 py-0.5;
-    input {
-      @apply bg-gray-100 border-none rounded-md;
-    }
-  }
-}