pagy 8.6.3 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2504119986405246907631188b14c4e366eb2247f7fdecdd6a14f187dbe56674
-  data.tar.gz: 9a355076182f3446c64279c7e158f9d826963c472e2e9b17e497cb863bdcadcf
+  metadata.gz: b395bd7a70ca0accdd5ce4fedb2bfe101023a01a79874b263b038205780e3088
+  data.tar.gz: dab7e704ca18de752b1d1b0980b74fd91012ebc909fd4a3447b82bbf56a43f13
 SHA512:
-  metadata.gz: 30b2e50c83d38b52d186c8f53615b6fe8491fd22ace660f351cca2993ed98c25ab3a8b61117e57c5f3b465f28daba3ef2efe0cf0332c0e2cc4a09d8986cfc217
-  data.tar.gz: 01cf06ebc92ce69ccc50252d259057d14b56b0149e9e982dbd52e8e1bd1fb889a7319dcf497df5c3c2d3b388372e5444520054eda76cbefbe908d7debb20f73e
+  metadata.gz: 3773ddfa69afccda961c895e64a31d69b6caff443150ab6ddbbf217d5dda24d780e2aff6a761b05399d6ff237d43f024ce9f2c01b3479e2c1ec7bc793506e4c7
+  data.tar.gz: 02363e34dbe87043b996b305479e54af4423933b0e97ccbbc825cb50fd6932eb08f9236b890fdab3781ea696e692ab4400ab79443bb189c4035646c30c7af146

data/apps/calendar.ru

@@ -15,7 +15,7 @@
 # DOC
 #    https://ddnexus.github.io/pagy/playground/#5-calendar-app
 
-VERSION = '8.6.3'
+VERSION = '9.0.0'
 
 # Gemfile
 require 'bundler/inline'

data/apps/demo.ru

@@ -18,7 +18,7 @@
 # DOC
 #    https://ddnexus.github.io/pagy/playground/#3-demo-app
 
-VERSION = '8.6.3'
+VERSION = '9.0.0'
 
 require 'bundler/inline'
 require 'bundler'
@@ -41,7 +41,7 @@ STYLES = { pagy:        { extra: 'pagy', prefix: '', css_anchor: 'pagy-scss' },
 STYLES.each_key do |style|
   require "pagy/extras/#{STYLES[style][:extra] || style}"
 end
-require 'pagy/extras/items'
+require 'pagy/extras/limit'
 require 'pagy/extras/trim'
 Pagy::DEFAULT[:trim_extra] = false         # opt-in trim
 
@@ -403,8 +403,8 @@ for details</p>
 <%= highlight(html) %>
 
 <% if style.match(/pagy|tailwind/) %>
-<h2>pagy_items_selector_js</h2>
-<%= html = pagy_items_selector_js(@pagy, id: 'items-selector-js') %>
+<h2>pagy_limit_selector_js</h2>
+<%= html = pagy_limit_selector_js(@pagy, id: 'limit-selector-js') %>
 <%= highlight(html) %>
 
 <h2>pagy_prev_a / pagy_next_a</h2>

data/apps/keyset_ar.ru

@@ -0,0 +1,236 @@
+# frozen_string_literal: true
+
+# Starting point to reproduce keyset related pagy issues
+
+# DEV USAGE
+#    pagy clone rails
+#    pagy ./keyset.ru
+
+# URL
+#    http://0.0.0.0:8000
+
+# HELP
+#    pagy -h
+
+# DOC
+#    https://ddnexus.github.io/pagy/playground/#5-keyset-app
+
+VERSION = '8.6.2'
+
+# Gemfile
+require 'bundler/inline'
+require 'bundler'
+Bundler.configure
+gemfile(ENV['PAGY_INSTALL_BUNDLE'] == 'true') do
+  source 'https://rubygems.org'
+  gem 'oj'
+  gem 'puma'
+  gem 'rails'
+  # activerecord/sqlite3_adapter.rb probably useless) constraint !!!
+  # https://github.com/rails/rails/blame/v7.1.3.4/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L14
+  gem 'sqlite3', '~> 1.4.0'
+end
+
+# require 'rails/all'     # too much stuff
+require 'action_controller/railtie'
+require 'active_record'
+
+OUTPUT = Rails.env.showcase? ? IO::NULL : $stdout
+
+# Rails config
+class PagyKeyset < Rails::Application # :nodoc:
+  config.root = __dir__
+  config.session_store :cookie_store, key: 'cookie_store_key'
+  Rails.application.credentials.secret_key_base = 'absolute_secret'
+
+  config.logger = Logger.new(OUTPUT)
+  Rails.logger  = config.logger
+
+  routes.draw do
+    root to: 'pets#index'
+  end
+end
+
+dir = Rails.env.development? ? '.' : Dir.pwd  # app dir in dev or pwd otherwise
+unless File.writable?(dir)
+  warn "ERROR: directory #{dir.inspect} is not writable (the pagy-rails-app needs to create DB files)"
+  exit 1
+end
+
+# Pagy initializer
+require 'pagy/extras/pagy'
+require 'pagy/extras/limit'
+require 'pagy/extras/keyset'
+Pagy::DEFAULT[:limit] = 10
+Pagy::DEFAULT.freeze
+
+PETS = <<~PETS
+  Luna  | dog    | 2018-03-10
+  Coco  | cat    | 2019-05-15
+  Dodo  | dog    | 2020-06-25
+  Wiki  | bird   | 2018-03-12
+  Baby  | rabbit | 2020-01-13
+  Neki  | horse  | 2021-07-20
+  Tino  | donkey | 2019-06-18
+  Plot  | cat    | 2022-09-21
+  Riki  | cat    | 2018-09-14
+  Susi  | horse  | 2018-10-26
+  Coco  | pig    | 2020-08-29
+  Momo  | bird   | 2023-08-25
+  Lili  | cat    | 2021-07-22
+  Beli  | pig    | 2020-07-26
+  Rocky | bird   | 2022-08-19
+  Vyvy  | dog    | 2018-05-16
+  Susi  | horse  | 2024-01-25
+  Ella  | cat    | 2020-02-20
+  Rocky | dog    | 2019-09-19
+  Juni  | rabbit | 2020-08-24
+  Coco  | bird   | 2021-03-17
+  Susi  | dog    | 2021-07-28
+  Luna  | horse  | 2023-05-14
+  Gigi  | pig    | 2022-05-19
+  Coco  | cat    | 2020-02-20
+  Nino  | donkey | 2019-06-17
+  Luna  | cat    | 2022-02-09
+  Popi  | dog    | 2020-09-26
+  Lili  | pig    | 2022-06-18
+  Mina  | horse  | 2021-04-21
+  Susi  | rabbit | 2023-05-18
+  Toni  | donkey | 2018-06-22
+  Rocky | horse  | 2019-09-28
+  Lili  | cat    | 2019-03-18
+  Roby  | cat    | 2022-06-19
+  Anto  | horse  | 2022-08-18
+  Susi  | pig    | 2021-04-21
+  Boly  | bird   | 2020-03-29
+  Sky   | cat    | 2023-07-19
+  Lili  | dog    | 2020-01-28
+  Fami  | snake  | 2023-04-27
+  Lopi  | pig    | 2019-06-19
+  Rocky | snake  | 2022-03-13
+  Denis | dog    | 2022-06-19
+  Maca  | cat    | 2022-06-19
+  Luna  | dog    | 2022-08-15
+  Jeme  | horse  | 2019-08-08
+  Sary  | bird   | 2023-04-29
+  Rocky | bird   | 2023-05-14
+  Coco  | dog    | 2023-05-27
+PETS
+
+# Activerecord initializer
+ActiveRecord::Base.logger = Logger.new(OUTPUT)
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: "#{dir}/tmp/pagy-keyset-ar.sqlite3")
+ActiveRecord::Schema.define do
+  create_table :pets, force: true do |t|
+    t.string   :animal
+    t.string   :name
+    t.date     :birthdate
+  end
+end
+
+# Models
+class Pet < ActiveRecord::Base
+end
+
+# DB seed
+pets = []
+PETS.each_line(chomp: true) do |pet|
+  name, animal, birthdate = pet.split('|').map(&:strip)
+  pets << { name:, animal:, birthdate: }
+end
+Pet.insert_all(pets)
+
+# Helpers
+module PetsHelper
+  include Pagy::Frontend
+
+  def order_symbol(dir)
+    { asc: '&#x2197;', desc: '&#x2198;' }[dir]
+  end
+end
+
+# Controllers
+class PetsController < ActionController::Base # :nodoc:
+  include Rails.application.routes.url_helpers
+  include Pagy::Backend
+
+  def index
+    Time.zone = 'UTC'
+
+    @order = { animal: :asc, name: :asc, birthdate: :desc, id: :asc }
+    @pagy, @pets = pagy_keyset(Pet.order(@order))
+    render inline: TEMPLATE
+  end
+end
+
+TEMPLATE = <<~ERB
+  <!DOCTYPE html>
+  <html lang="en">
+    <html>
+    <head>
+    <title>Pagy Keyset App</title>
+      <meta name="viewport" content="width=device-width, initial-scale=1.0">
+      <style type="text/css">
+        @media screen { html, body {
+          font-size: 1rem;
+          line-height: 1.2s;
+          padding: 0;
+          margin: 0;
+        } }
+        body {
+          background: white !important;
+          margin: 0 !important;
+          font-family: sans-serif !important;
+        }
+        .content {
+          padding: 1rem 1.5rem 2rem !important;
+        }
+
+        <%== Pagy.root.join('stylesheets', 'pagy.css').read %>
+      </style>
+    </head>
+
+    <body>
+
+      <div class="content">
+        <h1>Pagy Keyset App</h1>
+        <p>Self-contained, standalone Rails app usable to easily reproduce any keyset related pagy issue with ActiveRecord sets.</p>
+        <p>Please, report the following versions in any new issue.</p>
+        <h2>Versions</h2>
+        <ul>
+          <li>Ruby:  <%== RUBY_VERSION %></li>
+          <li>Rack:  <%== Rack::RELEASE %></li>
+          <li>Rails: <%== Rails.version %></li>
+          <li>Pagy:  <%== Pagy::VERSION %></li>
+        </ul>
+
+        <h3>Collection</h3>
+        <div id="records" class="collection">
+        <table border="1" cellspacing="0" cellpadding="3">
+          <tr>
+            <th>animal <%== order_symbol(@order[:animal]) %></th>
+            <th>name <%== order_symbol(@order[:name]) %></th>
+            <th>birthdate <%== order_symbol(@order[:birthdate]) %></th>
+            <th>id <%== order_symbol(@order[:id]) %></th>
+          </tr>
+          <% @pets.each do |pet| %>
+          <tr>
+            <td><%= pet.animal %></td>
+            <td><%= pet.name %></td>
+            <td><%= pet.birthdate %></td>
+            <td><%= pet.id %></td>
+          </tr>
+          <% end %>
+        </table>
+        </div>
+        <p>
+        <nav class="pagy" id="next" aria-label="Pagy next">
+          <%== pagy_next_a(@pagy, text: 'Next page &gt;') %>
+        </nav>
+      </div>
+
+    </body>
+  </html>
+ERB
+
+run PagyKeyset

data/apps/keyset_s.ru

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+# Starting point to reproduce keyset related pagy issues
+
+# DEV USAGE
+#    pagy clone rails
+#    pagy ./keyset.ru
+
+# URL
+#    http://0.0.0.0:8000
+
+# HELP
+#    pagy -h
+
+# DOC
+#    https://ddnexus.github.io/pagy/playground/#5-keyset-app
+
+VERSION = '8.6.2'
+
+# Gemfile
+require 'bundler/inline'
+require 'bundler'
+Bundler.configure
+gemfile(ENV['PAGY_INSTALL_BUNDLE'] == 'true') do
+  source 'https://rubygems.org'
+  gem 'oj'
+  gem 'puma'
+  gem 'rails'
+  # activerecord/sqlite3_adapter.rb probably useless) constraint !!!
+  # https://github.com/rails/rails/blame/v7.1.3.4/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L14
+  gem 'sqlite3', '~> 1.4.0'
+  gem 'sequel'
+end
+
+# require 'rails/all'     # too much stuff
+require 'action_controller/railtie'
+require 'sequel'
+
+OUTPUT = Rails.env.showcase? ? IO::NULL : $stdout
+
+# Rails config
+class PagyKeyset < Rails::Application # :nodoc:
+  config.root = __dir__
+  config.session_store :cookie_store, key: 'cookie_store_key'
+  Rails.application.credentials.secret_key_base = 'absolute_secret'
+
+  config.logger = Logger.new(OUTPUT)
+  Rails.logger  = config.logger
+
+  routes.draw do
+    root to: 'pets#index'
+  end
+end
+
+dir = Rails.env.development? ? '.' : Dir.pwd  # app dir in dev or pwd otherwise
+unless File.writable?(dir)
+  warn "ERROR: directory #{dir.inspect} is not writable (the pagy-rails-app needs to create DB files)"
+  exit 1
+end
+
+# Pagy initializer
+require 'pagy/extras/pagy'
+require 'pagy/extras/limit'
+require 'pagy/extras/keyset'
+Pagy::DEFAULT[:limit] = 10
+Pagy::DEFAULT.freeze
+
+PETS = <<~PETS
+  Luna  | dog    | 2018-03-10
+  Coco  | cat    | 2019-05-15
+  Dodo  | dog    | 2020-06-25
+  Wiki  | bird   | 2018-03-12
+  Baby  | rabbit | 2020-01-13
+  Neki  | horse  | 2021-07-20
+  Tino  | donkey | 2019-06-18
+  Plot  | cat    | 2022-09-21
+  Riki  | cat    | 2018-09-14
+  Susi  | horse  | 2018-10-26
+  Coco  | pig    | 2020-08-29
+  Momo  | bird   | 2023-08-25
+  Lili  | cat    | 2021-07-22
+  Beli  | pig    | 2020-07-26
+  Rocky | bird   | 2022-08-19
+  Vyvy  | dog    | 2018-05-16
+  Susi  | horse  | 2024-01-25
+  Ella  | cat    | 2020-02-20
+  Rocky | dog    | 2019-09-19
+  Juni  | rabbit | 2020-08-24
+  Coco  | bird   | 2021-03-17
+  Susi  | dog    | 2021-07-28
+  Luna  | horse  | 2023-05-14
+  Gigi  | pig    | 2022-05-19
+  Coco  | cat    | 2020-02-20
+  Nino  | donkey | 2019-06-17
+  Luna  | cat    | 2022-02-09
+  Popi  | dog    | 2020-09-26
+  Lili  | pig    | 2022-06-18
+  Mina  | horse  | 2021-04-21
+  Susi  | rabbit | 2023-05-18
+  Toni  | donkey | 2018-06-22
+  Rocky | horse  | 2019-09-28
+  Lili  | cat    | 2019-03-18
+  Roby  | cat    | 2022-06-19
+  Anto  | horse  | 2022-08-18
+  Susi  | pig    | 2021-04-21
+  Boly  | bird   | 2020-03-29
+  Sky   | cat    | 2023-07-19
+  Lili  | dog    | 2020-01-28
+  Fami  | snake  | 2023-04-27
+  Lopi  | pig    | 2019-06-19
+  Rocky | snake  | 2022-03-13
+  Denis | dog    | 2022-06-19
+  Maca  | cat    | 2022-06-19
+  Luna  | dog    | 2022-08-15
+  Jeme  | horse  | 2019-08-08
+  Sary  | bird   | 2023-04-29
+  Rocky | bird   | 2023-05-14
+  Coco  | dog    | 2023-05-27
+PETS
+
+Sequel.default_timezone = :utc
+
+## Sequel initializer
+DB = Sequel.connect(adapter: 'sqlite', user: 'root', password: 'password', host: 'localhost', port: '3306',
+                    database: "#{dir}/tmp/pagy-keyset-s.sqlite3", max_connections: 10, loggers: [Logger.new(OUTPUT)])
+
+DB.create_table! :pets do
+  primary_key :id
+  String :animal,    unique: false, null: false
+  String :name,      unique: false, null: false
+  Date   :birthdate, unique: false, null: false
+end
+
+dataset = DB[:pets]
+
+PETS.each_line(chomp: true) do |pet|
+  name, animal, birthdate = pet.split('|').map(&:strip)
+  dataset.insert(name:, animal:, birthdate:)
+end
+
+# Models
+class Pet < Sequel::Model
+end
+
+# Helpers
+module PetsHelper
+  include Pagy::Frontend
+
+  def order_symbol(dir)
+    { asc: '&#x2197;', desc: '&#x2198;' }[dir]
+  end
+end
+
+# Controllers
+class PetsController < ActionController::Base # :nodoc:
+  include Rails.application.routes.url_helpers
+  include Pagy::Backend
+
+  def index
+    Time.zone = 'UTC'
+
+    @order = { animal: :asc, name: :asc, birthdate: :desc, id: :asc }
+    @pagy, @pets = pagy_keyset(Pet.order(:animal, :name, Sequel.desc(:birthdate), :id))
+    render inline: TEMPLATE
+  end
+end
+
+TEMPLATE = <<~ERB
+  <!DOCTYPE html>
+  <html lang="en">
+    <html>
+    <head>
+    <title>Pagy Keyset App</title>
+      <meta name="viewport" content="width=device-width, initial-scale=1.0">
+      <style type="text/css">
+        @media screen { html, body {
+          font-size: 1rem;
+          line-height: 1.2s;
+          padding: 0;
+          margin: 0;
+        } }
+        body {
+          background: white !important;
+          margin: 0 !important;
+          font-family: sans-serif !important;
+        }
+        .content {
+          padding: 1rem 1.5rem 2rem !important;
+        }
+
+        <%== Pagy.root.join('stylesheets', 'pagy.css').read %>
+      </style>
+    </head>
+
+    <body>
+
+      <div class="content">
+        <h1>Pagy Keyset App</h1>
+        <p>Self-contained, standalone Rails app usable to easily reproduce any keyset related pagy issue with Sequel sets.</p>
+        <p>Please, report the following versions in any new issue.</p>
+        <h2>Versions</h2>
+        <ul>
+          <li>Ruby:  <%== RUBY_VERSION %></li>
+          <li>Rack:  <%== Rack::RELEASE %></li>
+          <li>Rails: <%== Rails.version %></li>
+          <li>Pagy:  <%== Pagy::VERSION %></li>
+        </ul>
+
+        <h3>Collection</h3>
+        <div id="records" class="collection">
+        <table border="1" cellspacing="0" cellpadding="3">
+          <tr>
+            <th>animal <%== order_symbol(@order[:animal]) %></th>
+            <th>name <%== order_symbol(@order[:name]) %></th>
+            <th>birthdate <%== order_symbol(@order[:birthdate]) %></th>
+            <th>id <%== order_symbol(@order[:id]) %></th>
+          </tr>
+          <% @pets.each do |pet| %>
+          <tr>
+            <td><%= pet.animal %></td>
+            <td><%= pet.name %></td>
+            <td><%= pet.birthdate %></td>
+            <td><%= pet.id %></td>
+          </tr>
+          <% end %>
+        </table>
+        </div>
+        <p>
+        <nav class="pagy" id="next" aria-label="Pagy next">
+          <%== pagy_next_a(@pagy, text: 'Next page &gt;') %>
+        </nav>
+      </div>
+
+    </body>
+  </html>
+ERB
+
+run PagyKeyset

data/apps/rails.ru

@@ -15,7 +15,7 @@
 # DOC
 #    https://ddnexus.github.io/pagy/playground/#2-rails-app
 
-VERSION = '8.6.3'
+VERSION = '9.0.0'
 
 # Gemfile
 require 'bundler/inline'
@@ -61,9 +61,9 @@ end
 
 # Pagy initializer
 require 'pagy/extras/pagy'
-require 'pagy/extras/items'
+require 'pagy/extras/limit'
 require 'pagy/extras/overflow'
-Pagy::DEFAULT[:items]    = 10
+Pagy::DEFAULT[:limit]    = 10
 Pagy::DEFAULT[:overflow] = :empty_page
 Pagy::DEFAULT.freeze
 
@@ -200,8 +200,8 @@ TEMPLATE = <<~ERB
         <h4>pagy_combo_nav_js</h4>
         <%== pagy_combo_nav_js(@pagy, id: 'combo-nav-js', aria_label: 'Pages combo_nav_js') %>
 
-        <h4>pagy_items_selector_js</h4>
-        <%== pagy_items_selector_js(@pagy, id: 'items-selector-js') %>
+        <h4>pagy_limit_selector_js</h4>
+        <%== pagy_limit_selector_js(@pagy, id: 'limit-selector-js') %>
 
         <h4>pagy_info</h4>
         <%== pagy_info(@pagy, id: 'pagy-info') %>

data/apps/repro.ru

@@ -15,7 +15,7 @@
 # DOC
 #    https://ddnexus.github.io/pagy/playground/#1-repro-app
 
-VERSION = '8.6.3'
+VERSION = '9.0.0'
 
 require 'bundler/inline'
 require 'bundler'
@@ -31,7 +31,7 @@ end
 # Edit this section adding/removing the extras and Pagy::DEFAULT as needed
 # pagy initializer
 require 'pagy/extras/pagy'
-require 'pagy/extras/items'
+require 'pagy/extras/limit'
 require 'pagy/extras/overflow'
 Pagy::DEFAULT[:overflow] = :empty_page
 Pagy::DEFAULT.freeze
@@ -169,8 +169,8 @@ __END__
   <h4>pagy_combo_nav_js</h4>
   <%= pagy_combo_nav_js(@pagy, id: 'combo-nav-js', aria_label: 'Pages combo_nav_js') %>
 
-  <h4>pagy_items_selector_js</h4>
-  <%= pagy_items_selector_js(@pagy, id: 'items-selector-js') %>
+  <h4>pagy_limit_selector_js</h4>
+  <%= pagy_limit_selector_js(@pagy, id: 'limit-selector-js') %>
 
   <h4>pagy_info</h4>
   <%= pagy_info(@pagy, id: 'pagy-info') %>

data/apps/tmp/local_secret.txt

@@ -1 +1 @@
-4c57eebd7544c7f0acc9943ab614ab3da71d2461f5581ed8d41e9b8aa1bf23bff831f82e934eed96c608da0feac2c3dd21383c269d896cf01fcd6fa81aca2462
+0db96a70cc96bc7061757f38eec002ce6b14c6d987c4373d79a9f48bdcb0a26f4e00c88eec7a18c496d2779eb277f8b4a85f41dcac4c85482c7d5dd7cf05ba87

data/bin/pagy

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-VERSION = '8.6.3'
-APPS    = %w[repro rails demo calendar].freeze
+VERSION = '9.0.0'
+APPS    = %w[repro rails demo calendar keyset_ar keyset_s].freeze
 LINUX   = RbConfig::CONFIG['host_os'].include?('linux')
 HOST    = '0.0.0.0'
 PORT    = '8000'
@@ -17,6 +17,8 @@ opts = Optimist.options do
       rails                      Reproduce rails related issues
       demo                       Showcase all the helpers and styles
       calendar                   Showcase the calendar; reproduce related issues
+      keyset_ar                  Showcase the keyset ActiveRecord pagination
+      keyset_s                   Showcase the keyset Sequel pagination
     USAGE
       pagy APP [options]         Showcase APP from the installed gem
       pagy clone APP             Clone APP to the current dir