WIP: Super refactoring 2

Author: ddnexus

Gemfile.lock

@@ -3,6 +3,7 @@ PATH
   specs:
     pagy (9.3.3)
       json
+      yaml
 
 GEM
   remote: https://rubygems.org/
@@ -87,7 +88,7 @@ GEM
     bigdecimal (3.1.9)
     builder (3.3.0)
     concurrent-ruby (1.3.4)
-    connection_pool (2.4.1)
+    connection_pool (2.5.0)
     crass (1.0.6)
     date (3.4.1)
     docile (1.4.1)
@@ -321,6 +322,7 @@ GEM
       base64
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
+    yaml (0.4.0)
     zeitwerk (2.7.1)
 
 PLATFORMS

gem/lib/pagy.rb

@@ -2,10 +2,20 @@
 # frozen_string_literal: true
 
 require 'pathname'
-require_relative 'pagy/autoloading'
+require_relative 'pagy/autoload'
 
 # Top superclass: it should define only what's common to all the subclasses
 class Pagy
+  autoload :Backend,            'pagy/backend'
+  autoload :Frontend,           'pagy/frontend'
+  autoload :I18n,               'pagy/i18n'
+  autoload :UISupport,          'pagy/ui_support'
+  autoload :Offset,             'pagy/offset'
+  autoload :Keyset,             'pagy/keyset'
+  autoload :ElasticsearchRails, 'pagy/mixins/elasticsearch_rails'
+  autoload :Meilisearch,        'pagy/mixins/meilisearch'
+  autoload :Searchkick,         'pagy/mixins/searchkick'
+
   VERSION     = '9.3.3'
   PAGE_TOKEN  = 'P '
   LABEL_TOKEN = 'L'
@@ -41,66 +51,8 @@ def assign_vars(vars)
       cclass  = cclass.superclass
       default = cclass::DEFAULT.merge(default)
     end
-    @vars   = { **default, **vars.delete_if { |k, v| default.key?(k) && (v.nil? || v == '') } }
-  end
-
-  # Shared with KeysetForUI
-  module SharedUIMethods
-    attr_reader :in, :last, :prev
-    alias pages last
-
-    # Label for the current page. Allow the customization of the output (overridden by the calendar extra)
-    def label = @page.to_s
-
-    # Label for any page. Allow the customization of the output (overridden by the calendar extra)
-    def label_for(page) = page.to_s
-
-    # Return the array of page numbers and :gap e.g. [1, :gap, 8, "9", 10, :gap, 36]
-    def series(size: @vars[:size], **_)
-      raise VariableError.new(self, :size, 'to be an Integer >= 0', size) \
-      unless size.is_a?(Integer) && size >= 0
-      return [] if size.zero?
-
-      [].tap do |series|
-        if size >= @last
-          series.push(*1..@last)
-        else
-          left  = ((size - 1) / 2.0).floor # left half might be 1 page shorter for even size
-          start = if @page <= left # beginning pages
-                    1
-                  elsif @page > (@last - size + left) # end pages
-                    @last - size + 1
-                  else
-                    # intermediate pages
-                    @page - left
-                  end
-          series.push(*start...start + size)
-          # Set first and last pages plus gaps when needed, respecting the size
-          if vars[:ends] && size >= 7
-            series[0]  = 1
-            series[1]  = :gap unless series[1] == 2
-            series[-2] = :gap unless series[-2] == @last - 1
-            series[-1] = @last
-          end
-        end
-        series[series.index(@page)] = @page.to_s unless @overflow # overflow has no current page
-      end
-    end
-
-    # `Pagy` instance method used by the `pagy*_nav_js` helpers.
-    # Return the reverse sorted array of widths, series, and labels generated from the :steps hash
-    # Notice: if :steps is false it will use the single {0 => @vars[:size]} size
-    def sequels(steps: @vars[:steps] || { 0 => @vars[:size] }, **_)
-      raise VariableError.new(self, :steps, 'to define the 0 width', steps) unless steps.key?(0)
-
-      widths, series = steps.sort.reverse.map { |width, size| [width, series(size:)] }.transpose
-      [widths, series, label_sequels(series)]
-    end
-
-    # Support for the Calendar API
-    def label_sequels(*); end
+    @vars = { **default, **vars.delete_if { |k, v| default.key?(k) && (v.nil? || v == '') } }
   end
-  include Autoloading
 end
 
 require_relative 'pagy/exceptions'

gem/lib/pagy/autoloading.rb gem/lib/pagy/autoload.rb

@@ -1,15 +1,7 @@
 # frozen_string_literal: true
 
 class Pagy
-  autoload :Frontend,           'pagy/frontend'
-  autoload :Backend,            'pagy/backend'
-  autoload :Offset,             'pagy/offset'
-  autoload :Keyset,             'pagy/keyset'
-  autoload :ElasticsearchRails, 'pagy/mixin/elasticsearch_rails'
-  autoload :Meilisearch,        'pagy/mixin/meilisearch'
-  autoload :Searchkick,         'pagy/mixin/searchkick'
-
-  module Autoloading
+  module Autoload
     METHOD_MIXINS = { pagy_arel:                   :arel,
                       pagy_array:                  :array,
                       pagy_bootstrap_nav:          :bootstrap,
@@ -20,11 +12,11 @@ module Autoloading
                       pagy_bulma_combo_nav_js:     :bulma,
                       pagy_calendar:               :calendar,
                       pagy_countless:              :countless,
-                      new_from_elasticserch_rails: :elasticsearch,
+                      new_from_elasticserch_rails: :elasticsearch_rails,
                       pagy_elasticsearch_rails:    :elasticsearch_rails,
                       pagy_headers:                :headers,
                       pagy_headers_merge:          :headers,
-                      pagy_keyset:                 :keysets,
+                      pagy_keyset:                 :keyset,
                       pagy_keyset_augmented_js:    :keyset_augmented,
                       new_from_meilisearch:        :meilisearch,
                       pagy_meilisearch:            :meilisearch,
@@ -48,7 +40,7 @@ def respond_to_missing?(method, ...)
     def method_missing(method, ...)
       return super unless respond_to?(method)
 
-      require_relative "mixin/#{METHOD_MIXINS[method]}"
+      require_relative "mixins/#{METHOD_MIXINS[method]}"
       send(method, ...)
     end
   end

gem/lib/pagy/backend.rb

@@ -8,7 +8,8 @@ class Pagy
   # or any collection by overriding any of the `pagy_*` methods in your controller.
   # See also the extras if you need specialized methods to paginate Arrays or other collections
   module Backend
-    include Pagy::Autoloading
+    include Autoload
+
     private
 
     # Sub-method called only by #pagy: here for easy customization of fetching by overriding

gem/lib/pagy/extras/gearbox.rb

@@ -10,7 +10,6 @@ class Pagy
   # Automatically change the limit depending on the page number
   # accepts an array as the :gearbox_limit variable, that will determine the limit for the first pages
   module GearboxExtra
-
     module OffsetOverride
       # Assign @limit based on the :gearbox_limit variable
       def assign_limit

gem/lib/pagy/extras/jsonapi.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require_relative '../url_helpers'
+require_relative '../links_helper'
 
 class Pagy
   DEFAULT[:jsonapi] = true
@@ -21,21 +22,10 @@ module BackendOverride
       private
 
       include UrlHelpers
+      include LinksHelper
 
       # Return the jsonapi links
-      def pagy_jsonapi_links(pagy, **)
-        if defined?(::Pagy::Keyset) && pagy.is_a?(Keyset)
-          { first: pagy_page_url(pagy, nil, **),
-            last: nil,
-            prev: nil,
-            next:  pagy.next ? pagy_page_url(pagy, pagy.next, **) : nil }
-        else
-          { first: pagy_page_url(pagy, 1, **),
-            last:  pagy_page_url(pagy, pagy.last, **),
-            prev:  pagy.prev ? pagy_page_url(pagy, pagy.prev, **) : nil,
-            next:  pagy.next ? pagy_page_url(pagy, pagy.next, **) : nil }
-        end
-      end
+      alias pagy_jsonapi_links pagy_links
 
       # Should skip the jsonapi
       def pagy_skip_jsonapi?(vars)

gem/lib/pagy/frontend.rb

@@ -1,14 +1,15 @@
 # See Pagy::Frontend API documentation: https://ddnexus.github.io/pagy/docs/api/frontend
 # frozen_string_literal: true
 
+require_relative 'b64'
 require_relative 'i18n'
 require_relative 'url_helpers'
 
 class Pagy
   # Frontend modules are specially optimized for performance.
   # The resulting code may not look very elegant, but produces the best benchmarks
   module Frontend
-    include Pagy::Autoloading
+    include Autoload
     include UrlHelpers
 
     # Return a performance optimized lambda to generate the HTML anchor element (a tag)

gem/lib/pagy/keyset.rb

@@ -4,25 +4,15 @@
 require 'json'
 require_relative 'b64'
 
-require_relative 'keyset/adapters/active_record'
-require_relative 'keyset/adapters/sequel'
-
 class Pagy
   # Implement wicked-fast keyset pagination for big data
   class Keyset < Pagy
-
-    autoload :Augmented, 'pagy/keyset/augmented'
+    autoload :ActiveRecord, 'pagy/keyset/active_record'
+    autoload :Sequel,       'pagy/keyset/sequel'
+    autoload :Augmented,    'pagy/keyset/augmented'
 
     class TypeError < ::TypeError; end
 
-    class ActiveRecord < Keyset
-      include Adapters::ActiveRecord
-    end
-
-    class Sequel < Keyset
-      include Adapters::Sequel
-    end
-
     # Pick the right adapter for the set and initilize the right class
     def self.new(set, **vars)
       if self == Pagy::Keyset || (defined?(::Pagy::Keyset::Augmented) && self == ::Pagy::Keyset::Augmented)

gem/lib/pagy/keyset/active_record.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'active_record_adapter'
+
+class Pagy
+  class Keyset
+    class ActiveRecord < Keyset
+      include ActiveRecordAdapter
+    end
+  end
+end

gem/lib/pagy/keyset/active_record_adapter.rb

@@ -0,0 +1,36 @@
+# See Pagy API documentation: https://ddnexus.github.io/pagy/docs/api/keyset
+# frozen_string_literal: true
+
+class Pagy
+  class Keyset < Pagy
+    # Keyset adapter for ActiveRecord
+    module ActiveRecordAdapter
+      # Append the missing keyset keys if the set is restricted by select
+      def apply_select
+        @set.select(*@keyset.keys)
+      end
+
+      # Extract the keyset from the set
+      def extract_keyset
+        @set.order_values.each_with_object({}) do |node, keyset|
+          keyset[node.value.name.to_sym] = node.direction
+        end
+      end
+
+      # Filter the page records
+      def filter_records = @set.where(after_cutoff_sql, **@filter_args)
+
+      # Get the keyset attributes from the record
+      def keyset_attributes_from(record) = record.slice(*@keyset.keys)
+
+      # Set with selected columns?
+      def select? = !@set.select_values.empty?
+
+      # Typecast the cut args
+      def typecast_args(args)
+        @set.model.new(args).slice(args.keys)
+            .to_hash.transform_keys(&:to_sym)
+      end
+    end
+  end
+end