pagy 9.4.0 → 43.5.5

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative '../../modules/searcher'
+
+class Pagy
+  module ElasticsearchRailsPaginator
+    module_function
+
+    def paginate(search, options)
+      if search.is_a?(Search::Arguments)  # Active mode
+
+        Searcher.wrap(search, options) do
+          model, arguments, search_options = search
+
+          search_options[:size] = options[:limit]
+          search_options[:from] = options[:limit] * ((options[:page] || 1) - 1)
+
+          method          = options[:search_method] || ElasticsearchRails::DEFAULT[:search_method]
+          response_object = model.send(method, *arguments, **search_options)
+          options[:count] = total_count_from(response_object)
+
+          [ElasticsearchRails.new(**options), response_object]
+        end
+
+      else # Passive mode
+        from, size      = pagination_params_from(search)
+        options[:limit] = size
+        options[:page]  = ((from || 0) / options[:limit]) + 1
+        options[:count] = total_count_from(search)
+
+        ElasticsearchRails.new(**options)
+      end
+    end
+
+    # Support different versions of ElasticsearchRails
+    def pagination_params_from(response_object)
+      definition = response_object.search.definition
+      definition = definition.to_hash if definition.respond_to?(:to_hash)
+      container  = (definition.is_a?(Hash) && (definition[:body] || definition)) || response_object.search.options
+      from       = (container[:from] || container['from']).to_i
+      size       = (container[:size] || container['size']).to_i
+      size       = 10 if size.zero?
+
+      [from, size]
+    end
+
+    # Support different versions of ElasticsearchRails
+    def total_count_from(response_object)
+      total = response_object.instance_eval do
+                respond_to?(:response) ? response['hits']['total'] : raw_response['hits']['total']
+              end
+
+      total.is_a?(Hash) ? total['value'] : total
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../../../pagy/modules/b64'
+
+class Pagy
+  module KeynavJsPaginator
+    module_function
+
+    def paginate(set, options)
+      page = options[:request].resolve_page(force_integer: false) # allow nil
+
+      return CountlessPaginator.paginate(set, page:, **options) if page&.match(' ')  # countless fallback
+
+      if page.is_a?(String) && (page_arguments = Keyset.decode(page))
+        # Restart the pagination from page 1/nil if the url has been requested from another browser
+        options[:page] = page_arguments \
+            if options[:request].cookie == page_arguments.shift # rubocop:disable Style/SoleNestedConditional
+      end
+
+      options[:limit] = options[:request].resolve_limit
+
+      pagy = Keyset::Keynav.new(set, **options)
+      [pagy, pagy.records]
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Pagy
+  module KeysetPaginator
+    module_function
+
+    def paginate(set, options)
+      options[:page] ||= options[:request].resolve_page(force_integer: false) # allow nil
+      options[:limit]  = options[:request].resolve_limit
+
+      pagy = Keyset.new(set, **options)
+      [pagy, pagy.records]
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../../modules/searcher'
+
+class Pagy
+  module MeilisearchPaginator
+    module_function
+
+    def paginate(search, options)
+      if search.is_a?(Search::Arguments) # Active mode
+
+        Searcher.wrap(search, options) do
+          model, arguments, search_options = search
+
+          search_options[:hits_per_page] = options[:limit]
+          search_options[:page]          = options[:page]
+
+          method          = options[:search_method] || Meilisearch::DEFAULT[:search_method]
+          results         = model.send(method, *arguments, search_options)
+          options[:count] = results.raw_answer['totalHits']
+
+          [Meilisearch.new(**options), results]
+        end
+
+      else # Passive mode
+        options[:limit] = search.raw_answer['hitsPerPage']
+        options[:page]  = search.raw_answer['page']
+        options[:count] = search.raw_answer['totalHits']
+
+        Meilisearch.new(**options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../../classes/request'
+
+class Pagy
+  paginators = { offset:              :OffsetPaginator,
+                 countless:           :CountlessPaginator,
+                 countish:            :CountishPaginator,
+                 keyset:              :KeysetPaginator,
+                 keynav_js:           :KeynavJsPaginator,
+                 calendar:            :CalendarPaginator,
+                 elasticsearch_rails: :ElasticsearchRailsPaginator,
+                 meilisearch:         :MeilisearchPaginator,
+                 searchkick:          :SearchkickPaginator,
+                 typesense_rails:     :TypesenseRailsPaginator }.freeze
+
+  path = Pathname.new(__dir__)
+  paginators.each { |symbol, name| autoload name, path.join(symbol.to_s) }
+
+  # Pagy::Method defines the #pagy method to be included in the app controller/view.
+  Method = Module.new do
+             protected
+
+             define_method :pagy do |paginator = :offset, collection, **options|
+               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                     # custom request Hash or self.request
+               options[:request]   = Request.new(options)        # Pagy::Request
+
+               Pagy.const_get(paginators[paginator]).paginate(*arguments)
+             end
+           end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative '../../modules/abilities/countable'
+
+class Pagy
+  module OffsetPaginator
+    module_function
+
+    def paginate(collection, options)
+      options[:page]  ||= options[:request].resolve_page
+      options[:limit]   = options[:request].resolve_limit
+      options[:count] ||= Countable.get_count(collection, options)
+
+      pagy    = Offset.new(**options)
+      records = if collection.instance_of?(Array)
+                  collection[pagy.offset, pagy.limit]
+                else
+                  pagy.records(collection)
+                end
+
+      [pagy, records]
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../../modules/searcher'
+
+class Pagy
+  module SearchkickPaginator
+    module_function
+
+    def paginate(search, options)
+      if search.is_a?(Search::Arguments) # Active mode
+
+        Searcher.wrap(search, options) do
+          model, arguments, search_options, block = search
+
+          search_options[:per_page] = options[:limit]
+          search_options[:page]     = options[:page]
+
+          method          = options[:search_method] || Searchkick::DEFAULT[:search_method]
+          results         = model.send(method, *arguments || '*', **search_options, &block)
+          options[:count] = results.total_count
+
+          [Searchkick.new(**options), results]
+        end
+
+      else # Passive mode
+        options[:limit] = search.respond_to?(:options) ? search.options[:per_page] : search.per_page
+        options[:page]  = search.respond_to?(:options) ? search.options[:page]     : search.current_page
+        options[:count] = search.total_count
+
+        Searchkick.new(**options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../../modules/searcher'
+
+class Pagy
+  module TypesenseRailsPaginator
+    module_function
+
+    def paginate(search, options)
+      if search.is_a?(Search::Arguments) # Active mode
+
+        Searcher.wrap(search, options) do
+          model, arguments, search_options = search
+
+          search_options[:per_page] = options[:limit]
+          search_options[:page]     = options[:page]
+
+          method          = options[:search_method] || TypesenseRails::DEFAULT[:search_method]
+          results         = model.send(method, *arguments, search_options)
+          options[:count] = results.raw_answer['found']
+
+          [TypesenseRails.new(**options), results]
+        end
+
+      else # Passive mode
+        options[:limit] = search.raw_answer['request_params']['per_page']
+        options[:page]  = search.raw_answer['page']
+        options[:count] = search.raw_answer['found']
+
+        TypesenseRails.new(**options)
+      end
+    end
+  end
+end

data/lib/pagy.rb

@@ -1,106 +1,96 @@
-# See Pagy API documentation: https://ddnexus.github.io/pagy/docs/api/pagy
 # frozen_string_literal: true
 
 require 'pathname'
-require_relative 'pagy/shared_methods'
 
-# Top superclass: it should define only what's common to all the subclasses
+require_relative 'pagy/classes/exceptions'
+require_relative 'pagy/modules/abilities/linkable'
+require_relative 'pagy/modules/abilities/configurable'
+require_relative 'pagy/toolbox/helpers/loaders'
+
+# Top superclass
 class Pagy
-  VERSION = '9.4.0'
-
-  # Core default: constant for easy access, but mutable for customizable defaults
-  DEFAULT = { count_args: [:all], # rubocop:disable Style/MutableConstant
-              ends:       true,
-              limit:      20,
-              outset:     0,
-              page:       1,
-              page_param: :page,
-              size:       7 }  # AR friendly
-
-  # Gem root pathname to get the path of Pagy files stylesheets, javascripts, apps, locales, etc.
-  def self.root
-    @root ||= Pathname.new(__dir__).parent.freeze
+  VERSION     = '43.5.5'
+  ROOT        = Pathname.new(__dir__).parent.freeze
+  DEFAULT     = { limit: 20, limit_key: 'limit', page_key: 'page' }.freeze
+  PAGE_TOKEN  = EscapedValue.new('P ')
+  LIMIT_TOKEN = EscapedValue.new('L ')
+  LABEL_TOKEN = 'L'
+  A_TAG       = '<a style="display: none;">#</a>'
+
+  path = Pathname.new(__FILE__).sub_ext('')
+  autoload :Method,             path.join('toolbox/paginators/method')
+  autoload :I18n,               path.join('modules/i18n/i18n')
+  autoload :Console,            path.join('modules/console')
+  autoload :Calendar,           path.join('classes/calendar/calendar')
+  autoload :Offset,             path.join('classes/offset/offset')
+  autoload :Search,             path.join('classes/offset/search')
+  autoload :ElasticsearchRails, path.join('classes/offset/search')
+  autoload :Meilisearch,        path.join('classes/offset/search')
+  autoload :Searchkick,         path.join('classes/offset/search')
+  autoload :TypesenseRails,     path.join('classes/offset/search')
+  autoload :Keyset,             path.join('classes/keyset/keyset')
+  autoload :SyncTask,           path.join('tasks/sync')
+
+  OPTIONS = {} # rubocop:disable Style/MutableConstant
+
+  extend Configurable
+  include Linkable
+  include HelperLoader
+
+  attr_reader :page, :next, :in, :limit, :options
+
+  protected
+
+  # Instance identity methods, overridden by the respective classes
+  def offset?    = false
+  def countless? = false
+  def calendar?  = false
+  def search?    = false
+  def keyset?    = false
+  def keynav?    = false
+
+  # Validate presence and min value of options
+  def assign_and_check(name_min)
+    name_min.each do |name, min|
+      value = @options[name]
+
+      if value.respond_to?(:to_i) && (integer = value.to_i) >= min
+        instance_variable_set(:"@#{name}", integer)
+      else
+        raise OptionError.new(self, name, ">= #{min}", value)
+      end
+    end
   end
 
-  include SharedMethods
-
-  attr_reader :count, :from, :in, :last, :next, :offset, :prev, :to
-  alias pages last
-
-  # Merge and validate the options, do some simple arithmetic and set the instance variables
-  def initialize(**vars)
-    assign_vars(DEFAULT, vars)
-    assign_and_check(count: 0, page: 1, outset: 0)
-    assign_limit
-    assign_offset
-    assign_last
-    check_overflow
-    @from = [@offset - @outset + 1, @count].min
-    @to   = [@offset - @outset + @limit, @count].min
-    @in   = [@to - @from + 1, @count].min
-    assign_prev_and_next
+  def validate_string_values(options)
+    (options.keys & %i[page_key limit_key]).each do |key|
+      raise OptionError.new(self, key, 'to be String', options[key]) \
+      unless options[key].is_a?(String)
+    end
   end
 
-  # Setup @last (overridden by the gearbox extra)
-  def assign_last
-    @last = [(@count.to_f / @limit).ceil, 1].max
-    @last = @vars[:max_pages] if @vars[:max_pages] && @last > vars[:max_pages]
-  end
+  # Merge all the DEFAULT constants of the class hierarchy with the options
+  def assign_options(**options)
+    @request = options.delete(:request) # internal object
+    validate_string_values(options)
 
-  # Assign @offset (overridden by the gearbox extra)
-  def assign_offset
-    @offset = (@limit * (@page - 1)) + @outset  # may be already set from gear_box
-  end
+    default  = {}
+    current  = self.class
 
-  # Assign @prev and @next
-  def assign_prev_and_next
-    @prev = (@page - 1 unless @page == 1)
-    @next = @page == @last ? (1 if @vars[:cycle]) : @page + 1
-  end
+    loop do
+      default = current::DEFAULT.merge(default)
+      current = current.superclass
+      break if current == Object
+    end
 
-  # Checks the @page <= @last
-  def check_overflow
-    raise OverflowError.new(self, :page, "in 1..#{@last}", @page) if @page > @last
+    clean_options = options.delete_if { |k, v| default.key?(k) && (v.nil? || v == '') }
+    @options      = default.merge!(clean_options).freeze
   end
 
-  # 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
-    end
+  # Hook module for numeric UI helpers
+  module NumericHelpers
+    include NumericHelperLoader
   end
 end
 
-require_relative 'pagy/backend'
-require_relative 'pagy/frontend'
-require_relative 'pagy/exceptions'
+require_relative ENV['PAGY_NEXT'] == 'true' ? 'pagy/next' : 'pagy/deprecated'

data/locales/ar.yml

@@ -1,6 +1,8 @@
-# :arabic pluralization (see https://github.com/ddnexus/pagy/blob/master/gem/lib/pagy/i18n.rb)
+# See https://ddnexus.github.io/pagy/resources/i18n
+
 ar:
   pagy:
+    p11n: 'Arabic'
     aria_label:
       nav:
         zero: "لا يوجد صفحات"
@@ -9,9 +11,9 @@ ar:
         few: "صفحات"
         many: "صفحات"
         other: "صفحات"
-      prev: "السابق"
+      previous: "السابق"
       next: "التالي"
-    prev: "<"
+    previous: "<"
     next: ">"
     gap: "…"
     item_name:
@@ -21,9 +23,10 @@ ar:
       few: "قليل"
       many: "كثير"
       other: "عناصر"
-    info:
+    info_tag:
+      no_count: "الصفحة %{page} من %{pages}"
       no_items: "لا يوجد %{item_name}"
       single_page: "عرض %{count} %{item_name}"
       multiple_pages: "عرض %{item_name} %{from}-%{to} من اجمالي %{count}"
-    combo_nav_js: "الصفحة %{page_input} من %{pages}"
-    limit_selector_js: "عرض %{limit_input} %{item_name} لكل صفحة"
+    input_nav_js: "الصفحة %{page_input} من %{pages}"
+    limit_tag_js: "عرض %{limit_input} %{item_name} لكل صفحة"

data/locales/be.yml

@@ -1,15 +1,17 @@
-# :east_slavic pluralization (see https://github.com/ddnexus/pagy/blob/master/gem/lib/pagy/i18n.rb)
+# See https://ddnexus.github.io/pagy/resources/i18n
+
 be:
   pagy:
+    p11n: 'EastSlavic'
     aria_label:
       nav:
         one: "Старонка"
         few: "Старонкi"
         many: "Старонкi"
         other: "Старонкi"
-      prev: "Назад"
+      previous: "Назад"
       next: "Наперад"
-    prev: "<"
+    previous: "<"
     next: ">"
     gap: "…"
     item_name:
@@ -17,9 +19,10 @@ be:
       few: "запісы"
       many: "запісаў"
       other: "запісаў"
-    info:
+    info_tag:
+      no_count: "Старонка %{page} з %{pages}"
       no_items: "Пакуль %{item_name} няма"
       single_page: "%{count} %{item_name}"
       multiple_pages: "Усяго %{count} %{item_name}, паказаны з %{from} па %{to}"
-    combo_nav_js: "Старонка %{page_input} з %{pages}"
-    limit_selector_js: "Паказаць %{limit_input} %{item_name} на старонцы"
+    input_nav_js: "Старонка %{page_input} з %{pages}"
+    limit_tag_js: "Паказаць %{limit_input} %{item_name} на старонцы"

data/locales/bg.yml

@@ -1,21 +1,24 @@
-# :one_other pluralization (see https://github.com/ddnexus/pagy/blob/master/gem/lib/pagy/i18n.rb)
+# See https://ddnexus.github.io/pagy/resources/i18n
+
 bg:
   pagy:
+    p11n: 'OneOther'
     aria_label:
       nav:
         one: "Страница"
         other: "Страници"
-      prev: "Предишна"
+      previous: "Предишна"
       next: "Следваща"
-    prev: "<"
+    previous: "<"
     next: ">"
     gap: "…"
     item_name:
       one: "резултат"
       other: "резултати"
-    info:
+    info_tag:
+      no_count: "Страница %{page} от %{pages}"
       no_items: "Няма намерени %{item_name}"
       single_page: "Показани са %{count} %{item_name}"
       multiple_pages: "Показани са %{item_name} %{from}-%{to} от %{count} общо"
-    combo_nav_js: "Страница %{page_input} от %{pages}"
-    limit_selector_js: "Покажи %{limit_input} %{item_name} на страница"
+    input_nav_js: "Страница %{page_input} от %{pages}"
+    limit_tag_js: "Покажи %{limit_input} %{item_name} на страница"

data/locales/bs.yml

@@ -1,15 +1,17 @@
-# :east_slavic pluralization (see https://github.com/ddnexus/pagy/blob/master/gem/lib/pagy/i18n.rb)
+# See https://ddnexus.github.io/pagy/resources/i18n
+
 bs:
   pagy:
+    p11n: 'EastSlavic'
     aria_label:
       nav:
         one: "Stranica"
         few: "Stranice"
         many: "Stranica"
         other: "Stranice"
-      prev: "Prethodna"
+      previous: "Prethodna"
       next: "Sljedeća"
-    prev: "<"
+    previous: "<"
     next: ">"
     gap: "…"
     item_name:
@@ -17,9 +19,10 @@ bs:
       few: "stavke"
       many: "stavki"
       other: "stavki"
-    info:
+    info_tag:
+      no_count: "Stranica %{page} od %{pages}"
       no_items: "Nije pronađena %{item_name}"
       single_page: "Prikazuje se %{count} %{item_name}"
       multiple_pages: "Prikaz %{item_name} %{from}-%{to} od %{count} ukupno"
-    combo_nav_js: "Stranica %{page_input} od %{pages}"
-    limit_selector_js: "Prikaži %{limit_input} %{item_name} po stranici"
+    input_nav_js: "Stranica %{page_input} od %{pages}"
+    limit_tag_js: "Prikaži %{limit_input} %{item_name} po stranici"

data/locales/ca.yml

@@ -1,21 +1,24 @@
-# :one_other pluralization (see https://github.com/ddnexus/pagy/blob/master/gem/lib/pagy/i18n.rb)
+# See https://ddnexus.github.io/pagy/resources/i18n
+
 ca:
   pagy:
+    p11n: 'OneOther'
     aria_label:
       nav:
         one: "Pàgina"
         other: "Pàgines"
-      prev: "Anterior"
+      previous: "Anterior"
       next: "Següent"
-    prev: "<"
+    previous: "<"
     next: ">"
     gap: "…"
     item_name:
       one: "element"
       other: "elements"
-    info:
+    info_tag:
+      no_count: "Pàgina %{page} de %{pages}"
       no_items: "No s'ha trobat cap resultat"
       single_page: "Mostrant %{count} %{item_name}"
       multiple_pages: "Mostrant %{item_name} %{from}-%{to} de %{count} en total"
-    combo_nav_js: "Pàgina %{page_input} de %{pages}"
-    limit_selector_js: "Mostra %{limit_input} %{item_name} per pàgina"
+    input_nav_js: "Pàgina %{page_input} de %{pages}"
+    limit_tag_js: "Mostra %{limit_input} %{item_name} per pàgina"

data/locales/ckb.yml

@@ -1,18 +1,20 @@
-# :other pluralization (see https://github.com/ddnexus/pagy/blob/master/gem/lib/pagy/i18n.rb)
+# See https://ddnexus.github.io/pagy/resources/i18n
 
 ckb:
   pagy:
+    p11n: 'Other'
     item_name: "بابەت"
     aria_label:
       nav: "پەڕەکان"
-      prev: "پاش"
+      previous: "پاش"
       next: "پێش"
-    prev: "<"
+    previous: "<"
     next: ">"
     gap: "…"
-    info:
+    info_tag:
+      no_count: "پەڕی %{page} لە %{pages}"
       no_items: "هیچ %{item_name}ێک نەدۆزرایەوە"
       single_page: "پیشاندانی %{count} %{item_name}"
       multiple_pages: "پشاندانی %{item_name}ی %{from}-%{to} لە کۆی %{count} بە گشتی"
-    combo_nav_js: "پەڕی %{page_input} لە %{pages}"
-    limit_selector_js: "نیشاندانی %{limit_input} %{item_name} لە هەر پەڕێک"
+    input_nav_js: "پەڕی %{page_input} لە %{pages}"
+    limit_tag_js: "نیشاندانی %{limit_input} %{item_name} لە هەر پەڕێک"