pagy 43.2.0 → 43.2.2

data/lib/pagy/classes/keyset/keynav.rb

@@ -8,9 +8,10 @@ class Pagy
       PRIOR_PREFIX = 'prior_'
       PAGE_PREFIX  = 'page_'
 
-      path = Pathname.new(__FILE__).sub_ext('')
-      autoload :ActiveRecord, path.join('active_record')
-      autoload :Sequel,       path.join('sequel')
+      # Define empty subclasses to allow specific typing without triggering autoload.
+      # The .new factory in Keyset will handle mixing in the adapter logic from Pagy::Keyset::Adapters.
+      class ActiveRecord < self; end
+      class Sequel < self; end
 
       # Finalize the instance variables needed for the UI
       def initialize(set, **)

data/lib/pagy/classes/keyset/keyset.rb

@@ -6,31 +6,53 @@ require_relative '../../modules/b64'
 class Pagy
   # Implement wicked-fast keyset pagination for big data
   class Keyset < Pagy
-    path = Pathname.new(__dir__)
-    autoload :ActiveRecord, path.join('active_record')
-    autoload :Sequel,       path.join('sequel')
-    autoload :Keynav,       path.join('keynav')
+    # Autoload adapters: files are loaded only when const_get accesses them
+    module Adapters
+      path = Pathname.new(__dir__)
+      autoload :ActiveRecord, path.join('adapters/active_record')
+      autoload :Sequel,       path.join('adapters/sequel')
+    end
+
+    autoload :Keynav,  Pathname.new(__dir__).join('keynav')
+
+    # Define empty subclasses to allow specific typing without triggering autoload
+    class ActiveRecord < self; end
+    class Sequel       < self; end
 
     class TypeError < ::TypeError; end
 
-    # Initialize Keyset* and Keyset::Keynav* classes and subclasses
+    # Factory method: detects the set type, configures the subclass, and instantiates
     def self.new(set, **)
-      # Subclass instances run only the initializer
-      if /::(?:ActiveRecord|Sequel)$/.match?(name)  # check without triggering autoload
+      # 1. Handle direct subclass usage (e.g. Pagy::Keyset::ActiveRecord.new)
+      if /::(?:ActiveRecord|Sequel)$/.match?(name)
+        # Ensure the adapter is mixed in (lazy load)
+        mix_in_adapter(name.split('::').last)
         return allocate.tap { |instance| instance.send(:initialize, set, **) }
       end
 
-      subclass = if defined?(::ActiveRecord) && set.is_a?(::ActiveRecord::Relation)
-                   self::ActiveRecord
+      # 2. Handle Factory usage (Pagy::Keyset.new)
+      orm_name = if defined?(::ActiveRecord) && set.is_a?(::ActiveRecord::Relation)
+                   :ActiveRecord
                  elsif defined?(::Sequel) && set.is_a?(::Sequel::Dataset)
-                   self::Sequel
+                   :Sequel
                  else
                    raise TypeError, "expected an ActiveRecord::Relation or Sequel::Dataset; got #{set.class}"
                  end
+
+      # Get the specific subclass (self::ActiveRecord)
+      subclass = const_get(orm_name)
+      # Ensure the adapter is mixed in (lazy load)
+      subclass.mix_in_adapter(orm_name)
       subclass.new(set, **)
     end
 
-    def initialize(set, **) # rubocop:disable Lint/MissingSuper
+    # Helper to lazy-include the adapter module
+    def self.mix_in_adapter(orm_name)
+      adapter_module = Pagy::Keyset::Adapters.const_get(orm_name)
+      include(adapter_module) unless self < adapter_module
+    end
+
+    def initialize(set, **)
       assign_options(**)
       assign_and_check(limit: 1)
       @set    = set
@@ -102,7 +124,7 @@ class Pagy
           last_column, last_direction = keyset.pop
           intersection = +'('
           intersection << (keyset.map { |column, _d| "#{identifier[column]} = #{placeholder[column]}" } \
-                            << "#{identifier[last_column]} #{operator[last_direction]} #{placeholder[last_column]}").join(' AND ')
+          << "#{identifier[last_column]} #{operator[last_direction]} #{placeholder[last_column]}").join(' AND ')
           intersection << ')'
           union << intersection
         end

data/lib/pagy/classes/offset/countless.rb

@@ -4,7 +4,7 @@ class Pagy
   class Offset
     # Offset pagination without a count
     class Countless < Offset
-      def initialize(**) # rubocop:disable Lint/MissingSuper
+      def initialize(**)
         assign_options(**)
         assign_and_check(limit: 1, page: 1)
         @page = upto_max_pages(@page)

data/lib/pagy/classes/offset/offset.rb

@@ -14,7 +14,7 @@ class Pagy
     include Rangeable
     include Shiftable
 
-    def initialize(**) # rubocop:disable Lint/MissingSuper
+    def initialize(**)
       assign_options(**)
       assign_and_check(limit: 1, count: 0, page: 1)
       assign_last

data/lib/pagy/classes/offset/search.rb

@@ -3,7 +3,7 @@
 class Pagy
   module Search
     class Arguments < Array
-      def respond_to_missing? = true
+      def respond_to_missing?(*) = true
 
       def method_missing(*) = push(*)
     end

data/lib/pagy/classes/request.rb

@@ -11,7 +11,7 @@ class Pagy
         if request.is_a?(Hash)
           request.values_at(:base_url, :path, :params, :cookie)
         else
-          [request.base_url, request.path, request.GET.merge(request.POST).to_h, request.cookies['pagy']]
+          [request.base_url, request.path, get_params(request), request.cookies['pagy']]
         end
     end
 
@@ -32,5 +32,9 @@ class Pagy
 
       [requested_limit.to_i, @options[:client_max_limit]].min
     end
+
+    private
+
+    def get_params(request) = request.GET.merge(request.POST).to_h
   end
 end

data/lib/pagy/cli.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'fileutils'
+require 'rbconfig'
+require 'pagy'
+require_relative '../../apps/index'
+
+class Pagy
+  class CLI
+    LINUX = RbConfig::CONFIG['host_os'].include?('linux')
+    HOST  = 'localhost'
+    PORT  = '8000'
+
+    def start(args = ARGV)
+      options = parse_options(args)
+      run_command(args, options)
+    end
+
+    private
+
+    def parse_options(args)
+      options = { env: 'development', host: HOST, port: PORT,
+                  rerun: false, clear: false, quiet: false }
+
+      parser = OptionParser.new do |opts|
+        opts.banner = <<~BANNER
+          Pagy #{VERSION} (https://ddnexus.github.io/pagy/playground)
+          Playground to showcase, clone and develop Pagy APPs
+
+          Usage:
+            pagy APP [opts]   Showcase APP from the installed gem
+            pagy clone APP    Clone APP to the current dir
+            pagy FILE [opts]  Develop app FILE from local path
+        BANNER
+
+        opts.summary_indent = '  '
+        opts.summary_width  = 18
+
+        opts.separator "\nAPPs"
+        PagyApps::INDEX.each do |name, path|
+          desc = File.readlines(path)[3].sub('#    ', '').strip
+          opts.separator "  #{name.ljust(18)}#{desc}"
+        end
+
+        opts.separator "\nRackup options"
+        opts.on('-e', '--env ENV', 'Environment') { |v| options[:env] = v }
+        opts.on('-o', '--host HOST', 'Host')      { |v| options[:host] = v }
+        opts.on('-p', '--port PORT', 'Port')      { |v| options[:port] = v }
+
+        if LINUX
+          opts.separator "\nRerun options"
+          opts.on('--rerun', 'Enable rerun for development') { options[:rerun] = true }
+          opts.on('--clear', 'Clear screen before each rerun') { options[:clear] = true }
+        end
+
+        opts.separator "\nOther options"
+        opts.on('-q', '--quiet', 'Quiet mode for development') { options[:quiet] = true }
+        opts.on('-v', '--version', 'Show version') do
+          puts VERSION
+          exit
+        end
+        opts.on('-h', '--help', 'Show this help') do
+          puts opts
+          exit
+        end
+
+        opts.separator "\nExamples"
+        opts.separator "  pagy demo          Showcase demo at http://#{HOST}:#{PORT}"
+        opts.separator '  pagy clone repro   Clone repro to ./repro.ru (rename it)'
+        opts.separator "  pagy ~/myapp.ru    Develop ~/myapp.ru at #{HOST}:#{PORT}"
+      end
+
+      begin
+        parser.parse!(args)
+      rescue OptionParser::InvalidOption => e
+        abort e.message
+      end
+
+      if args.empty?
+        puts parser
+        exit
+      end
+
+      options
+    end
+
+    def run_command(args, options)
+      run_from_repo = Pagy::ROOT.join('pagy.gemspec').exist?
+      setup_gems(run_from_repo)
+
+      arg = args.shift
+
+      if arg.eql?('clone')
+        clone_app(args.shift)
+      else
+        serve_app(arg, options, run_from_repo)
+      end
+    end
+
+    def clone_app(name)
+      abort "Expected APP to be in [#{PagyApps::INDEX.keys.join(', ')}]; got #{name.inspect}" unless PagyApps::INDEX.key?(name)
+
+      if File.exist?(name)
+        print "Do you want to overwrite the #{name.inspect} file? (y/n)> "
+        answer = gets.chomp
+        abort "#{name.inspect} file already present" unless answer.start_with?(/y/i)
+      end
+      FileUtils.cp(PagyApps::INDEX[name], '.', verbose: true)
+    end
+
+    def serve_app(arg, options, run_from_repo)
+      if PagyApps::INDEX.key?(arg)
+        options[:env]   = 'showcase'
+        options[:rerun] = false
+        options[:quiet] = true
+        # Avoid the creation of './tmp/local_secret.txt' for showcase env
+        ENV['SECRET_KEY_BASE'] = 'absolute secret!' if arg.eql?('rails')
+        file = PagyApps::INDEX[arg]
+      else
+        file = arg
+      end
+      abort "#{file.inspect} app not found" unless File.exist?(file)
+
+      gem_dir = File.expand_path('../..', __dir__)
+      rackup  = "rackup -I #{gem_dir}/lib -r pagy -o #{options[:host]} -p #{options[:port]} -E #{options[:env]} #{file}"
+      rackup << ' -q' if options[:quiet]
+
+      if options[:rerun]
+        name  = File.basename(file)
+        dir   = File.dirname(file)
+        rerun = if run_from_repo
+                  "rerun --name #{name} -d #{dir},#{gem_dir} -p **/*.{rb,js,css,scss,ru,yml}"
+                else
+                  "rerun --name #{name} -d #{dir} -p #{name}"
+                end
+        rerun << ' -q' if options[:quiet]
+        rerun << ' -c' if options[:clear]
+        rerun << " -- #{rackup}"
+      end
+
+      exec(rerun || rackup)
+    end
+
+    # Kept as a separate method because mocking 'gemfile' (dsl) is complex otherwise
+    def setup_gems(run_from_repo)
+      require 'bundler/inline'
+      gemfile(!run_from_repo) do
+        source 'https://rubygems.org'
+        gem 'logger'
+        gem 'rackup'
+        gem 'rerun' if LINUX
+      end
+    end
+  end
+end

data/lib/pagy/modules/abilities/linkable.rb

@@ -47,13 +47,17 @@ class Pagy
         @options.merge(options)
                 .values_at(:root_key, :page_key, :limit_key, :client_max_limit, :limit, :querify, :absolute, :path, :fragment)
       params = @request.params.clone(freeze: false)
-      (root_key ? params[root_key] ||= {} : params).tap do |h|
+      (root_key ? params[root_key] = params[root_key]&.clone(freeze: false) || {} : params).tap do |h|
         { page_key  => compose_page_param(page),
           limit_key => client_max_limit && limit }.each { |k, v| v ? h[k] = v : h.delete(k) }
       end
       querify&.(params) # Must modify the params: the returned value is ignored
+      fragment &&= "##{fragment.delete_prefix('#')}"
+      compose_url(absolute, path, params, fragment)
+    end
+
+    def compose_url(absolute, path, params, fragment)
       query_string = QueryUtils.build_nested_query(params).sub(/\A(?=.)/, '?')
-      fragment   &&= "##{fragment.delete_prefix('#')}"
       "#{@request.base_url if absolute}#{path || @request.path}#{query_string}#{fragment}"
     end
   end

data/lib/pagy/toolbox/helpers/data_hash.rb

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 
 class Pagy
-  DEFAULT_DATA_KEYS = %i[url_template first_url previous_url page_url next_url last_url
+  DEFAULT_DATA_KEYS = %i[url_template first_url previous_url current_url page_url next_url last_url
                          count page limit last in from to previous next options].freeze
 
   # Generate a hash of the wanted internal data
   def data_hash(data_keys: @options[:data_keys] || DEFAULT_DATA_KEYS, **)
-    data_keys -= %i[count limit] if calendar?
     template   = compose_page_url(PAGE_TOKEN, **)
-    to_url     = ->(page) { template.sub(PAGE_TOKEN, page.to_s) }
-
+    to_url     = ->(page) { template.sub(PAGE_TOKEN, page.to_s) if page }
+    data_keys -= %i[count limit] if calendar?
     data_keys.each_with_object({}) do |key, data|
-      data[key] = case key
-                  when :url_template then template
-                  when :first_url    then compose_page_url(nil, **)
-                  when :previous_url then to_url.(@previous)
-                  when :page_url     then to_url.(@page)
-                  when :next_url     then to_url.(@next)
-                  when :last_url     then to_url.(@last)
-                  else send(key)
-                  end
+      value = case key
+              when :url_template           then template
+              when :first_url              then compose_page_url(nil, **)
+              when :previous_url           then to_url.(@previous)
+              when :current_url, :page_url then to_url.(@page)
+              when :next_url               then to_url.(@next)
+              when :last_url               then to_url.(@last)
+              else send(key)
+              end
+      data[key] = value if value
     rescue NoMethodError
-      raise OptionError.new(self, :data, 'to contain known keys', key)
+      raise OptionError.new(self, :data_keys, 'to contain known keys/methods', key)
     end
   end
 end

data/lib/pagy/toolbox/helpers/limit_tag_js.rb

@@ -7,12 +7,12 @@ class Pagy
   def limit_tag_js(id: nil, item_name: nil, client_max_limit: @options[:client_max_limit], **)
     raise OptionError.new(self, :client_max_limit, 'to be truthy', client_max_limit) unless client_max_limit
 
-    limit_input = %(<input name="limit" type="number" min="1" max="#{@options[:client_max_limit]}" value="#{
+    limit_input = %(<input name="limit" type="number" min="1" max="#{client_max_limit}" value="#{
                     @limit}" style="padding: 0; text-align: center; width: #{@limit.to_s.length + 1}rem;">#{A_TAG})
     url_token   = compose_page_url(PAGE_TOKEN, limit: LIMIT_TOKEN)
 
     %(<span#{%( id="#{id}") if id} class="pagy limit-tag-js" #{
-      data_pagy_attribute(:ltj, @from, url_token)
+      data_pagy_attribute(:ltj, @from, url_token, PAGE_TOKEN, LIMIT_TOKEN)
       }><label>#{
       I18n.translate('pagy.limit_tag_js',
                      item_name: item_name || I18n.translate('pagy.item_name', count: @limit),

data/lib/pagy/toolbox/helpers/loader.rb

@@ -24,8 +24,11 @@ class Pagy
       send(visibility)
       # Load the method, overriding its own alias. Next requests will call the method directly.
       define_method(:"load_#{visibility}") do |*args, **kwargs|
+        # Tests shadow the usage of these lines
+        # :nocov:
         require_relative methods[__callee__]
         send(__callee__, *args, **kwargs)
+        # :nocov:
       end
       methods.each_key { |method| alias_method method, :"load_#{visibility}" }
     end

data/lib/pagy/toolbox/helpers/page_url.rb

@@ -2,17 +2,15 @@
 
 class Pagy
   # Return the page url for any page
-  # :nocov:
   def page_url(page, **)
     target = case page
-             when :first    then nil
-             when :current  then @page
-             when :previous then @previous
-             when :next     then @next
-             when :last     then @last
-             else                page
+             when :first          then nil
+             when :current, :page then @page
+             when :previous       then @previous
+             when :next           then @next
+             when :last           then @last
+             else                      page
              end
     compose_page_url(target, **) if target || page == :first
   end
-  # :nocov:
 end

data/lib/pagy/toolbox/helpers/support/wrap_input_nav_js.rb

@@ -12,7 +12,7 @@ class Pagy
   def wrap_input_nav_js(html, nav_classes, id: nil, aria_label: nil, **)
     %(<nav#{%( id="#{id}") if id} class="#{nav_classes}" #{
       nav_aria_label_attribute(aria_label:)} #{
-      data = [:inj, compose_page_url(PAGE_TOKEN, **)]
+      data = [:inj, compose_page_url(PAGE_TOKEN, **), PAGE_TOKEN]
       data.push(@update) if keynav?
       data_pagy_attribute(*data)
       }>#{html}</nav>)

data/lib/pagy/toolbox/helpers/support/wrap_series_nav_js.rb

@@ -29,7 +29,7 @@ class Pagy
     nav_classes = "pagy-rjs #{nav_classes}" if sequels[0].size > 1
     %(<nav#{%( id="#{id}") if id} class="#{nav_classes}" #{
       nav_aria_label_attribute(aria_label:)} #{
-      data = [:snj, tokens.values, sequels]
+      data = [:snj, tokens.values, PAGE_TOKEN, sequels]
       data.push(@update) if keynav?
       data_pagy_attribute(*data)
       }></nav>)

data/lib/pagy/toolbox/paginators/method.rb

@@ -21,11 +21,11 @@ class Pagy
              protected
 
              define_method :pagy do |paginator = :offset, collection, **options|
-               arguments = if paginator == :calendar
-                             [self, collection, options]
-                           else
-                             [collection, options = Pagy.options.merge(options)]
-                           end
+               arguments           = if paginator == :calendar
+                                       [self, collection, options]
+                                     else
+                                       [collection, options = Pagy.options.merge(options)]
+                                     end
                options[:root_key]  = 'page' if options[:jsonapi] # enforce 'page' root_key for JSON:API
                options[:request] ||= request                     # user set request or self.request
                options[:request]   = Request.new(options)        # Pagy::Request

data/lib/pagy.rb

@@ -8,7 +8,7 @@ require_relative 'pagy/toolbox/helpers/loader'
 
 # Top superclass: it defines only what's common to all the subclasses
 class Pagy
-  VERSION     = '43.2.0'
+  VERSION     = '43.2.2'
   ROOT        = Pathname.new(__dir__).parent.freeze
   DEFAULT     = { limit: 20, limit_key: 'limit', page_key: 'page' }.freeze
   PAGE_TOKEN  = EscapedValue.new('P ')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 43.2.0
+  version: 43.2.2
 platform: ruby
 authors:
 - Domizio Demichelis
@@ -48,6 +48,7 @@ files:
 - LICENSE.txt
 - apps/calendar.ru
 - apps/demo.ru
+- apps/enable_rails_page_segment.rb
 - apps/index.rb
 - apps/keynav+root_key.ru
 - apps/keynav.ru
@@ -64,7 +65,6 @@ files:
 - javascripts/pagy.min.js
 - javascripts/pagy.mjs
 - javascripts/wand.js
-- lib/optimist.rb
 - lib/pagy.rb
 - lib/pagy/classes/calendar/calendar.rb
 - lib/pagy/classes/calendar/day.rb
@@ -74,19 +74,16 @@ files:
 - lib/pagy/classes/calendar/week.rb
 - lib/pagy/classes/calendar/year.rb
 - lib/pagy/classes/exceptions.rb
-- lib/pagy/classes/keyset/active_record.rb
 - lib/pagy/classes/keyset/adapters/active_record.rb
 - lib/pagy/classes/keyset/adapters/sequel.rb
 - lib/pagy/classes/keyset/keynav.rb
-- lib/pagy/classes/keyset/keynav/active_record.rb
-- lib/pagy/classes/keyset/keynav/sequel.rb
 - lib/pagy/classes/keyset/keyset.rb
-- lib/pagy/classes/keyset/sequel.rb
 - lib/pagy/classes/offset/countish.rb
 - lib/pagy/classes/offset/countless.rb
 - lib/pagy/classes/offset/offset.rb
 - lib/pagy/classes/offset/search.rb
 - lib/pagy/classes/request.rb
+- lib/pagy/cli.rb
 - lib/pagy/console.rb
 - lib/pagy/modules/abilities/configurable.rb
 - lib/pagy/modules/abilities/countable.rb