Bump to pagy 43.x

n-rodriguez · n-rodriguez · commit 331d3cd0fa94 · 2025-11-20T00:34:54.000+01:00
diff --git a/Gemfile b/Gemfile
@@ -30,3 +30,5 @@ gem 'rubocop-performance', require: false
 gem 'rubocop-rake',        require: false
 gem 'rubocop-rspec',       require: false
 gem 'rubocop-rspec_rails', require: false
+
+gem 'pagy', git: 'https://github.com/ddnexus/pagy.git', branch: 'dev'
diff --git a/app/views/smart_listing/_pagination.html.erb b/app/views/smart_listing/_pagination.html.erb
@@ -1,25 +1,25 @@
 <%#
-  This template is i18n-ready: if you don't use i18n, then you can replace the pagy_t
+  This template is i18n-ready: if you don't use i18n, then you can replace the Pagy::I18n.translate
   calls with the actual strings ("&lsaquo; Prev", "Next &rsaquo;", "&hellip;").
 
   The link variable is set to a proc that returns the link tag.
   Usage: link.call( page_number [, text [, extra_attributes_string ]])
 -%>
-<% link = pagy_anchor(pagy, anchor_string: (remote ? 'data-remote="true"' : '')) -%>
+<% link = pagy.send(:a_lambda, anchor_string: (remote ? 'data-remote="true"' : '')) -%>
 <%#                            -%><div class="m-lg">
 <%#                            -%><nav aria-label="pager"  class="pagy-bootstrap-nav text-center" role="navigation">
 <%#                            -%>  <ul class="pagination justify-content-center">
-<% if pagy.prev                -%>    <li class="page-item prev"><%== link.call(pagy.prev, pagy_t('pagy.aria_label.prev'), aria_label: 'previous') %></li>
-<% else                        -%>    <li class="page-item prev disabled"><a href="#" class="page-link"><%== pagy_t('pagy.aria_label.prev') %></a></li>
+<% if pagy.previous            -%>    <li class="page-item prev"><%== link.call(pagy.previous, Pagy::I18n.translate('pagy.aria_label.previous'), aria_label: 'previous') %></li>
+<% else                        -%>    <li class="page-item prev disabled"><a href="#" class="page-link"><%== Pagy::I18n.translate('pagy.aria_label.previous') %></a></li>
 <% end                         -%>
-<% pagy.series.each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36] -%>
+<% pagy.send(:series).each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36] -%>
 <%   if    item.is_a?(Integer) -%>    <li class="page-item"><%== link.call(item) %></li>
 <%   elsif item.is_a?(String)  -%>    <li class="page-item active"><%== link.call(item, classes: 'page-link') %></li>
-<%   elsif item == :gap        -%>    <li class="page-item disabled gap"><a href="#" class="page-link"><%== pagy_t('pagy.gap') %></a></li>
+<%   elsif item == :gap        -%>    <li class="page-item disabled gap"><a href="#" class="page-link"><%== Pagy::I18n.translate('pagy.gap') %></a></li>
 <%   end                       -%>
 <% end                         -%>
-<% if pagy.next                -%>    <li class="page-item next"><%== link.call(pagy.next, pagy_t('pagy.aria_label.next'), aria_label: 'next') %></li>
-<% else                        -%>    <li class="page-item next disabled"><a href="#" class="page-link"><%== pagy_t('pagy.aria_label.next') %></a></li>
+<% if pagy.next                -%>    <li class="page-item next"><%== link.call(pagy.next, Pagy::I18n.translate('pagy.aria_label.next'), aria_label: 'next') %></li>
+<% else                        -%>    <li class="page-item next disabled"><a href="#" class="page-link"><%== Pagy::I18n.translate('pagy.aria_label.next') %></a></li>
 <% end                         -%>
 <%#                            -%>  </ul>
 <%#                            -%></nav>
diff --git a/gemfiles/rails_7.2.gemfile b/gemfiles/rails_7.2.gemfile
@@ -25,6 +25,7 @@ gem "rubocop-performance", require: false
 gem "rubocop-rake", require: false
 gem "rubocop-rspec", require: false
 gem "rubocop-rspec_rails", require: false
+gem "pagy", git: "https://github.com/ddnexus/pagy.git", branch: "dev"
 gem "rails", "~> 7.2.0"
 
 gemspec path: "../"
diff --git a/gemfiles/rails_8.0.gemfile b/gemfiles/rails_8.0.gemfile
@@ -25,6 +25,7 @@ gem "rubocop-performance", require: false
 gem "rubocop-rake", require: false
 gem "rubocop-rspec", require: false
 gem "rubocop-rspec_rails", require: false
+gem "pagy", git: "https://github.com/ddnexus/pagy.git", branch: "dev"
 gem "rails", "~> 8.0.0"
 
 gemspec path: "../"
diff --git a/gemfiles/rails_8.1.gemfile b/gemfiles/rails_8.1.gemfile
@@ -25,6 +25,7 @@ gem "rubocop-performance", require: false
 gem "rubocop-rake", require: false
 gem "rubocop-rspec", require: false
 gem "rubocop-rspec_rails", require: false
+gem "pagy", git: "https://github.com/ddnexus/pagy.git", branch: "dev"
 gem "rails", "~> 8.1.0"
 
 gemspec path: "../"
diff --git a/lib/smart_listing.rb b/lib/smart_listing.rb
@@ -2,7 +2,8 @@
 
 # require external dependencies
 require 'pagy'
-require 'pagy/extras/array'
+require 'pagy/toolbox/helpers/support/series'
+require 'pagy/toolbox/helpers/support/a_lambda'
 require 'zeitwerk'
 
 # load zeitwerk
diff --git a/lib/smart_listing/base.rb b/lib/smart_listing/base.rb
@@ -2,15 +2,16 @@
 
 module SmartListing
   class Base
-    include Pagy::Backend
+    include Pagy::Method
 
     attr_reader :name, :collection, :options, :per_page, :sort, :page, :count, :params, :pagy_collection
 
     # Params that should not be visible in pagination links (pages, per-page, sorting, etc.)
     UNSAFE_PARAMS = %i[authenticity_token commit utf8 _method script_name].freeze
 
-    def initialize(name, collection, options = {})
+    def initialize(name, collection, view_context, options = {})
       @name = name
+      @view_context = view_context
       @pagy_collection = nil
 
       config_profile = options.delete(:config_profile)
@@ -53,7 +54,7 @@ def setup(params, cookies)
       end
 
       sort!(@options[:array])
-      paginate!(@options[:array])
+      paginate!
     end
     # rubocop:enable Layout/LineLength
 
@@ -117,6 +118,10 @@ def base_param
       "#{name}_smart_listing"
     end
 
+    def request
+      @view_context.request
+    end
+
     private
 
     def get_param(key, store = @params)
@@ -162,16 +167,20 @@ def sort!(is_array)
       is_array ? sort_array : sort_active_record
     end
 
-    def paginate!(is_array)
+    def paginate!
       return unless @options[:paginate] && @per_page > 0
 
-      params = pagy_options.fetch(:params, {}).merge(smart_listing_name: name)
+      root_key = :"#{name}_smart_listing"
+      sort     = @view_context.params.dig(root_key, :sort)&.to_unsafe_h
+      params   = pagy_options.fetch(:params, {}).merge(smart_listing_name: name)
+      querify  = ->(p) { merge_params(p, params, root_key, sort) }
 
-      if is_array
-        @pagy_collection, @collection = pagy_array(@collection, page: @page, limit: @per_page, params: params)
-      else
-        @pagy_collection, @collection = pagy(@collection, page: @page, limit: @per_page, params: params)
-      end
+      @pagy_collection, @collection = pagy(:offset, @collection, page: @page, limit: @per_page, root_key: root_key, querify: querify)
+    end
+
+    def merge_params(pagy_params, params, root_key, sort)
+      pagy_params[root_key][:sort] = sort if sort
+      pagy_params.merge!(params)
     end
 
     def sort_array
diff --git a/lib/smart_listing/builder.rb b/lib/smart_listing/builder.rb
@@ -15,7 +15,7 @@ def name
     end
 
     def paginate(_options = {})
-      return unless @smart_listing.pagy_collection.series.size > 1
+      return unless @smart_listing.pagy_collection.send(:series).size > 1
 
       render(partial: @smart_listing.pagy_options[:partial], locals: { pagy: @smart_listing.pagy_collection, remote: @smart_listing.remote? }).html_safe
     end
diff --git a/lib/smart_listing/controller_helper.rb b/lib/smart_listing/controller_helper.rb
@@ -16,7 +16,7 @@ def smart_listing_create(*args)
       view_context = respond_to?(:controller) ? controller.view_context : self.view_context
       options = { config_profile: view_context.smart_listing_config_profile }.merge(options)
 
-      list = SmartListing::Base.new(name, collection, options)
+      list = SmartListing::Base.new(name, collection, view_context, options)
       list.setup(params, cookies)
 
       @smart_listings ||= {}
diff --git a/lib/smart_listing/view_helper.rb b/lib/smart_listing/view_helper.rb
@@ -2,7 +2,6 @@
 
 module SmartListing
   module ViewHelper
-    include Pagy::Frontend
 
     def smart_listing_config_profile
       defined?(super) ? super : :default
@@ -115,14 +114,6 @@ def smart_listing_limit_left(name)
       smart_listing.max_count - smart_listing.count
     end
 
-    def pagy_url_for(pagy, page, absolute: false) # rubocop:disable Lint/UnusedMethodArgument
-      list = pagy.vars[:params][:smart_listing_name]
-      url_params = params.to_unsafe_h.merge(pagy.vars[:params])
-      url_params[:"#{list}_smart_listing"] ||= {}
-      url_params[:"#{list}_smart_listing"][pagy.vars[:page_param]] = page
-      url_for(url_params)
-    end
-
     #################################################################################################
     # JS helpers:
 
diff --git a/smart_listing.gemspec b/smart_listing.gemspec
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
 
   s.files = Dir['README.md', 'Changed.md', 'LICENSE', 'lib/**/*.rb', 'config/**/*.yml', 'app/**/*.rb', 'app/**/*.erb']
 
-  s.add_dependency 'pagy', '~> 9.4.0'
+  s.add_dependency 'pagy', '>= 43.0'
   s.add_dependency 'rails', '>= 7.0'
   s.add_dependency 'zeitwerk'
 end
diff --git a/spec/lib/smart_listing/base_spec.rb b/spec/lib/smart_listing/base_spec.rb
@@ -3,11 +3,39 @@
 require 'spec_helper'
 
 RSpec.describe SmartListing::Base do
+  let(:view_context) { instance_double(ActionView::Base) }
+  let(:request) { instance_double(ActionDispatch::Request) }
+
+  def set_expectations
+    allow(view_context).to receive_messages(params: {}, request: request)
+    allow(request).to receive_messages(
+      base_url: 'http://example.com',
+      path: '/paginate',
+      GET: {},
+      POST: {},
+      cookies: {}
+    )
+  end
+
+  def check_expectations
+    expect(view_context).to have_received(:params)
+    expect(request).to have_received(:base_url)
+    expect(request).to have_received(:path)
+    expect(request).to have_received(:GET)
+    expect(request).to have_received(:POST)
+    expect(request).to have_received(:cookies)
+    expect(view_context).to have_received(:request)
+  end
+
+  before(mock_view_context: true) { set_expectations }
+  after(mock_view_context: true)  { check_expectations }
+
+
   def build_list(options: {})
-    SmartListing::Base.new(:users, User.all, options)
+    SmartListing::Base.new(:users, User.all, view_context, options)
   end
 
-  describe '#per_page' do
+  describe '#per_page', mock_view_context: true do
     context 'when there is no specification in params or cookies' do
       it 'take first value in the page sizes' do
         options = { page_sizes: [1] }
@@ -68,7 +96,7 @@ def build_list(options: {})
     end
 
     context 'when the per page value is at 0' do
-      context 'when the unlimited per page option is enabled' do
+      context 'when the unlimited per page option is enabled', mock_view_context: false do
         it 'set the per page at 0' do
           options = { page_sizes: [1, 2], unlimited_per_page: true }
           list = build_list(options: options)
@@ -104,7 +132,7 @@ def build_list(options: {})
     end
   end
 
-  describe '#sort' do
+  describe '#sort', mock_view_context: true do
     context 'when there is a value in params' do
       it 'set sort with the given value' do
         list = build_list
@@ -128,7 +156,7 @@ def build_list(options: {})
     end
   end
 
-  describe '#page' do
+  describe '#page', mock_view_context: true do
     context 'when the page is in the range' do
       it 'set the value with the given params' do
         User.create
@@ -156,7 +184,7 @@ def build_list(options: {})
     end
   end
 
-  describe '#collection' do
+  describe '#collection', mock_view_context: true do
     context 'when the collection is an array' do
       it 'sort the collection by the first attribute' do
         user1 = User.create(name: '1')
