pagy 8.4.0 → 9.0.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/apps/calendar.ru +682 -2137
- data/apps/demo.ru +17 -13
- data/apps/keyset_ar.ru +236 -0
- data/apps/keyset_s.ru +238 -0
- data/apps/rails.ru +25 -15
- data/apps/repro.ru +17 -14
- data/bin/pagy +17 -12
- data/config/pagy.rb +37 -34
- data/javascripts/pagy.min.js +4 -0
- data/javascripts/pagy.min.js.map +10 -0
- data/javascripts/pagy.mjs +100 -0
- data/lib/optimist.rb +1 -1
- data/lib/pagy/b64.rb +33 -0
- data/lib/pagy/backend.rb +19 -19
- data/lib/pagy/calendar/day.rb +4 -3
- data/lib/pagy/calendar/month.rb +4 -3
- data/lib/pagy/calendar/quarter.rb +4 -3
- data/lib/pagy/calendar/unit.rb +103 -0
- data/lib/pagy/calendar/week.rb +3 -3
- data/lib/pagy/calendar/year.rb +4 -3
- data/lib/pagy/calendar.rb +54 -97
- data/lib/pagy/countless.rb +15 -16
- data/lib/pagy/extras/arel.rb +3 -11
- data/lib/pagy/extras/array.rb +5 -10
- data/lib/pagy/extras/bootstrap.rb +5 -5
- data/lib/pagy/extras/bulma.rb +10 -7
- data/lib/pagy/extras/calendar.rb +34 -5
- data/lib/pagy/extras/countless.rb +8 -13
- data/lib/pagy/extras/elasticsearch_rails.rb +16 -25
- data/lib/pagy/extras/gearbox.rb +26 -26
- data/lib/pagy/extras/headers.rb +25 -24
- data/lib/pagy/extras/i18n.rb +1 -1
- data/lib/pagy/extras/js_tools.rb +10 -10
- data/lib/pagy/extras/jsonapi.rb +26 -19
- data/lib/pagy/extras/keyset.rb +30 -0
- data/lib/pagy/extras/limit.rb +63 -0
- data/lib/pagy/extras/meilisearch.rb +9 -17
- data/lib/pagy/extras/metadata.rb +6 -2
- data/lib/pagy/extras/overflow.rb +11 -10
- data/lib/pagy/extras/pagy.rb +16 -16
- data/lib/pagy/extras/searchkick.rb +9 -17
- data/lib/pagy/extras/size.rb +40 -0
- data/lib/pagy/extras/standalone.rb +6 -6
- data/lib/pagy/extras/trim.rb +3 -3
- data/lib/pagy/frontend.rb +37 -35
- data/lib/pagy/i18n.rb +2 -2
- data/lib/pagy/keyset/active_record.rb +38 -0
- data/lib/pagy/keyset/sequel.rb +51 -0
- data/lib/pagy/keyset.rb +98 -0
- data/lib/pagy/shared_methods.rb +27 -0
- data/lib/pagy/url_helpers.rb +5 -5
- data/lib/pagy.rb +70 -94
- data/locales/ar.yml +9 -10
- data/locales/be.yml +2 -2
- data/locales/bg.yml +2 -2
- data/locales/bs.yml +2 -2
- data/locales/ca.yml +5 -7
- data/locales/ckb.yml +2 -2
- data/locales/cs.yml +2 -2
- data/locales/da.yml +2 -2
- data/locales/de.yml +2 -2
- data/locales/en.yml +2 -2
- data/locales/es.yml +2 -2
- data/locales/fr.yml +2 -2
- data/locales/hr.yml +2 -2
- data/locales/id.yml +2 -2
- data/locales/it.yml +2 -2
- data/locales/ja.yml +2 -2
- data/locales/km.yml +2 -2
- data/locales/ko.yml +2 -2
- data/locales/nb.yml +2 -2
- data/locales/nl.yml +2 -2
- data/locales/nn.yml +2 -2
- data/locales/pl.yml +2 -2
- data/locales/pt-BR.yml +2 -2
- data/locales/pt.yml +2 -2
- data/locales/ru.yml +2 -2
- data/locales/sr.yml +2 -2
- data/locales/sv-SE.yml +2 -2
- data/locales/sv.yml +2 -2
- data/locales/sw.yml +2 -2
- data/locales/ta.yml +2 -2
- data/locales/tr.yml +2 -2
- data/locales/uk.yml +2 -2
- data/locales/vi.yml +2 -2
- data/locales/zh-CN.yml +2 -2
- data/locales/zh-HK.yml +2 -2
- data/locales/zh-TW.yml +2 -2
- metadata +19 -19
- data/javascripts/pagy-dev.js +0 -114
- data/javascripts/pagy-module.js +0 -113
- data/javascripts/pagy.js +0 -1
- data/lib/pagy/calendar/helper.rb +0 -65
- data/lib/pagy/extras/foundation.rb +0 -95
- data/lib/pagy/extras/items.rb +0 -64
- data/lib/pagy/extras/materialize.rb +0 -100
- data/lib/pagy/extras/semantic.rb +0 -94
- data/lib/pagy/extras/uikit.rb +0 -98
- /data/javascripts/{pagy-module.d.ts → pagy.d.ts} +0 -0
@@ -28,18 +28,18 @@ class Pagy # :nodoc:
|
|
28
28
|
args.define_singleton_method(:method_missing) { |*a| args += a }
|
29
29
|
end
|
30
30
|
end
|
31
|
-
alias_method
|
31
|
+
alias_method DEFAULT[:elasticsearch_rails_pagy_search], :pagy_elasticsearch_rails
|
32
32
|
end
|
33
33
|
Pagy::ElasticsearchRails = ModelExtension
|
34
34
|
|
35
35
|
# Additions for the Pagy class
|
36
36
|
module PagyAddOn
|
37
37
|
# Create a Pagy object from an Elasticsearch::Model::Response::Response object
|
38
|
-
def new_from_elasticsearch_rails(response, vars
|
39
|
-
vars[:
|
40
|
-
vars[:page] = ((response.search.options[:from] || 0) / vars[:
|
38
|
+
def new_from_elasticsearch_rails(response, **vars)
|
39
|
+
vars[:limit] = response.search.options[:size] || 10
|
40
|
+
vars[:page] = ((response.search.options[:from] || 0) / vars[:limit]) + 1
|
41
41
|
vars[:count] = ElasticsearchRailsExtra.total_count(response)
|
42
|
-
new(vars)
|
42
|
+
Pagy.new(**vars)
|
43
43
|
end
|
44
44
|
end
|
45
45
|
Pagy.extend PagyAddOn
|
@@ -48,32 +48,23 @@ class Pagy # :nodoc:
|
|
48
48
|
module BackendAddOn
|
49
49
|
private
|
50
50
|
|
51
|
-
# Return Pagy object and
|
52
|
-
def pagy_elasticsearch_rails(pagy_search_args, vars
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
options[:size]
|
57
|
-
options[:from]
|
58
|
-
response
|
59
|
-
vars[:count]
|
51
|
+
# Return Pagy object and records
|
52
|
+
def pagy_elasticsearch_rails(pagy_search_args, **vars)
|
53
|
+
vars[:page] ||= pagy_get_page(vars)
|
54
|
+
vars[:limit] ||= pagy_get_limit(vars)
|
55
|
+
model, query_or_payload, options, *called = pagy_search_args
|
56
|
+
options[:size] = vars[:limit]
|
57
|
+
options[:from] = vars[:limit] * ((vars[:page] || 1) - 1)
|
58
|
+
response = model.send(DEFAULT[:elasticsearch_rails_search], query_or_payload, **options)
|
59
|
+
vars[:count] = ElasticsearchRailsExtra.total_count(response)
|
60
60
|
|
61
|
-
pagy = ::Pagy.new(vars)
|
61
|
+
pagy = ::Pagy.new(**vars)
|
62
62
|
# with :last_page overflow we need to re-run the method in order to get the hits
|
63
|
-
return pagy_elasticsearch_rails(pagy_search_args, vars
|
63
|
+
return pagy_elasticsearch_rails(pagy_search_args, **vars, page: pagy.page) \
|
64
64
|
if defined?(::Pagy::OverflowExtra) && pagy.overflow? && pagy.vars[:overflow] == :last_page
|
65
65
|
|
66
66
|
[pagy, called.empty? ? response : response.send(*called)]
|
67
67
|
end
|
68
|
-
|
69
|
-
# Sub-method called only by #pagy_elasticsearch_rails: here for easy customization of variables by overriding
|
70
|
-
# the _collection argument is not available when the method is called
|
71
|
-
def pagy_elasticsearch_rails_get_vars(_collection, vars)
|
72
|
-
pagy_set_items_from_params(vars) if defined?(ItemsExtra)
|
73
|
-
vars[:items] ||= DEFAULT[:items]
|
74
|
-
vars[:page] ||= pagy_get_page(vars)
|
75
|
-
vars
|
76
|
-
end
|
77
68
|
end
|
78
69
|
Backend.prepend BackendAddOn
|
79
70
|
end
|
data/lib/pagy/extras/gearbox.rb
CHANGED
@@ -3,27 +3,39 @@
|
|
3
3
|
|
4
4
|
class Pagy # :nodoc:
|
5
5
|
DEFAULT[:gearbox_extra] = true # extra enabled by default
|
6
|
-
DEFAULT[:
|
6
|
+
DEFAULT[:gearbox_limit] = [15, 30, 60, 100]
|
7
7
|
|
8
|
-
# Automatically change the
|
9
|
-
# accepts an array as the :
|
8
|
+
# Automatically change the limit depending on the page number
|
9
|
+
# accepts an array as the :gearbox_limit variable, that will determine the limit for the first pages
|
10
10
|
module GearboxExtra
|
11
|
-
#
|
12
|
-
def
|
13
|
-
return super if !@vars[:gearbox_extra] || @vars[:
|
11
|
+
# Assign @limit based on the :gearbox_limit variable
|
12
|
+
def assign_limit
|
13
|
+
return super if !@vars[:gearbox_extra] || @vars[:limit_extra]
|
14
14
|
|
15
|
-
gears = @vars[:
|
16
|
-
raise VariableError.new(self, :
|
15
|
+
gears = @vars[:gearbox_limit]
|
16
|
+
raise VariableError.new(self, :gearbox_limit, 'to be an Array of positives', gears) \
|
17
17
|
unless gears.is_a?(Array) && gears.all? { |num| num.positive? rescue false } # rubocop:disable Style/RescueModifier
|
18
18
|
|
19
|
-
@
|
19
|
+
@limit = gears[@page - 1] || gears.last
|
20
20
|
end
|
21
21
|
|
22
|
-
#
|
23
|
-
def
|
24
|
-
return super if !@vars[:gearbox_extra] || @vars[:
|
22
|
+
# Asgnsi @offset based on the :gearbox_limit variable
|
23
|
+
def assign_offset
|
24
|
+
return super if !@vars[:gearbox_extra] || @vars[:limit_extra]
|
25
25
|
|
26
|
-
gears
|
26
|
+
gears = @vars[:gearbox_limit]
|
27
|
+
@offset = if @page <= gears.count
|
28
|
+
gears[0, @page - 1].sum
|
29
|
+
else
|
30
|
+
gears.sum + (gears.last * (@page - gears.count - 1))
|
31
|
+
end + @outset
|
32
|
+
end
|
33
|
+
|
34
|
+
# Assign @last based on the :gearbox_limit variable and @count
|
35
|
+
def assign_last
|
36
|
+
return super if !@vars[:gearbox_extra] || @vars[:limit_extra]
|
37
|
+
|
38
|
+
gears = @vars[:gearbox_limit]
|
27
39
|
# This algorithm is thousands of times faster than the one in the geared_pagination gem
|
28
40
|
@last = (if count > (sum = gears.sum)
|
29
41
|
[((count - sum).to_f / gears.last).ceil, 1].max + gears.count
|
@@ -36,19 +48,7 @@ class Pagy # :nodoc:
|
|
36
48
|
end
|
37
49
|
[pages, 1].max
|
38
50
|
end)
|
39
|
-
@last = vars[:max_pages] if vars[:max_pages] && @last > vars[:max_pages]
|
40
|
-
end
|
41
|
-
|
42
|
-
# Setup @offset based on the :gearbox_items variable
|
43
|
-
def setup_offset_var
|
44
|
-
return super if !@vars[:gearbox_extra] || @vars[:items_extra]
|
45
|
-
|
46
|
-
gears = @vars[:gearbox_items]
|
47
|
-
@offset = if @page <= gears.count
|
48
|
-
gears[0, @page - 1].sum
|
49
|
-
else
|
50
|
-
gears.sum + (gears.last * (@page - gears.count - 1))
|
51
|
-
end + @outset
|
51
|
+
@last = @vars[:max_pages] if @vars[:max_pages] && @last > @vars[:max_pages]
|
52
52
|
end
|
53
53
|
end
|
54
54
|
prepend GearboxExtra
|
data/lib/pagy/extras/headers.rb
CHANGED
@@ -5,7 +5,7 @@ require_relative '../url_helpers'
|
|
5
5
|
|
6
6
|
class Pagy # :nodoc:
|
7
7
|
DEFAULT[:headers] = { page: 'current-page',
|
8
|
-
|
8
|
+
limit: 'page-items',
|
9
9
|
count: 'total-count',
|
10
10
|
pages: 'total-pages' }
|
11
11
|
# Add specialized backend methods to add pagination response headers
|
@@ -21,32 +21,33 @@ class Pagy # :nodoc:
|
|
21
21
|
|
22
22
|
# Generate a hash of RFC-8288 compliant http headers
|
23
23
|
def pagy_headers(pagy)
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
24
|
+
headers = pagy.vars[:headers]
|
25
|
+
pagy_link_header(pagy).tap do |hash|
|
26
|
+
hash[headers[:page]] = pagy.page.to_s if pagy.page && headers[:page]
|
27
|
+
hash[headers[:limit]] = pagy.limit.to_s \
|
28
|
+
if headers[:limit] && !(defined?(::Pagy::Calendar) && pagy.is_a?(Calendar::Unit))
|
29
|
+
return hash if (defined?(::Pagy::Countless) && pagy.is_a?(Countless)) || \
|
30
|
+
(defined?(::Pagy::Keyset) && pagy.is_a?(Keyset))
|
28
31
|
|
29
|
-
|
30
|
-
def pagy_headers_hash(pagy)
|
31
|
-
countless = defined?(Countless) && pagy.is_a?(Countless)
|
32
|
-
rel = { 'first' => 1, 'prev' => pagy.prev, 'next' => pagy.next }
|
33
|
-
rel['last'] = pagy.last unless countless
|
34
|
-
url_str = pagy_url_for(pagy, PAGE_TOKEN, absolute: true)
|
35
|
-
link = rel.filter_map do |r, num|
|
36
|
-
next unless num # rubocop:disable Layout/EmptyLineAfterGuardClause
|
37
|
-
[r, url_str.sub(PAGE_TOKEN, num.to_s)]
|
38
|
-
end.compact.to_h
|
39
|
-
hash = { 'link' => link }
|
40
|
-
headers = pagy.vars[:headers]
|
41
|
-
hash[headers[:page]] = pagy.page.to_s if headers[:page]
|
42
|
-
if headers[:items] && !(defined?(Calendar) && pagy.is_a?(Calendar)) # items is not for Calendar
|
43
|
-
hash[headers[:items]] = pagy.vars[:items].to_s
|
44
|
-
end
|
45
|
-
unless countless
|
46
|
-
hash[headers[:pages]] = pagy.pages.to_s if headers[:pages]
|
32
|
+
hash[headers[:pages]] = pagy.last.to_s if headers[:pages]
|
47
33
|
hash[headers[:count]] = pagy.count.to_s if pagy.count && headers[:count] # count may be nil with Calendar
|
48
34
|
end
|
49
|
-
|
35
|
+
end
|
36
|
+
|
37
|
+
def pagy_link_header(pagy)
|
38
|
+
{ 'link' => [].tap do |link|
|
39
|
+
if defined?(::Pagy::Keyset) && pagy.is_a?(Keyset)
|
40
|
+
link << %(<#{pagy_url_for(pagy, nil, absolute: true)}>; rel="first")
|
41
|
+
link << %(<#{pagy_url_for(pagy, pagy.next, absolute: true)}>; rel="next") if pagy.next
|
42
|
+
else
|
43
|
+
url_str = pagy_url_for(pagy, PAGE_TOKEN, absolute: true)
|
44
|
+
link << %(<#{url_str.sub(PAGE_TOKEN, '1')}>; rel="first")
|
45
|
+
link << %(<#{url_str.sub(PAGE_TOKEN, pagy.prev.to_s)}>; rel="prev") if pagy.prev
|
46
|
+
link << %(<#{url_str.sub(PAGE_TOKEN, pagy.next.to_s)}>; rel="next") if pagy.next
|
47
|
+
link << %(<#{url_str.sub(PAGE_TOKEN, pagy.last.to_s)}>; rel="last") \
|
48
|
+
unless defined?(::Pagy::Countless) && pagy.is_a?(Countless)
|
49
|
+
end
|
50
|
+
end.join(', ') }
|
50
51
|
end
|
51
52
|
end
|
52
53
|
Backend.prepend HeadersExtra
|
data/lib/pagy/extras/i18n.rb
CHANGED
@@ -19,7 +19,7 @@ class Pagy # :nodoc:
|
|
19
19
|
end
|
20
20
|
end
|
21
21
|
end
|
22
|
-
Calendar.prepend I18nExtra::CalendarOverride if defined?(Calendar)
|
22
|
+
Calendar::Unit.prepend I18nExtra::CalendarOverride if defined?(::Pagy::Calendar::Unit)
|
23
23
|
|
24
24
|
# Add the pagy locales to the I18n.load_path
|
25
25
|
::I18n.load_path += Dir[Pagy.root.join('locales', '*.yml')]
|
data/lib/pagy/extras/js_tools.rb
CHANGED
@@ -1,5 +1,7 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
+
require_relative '../b64'
|
4
|
+
|
3
5
|
class Pagy # :nodoc:
|
4
6
|
DEFAULT[:steps] = false # default false will use {0 => @vars[:size]}
|
5
7
|
|
@@ -13,11 +15,11 @@ class Pagy # :nodoc:
|
|
13
15
|
# `Pagy` instance method used by the `pagy*_nav_js` helpers.
|
14
16
|
# It returns the sequels of width/series generated from the :steps hash
|
15
17
|
# Example:
|
16
|
-
# >> pagy = Pagy.new(count:1000, page: 20, steps: {0 =>
|
18
|
+
# >> pagy = Pagy.new(count:1000, page: 20, steps: {0 => 5, 350 => 7, 550 => 9})
|
17
19
|
# >> pagy.sequels
|
18
|
-
# #=> { "0" => [
|
19
|
-
# "350" => [1,
|
20
|
-
# "550" => [1
|
20
|
+
# #=> { "0" => [18, 19, "20", 21, 22],
|
21
|
+
# "350" => [1, :gap, 19, "20", 21, :gap, 50],
|
22
|
+
# "550" => [1 :gap, 18, 19, "20", 21, 22, :gap, 50] }
|
21
23
|
# Notice: if :steps is false it will use the single {0 => @vars[:size]} size
|
22
24
|
def sequels(steps: @vars[:steps] || { 0 => @vars[:size] }, **_)
|
23
25
|
raise VariableError.new(self, :steps, 'to define the 0 width', steps) unless steps.key?(0)
|
@@ -42,17 +44,16 @@ class Pagy # :nodoc:
|
|
42
44
|
end
|
43
45
|
end
|
44
46
|
end
|
45
|
-
Calendar.prepend CalendarOverride if defined?(Calendar)
|
47
|
+
Calendar::Unit.prepend CalendarOverride if defined?(::Pagy::Calendar::Unit)
|
46
48
|
|
47
49
|
# Additions for the Frontend
|
48
50
|
module FrontendAddOn
|
49
|
-
if defined?(Oj)
|
51
|
+
if defined?(::Oj)
|
50
52
|
# Return a data tag with the base64 encoded JSON-serialized args generated with the faster oj gem
|
51
53
|
# Base64 encoded JSON is smaller than HTML escaped JSON
|
52
54
|
def pagy_data(pagy, *args)
|
53
55
|
args << pagy.vars[:page_param] if pagy.vars[:trim_extra]
|
54
|
-
|
55
|
-
%(data-pagy="#{strict_base64_encoded}")
|
56
|
+
%(data-pagy="#{B64.encode(Oj.dump(args, mode: :strict))}")
|
56
57
|
end
|
57
58
|
else
|
58
59
|
require 'json'
|
@@ -60,8 +61,7 @@ class Pagy # :nodoc:
|
|
60
61
|
# Base64 encoded JSON is smaller than HTML escaped JSON
|
61
62
|
def pagy_data(pagy, *args)
|
62
63
|
args << pagy.vars[:page_param] if pagy.vars[:trim_extra]
|
63
|
-
|
64
|
-
%(data-pagy="#{strict_base64_encoded}")
|
64
|
+
%(data-pagy="#{B64.encode(args.to_json)}")
|
65
65
|
end
|
66
66
|
end
|
67
67
|
end
|
data/lib/pagy/extras/jsonapi.rb
CHANGED
@@ -24,10 +24,17 @@ class Pagy # :nodoc:
|
|
24
24
|
|
25
25
|
# Return the jsonapi links
|
26
26
|
def pagy_jsonapi_links(pagy, **opts)
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
27
|
+
if defined?(::Pagy::Keyset) && pagy.is_a?(Keyset)
|
28
|
+
{ first: pagy_url_for(pagy, nil, **opts),
|
29
|
+
last: nil,
|
30
|
+
prev: nil,
|
31
|
+
next: pagy.next ? pagy_url_for(pagy, pagy.next, **opts) : nil }
|
32
|
+
else
|
33
|
+
{ first: pagy_url_for(pagy, 1, **opts),
|
34
|
+
last: pagy_url_for(pagy, pagy.last, **opts),
|
35
|
+
prev: pagy.prev ? pagy_url_for(pagy, pagy.prev, **opts) : nil,
|
36
|
+
next: pagy.next ? pagy_url_for(pagy, pagy.next, **opts) : nil }
|
37
|
+
end
|
31
38
|
end
|
32
39
|
|
33
40
|
# Should skip the jsonapi
|
@@ -38,40 +45,40 @@ class Pagy # :nodoc:
|
|
38
45
|
end
|
39
46
|
|
40
47
|
# Override the Backend method
|
41
|
-
def pagy_get_page(vars)
|
42
|
-
return super if pagy_skip_jsonapi?(vars)
|
43
|
-
return 1 if params[:page].nil?
|
48
|
+
def pagy_get_page(vars, force_integer: true)
|
49
|
+
return super if pagy_skip_jsonapi?(vars) || params[:page].nil?
|
44
50
|
|
45
|
-
|
51
|
+
page = params[:page][vars[:page_param] || DEFAULT[:page_param]]
|
52
|
+
force_integer ? (page || 1).to_i : page
|
46
53
|
end
|
47
54
|
end
|
48
55
|
Backend.prepend BackendOverride
|
49
56
|
|
50
|
-
# Module overriding
|
51
|
-
module
|
57
|
+
# Module overriding LimitExtra
|
58
|
+
module LimitExtraOverride
|
52
59
|
private
|
53
60
|
|
54
|
-
# Override the
|
55
|
-
def
|
61
|
+
# Override the LimitExtra::Backend method
|
62
|
+
def pagy_get_limit_param(vars)
|
56
63
|
return super if pagy_skip_jsonapi?(vars)
|
57
|
-
return
|
64
|
+
return unless params[:page]
|
58
65
|
|
59
|
-
params[:page][vars[:
|
66
|
+
params[:page][vars[:limit_param] || DEFAULT[:limit_param]]
|
60
67
|
end
|
61
68
|
end
|
62
69
|
# :nocov:
|
63
|
-
|
70
|
+
LimitExtra::BackendAddOn.prepend LimitExtraOverride if defined?(::Pagy::LimitExtra::BackendAddOn)
|
64
71
|
# :nocov:
|
65
72
|
|
66
73
|
# Module overriding UrlHelper
|
67
74
|
module UrlHelperOverride
|
68
75
|
# Override UrlHelper method
|
69
|
-
def pagy_set_query_params(page, vars,
|
76
|
+
def pagy_set_query_params(page, vars, query_params)
|
70
77
|
return super unless vars[:jsonapi]
|
71
78
|
|
72
|
-
|
73
|
-
|
74
|
-
|
79
|
+
query_params['page'] ||= {}
|
80
|
+
query_params['page'][vars[:page_param].to_s] = page
|
81
|
+
query_params['page'][vars[:limit_param].to_s] = vars[:limit] if vars[:limit_extra]
|
75
82
|
end
|
76
83
|
end
|
77
84
|
UrlHelpers.prepend UrlHelperOverride
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/keyset
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
require_relative '../keyset'
|
5
|
+
|
6
|
+
class Pagy # :nodoc:
|
7
|
+
# Add keyset pagination
|
8
|
+
module KeysetExtra
|
9
|
+
private
|
10
|
+
|
11
|
+
# Return Pagy::Keyset object and paginated records
|
12
|
+
def pagy_keyset(set, **vars)
|
13
|
+
vars[:page] ||= pagy_get_page(vars, force_integer: false) # allow nil
|
14
|
+
vars[:limit] ||= pagy_get_limit(vars)
|
15
|
+
pagy = Keyset.new(set, **vars)
|
16
|
+
[pagy, pagy.records]
|
17
|
+
end
|
18
|
+
|
19
|
+
# Return the URL string for the first page
|
20
|
+
def pagy_keyset_first_url(pagy, **vars)
|
21
|
+
pagy_url_for(pagy, nil, **vars)
|
22
|
+
end
|
23
|
+
|
24
|
+
# Return the URL string for the next page or nil
|
25
|
+
def pagy_keyset_next_url(pagy, **vars)
|
26
|
+
pagy_url_for(pagy, pagy.next, **vars) if pagy.next
|
27
|
+
end
|
28
|
+
end
|
29
|
+
Backend.prepend KeysetExtra
|
30
|
+
end
|
@@ -0,0 +1,63 @@
|
|
1
|
+
# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/limit
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
require_relative 'js_tools'
|
5
|
+
|
6
|
+
class Pagy # :nodoc:
|
7
|
+
DEFAULT[:limit_param] = :limit
|
8
|
+
DEFAULT[:limit_max] = 100
|
9
|
+
DEFAULT[:limit_extra] = true # extra enabled by default
|
10
|
+
|
11
|
+
# Allow the client to request a custom limit per page with an optional selector UI
|
12
|
+
module LimitExtra
|
13
|
+
# Additions for the Backend module
|
14
|
+
module BackendAddOn
|
15
|
+
private
|
16
|
+
|
17
|
+
# Set the limit variable considering the params and other pagy variables
|
18
|
+
def pagy_get_limit(vars)
|
19
|
+
return super unless vars.key?(:limit_extra) ? vars[:limit_extra] : DEFAULT[:limit_extra] # :limit_extra is false
|
20
|
+
return super unless (limit_count = pagy_get_limit_param(vars)) # no limit from request params
|
21
|
+
|
22
|
+
vars[:limit] = [limit_count.to_i, vars.key?(:limit_max) ? vars[:limit_max] : DEFAULT[:limit_max]].compact.min
|
23
|
+
end
|
24
|
+
|
25
|
+
# Get the limit count from the params
|
26
|
+
# Overridable by the jsonapi extra
|
27
|
+
def pagy_get_limit_param(vars)
|
28
|
+
params[vars[:limit_param] || DEFAULT[:limit_param]]
|
29
|
+
end
|
30
|
+
end
|
31
|
+
Backend.prepend LimitExtra::BackendAddOn
|
32
|
+
|
33
|
+
# Additions for the Frontend module
|
34
|
+
module FrontendAddOn
|
35
|
+
LIMIT_TOKEN = '__pagy_limit__'
|
36
|
+
|
37
|
+
# Return the limit selector HTML. For example "Show [20] items per page"
|
38
|
+
def pagy_limit_selector_js(pagy, id: nil, item_name: nil)
|
39
|
+
return '' unless pagy.vars[:limit_extra]
|
40
|
+
|
41
|
+
id = %( id="#{id}") if id
|
42
|
+
vars = pagy.vars
|
43
|
+
limit = vars[:limit]
|
44
|
+
vars[:limit] = LIMIT_TOKEN
|
45
|
+
url_token = pagy_url_for(pagy, PAGE_TOKEN)
|
46
|
+
vars[:limit] = limit # restore the limit
|
47
|
+
|
48
|
+
limit_input = %(<input name="limit" type="number" min="1" max="#{vars[:limit_max]}" value="#{
|
49
|
+
limit}" style="padding: 0; text-align: center; width: #{limit.to_s.length + 1}rem;">#{JSTools::A_TAG})
|
50
|
+
|
51
|
+
%(<span#{id} class="pagy limit-selector-js" #{
|
52
|
+
pagy_data(pagy, :selector, pagy.from, url_token)
|
53
|
+
}><label>#{
|
54
|
+
pagy_t('pagy.limit_selector_js',
|
55
|
+
item_name: item_name || pagy_t('pagy.item_name', count: limit),
|
56
|
+
limit_input:,
|
57
|
+
count: limit)
|
58
|
+
}</label></span>)
|
59
|
+
end
|
60
|
+
end
|
61
|
+
Frontend.prepend LimitExtra::FrontendAddOn
|
62
|
+
end
|
63
|
+
end
|
@@ -20,12 +20,12 @@ class Pagy # :nodoc:
|
|
20
20
|
# Extension for the Pagy class
|
21
21
|
module PagyExtension
|
22
22
|
# Create a Pagy object from a Meilisearch results
|
23
|
-
def new_from_meilisearch(results, vars
|
24
|
-
vars[:
|
23
|
+
def new_from_meilisearch(results, **vars)
|
24
|
+
vars[:limit] = results.raw_answer['hitsPerPage']
|
25
25
|
vars[:page] = results.raw_answer['page']
|
26
26
|
vars[:count] = results.raw_answer['totalHits']
|
27
27
|
|
28
|
-
new(vars)
|
28
|
+
new(**vars)
|
29
29
|
end
|
30
30
|
end
|
31
31
|
Pagy.extend PagyExtension
|
@@ -35,30 +35,22 @@ class Pagy # :nodoc:
|
|
35
35
|
private
|
36
36
|
|
37
37
|
# Return Pagy object and results
|
38
|
-
def pagy_meilisearch(pagy_search_args, vars
|
38
|
+
def pagy_meilisearch(pagy_search_args, **vars)
|
39
|
+
vars[:page] ||= pagy_get_page(vars)
|
40
|
+
vars[:limit] ||= pagy_get_limit(vars)
|
39
41
|
model, term, options = pagy_search_args
|
40
|
-
|
41
|
-
options[:hits_per_page] = vars[:items]
|
42
|
+
options[:hits_per_page] = vars[:limit]
|
42
43
|
options[:page] = vars[:page]
|
43
44
|
results = model.send(:ms_search, term, options)
|
44
45
|
vars[:count] = results.raw_answer['totalHits']
|
45
46
|
|
46
|
-
pagy = ::Pagy.new(vars)
|
47
|
+
pagy = ::Pagy.new(**vars)
|
47
48
|
# with :last_page overflow we need to re-run the method in order to get the hits
|
48
|
-
return pagy_meilisearch(pagy_search_args, vars
|
49
|
+
return pagy_meilisearch(pagy_search_args, **vars, page: pagy.page) \
|
49
50
|
if defined?(::Pagy::OverflowExtra) && pagy.overflow? && pagy.vars[:overflow] == :last_page
|
50
51
|
|
51
52
|
[pagy, results]
|
52
53
|
end
|
53
|
-
|
54
|
-
# Sub-method called only by #pagy_meilisearch: here for easy customization of variables by overriding.
|
55
|
-
# The _collection argument is not available when the method is called.
|
56
|
-
def pagy_meilisearch_get_vars(_collection, vars)
|
57
|
-
pagy_set_items_from_params(vars) if defined?(ItemsExtra)
|
58
|
-
vars[:items] ||= DEFAULT[:items]
|
59
|
-
vars[:page] ||= pagy_get_page(vars)
|
60
|
-
vars
|
61
|
-
end
|
62
54
|
end
|
63
55
|
Backend.prepend BackendAddOn
|
64
56
|
end
|
data/lib/pagy/extras/metadata.rb
CHANGED
@@ -5,7 +5,7 @@ require_relative '../url_helpers'
|
|
5
5
|
|
6
6
|
class Pagy # :nodoc:
|
7
7
|
DEFAULT[:metadata] = %i[ scaffold_url first_url prev_url page_url next_url last_url
|
8
|
-
count page
|
8
|
+
count page limit vars pages last in from to prev next series ]
|
9
9
|
|
10
10
|
# Add a specialized backend method for pagination metadata
|
11
11
|
module MetadataExtra
|
@@ -17,7 +17,11 @@ class Pagy # :nodoc:
|
|
17
17
|
def pagy_metadata(pagy, absolute: nil)
|
18
18
|
scaffold_url = pagy_url_for(pagy, PAGE_TOKEN, absolute:)
|
19
19
|
{}.tap do |metadata|
|
20
|
-
keys = defined?(Calendar) && pagy.is_a?(Calendar)
|
20
|
+
keys = if defined?(::Pagy::Calendar::Unit) && pagy.is_a?(Calendar::Unit)
|
21
|
+
pagy.vars[:metadata] - %i[count limit]
|
22
|
+
else
|
23
|
+
pagy.vars[:metadata]
|
24
|
+
end
|
21
25
|
keys.each do |key|
|
22
26
|
metadata[key] = case key
|
23
27
|
when :scaffold_url then scaffold_url
|
data/lib/pagy/extras/overflow.rb
CHANGED
@@ -14,7 +14,7 @@ class Pagy # :nodoc:
|
|
14
14
|
end
|
15
15
|
|
16
16
|
# Add rescue clause for different behaviors
|
17
|
-
def initialize(vars)
|
17
|
+
def initialize(**vars)
|
18
18
|
@overflow ||= false # still true if :last_page re-run the method after an overflow
|
19
19
|
super
|
20
20
|
rescue OverflowError
|
@@ -24,13 +24,14 @@ class Pagy # :nodoc:
|
|
24
24
|
raise # same as without the extra
|
25
25
|
when :last_page
|
26
26
|
requested_page = @vars[:page] # save the requested page (even after re-run)
|
27
|
-
initialize
|
27
|
+
initialize(**vars, page: @last) # re-run with the last page
|
28
28
|
@vars[:page] = requested_page # restore the requested page
|
29
29
|
when :empty_page
|
30
|
-
@
|
31
|
-
if defined?(Calendar)
|
30
|
+
@in = @from = @to = 0 # vars relative to the actual page
|
31
|
+
if defined?(::Pagy::Calendar::Unit) \
|
32
|
+
&& is_a?(Calendar::Unit) # only for Calendar::Units instances
|
32
33
|
edge = @order == :asc ? @final : @initial # get the edge of the overflow side (neat, but any time would do)
|
33
|
-
@from = @to = edge # set both to the edge
|
34
|
+
@from = @to = edge # set both to the edge time (a >=&&< query will get no records)
|
34
35
|
end
|
35
36
|
@prev = @last # prev relative to the actual page
|
36
37
|
extend Series # special series for :empty_page
|
@@ -51,12 +52,12 @@ class Pagy # :nodoc:
|
|
51
52
|
end
|
52
53
|
end
|
53
54
|
Pagy.prepend PagyOverride
|
54
|
-
Pagy::Calendar.prepend PagyOverride if defined?(Calendar)
|
55
|
+
Pagy::Calendar::Unit.prepend PagyOverride if defined?(::Pagy::Calendar::Unit)
|
55
56
|
|
56
57
|
# Support for Pagy::Countless class
|
57
58
|
module CountlessOverride
|
58
59
|
# Add rescue clause for different behaviors
|
59
|
-
def finalize(
|
60
|
+
def finalize(fetched_size)
|
60
61
|
@overflow = false
|
61
62
|
super
|
62
63
|
rescue OverflowError
|
@@ -65,8 +66,8 @@ class Pagy # :nodoc:
|
|
65
66
|
when :exception
|
66
67
|
raise # same as without the extra
|
67
68
|
when :empty_page
|
68
|
-
@offset = @
|
69
|
-
@vars[:size] =
|
69
|
+
@offset = @limit = @from = @to = 0 # vars relative to the actual page
|
70
|
+
@vars[:size] = 0 # no page in the series
|
70
71
|
self
|
71
72
|
else
|
72
73
|
raise VariableError.new(self, :overflow, 'to be in [:empty_page, :exception]', @vars[:overflow])
|
@@ -74,7 +75,7 @@ class Pagy # :nodoc:
|
|
74
75
|
end
|
75
76
|
end
|
76
77
|
# :nocov:
|
77
|
-
Pagy::Countless.prepend CountlessOverride if defined?(Countless)
|
78
|
+
Pagy::Countless.prepend CountlessOverride if defined?(::Pagy::Countless)
|
78
79
|
# :nocov:
|
79
80
|
end
|
80
81
|
end
|