Merge branch 'dev'

.github/.env

@@ -1,2 +1,2 @@
 GEM=pagy
-VERSION=6.4.1
+VERSION=6.4.2

CHANGELOG.md

@@ -25,6 +25,12 @@ None
 
 <hr>
 
+## Version 6.4.2
+
+- Better module overrides in jsonapi
+- Replaced the is_a?(Hash) check for jsonapi reserved :page param with respond_to?(:Fetch) and prepended to the Frontend
+- Docs improvements and fixes
+
 ## Version 6.4.1
 
 - Remove dependency on base64 (#618)Ruby 3.3 prints a warning if base64 is used without specifying it in the gemfile.

Gemfile

@@ -7,6 +7,8 @@ source 'https://rubygems.org'
 
 gem 'rake'
 
+gem 'readline-ext' # temporary fix for RM 3.3.2 console with ruby >= 3.3.0
+
 group :test do
   gem 'activesupport'
   gem 'codecov', require: false

Gemfile.lock

@@ -68,6 +68,7 @@ GEM
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rbzip2 (0.3.0)
+    readline-ext (0.2.0)
     regexp_parser (2.9.0)
     rematch (1.4.2)
     rerun (0.14.0)
@@ -137,6 +138,7 @@ DEPENDENCIES
   rack
   rake
   rake-manifest
+  readline-ext
   rematch
   rerun
   rubocop

lib/config/pagy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Pagy initializer file (6.4.1)
+# Pagy initializer file (6.4.2)
 # Customize only what you really need and notice that the core Pagy works also without any of the following lines.
 # Should you just cherry pick part of this file, please maintain the require-order of the extras
 

lib/javascripts/pagy-module.js

@@ -81,7 +81,7 @@ const Pagy = (() => {
     const trim = (link, param) => link.replace(new RegExp(`(\\?|&)${param}=1\\b(?!&)|\\b${param}=1&`), "");
     // Public interface
     return {
-        version: "6.4.1",
+        version: "6.4.2",
         // Scan for elements with a "data-pagy" attribute and call their init functions with the decoded args
         init(arg) {
             const target = arg instanceof Element ? arg : document;

lib/pagy.rb

@@ -5,7 +5,7 @@
 
 # Core class
 class Pagy
-  VERSION = '6.4.1'
+  VERSION = '6.4.2'
 
   # Root pathname to get the path of Pagy files like templates or dictionaries
   def self.root

lib/pagy/extras/jsonapi.rb

@@ -12,51 +12,71 @@ module JsonApiExtra
     class ReservedParamError < StandardError
       # Inform about the actual value
       def initialize(value)
-        super("expected reserved :page param to be nil or Hash; got #{value.inspect}")
+        super("expected reserved :page param to be nil or Hash-like; got #{value.inspect}")
       end
     end
 
-    private
+    # Module overriding Backend
+    module BackendOverride
+      private
 
-    include UrlHelpers
+      include UrlHelpers
 
-    # Return the jsonapi links
-    def pagy_jsonapi_links(pagy, **opts)
-      { first: pagy_url_for(pagy, 1,         **opts),
-        last:  pagy_url_for(pagy, pagy.last, **opts),
-        prev:  pagy_url_for(pagy, pagy.prev, **opts),
-        next:  pagy_url_for(pagy, pagy.next, **opts) }
-    end
+      # Return the jsonapi links
+      def pagy_jsonapi_links(pagy, **opts)
+        { first: pagy_url_for(pagy, 1,         **opts),
+          last:  pagy_url_for(pagy, pagy.last, **opts),
+          prev:  pagy_url_for(pagy, pagy.prev, **opts),
+          next:  pagy_url_for(pagy, pagy.next, **opts) }
+      end
 
-    # Should skip the jsonapi
-    def pagy_skip_jsonapi?(vars)
-      return true if vars[:jsonapi] == false || (vars[:jsonapi].nil? && DEFAULT[:jsonapi] == false)
-      # check the reserved :page param and raise PageParamError or return nil
-      raise ReservedParamError, params[:page] unless params[:page].is_a?(Hash) || params[:page].nil?
-    end
+      # Should skip the jsonapi
+      def pagy_skip_jsonapi?(vars)
+        return true if vars[:jsonapi] == false || (vars[:jsonapi].nil? && DEFAULT[:jsonapi] == false)
+        # check the reserved :page param
+        raise ReservedParamError, params[:page] unless params[:page].respond_to?(:fetch) || params[:page].nil?
+      end
 
-    # Override the Backend method
-    def pagy_get_page(vars)
-      return super if pagy_skip_jsonapi?(vars)
+      # Override the Backend method
+      def pagy_get_page(vars)
+        return super if pagy_skip_jsonapi?(vars)
+        return 1 if params[:page].nil?
 
-      ((params[:page].is_a?(Hash) && params[:page][vars[:page_param] || DEFAULT[:page_param]]) || 1).to_i
+        params[:page][vars[:page_param] || DEFAULT[:page_param]].to_i
+      end
     end
+    Backend.prepend BackendOverride
+
+    # Module overriding ItemsExtra
+    module ItemsExtraOverride
+      private
 
-    # Override the ItemsExtra::Backend method
-    def pagy_get_items_size(vars)
-      return super if pagy_skip_jsonapi?(vars)
+      # Override the ItemsExtra::Backend method
+      def pagy_get_items_size(vars)
+        return super if pagy_skip_jsonapi?(vars)
+        return if params[:page].nil?
 
-      params[:page][vars[:items_param] || DEFAULT[:items_param]] if params[:page].is_a?(Hash)
+        params[:page][vars[:items_param] || DEFAULT[:items_param]]
+      end
     end
+    # Swap the next lines in ruby 3.0+ baseline
+    # ItemsExtra::Backend.prepend ItemsExtraOverride if defined?(ItemsExtra::Backend)
+    Backend.prepend ItemsExtraOverride if defined?(ItemsExtra::Backend)
 
-    # Override UrlHelper method
-    def pagy_set_query_params(page, vars, params)
-      return super unless vars[:jsonapi]
+    # Module overriding UrlHelper
+    module UrlHelperOverride
+      # Override UrlHelper method
+      def pagy_set_query_params(page, vars, params)
+        return super unless vars[:jsonapi]
 
-      params['page'] ||= {}
-      params['page'][vars[:page_param].to_s]  = page
-      params['page'][vars[:items_param].to_s] = vars[:items] if vars[:items_extra]
+        params['page'] ||= {}
+        params['page'][vars[:page_param].to_s]  = page
+        params['page'][vars[:items_param].to_s] = vars[:items] if vars[:items_extra]
+      end
     end
+    # Swap the next lines in ruby 3.0+ baseline
+    UrlHelpers.prepend UrlHelperOverride
+    # Backend.prepend UrlHelperOverride
+    # Frontend.prepend UrlHelperOverride
   end
-  Backend.prepend JsonApiExtra
 end

retype.yml

@@ -4,7 +4,7 @@ url: https://ddnexus.github.io/pagy
 
 branding:
   title: Pagy
-  label: 6.4.1
+  label: 6.4.2
   colors:
     label:
       text: "#FFFFFF"

src/pagy.ts

@@ -92,7 +92,7 @@ const Pagy = (() => {
 
     // Public interface
     return {
-        version: "6.4.1",
+        version: "6.4.2",
 
         // Scan for elements with a "data-pagy" attribute and call their init functions with the decoded args
         init(arg?:Element|never) {