pagy 8.4.0 → 9.0.9

Sign up to get free protection for your applications and to get access to all the features.
Files changed (100) hide show
  1. checksums.yaml +4 -4
  2. data/apps/calendar.ru +682 -2137
  3. data/apps/demo.ru +17 -13
  4. data/apps/keyset_ar.ru +236 -0
  5. data/apps/keyset_s.ru +238 -0
  6. data/apps/rails.ru +25 -15
  7. data/apps/repro.ru +17 -14
  8. data/bin/pagy +17 -12
  9. data/config/pagy.rb +37 -34
  10. data/javascripts/pagy.min.js +4 -0
  11. data/javascripts/pagy.min.js.map +10 -0
  12. data/javascripts/pagy.mjs +100 -0
  13. data/lib/optimist.rb +1 -1
  14. data/lib/pagy/b64.rb +33 -0
  15. data/lib/pagy/backend.rb +19 -19
  16. data/lib/pagy/calendar/day.rb +4 -3
  17. data/lib/pagy/calendar/month.rb +4 -3
  18. data/lib/pagy/calendar/quarter.rb +4 -3
  19. data/lib/pagy/calendar/unit.rb +103 -0
  20. data/lib/pagy/calendar/week.rb +3 -3
  21. data/lib/pagy/calendar/year.rb +4 -3
  22. data/lib/pagy/calendar.rb +54 -97
  23. data/lib/pagy/countless.rb +15 -16
  24. data/lib/pagy/extras/arel.rb +3 -11
  25. data/lib/pagy/extras/array.rb +5 -10
  26. data/lib/pagy/extras/bootstrap.rb +5 -5
  27. data/lib/pagy/extras/bulma.rb +10 -7
  28. data/lib/pagy/extras/calendar.rb +34 -5
  29. data/lib/pagy/extras/countless.rb +8 -13
  30. data/lib/pagy/extras/elasticsearch_rails.rb +16 -25
  31. data/lib/pagy/extras/gearbox.rb +26 -26
  32. data/lib/pagy/extras/headers.rb +25 -24
  33. data/lib/pagy/extras/i18n.rb +1 -1
  34. data/lib/pagy/extras/js_tools.rb +10 -10
  35. data/lib/pagy/extras/jsonapi.rb +26 -19
  36. data/lib/pagy/extras/keyset.rb +30 -0
  37. data/lib/pagy/extras/limit.rb +63 -0
  38. data/lib/pagy/extras/meilisearch.rb +9 -17
  39. data/lib/pagy/extras/metadata.rb +6 -2
  40. data/lib/pagy/extras/overflow.rb +11 -10
  41. data/lib/pagy/extras/pagy.rb +16 -16
  42. data/lib/pagy/extras/searchkick.rb +9 -17
  43. data/lib/pagy/extras/size.rb +40 -0
  44. data/lib/pagy/extras/standalone.rb +6 -6
  45. data/lib/pagy/extras/trim.rb +3 -3
  46. data/lib/pagy/frontend.rb +37 -35
  47. data/lib/pagy/i18n.rb +2 -2
  48. data/lib/pagy/keyset/active_record.rb +38 -0
  49. data/lib/pagy/keyset/sequel.rb +51 -0
  50. data/lib/pagy/keyset.rb +98 -0
  51. data/lib/pagy/shared_methods.rb +27 -0
  52. data/lib/pagy/url_helpers.rb +5 -5
  53. data/lib/pagy.rb +70 -94
  54. data/locales/ar.yml +9 -10
  55. data/locales/be.yml +2 -2
  56. data/locales/bg.yml +2 -2
  57. data/locales/bs.yml +2 -2
  58. data/locales/ca.yml +5 -7
  59. data/locales/ckb.yml +2 -2
  60. data/locales/cs.yml +2 -2
  61. data/locales/da.yml +2 -2
  62. data/locales/de.yml +2 -2
  63. data/locales/en.yml +2 -2
  64. data/locales/es.yml +2 -2
  65. data/locales/fr.yml +2 -2
  66. data/locales/hr.yml +2 -2
  67. data/locales/id.yml +2 -2
  68. data/locales/it.yml +2 -2
  69. data/locales/ja.yml +2 -2
  70. data/locales/km.yml +2 -2
  71. data/locales/ko.yml +2 -2
  72. data/locales/nb.yml +2 -2
  73. data/locales/nl.yml +2 -2
  74. data/locales/nn.yml +2 -2
  75. data/locales/pl.yml +2 -2
  76. data/locales/pt-BR.yml +2 -2
  77. data/locales/pt.yml +2 -2
  78. data/locales/ru.yml +2 -2
  79. data/locales/sr.yml +2 -2
  80. data/locales/sv-SE.yml +2 -2
  81. data/locales/sv.yml +2 -2
  82. data/locales/sw.yml +2 -2
  83. data/locales/ta.yml +2 -2
  84. data/locales/tr.yml +2 -2
  85. data/locales/uk.yml +2 -2
  86. data/locales/vi.yml +2 -2
  87. data/locales/zh-CN.yml +2 -2
  88. data/locales/zh-HK.yml +2 -2
  89. data/locales/zh-TW.yml +2 -2
  90. metadata +19 -19
  91. data/javascripts/pagy-dev.js +0 -114
  92. data/javascripts/pagy-module.js +0 -113
  93. data/javascripts/pagy.js +0 -1
  94. data/lib/pagy/calendar/helper.rb +0 -65
  95. data/lib/pagy/extras/foundation.rb +0 -95
  96. data/lib/pagy/extras/items.rb +0 -64
  97. data/lib/pagy/extras/materialize.rb +0 -100
  98. data/lib/pagy/extras/semantic.rb +0 -94
  99. data/lib/pagy/extras/uikit.rb +0 -98
  100. /data/javascripts/{pagy-module.d.ts → pagy.d.ts} +0 -0
data/apps/repro.ru CHANGED
@@ -15,7 +15,7 @@
15
15
  # DOC
16
16
  # https://ddnexus.github.io/pagy/playground/#1-repro-app
17
17
 
18
- VERSION = '8.4.0'
18
+ VERSION = '9.0.9'
19
19
 
20
20
  require 'bundler/inline'
21
21
  require 'bundler'
@@ -31,26 +31,29 @@ end
31
31
  # Edit this section adding/removing the extras and Pagy::DEFAULT as needed
32
32
  # pagy initializer
33
33
  require 'pagy/extras/pagy'
34
- require 'pagy/extras/items'
34
+ require 'pagy/extras/limit'
35
35
  require 'pagy/extras/overflow'
36
36
  Pagy::DEFAULT[:overflow] = :empty_page
37
- Pagy::DEFAULT[:size] = [1, 4, 4, 1]
38
37
  Pagy::DEFAULT.freeze
39
38
 
40
39
  require 'sinatra/base'
41
40
  # Sinatra application
42
41
  class PagyRepro < Sinatra::Base
43
- PAGY_JS = "pagy#{'-dev' if ENV['DEBUG']}.js".freeze
44
-
45
42
  configure do
46
43
  enable :inline_templates
47
44
  end
48
45
  include Pagy::Backend
49
- # Serve pagy.js or pagy-dev.js
50
- get("/#{PAGY_JS}") do
51
- content_type 'application/javascript'
52
- send_file Pagy.root.join('javascripts', PAGY_JS)
46
+
47
+ get('/javascripts/:file') do
48
+ format = params[:file].split('.').last
49
+ if format == 'js'
50
+ content_type 'application/javascript'
51
+ elsif format == 'map'
52
+ content_type 'application/json'
53
+ end
54
+ send_file Pagy.root.join('javascripts', params[:file])
53
55
  end
56
+
54
57
  # Edit this action as needed
55
58
  get '/' do
56
59
  collection = MockCollection.new
@@ -96,7 +99,7 @@ __END__
96
99
  <html>
97
100
  <head>
98
101
  <title>Pagy Repro App</title>
99
- <script src="<%= %(/#{PAGY_JS}) %>"></script>
102
+ <script src="javascripts/pagy.min.js"></script>
100
103
  <script>
101
104
  window.addEventListener("load", Pagy.init);
102
105
  </script>
@@ -104,7 +107,7 @@ __END__
104
107
  <style type="text/css">
105
108
  @media screen { html, body {
106
109
  font-size: 1rem;
107
- line-heigth: 1.2s;
110
+ line-height: 1.2s;
108
111
  padding: 0;
109
112
  margin: 0;
110
113
  } }
@@ -161,13 +164,13 @@ __END__
161
164
 
162
165
  <h4>pagy_nav_js</h4>
163
166
  <%= pagy_nav_js(@pagy, id: 'nav-js-responsive', aria_label: 'Pages nav_js_responsove',
164
- steps: { 0 => [1,1,1,1], 500 => [1,3,3,1], 750 => [1,5,5,1], 1000 => [2,6,6,2] }) %>
167
+ steps: { 0 => 5, 500 => 7, 750 => 9, 1000 => 11 }) %>
165
168
 
166
169
  <h4>pagy_combo_nav_js</h4>
167
170
  <%= pagy_combo_nav_js(@pagy, id: 'combo-nav-js', aria_label: 'Pages combo_nav_js') %>
168
171
 
169
- <h4>pagy_items_selector_js</h4>
170
- <%= pagy_items_selector_js(@pagy, id: 'items-selector-js') %>
172
+ <h4>pagy_limit_selector_js</h4>
173
+ <%= pagy_limit_selector_js(@pagy, id: 'limit-selector-js') %>
171
174
 
172
175
  <h4>pagy_info</h4>
173
176
  <%= pagy_info(@pagy, id: 'pagy-info') %>
data/bin/pagy CHANGED
@@ -1,8 +1,11 @@
1
1
  #!/usr/bin/env ruby
2
2
  # frozen_string_literal: true
3
3
 
4
- VERSION = '8.4.0'
5
- APPS = %w[repro rails demo calendar].freeze
4
+ VERSION = '9.0.9'
5
+ APPS = %w[repro rails demo calendar keyset_ar keyset_s].freeze
6
+ LINUX = RbConfig::CONFIG['host_os'].include?('linux')
7
+ HOST = '0.0.0.0'
8
+ PORT = '8000'
6
9
 
7
10
  require_relative '../lib/optimist'
8
11
  opts = Optimist.options do
@@ -14,23 +17,27 @@ opts = Optimist.options do
14
17
  rails Reproduce rails related issues
15
18
  demo Showcase all the helpers and styles
16
19
  calendar Showcase the calendar; reproduce related issues
20
+ keyset_ar Showcase the keyset ActiveRecord pagination
21
+ keyset_s Showcase the keyset Sequel pagination
17
22
  USAGE
18
23
  pagy APP [options] Showcase APP from the installed gem
19
24
  pagy clone APP Clone APP to the current dir
20
25
  pagy APPFILE [options] Develop APPFILE from local path
21
26
  EXAMPLES
22
- pagy demo Showcase demo at http://0.0.0.0:8000
27
+ pagy demo Showcase demo at http://#{HOST}:#{PORT}
23
28
  pagy clone repro Clone repro to ./repro.ru
24
- pagy ~/my-repro.ru Develop ~/my-repro.ru at http://0.0.0.0:8000
29
+ pagy ~/my-repro.ru Develop ~/my-repro.ru at#{HOST}:#{PORT}
25
30
  HEAD
26
31
  text 'Rackup options'
27
32
  opt :env, 'Environment', default: 'development'
28
- opt :host, 'Host', default: '0.0.0.0', short: :o
29
- opt :port, 'Port', default: 8000
33
+ opt :host, 'Host', default: HOST, short: :o
34
+ opt :port, 'Port', default: PORT
30
35
  opt :install, 'Install bundle for users', default: true
31
- text 'Rerun options'
32
- opt :rerun, 'Enable rerun for development', default: true
33
- opt :clear, 'Clear screen before each rerun'
36
+ if LINUX
37
+ text 'Rerun options'
38
+ opt :rerun, 'Enable rerun for development', default: true
39
+ opt :clear, 'Clear screen before each rerun'
40
+ end
34
41
  text 'Other options'
35
42
  opt :quiet, 'Quiet mode for development'
36
43
  version VERSION
@@ -38,8 +45,6 @@ end
38
45
  Optimist.educate if ARGV.empty?
39
46
 
40
47
  run_from_repo = File.exist?(File.expand_path('../pagy.gemspec', __dir__))
41
- # Never install if run from pagy repo (for pagy devs)
42
- opts[:install] = false if run_from_repo
43
48
 
44
49
  # Handles gems
45
50
  require 'bundler/inline'
@@ -48,7 +53,7 @@ Bundler.configure
48
53
  gemfile(opts[:install]) do
49
54
  source 'https://rubygems.org'
50
55
  gem 'rackup'
51
- gem 'rerun'
56
+ gem 'rerun' if LINUX
52
57
  end
53
58
 
54
59
  path = ->(app) { File.expand_path("../apps/#{app}.ru", __dir__) }
data/config/pagy.rb CHANGED
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Pagy initializer file (8.4.0)
3
+ # Pagy initializer file (9.0.9)
4
4
  # Customize only what you really need and notice that the core Pagy works also without any of the following lines.
5
5
  # Should you just cherry pick part of this file, please maintain the require-order of the extras
6
6
 
@@ -10,16 +10,25 @@
10
10
  # You can set any pagy variable as a Pagy::DEFAULT. They can also be overridden per instance by just passing them to
11
11
  # Pagy.new|Pagy::Countless.new|Pagy::Calendar::*.new or any of the #pagy* controller methods
12
12
  # Here are the few that make more sense as DEFAULTs:
13
- # Pagy::DEFAULT[:items] = 20 # default
14
- # Pagy::DEFAULT[:size] = [1,4,4,1] # default in pagy < 7.0
13
+ # Pagy::DEFAULT[:limit] = 20 # default
14
+ # Pagy::DEFAULT[:size] = 7 # default
15
+ # Pagy::DEFAULT[:ends] = true # default
15
16
  # Pagy::DEFAULT[:page_param] = :page # default
16
17
  # Pagy::DEFAULT[:count_args] = [] # example for non AR ORMs
18
+ # Pagy::DEFAULT[:max_pages] = 3000 # example
17
19
 
18
20
 
19
21
  # Extras
20
22
  # See https://ddnexus.github.io/pagy/categories/extra
21
23
 
22
24
 
25
+ # Legacy Compatibility Extras
26
+
27
+ # Size extra: Enable the Array type for the `:size` variable (e.g. `size: [1,4,4,1]`)
28
+ # See https://ddnexus.github.io/pagy/docs/extras/size
29
+ # require 'pagy/extras/size' # must be required before the other extras
30
+
31
+
23
32
  # Backend Extras
24
33
 
25
34
  # Arel extra: For better performance utilizing grouped ActiveRecord collections:
@@ -33,21 +42,12 @@
33
42
  # Calendar extra: Add pagination filtering by calendar time unit (year, quarter, month, week, day)
34
43
  # See https://ddnexus.github.io/pagy/docs/extras/calendar
35
44
  # require 'pagy/extras/calendar'
36
- # Default for each unit
37
- # Pagy::Calendar::Year::DEFAULT[:order] = :asc # Time direction of pagination
38
- # Pagy::Calendar::Year::DEFAULT[:format] = '%Y' # strftime format
39
- #
40
- # Pagy::Calendar::Quarter::DEFAULT[:order] = :asc # Time direction of pagination
41
- # Pagy::Calendar::Quarter::DEFAULT[:format] = '%Y-Q%q' # strftime format
42
- #
43
- # Pagy::Calendar::Month::DEFAULT[:order] = :asc # Time direction of pagination
44
- # Pagy::Calendar::Month::DEFAULT[:format] = '%Y-%m' # strftime format
45
- #
46
- # Pagy::Calendar::Week::DEFAULT[:order] = :asc # Time direction of pagination
47
- # Pagy::Calendar::Week::DEFAULT[:format] = '%Y-%W' # strftime format
48
- #
49
- # Pagy::Calendar::Day::DEFAULT[:order] = :asc # Time direction of pagination
50
- # Pagy::Calendar::Day::DEFAULT[:format] = '%Y-%m-%d' # strftime format
45
+ # Default for each calendar unit class in IRB:
46
+ # >> Pagy::Calendar::Year::DEFAULT
47
+ # >> Pagy::Calendar::Quarter::DEFAULT
48
+ # >> Pagy::Calendar::Month::DEFAULT
49
+ # >> Pagy::Calendar::Week::DEFAULT
50
+ # >> Pagy::Calendar::Day::DEFAULT
51
51
  #
52
52
  # Uncomment the following lines, if you need calendar localization without using the I18n extra
53
53
  # module LocalizePagyCalendar
@@ -75,10 +75,14 @@
75
75
  # See http://ddnexus.github.io/pagy/extras/headers
76
76
  # require 'pagy/extras/headers'
77
77
  # Pagy::DEFAULT[:headers] = { page: 'Current-Page',
78
- # items: 'Page-Items',
78
+ # limit: 'Page-Items',
79
79
  # count: 'Total-Count',
80
80
  # pages: 'Total-Pages' } # default
81
81
 
82
+ # Keyset extra: Paginate with the Pagy keyset pagination technique
83
+ # See http://ddnexus.github.io/pagy/extras/keyset
84
+ # require 'pagy/extras/keyset'
85
+
82
86
  # Meilisearch extra: Paginate `Meilisearch` result objects
83
87
  # See https://ddnexus.github.io/pagy/docs/extras/meilisearch
84
88
  # Default :pagy_search method: change only if you use also
@@ -90,8 +94,8 @@
90
94
 
91
95
  # Metadata extra: Provides the pagination metadata to Javascript frameworks like Vue.js, react.js, etc.
92
96
  # See https://ddnexus.github.io/pagy/docs/extras/metadata
93
- # you must require the frontend helpers internal extra (BEFORE the metadata extra) ONLY if you need also the :sequels
94
- # require 'pagy/extras/frontend_helpers'
97
+ # you must require the JS Tools internal extra (BEFORE the metadata extra) ONLY if you need also the :sequels
98
+ # require 'pagy/extras/js_tools'
95
99
  # require 'pagy/extras/metadata'
96
100
  # For performance reasons, you should explicitly set ONLY the metadata you use in the frontend
97
101
  # Pagy::DEFAULT[:metadata] = %i[scaffold_url page prev next last] # example
@@ -100,7 +104,7 @@
100
104
  # See https://ddnexus.github.io/pagy/docs/extras/searchkick
101
105
  # Default :pagy_search method: change only if you use also
102
106
  # the elasticsearch_rails or meilisearch extra that defines the same
103
- # DEFAULT[:searchkick_pagy_search] = :pagy_search
107
+ # Pagy::DEFAULT[:searchkick_pagy_search] = :pagy_search
104
108
  # Default original :search method called internally to do the actual search
105
109
  # Pagy::DEFAULT[:searchkick_search] = :search
106
110
  # require 'pagy/extras/searchkick'
@@ -125,25 +129,25 @@
125
129
 
126
130
  # Multi size var used by the *_nav_js helpers
127
131
  # See https://ddnexus.github.io/pagy/docs/extras/pagy#steps
128
- # Pagy::DEFAULT[:steps] = { 0 => [2,3,3,2], 540 => [3,5,5,3], 720 => [5,7,7,5] } # example
132
+ # Pagy::DEFAULT[:steps] = { 0 => 5, 540 => 7, 720 => 9 } # example
129
133
 
130
134
 
131
135
  # Feature Extras
132
136
 
133
- # Gearbox extra: Automatically change the number of items per page depending on the page number
137
+ # Gearbox extra: Automatically change the limit per page depending on the page number
134
138
  # See https://ddnexus.github.io/pagy/docs/extras/gearbox
135
139
  # require 'pagy/extras/gearbox'
136
140
  # set to false only if you want to make :gearbox_extra an opt-in variable
137
141
  # Pagy::DEFAULT[:gearbox_extra] = false # default true
138
- # Pagy::DEFAULT[:gearbox_items] = [15, 30, 60, 100] # default
142
+ # Pagy::DEFAULT[:gearbox_limit] = [15, 30, 60, 100] # default
139
143
 
140
- # Items extra: Allow the client to request a custom number of items per page with an optional selector UI
141
- # See https://ddnexus.github.io/pagy/docs/extras/items
142
- # require 'pagy/extras/items'
143
- # set to false only if you want to make :items_extra an opt-in variable
144
- # Pagy::DEFAULT[:items_extra] = false # default true
145
- # Pagy::DEFAULT[:items_param] = :items # default
146
- # Pagy::DEFAULT[:max_items] = 100 # default
144
+ # Limit extra: Allow the client to request a custom limit per page with an optional selector UI
145
+ # See https://ddnexus.github.io/pagy/docs/extras/limit
146
+ # require 'pagy/extras/limit'
147
+ # set to false only if you want to make :limit_extra an opt-in variable
148
+ # Pagy::DEFAULT[:limit_extra] = false # default true
149
+ # Pagy::DEFAULT[:limit_param] = :limit # default
150
+ # Pagy::DEFAULT[:limit_max] = 100 # default
147
151
 
148
152
  # Overflow extra: Allow for easy handling of overflowing pages
149
153
  # See https://ddnexus.github.io/pagy/docs/extras/overflow
@@ -167,10 +171,9 @@
167
171
  # set to false only if you want to make :jsonapi an opt-in variable
168
172
  # Pagy::DEFAULT[:jsonapi] = false # default true
169
173
 
170
-
171
174
  # Rails
172
175
  # Enable the .js file required by the helpers that use javascript
173
- # (pagy*_nav_js, pagy*_combo_nav_js, and pagy_items_selector_js)
176
+ # (pagy*_nav_js, pagy*_combo_nav_js, and pagy_limit_selector_js)
174
177
  # See https://ddnexus.github.io/pagy/docs/api/javascript
175
178
 
176
179
  # With the asset pipeline
@@ -0,0 +1,4 @@
1
+ window.Pagy=(()=>{const j=new ResizeObserver((B)=>B.forEach((D)=>D.target.querySelectorAll(".pagy-rjs").forEach((E)=>E.pagyRender()))),x=(B,[D,E,z,G])=>{const F=B.parentElement??B,K=Object.keys(E).map((H)=>parseInt(H)).sort((H,M)=>M-H);let L=-1;const T=(H,M,R)=>H.replace(/__pagy_page__/g,M).replace(/__pagy_label__/g,R);if((B.pagyRender=function(){const H=K.find((Q)=>Q<F.clientWidth)||0;if(H===L)return;let M=D.before;const R=E[H.toString()],X=z?.[H.toString()]??R.map((Q)=>Q.toString());R.forEach((Q,J)=>{const $=X[J];let U;if(typeof Q==="number")U=T(D.a,Q.toString(),$);else if(Q==="gap")U=D.gap;else U=T(D.current,Q,$);M+=typeof G==="string"&&Q==1?Z(U,G):U}),M+=D.after,B.innerHTML="",B.insertAdjacentHTML("afterbegin",M),L=H})(),B.classList.contains("pagy-rjs"))j.observe(F)},A=(B,[D,E])=>Y(B,(z)=>[z,D.replace(/__pagy_page__/,z)],E),C=(B,[D,E,z])=>{Y(B,(G)=>{const F=Math.max(Math.ceil(D/parseInt(G)),1).toString(),K=E.replace(/__pagy_page__/,F).replace(/__pagy_limit__/,G);return[F,K]},z)},Y=(B,D,E)=>{const z=B.querySelector("input"),G=B.querySelector("a"),F=z.value,K=function(){if(z.value===F)return;const[L,T,H]=[z.min,z.value,z.max].map((X)=>parseInt(X)||0);if(T<L||T>H){z.value=F,z.select();return}let[M,R]=D(z.value);if(typeof E==="string"&&M==="1")R=Z(R,E);G.href=R,G.click()};["change","focus"].forEach((L)=>z.addEventListener(L,()=>z.select())),z.addEventListener("focusout",K),z.addEventListener("keypress",(L)=>{if(L.key==="Enter")K()})},Z=(B,D)=>B.replace(new RegExp(`[?&]${D}=1\\b(?!&)|\\b${D}=1&`),"");return{version:"9.0.9",init(B){const E=(B instanceof Element?B:document).querySelectorAll("[data-pagy]");for(let z of E)try{const G=Uint8Array.from(atob(z.getAttribute("data-pagy")),(L)=>L.charCodeAt(0)),[F,...K]=JSON.parse(new TextDecoder().decode(G));if(F==="nav")x(z,K);else if(F==="combo")A(z,K);else if(F==="selector")C(z,K);else console.warn("Skipped Pagy.init() for: %o\nUnknown keyword '%s'",z,F)}catch(G){console.warn("Skipped Pagy.init() for: %o\n%s",z,G)}}}})();
2
+
3
+ //# debugId=83D9FF1F74D4A1AA64756E2164756E21
4
+ //# sourceMappingURL=pagy.min.js.map
@@ -0,0 +1,10 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../../src/pagy.ts"],
4
+ "sourcesContent": [
5
+ "type NavArgs = readonly [Tokens, Sequels, null | LabelSequels, string?]\ntype ComboArgs = readonly [string, string?]\ntype SelectorArgs = readonly [number, string, string?]\ntype JsonArgs = ['nav', NavArgs] | ['combo', ComboArgs] | ['selector', SelectorArgs]\n\ninterface Tokens {\n readonly before:string\n readonly a:string\n readonly current:string\n readonly gap:string\n readonly after:string\n}\ninterface Sequels {readonly [width:string]:(string | number)[]}\ninterface LabelSequels {readonly [width:string]:string[]}\ninterface NavElement extends Element {pagyRender():void}\n\nconst Pagy = (() => {\n // The observer instance for responsive navs\n const rjsObserver = new ResizeObserver(\n entries => entries.forEach(e => e.target.querySelectorAll<NavElement>(\".pagy-rjs\")\n .forEach(el => el.pagyRender())));\n // Init the *_nav_js helpers\n const initNav = (el:NavElement, [tokens, sequels, labelSequels, trimParam]:NavArgs) => {\n const container = el.parentElement ?? el;\n const widths = Object.keys(sequels).map(w => parseInt(w)).sort((a, b) => b - a);\n let lastWidth = -1;\n const fillIn = (a:string, page:string, label:string):string =>\n a.replace(/__pagy_page__/g, page).replace(/__pagy_label__/g, label);\n (el.pagyRender = function () {\n const width = widths.find(w => w < container.clientWidth) || 0;\n if (width === lastWidth) { return } // no change: abort\n let html = tokens.before; // already trimmed in html\n const series = sequels[width.toString()];\n const labels = labelSequels?.[width.toString()] ?? series.map(l => l.toString());\n series.forEach((item, i) => {\n const label = labels[i];\n let filled;\n if (typeof item === \"number\") {\n filled = fillIn(tokens.a, item.toString(), label);\n } else if (item === \"gap\") {\n filled = tokens.gap;\n } else { // active page\n filled = fillIn(tokens.current, item, label);\n }\n html += (typeof trimParam === \"string\" && item == 1) ? trim(filled, trimParam) : filled;\n });\n html += tokens.after;\n el.innerHTML = \"\";\n el.insertAdjacentHTML(\"afterbegin\", html);\n lastWidth = width;\n })();\n if (el.classList.contains(\"pagy-rjs\")) { rjsObserver.observe(container) }\n };\n\n // Init the *_combo_nav_js helpers\n const initCombo = (el:Element, [url_token, trimParam]:ComboArgs) =>\n initInput(el, inputValue => [inputValue, url_token.replace(/__pagy_page__/, inputValue)], trimParam);\n\n // Init the limit_selector_js helper\n const initSelector = (el:Element, [from, url_token, trimParam]:SelectorArgs) => {\n initInput(el, inputValue => {\n const page = Math.max(Math.ceil(from / parseInt(inputValue)), 1).toString();\n const url = url_token.replace(/__pagy_page__/, page).replace(/__pagy_limit__/, inputValue);\n return [page, url];\n }, trimParam);\n };\n\n // Init the input element\n const initInput = (el:Element, getVars:(v:string) => [string, string], trimParam?:string) => {\n const input = el.querySelector(\"input\") as HTMLInputElement;\n const link = el.querySelector(\"a\") as HTMLAnchorElement;\n const initial = input.value;\n const action = function () {\n if (input.value === initial) { return } // not changed\n const [min, val, max] = [input.min, input.value, input.max].map(n => parseInt(n) || 0);\n if (val < min || val > max) { // reset invalid/out-of-range\n input.value = initial;\n input.select();\n return;\n }\n let [page, url] = getVars(input.value); // eslint-disable-line prefer-const\n if (typeof trimParam === \"string\" && page === \"1\") { url = trim(url, trimParam) }\n link.href = url;\n link.click();\n };\n [\"change\", \"focus\"].forEach(e => input.addEventListener(e, () => input.select())); // auto-select\n input.addEventListener(\"focusout\", action); // trigger action\n input.addEventListener(\"keypress\", e => { if (e.key === \"Enter\") { action() } }); // trigger action\n };\n\n // Trim the ${page-param}=1 params in links\n const trim = (a:string, param:string) =>\n a.replace(new RegExp(`[?&]${param}=1\\\\b(?!&)|\\\\b${param}=1&`), \"\");\n\n // Public interface\n return {\n version: \"9.0.9\",\n\n // Scan for elements with a \"data-pagy\" attribute and call their init functions with the decoded args\n init(arg?:Element) {\n const target = arg instanceof Element ? arg : document;\n const elements = target.querySelectorAll(\"[data-pagy]\");\n for (const el of elements) {\n try {\n const uint8array = Uint8Array.from(atob(el.getAttribute(\"data-pagy\") as string), c => c.charCodeAt(0));\n const [keyword, ...args] = JSON.parse((new TextDecoder()).decode(uint8array)) as JsonArgs; // base64-utf8 -> JSON -> Array\n if (keyword === \"nav\") {\n initNav(el as NavElement, args as unknown as NavArgs);\n } else if (keyword === \"combo\") {\n initCombo(el, args as unknown as ComboArgs);\n } else if (keyword === \"selector\") {\n initSelector(el, args as unknown as SelectorArgs);\n } else {\n console.warn(\"Skipped Pagy.init() for: %o\\nUnknown keyword '%s'\", el, keyword);\n }\n } catch (err) { console.warn(\"Skipped Pagy.init() for: %o\\n%s\", el, err) }\n }\n }\n };\n})();\n\nexport default Pagy;\n"
6
+ ],
7
+ "mappings": "AAgBA,IAAM,GAAQ,IAAM,CAElB,MAAM,EAAc,IAAI,eACpB,KAAW,EAAQ,QAAQ,KAAK,EAAE,OAAO,iBAA6B,WAAW,EAC/C,QAAQ,KAAM,EAAG,WAAW,CAAC,CAAC,CAAC,EAE/D,EAAU,CAAC,GAAgB,EAAQ,EAAS,EAAc,KAAuB,CACrF,MAAM,EAAY,EAAG,eAAiB,EAChC,EAAY,OAAO,KAAK,CAAO,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,EAAG,IAAM,EAAI,CAAC,EACjF,IAAI,EAAc,GAClB,MAAM,EAAY,CAAC,EAAU,EAAa,IACtC,EAAE,QAAQ,iBAAkB,CAAI,EAAE,QAAQ,kBAAmB,CAAK,EAwBtE,IAvBC,EAAG,mBAAsB,EAAG,CAC3B,MAAM,EAAQ,EAAO,KAAK,KAAK,EAAI,EAAU,WAAW,GAAK,EAC7D,GAAI,IAAU,EAAa,OAC3B,IAAI,EAAW,EAAO,OACtB,MAAM,EAAS,EAAQ,EAAM,SAAS,GAChC,EAAS,IAAe,EAAM,SAAS,IAAM,EAAO,IAAI,KAAK,EAAE,SAAS,CAAC,EAC/E,EAAO,QAAQ,CAAC,EAAM,IAAM,CAC1B,MAAM,EAAQ,EAAO,GACrB,IAAI,EACJ,UAAW,IAAS,SAClB,EAAS,EAAO,EAAO,EAAG,EAAK,SAAS,EAAG,CAAK,UACvC,IAAS,MAClB,EAAS,EAAO,QAEhB,GAAS,EAAO,EAAO,QAAS,EAAM,CAAK,EAE7C,UAAgB,IAAc,UAAY,GAAQ,EAAK,EAAK,EAAQ,CAAS,EAAI,EAClF,EACD,GAAe,EAAO,MACtB,EAAG,UAAY,GACf,EAAG,mBAAmB,aAAc,CAAI,EACxC,EAAY,IACX,EACC,EAAG,UAAU,SAAS,UAAU,EAAK,EAAY,QAAQ,CAAS,GAIlE,EAAY,CAAC,GAAa,EAAW,KACvC,EAAU,EAAI,KAAc,CAAC,EAAY,EAAU,QAAQ,gBAAiB,CAAU,CAAC,EAAG,CAAS,EAGjG,EAAe,CAAC,GAAa,EAAM,EAAW,KAA4B,CAC9E,EAAU,EAAI,KAAc,CAC1B,MAAM,EAAO,KAAK,IAAI,KAAK,KAAK,EAAO,SAAS,CAAU,CAAC,EAAG,CAAC,EAAE,SAAS,EACpE,EAAO,EAAU,QAAQ,gBAAiB,CAAI,EAAE,QAAQ,iBAAkB,CAAU,EAC1F,MAAO,CAAC,EAAM,CAAG,GAChB,CAAS,GAIR,EAAY,CAAC,EAAY,EAAwC,IAAsB,CAC3F,MAAM,EAAU,EAAG,cAAc,OAAO,EAClC,EAAU,EAAG,cAAc,GAAG,EAC9B,EAAU,EAAM,MAChB,UAAmB,EAAG,CAC1B,GAAI,EAAM,QAAU,EAAW,OAC/B,MAAO,EAAK,EAAK,GAAO,CAAC,EAAM,IAAK,EAAM,MAAO,EAAM,GAAG,EAAE,IAAI,KAAK,SAAS,CAAC,GAAK,CAAC,EACrF,GAAI,EAAM,GAAO,EAAM,EAAK,CAC1B,EAAM,MAAQ,EACd,EAAM,OAAO,EACb,OAEF,IAAK,EAAM,GAAO,EAAQ,EAAM,KAAK,EACrC,UAAW,IAAc,UAAY,IAAS,IAAO,EAAM,EAAK,EAAK,CAAS,EAC9E,EAAK,KAAO,EACZ,EAAK,MAAM,GAEb,CAAC,SAAU,OAAO,EAAE,QAAQ,KAAK,EAAM,iBAAiB,EAAG,IAAM,EAAM,OAAO,CAAC,CAAC,EAChF,EAAM,iBAAiB,WAAY,CAAM,EACzC,EAAM,iBAAiB,WAAY,KAAK,CAAE,GAAI,EAAE,MAAQ,QAAW,EAAO,EAAK,GAI3E,EAAO,CAAC,EAAU,IACpB,EAAE,QAAQ,IAAI,OAAO,OAAO,kBAAsB,MAAU,EAAG,EAAE,EAGrE,MAAO,CACL,QAAS,QAGT,IAAI,CAAC,EAAc,CAEjB,MAAM,GADW,aAAe,QAAU,EAAM,UACxB,iBAAiB,aAAa,EACtD,QAAW,KAAM,EACf,GAAI,CACF,MAAM,EAAqB,WAAW,KAAK,KAAK,EAAG,aAAa,WAAW,CAAW,EAAG,KAAK,EAAE,WAAW,CAAC,CAAC,GACtG,KAAY,GAAQ,KAAK,MAAO,IAAI,YAAY,EAAG,OAAO,CAAU,CAAC,EAC5E,GAAI,IAAY,MACd,EAAQ,EAAkB,CAA0B,UAC3C,IAAY,QACrB,EAAU,EAAI,CAA4B,UACjC,IAAY,WACrB,EAAa,EAAI,CAA+B,MAEhD,SAAQ,KAAK,oDAAqD,EAAI,CAAO,QAExE,EAAP,CAAc,QAAQ,KAAK,kCAAmC,EAAI,CAAG,GAG7E,IACC",
8
+ "debugId": "83D9FF1F74D4A1AA64756E2164756E21",
9
+ "names": []
10
+ }
@@ -0,0 +1,100 @@
1
+ const Pagy = (() => {
2
+ const rjsObserver = new ResizeObserver((entries) => entries.forEach((e) => e.target.querySelectorAll(".pagy-rjs").forEach((el) => el.pagyRender())));
3
+ const initNav = (el, [tokens, sequels, labelSequels, trimParam]) => {
4
+ const container = el.parentElement ?? el;
5
+ const widths = Object.keys(sequels).map((w) => parseInt(w)).sort((a, b) => b - a);
6
+ let lastWidth = -1;
7
+ const fillIn = (a, page, label) => a.replace(/__pagy_page__/g, page).replace(/__pagy_label__/g, label);
8
+ (el.pagyRender = function() {
9
+ const width = widths.find((w) => w < container.clientWidth) || 0;
10
+ if (width === lastWidth) {
11
+ return;
12
+ }
13
+ let html = tokens.before;
14
+ const series = sequels[width.toString()];
15
+ const labels = labelSequels?.[width.toString()] ?? series.map((l) => l.toString());
16
+ series.forEach((item, i) => {
17
+ const label = labels[i];
18
+ let filled;
19
+ if (typeof item === "number") {
20
+ filled = fillIn(tokens.a, item.toString(), label);
21
+ } else if (item === "gap") {
22
+ filled = tokens.gap;
23
+ } else {
24
+ filled = fillIn(tokens.current, item, label);
25
+ }
26
+ html += typeof trimParam === "string" && item == 1 ? trim(filled, trimParam) : filled;
27
+ });
28
+ html += tokens.after;
29
+ el.innerHTML = "";
30
+ el.insertAdjacentHTML("afterbegin", html);
31
+ lastWidth = width;
32
+ })();
33
+ if (el.classList.contains("pagy-rjs")) {
34
+ rjsObserver.observe(container);
35
+ }
36
+ };
37
+ const initCombo = (el, [url_token, trimParam]) => initInput(el, (inputValue) => [inputValue, url_token.replace(/__pagy_page__/, inputValue)], trimParam);
38
+ const initSelector = (el, [from, url_token, trimParam]) => {
39
+ initInput(el, (inputValue) => {
40
+ const page = Math.max(Math.ceil(from / parseInt(inputValue)), 1).toString();
41
+ const url = url_token.replace(/__pagy_page__/, page).replace(/__pagy_limit__/, inputValue);
42
+ return [page, url];
43
+ }, trimParam);
44
+ };
45
+ const initInput = (el, getVars, trimParam) => {
46
+ const input = el.querySelector("input");
47
+ const link = el.querySelector("a");
48
+ const initial = input.value;
49
+ const action = function() {
50
+ if (input.value === initial) {
51
+ return;
52
+ }
53
+ const [min, val, max] = [input.min, input.value, input.max].map((n) => parseInt(n) || 0);
54
+ if (val < min || val > max) {
55
+ input.value = initial;
56
+ input.select();
57
+ return;
58
+ }
59
+ let [page, url] = getVars(input.value);
60
+ if (typeof trimParam === "string" && page === "1") {
61
+ url = trim(url, trimParam);
62
+ }
63
+ link.href = url;
64
+ link.click();
65
+ };
66
+ ["change", "focus"].forEach((e) => input.addEventListener(e, () => input.select()));
67
+ input.addEventListener("focusout", action);
68
+ input.addEventListener("keypress", (e) => {
69
+ if (e.key === "Enter") {
70
+ action();
71
+ }
72
+ });
73
+ };
74
+ const trim = (a, param) => a.replace(new RegExp(`[?&]${param}=1\\b(?!&)|\\b${param}=1&`), "");
75
+ return {
76
+ version: "9.0.9",
77
+ init(arg) {
78
+ const target = arg instanceof Element ? arg : document;
79
+ const elements = target.querySelectorAll("[data-pagy]");
80
+ for (const el of elements) {
81
+ try {
82
+ const uint8array = Uint8Array.from(atob(el.getAttribute("data-pagy")), (c) => c.charCodeAt(0));
83
+ const [keyword, ...args] = JSON.parse(new TextDecoder().decode(uint8array));
84
+ if (keyword === "nav") {
85
+ initNav(el, args);
86
+ } else if (keyword === "combo") {
87
+ initCombo(el, args);
88
+ } else if (keyword === "selector") {
89
+ initSelector(el, args);
90
+ } else {
91
+ console.warn("Skipped Pagy.init() for: %o\nUnknown keyword '%s'", el, keyword);
92
+ }
93
+ } catch (err) {
94
+ console.warn("Skipped Pagy.init() for: %o\n%s", el, err);
95
+ }
96
+ }
97
+ }
98
+ };
99
+ })();
100
+ export default Pagy;
data/lib/optimist.rb CHANGED
@@ -137,7 +137,7 @@ module Optimist
137
137
  ## There's one ambiguous case to be aware of: when +:multi+: is true and a
138
138
  ## +:default+ is set to an array (of something), it's ambiguous whether this
139
139
  ## is a multi-value argument as well as a multi-occurrence argument.
140
- ## In thise case, Optimist assumes that it's not a multi-value argument.
140
+ ## In this case, Optimist assumes that it's not a multi-value argument.
141
141
  ## If you want a multi-value, multi-occurrence argument with a default
142
142
  ## value, you must specify +:type+ as well.
143
143
 
data/lib/pagy/b64.rb ADDED
@@ -0,0 +1,33 @@
1
+ # frozen_string_literal: true
2
+
3
+ class Pagy # :nodoc:
4
+ # Cheap Base64 specialized methods to avoid dependencies
5
+ module B64
6
+ module_function
7
+
8
+ def encode(bin)
9
+ [bin].pack('m0')
10
+ end
11
+
12
+ def decode(str)
13
+ str.unpack1('m0')
14
+ end
15
+
16
+ def urlsafe_encode(bin)
17
+ str = encode(bin)
18
+ str.chomp!('==') or str.chomp!('=')
19
+ str.tr!('+/', '-_')
20
+ str
21
+ end
22
+
23
+ def urlsafe_decode(str)
24
+ if !str.end_with?('=') && str.length % 4 != 0
25
+ str = str.ljust((str.length + 3) & ~3, '=')
26
+ str.tr!('-_', '+/')
27
+ else
28
+ str = str.tr('-_', '+/')
29
+ end
30
+ decode(str)
31
+ end
32
+ end
33
+ end
data/lib/pagy/backend.rb CHANGED
@@ -8,19 +8,13 @@ class Pagy
8
8
  module Backend
9
9
  private
10
10
 
11
- # Return Pagy object and paginated items/results
12
- def pagy(collection, vars = {})
13
- pagy = Pagy.new(pagy_get_vars(collection, vars))
14
- [pagy, pagy_get_items(collection, pagy)]
15
- end
16
-
17
- # Sub-method called only by #pagy: here for easy customization of variables by overriding
18
- # You may need to override the count call for non AR collections
19
- def pagy_get_vars(collection, vars)
20
- pagy_set_items_from_params(vars) if defined?(ItemsExtra)
11
+ # Return Pagy object and paginated results
12
+ def pagy(collection, **vars)
21
13
  vars[:count] ||= pagy_get_count(collection, vars)
14
+ vars[:limit] ||= pagy_get_limit(vars)
22
15
  vars[:page] ||= pagy_get_page(vars)
23
- vars
16
+ pagy = Pagy.new(**vars)
17
+ [pagy, pagy_get_items(collection, pagy)]
24
18
  end
25
19
 
26
20
  # Get the count from the collection
@@ -29,16 +23,22 @@ class Pagy
29
23
  (count = collection.count(*count_args)).is_a?(Hash) ? count.size : count
30
24
  end
31
25
 
32
- # Get the page integer from the params
33
- # Overridable by the jsonapi extra
34
- def pagy_get_page(vars)
35
- [params[vars[:page_param] || DEFAULT[:page_param]].to_i, 1].max
36
- end
37
-
38
- # Sub-method called only by #pagy: here for easy customization of record-extraction by overriding
26
+ # Sub-method called only by #pagy: here for easy customization of fetching by overriding
39
27
  # You may need to override this method for collections without offset|limit
40
28
  def pagy_get_items(collection, pagy)
41
- collection.offset(pagy.offset).limit(pagy.in)
29
+ collection.offset(pagy.offset).limit(pagy.limit)
30
+ end
31
+
32
+ # Override for limit extra
33
+ def pagy_get_limit(_vars)
34
+ DEFAULT[:limit]
35
+ end
36
+
37
+ # Get the page integer from the params
38
+ # Overridable by the jsonapi extra
39
+ def pagy_get_page(vars, force_integer: true)
40
+ page = params[vars[:page_param] || DEFAULT[:page_param]]
41
+ force_integer ? (page || 1).to_i : page
42
42
  end
43
43
  end
44
44
  end
@@ -3,16 +3,17 @@
3
3
 
4
4
  class Pagy # :nodoc:
5
5
  class Calendar # :nodoc:
6
- # Calendar day subclass
7
- class Day < Calendar
6
+ # Day unit subclass
7
+ class Day < Unit
8
8
  DEFAULT = { size: 31, # rubocop:disable Style/MutableConstant
9
+ ends: false,
9
10
  order: :asc,
10
11
  format: '%d' }
11
12
 
12
13
  protected
13
14
 
14
15
  # Setup the calendar variables
15
- def setup_unit_vars
16
+ def assign_unit_vars
16
17
  super
17
18
  @initial = @starting.beginning_of_day
18
19
  @final = @ending.tomorrow.beginning_of_day
@@ -3,16 +3,17 @@
3
3
 
4
4
  class Pagy # :nodoc:
5
5
  class Calendar # :nodoc:
6
- # Calendar month subclass
7
- class Month < Calendar
6
+ # Month unit subclass
7
+ class Month < Unit
8
8
  DEFAULT = { size: 12, # rubocop:disable Style/MutableConstant
9
+ ends: false,
9
10
  order: :asc,
10
11
  format: '%b' }
11
12
 
12
13
  protected
13
14
 
14
15
  # Setup the calendar variables
15
- def setup_unit_vars
16
+ def assign_unit_vars
16
17
  super
17
18
  @initial = @starting.beginning_of_month
18
19
  @final = @ending.next_month.beginning_of_month
@@ -3,9 +3,10 @@
3
3
 
4
4
  class Pagy # :nodoc:
5
5
  class Calendar # :nodoc:
6
- # Calendar quarter subclass
7
- class Quarter < Calendar
6
+ # Quarter unit subclass
7
+ class Quarter < Unit
8
8
  DEFAULT = { size: 4, # rubocop:disable Style/MutableConstant
9
+ ends: false,
9
10
  order: :asc,
10
11
  format: 'Q%q' } # '%q' token
11
12
 
@@ -19,7 +20,7 @@ class Pagy # :nodoc:
19
20
  protected
20
21
 
21
22
  # Setup the calendar variables
22
- def setup_unit_vars
23
+ def assign_unit_vars
23
24
  super
24
25
  @initial = @starting.beginning_of_quarter
25
26
  @final = @ending.next_quarter.beginning_of_quarter