Merge pull request #1498 from denny/update/pagy-4-5-deprecations

Update pagy from 4 to 5
denny · Feb 1, 2024 · 16defdb · 16defdb
2 parents 8298fdd + 32a7551
commit 16defdb
Show file tree

Hide file tree

Showing 15 changed files with 50 additions and 39 deletions.
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -5,7 +5,7 @@ PATH
       acts-as-taggable-on
       acts_as_paranoid
       nokogiri (>= 1.11.0.rc4)
-      pagy (~> 4.11)
+      pagy (~> 5.10)
       pg (>= 1.2.3, < 1.6.0)
       pundit
       rails (~> 6.1.2, >= 6.1.2.1)
@@ -18,7 +18,7 @@ PATH
       acts_as_paranoid
       ckeditor
       nokogiri (>= 1.11.0.rc4)
-      pagy
+      pagy (~> 5.10)
       pg (>= 1.2.3, < 1.6.0)
       pundit
       rails (~> 6.1.2, >= 6.1.2.1)
@@ -47,7 +47,7 @@ PATH
       mini_magick
       mjml-rails
       nokogiri (>= 1.10.4)
-      pagy (~> 4.11)
+      pagy (~> 5.10)
       persistent-dmnd
       pg (>= 1.2.3, < 1.6.0)
       pry-rails
@@ -72,7 +72,7 @@ PATH
     shiny_forms (21.06)
       acts_as_paranoid
       nokogiri (>= 1.11.0.rc4)
-      pagy
+      pagy (~> 5.10)
       pg (>= 1.2.3, < 1.6.0)
       pundit
       rails (~> 6.1.2, >= 6.1.2.1)
@@ -84,7 +84,7 @@ PATH
       acts_as_paranoid
       ckeditor
       nokogiri (>= 1.11.0.rc4)
-      pagy
+      pagy (~> 5.10)
       pg (>= 1.2.3, < 1.6.0)
       pundit
       rails (~> 6.1.2, >= 6.1.2.1)
@@ -95,7 +95,7 @@ PATH
     shiny_lists (21.06)
       acts_as_paranoid
       nokogiri (>= 1.11.0.rc4)
-      pagy
+      pagy (~> 5.10)
       pg (>= 1.2.3, < 1.6.0)
       pundit
       rails (~> 6.1.2, >= 6.1.2.1)
@@ -108,7 +108,7 @@ PATH
       acts_as_paranoid
       ckeditor
       nokogiri (>= 1.11.0.rc4)
-      pagy
+      pagy (~> 5.10)
       pg (>= 1.2.3, < 1.6.0)
       pundit
       rails (~> 6.1.2, >= 6.1.2.1)
@@ -120,7 +120,7 @@ PATH
       acts_as_paranoid
       ckeditor
       nokogiri (>= 1.11.0.rc4)
-      pagy
+      pagy (~> 5.10)
       pg (>= 1.2.3, < 1.6.0)
       pundit
       rails (~> 6.1.2, >= 6.1.2.1)
@@ -132,7 +132,7 @@ PATH
       acts_as_paranoid
       ckeditor
       nokogiri (>= 1.11.0.rc4)
-      pagy
+      pagy (~> 5.10)
       pg (>= 1.2.3, < 1.6.0)
       pundit
       rails (~> 6.1.2, >= 6.1.2.1)
@@ -143,7 +143,7 @@ PATH
     shiny_profiles (21.06)
       acts_as_paranoid
       nokogiri (>= 1.11.0.rc4)
-      pagy
+      pagy (~> 5.10)
       pg (>= 1.2.3, < 1.6.0)
       pundit
       rails (~> 6.1.2, >= 6.1.2.1)
@@ -165,7 +165,7 @@ PATH
       algoliasearch-rails (~> 1.25)
       ckeditor
       nokogiri (>= 1.11.0.rc4)
-      pagy
+      pagy (~> 5.10)
       pg (>= 1.2.3, < 1.6.0)
       pg_search
       pundit
@@ -529,7 +529,8 @@ GEM
       parser
       sorbet-runtime (>= 0.5.9914)
       zeitwerk (>= 2.6.1)
-    pagy (4.11.0)
+    pagy (5.10.1)
+      activesupport
     parallel (1.24.0)
     parallel_tests (4.4.0)
       parallel

diff --git a/plugins/ShinyAccess/shiny_access.gemspec b/plugins/ShinyAccess/shiny_access.gemspec
@@ -50,7 +50,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'acts-as-taggable-on'
 
   # Pagination
-  spec.add_dependency 'pagy', '~> 4.11'
+  spec.add_dependency 'pagy', '~> 5.10'
 
   # HTML & XML parser
   spec.add_dependency 'nokogiri', '>= 1.11.0.rc4'

diff --git a/plugins/ShinyBlog/shiny_blog.gemspec b/plugins/ShinyBlog/shiny_blog.gemspec
@@ -50,7 +50,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'acts-as-taggable-on'
 
   # Pagination
-  spec.add_dependency 'pagy'
+  spec.add_dependency 'pagy', '~> 5.10'
 
   # CKEditor: WYSIWYG editor for admin area
   spec.add_dependency 'ckeditor'

diff --git a/plugins/ShinyCMS/app/public/controllers/concerns/shinycms/controller_base.rb b/plugins/ShinyCMS/app/public/controllers/concerns/shinycms/controller_base.rb
@@ -47,10 +47,12 @@ def set_view_paths
       end
 
       # Change pager link format from admin/action?page=3&items=12 to admin/action/page/3/items/12
-      def pagy_url_for( pagy, page )
+      # rubocop:disable Lint/UnusedMethodArgument
+      def pagy_url_for( pagy, page, absolute: false, html_escaped: false )
         params = request.query_parameters.merge( page: page, items: pagy.vars[:items], only_path: true )
         url_for( params )
       end
+      # rubocop:enable Lint/UnusedMethodArgument
 
       def recaptcha_v3_site_key
         ENV[ 'RECAPTCHA_V3_SITE_KEY' ]

diff --git a/plugins/ShinyCMS/config/initializers/pagy.rb b/plugins/ShinyCMS/config/initializers/pagy.rb
@@ -21,7 +21,7 @@
 
 # Countless extra (paginate without any count): https://ddnexus.github.io/pagy/extras/countless
 require 'pagy/extras/countless'
-# Pagy::VARS[:cycle] = false    # default
+# Pagy::DEFAULT[:cycle] = false    # default
 
 # Elasticsearch Rails extra: https://ddnexus.github.io/pagy/extras/elasticsearch_rails
 # require 'pagy/extras/elasticsearch_rails'
@@ -57,13 +57,13 @@
 # require 'pagy/extras/navs'
 
 # Multi size var used by the *_nav_js helpers: https://ddnexus.github.io/pagy/extras/navs#steps
-# Pagy::VARS[:steps] = { 0 => [2,3,3,2], 540 => [3,5,5,3], 720 => [5,7,7,5] }   # example
+# Pagy::DEFAULT[:steps] = { 0 => [2,3,3,2], 540 => [3,5,5,3], 720 => [5,7,7,5] }   # example
 
 ### Feature Extras
 
 # HTTP Headers extra: http://ddnexus.github.io/pagy/extras/headers
 # require 'pagy/extras/headers'
-# Pagy::VARS[:headers] = { page: 'Current-Page', items: 'Page-Items', count: 'Total-Count', pages: 'Total-Pages' }
+# Pagy::DEFAULT[:headers] = { page: 'Current-Page', items: 'Page-Items', count: 'Total-Count', pages: 'Total-Pages' }
 
 # Support extra: https://ddnexus.github.io/pagy/extras/support
 # Extra support for features like: incremental, infinite, auto-scroll pagination
@@ -72,40 +72,40 @@
 # Items extra: https://ddnexus.github.io/pagy/extras/items
 # Allow the client to request a custom number of items per page with an optional selector UI
 require 'pagy/extras/items'
-# Pagy::VARS[ :items_param ] = :items    # default
-# Pagy::VARS[ :max_items   ] = 100       # default
+# Pagy::DEFAULT[ :items_param ] = :items    # default
+# Pagy::DEFAULT[ :max_items   ] = 100       # default
 
 # Overflow extra: https://ddnexus.github.io/pagy/extras/overflow
 # require 'pagy/extras/overflow'
-# Pagy::VARS[:overflow] = :empty_page    # default  (other options: :last_page and :exception)
+# Pagy::DEFAULT[:overflow] = :empty_page    # default  (other options: :last_page and :exception)
 
 # Metadata (for JS frameworks) extra: https://ddnexus.github.io/pagy/extras/metadata
 # require 'pagy/extras/shared'
 # require 'pagy/extras/metadata'
-# Pagy::VARS[:metadata] = [:scaffold_url, :count, :page, :prev, :next, :last]  # example
+# Pagy::DEFAULT[:metadata] = [:scaffold_url, :count, :page, :prev, :next, :last]  # example
 
 # Trim extra: https://ddnexus.github.io/pagy/extras/trim
 # Remove page=1 param from links
 require 'pagy/extras/trim'
 
 ## Pagy Variables (https://ddnexus.github.io/pagy/api/pagy#variables)
 
-# All the Pagy::VARS are set for all the Pagy instances but can be overridden
+# All the Pagy::DEFAULT are set for all the Pagy instances but can be overridden
 # per instance by just passing them to Pagy.new or the #pagy controller method
 
 ### Instance variables (https://ddnexus.github.io/pagy/api/pagy#instance-variables)
 
 # TODO: pull this from settings, and allow different defaults for main site and admin area
-Pagy::VARS[ :items ] = 10
+Pagy::DEFAULT[ :items ] = 10
 
 ### Other Variables (https://ddnexus.github.io/pagy/api/pagy#other-variables)
 
-Pagy::VARS[ :size ] = [ 3, 3, 3, 3 ]
+Pagy::DEFAULT[ :size ] = [ 3, 3, 3, 3 ]
 
-# Pagy::VARS[:page_param] = :page                           # default
-# Pagy::VARS[:params]     = {}                              # default
-# Pagy::VARS[:anchor]     = '#anchor'                       # example
-# Pagy::VARS[:link_extra] = 'data-remote="true"'            # example
+# Pagy::DEFAULT[:page_param] = :page                           # default
+# Pagy::DEFAULT[:params]     = {}                              # default
+# Pagy::DEFAULT[:anchor]     = '#anchor'                       # example
+# Pagy::DEFAULT[:link_extra] = 'data-remote="true"'            # example
 
 ## Rails
 
@@ -139,4 +139,4 @@
 # require 'pagy/extras/i18n'
 
 # Default i18n key
-# Pagy::VARS[:i18n_key] = 'pagy.item_name'
+# Pagy::DEFAULT[:i18n_key] = 'pagy.item_name'
diff --git a/plugins/ShinyCMS/shinycms.gemspec b/plugins/ShinyCMS/shinycms.gemspec
@@ -84,7 +84,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'ckeditor'
 
   # Pagination
-  spec.add_dependency 'pagy', '~> 4.11'
+  spec.add_dependency 'pagy', '~> 5.10'
 
   # Atom feeds
   spec.add_dependency 'rss'

diff --git a/plugins/ShinyCMS/spec/support/shared_examples/shinycms/paging_example.rb b/plugins/ShinyCMS/spec/support/shared_examples/shinycms/paging_example.rb
@@ -82,5 +82,13 @@
         expect( response.body ).not_to have_css match_tag, text: items[10].public_send( match_text )
       end
     end
+
+    describe 'URL is correctly formatted in links' do
+      it 'has a link to see older items' do
+        get "#{base_url}/page/1/items/5"
+
+        expect( response.body ).to have_link 'Older', href: "#{base_url}/page/2/items/5"
+      end
+    end
   end
 end
diff --git a/plugins/ShinyForms/shiny_forms.gemspec b/plugins/ShinyForms/shiny_forms.gemspec
@@ -47,7 +47,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'acts_as_paranoid'
 
   # Pagination
-  spec.add_dependency 'pagy'
+  spec.add_dependency 'pagy', '~> 5.10'
 
   # HTML & XML parser
   spec.add_dependency 'nokogiri', '>= 1.11.0.rc4'

diff --git a/plugins/ShinyInserts/shiny_inserts.gemspec b/plugins/ShinyInserts/shiny_inserts.gemspec
@@ -47,7 +47,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'acts_as_paranoid'
 
   # Pagination
-  spec.add_dependency 'pagy'
+  spec.add_dependency 'pagy', '~> 5.10'
 
   # CKEditor: WYSIWYG editor for admin area
   spec.add_dependency 'ckeditor'

diff --git a/plugins/ShinyLists/shiny_lists.gemspec b/plugins/ShinyLists/shiny_lists.gemspec
@@ -47,7 +47,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'acts_as_paranoid'
 
   # Pagination
-  spec.add_dependency 'pagy'
+  spec.add_dependency 'pagy', '~> 5.10'
 
   # HTML & XML parser
   spec.add_dependency 'nokogiri', '>= 1.11.0.rc4'

diff --git a/plugins/ShinyNews/shiny_news.gemspec b/plugins/ShinyNews/shiny_news.gemspec
@@ -50,7 +50,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'acts-as-taggable-on'
 
   # Pagination
-  spec.add_dependency 'pagy'
+  spec.add_dependency 'pagy', '~> 5.10'
 
   # CKEditor: WYSIWYG editor for admin area
   spec.add_dependency 'ckeditor'

diff --git a/plugins/ShinyNewsletters/shiny_newsletters.gemspec b/plugins/ShinyNewsletters/shiny_newsletters.gemspec
@@ -47,7 +47,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'acts_as_paranoid'
 
   # Pagination
-  spec.add_dependency 'pagy'
+  spec.add_dependency 'pagy', '~> 5.10'
 
   # CKEditor: WYSIWYG editor for admin area
   spec.add_dependency 'ckeditor'

diff --git a/plugins/ShinyPages/shiny_pages.gemspec b/plugins/ShinyPages/shiny_pages.gemspec
@@ -47,7 +47,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'acts_as_paranoid'
 
   # Pagination
-  spec.add_dependency 'pagy'
+  spec.add_dependency 'pagy', '~> 5.10'
 
   # CKEditor: WYSIWYG editor for admin area
   spec.add_dependency 'ckeditor'

diff --git a/plugins/ShinyProfiles/shiny_profiles.gemspec b/plugins/ShinyProfiles/shiny_profiles.gemspec
@@ -47,7 +47,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'acts_as_paranoid'
 
   # Pagination
-  spec.add_dependency 'pagy'
+  spec.add_dependency 'pagy', '~> 5.10'
 
   # HTML & XML parser
   spec.add_dependency 'nokogiri', '>= 1.11.0.rc4'

diff --git a/plugins/ShinySearch/shiny_search.gemspec b/plugins/ShinySearch/shiny_search.gemspec
@@ -54,7 +54,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'acts-as-taggable-on'
 
   # Pagination
-  spec.add_dependency 'pagy'
+  spec.add_dependency 'pagy', '~> 5.10'
 
   # CKEditor: WYSIWYG editor for admin area
   spec.add_dependency 'ckeditor'