Merge pull request #7915 from ministryofjustice/ctskf-486-kaminari-to…

…-pagy [CTSKF-486] Replace Kaminari with Pagy
ministryofjustice · Jan 7, 2025 · a1c7302 · a1c7302
2 parents ea03a9b + 0994d9f
commit a1c7302
Show file tree

Hide file tree

Showing 47 changed files with 342 additions and 159 deletions.
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -242,10 +242,11 @@ Metrics/AbcSize:
     - 'spec/support/seed_helpers.rb'
     - 'spec/support/validation_helpers.rb'
 
-# Offense count: 19
+# Offense count: 20
 # Configuration parameters: CountComments, Max, CountAsOne.
 Metrics/ClassLength:
   Exclude:
+    - 'app/controllers/case_workers/claims_controller.rb'
     - 'app/controllers/external_users/claims_controller.rb'
     - 'app/interfaces/api/entities/search_result.rb'
     - 'app/interfaces/api/v1/dropdown_data.rb'

diff --git a/Gemfile b/Gemfile
@@ -29,13 +29,13 @@ gem 'jquery-rails', '~> 4.6.0'
 gem 'json-schema',            '~> 5.1.1'
 gem 'jsbundling-rails'
 gem 'nokogiri',               '~> 1.18'
-gem 'kaminari',               '>= 1.2.1'
 gem 'libreconv',              '~> 0.9.5'
 gem 'logstasher',             '2.1.5'
 gem 'logstuff',               '0.0.2'
 gem 'net-imap'
 gem 'net-pop'
 gem 'net-smtp'
+gem 'pagy'
 gem 'paper_trail', '~> 16.0.0'
 gem 'pg',                     '~> 1.5.9'
 gem 'rails', '~> 7.0.8'

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -348,18 +348,6 @@ GEM
     jsonapi-renderer (0.2.2)
     jwt (2.10.1)
       base64
-    kaminari (1.2.2)
-      activesupport (>= 4.1.0)
-      kaminari-actionview (= 1.2.2)
-      kaminari-activerecord (= 1.2.2)
-      kaminari-core (= 1.2.2)
-    kaminari-actionview (1.2.2)
-      actionview
-      kaminari-core (= 1.2.2)
-    kaminari-activerecord (1.2.2)
-      activerecord
-      kaminari-core (= 1.2.2)
-    kaminari-core (1.2.2)
     laa-fee-calculator-client (2.0.0)
       faraday (~> 2.9)
       faraday-http-cache (~> 2.2)
@@ -435,6 +423,7 @@ GEM
       version_gem (~> 1.1)
     orm_adapter (0.5.0)
     ostruct (0.6.1)
+    pagy (9.3.3)
     paper_trail (16.0.0)
       activerecord (>= 6.1)
       request_store (~> 1.4)
@@ -739,7 +728,6 @@ DEPENDENCIES
   jsbundling-rails
   json-schema (~> 5.1.1)
   json_spec
-  kaminari (>= 1.2.1)
   laa-cda!
   laa-fee-calculator-client (~> 2.0)
   launchy (~> 3.0.1)
@@ -754,6 +742,7 @@ DEPENDENCIES
   net-smtp
   net-ssh (~> 7.3)
   nokogiri (~> 1.18)
+  pagy
   paper_trail (~> 16.0.0)
   parallel_tests
   pg (~> 1.5.9)

diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
@@ -4,6 +4,8 @@ class ApplicationController < ActionController::Base
   skip_forgery_protection if ENV.fetch('DISABLE_CSRF', nil) == '1'
 
   include CookieConcern
+  include Pagy::Backend
+
   before_action :set_default_cookie_usage
 
   helper_method :current_user_messages_count

diff --git a/app/controllers/case_workers/admin/allocations_controller.rb b/app/controllers/case_workers/admin/allocations_controller.rb
@@ -7,6 +7,7 @@ class AllocationsController < CaseWorkers::Admin::ApplicationController
       before_action :set_claims, only: %i[new create]
       before_action :set_summary_values, only: [:new], if: :summary_from_previous_request?
       before_action :process_claim_ids, only: [:create], if: :quantity_allocation?
+      before_action :sort_and_paginate
 
       def new
         @allocation = Allocation.new
@@ -88,7 +89,13 @@ def search_claims(states = nil)
       end
 
       def sort_and_paginate
-        @claims = @claims.sort_using(sort_column, sort_direction).page(current_page).per(page_size)
+        @claims = @claims.sort_using(sort_column, sort_direction) unless @claims.remote?
+        @pagy = Pagy.new(
+          count: @claims.total_count,
+          limit: @claims.limit_value,
+          page: @claims.current_page,
+          pages: @claims.total_pages
+        )
       end
 
       def allocation_params

diff --git a/app/controllers/case_workers/claims_controller.rb b/app/controllers/case_workers/claims_controller.rb
@@ -119,8 +119,13 @@ def search_terms
     end
 
     def sort_and_paginate
-      # GOTCHA: must paginate in same call that sorts/orders
-      @claims = @claims.sort_using(sort_column, sort_direction).page(current_page).per(page_size) unless @claims.remote?
+      @claims = @claims.sort_using(sort_column, sort_direction) unless @claims.remote?
+      @pagy = Pagy.new(
+        count: @claims.total_count,
+        limit: @claims.limit_value,
+        page: @claims.current_page,
+        pages: @claims.total_pages
+      )
     end
 
     def sort_claims

diff --git a/app/controllers/concerns/pagination_helpers.rb b/app/controllers/concerns/pagination_helpers.rb
@@ -14,6 +14,6 @@ def page_size
   end
 
   def current_page
-    params[:page].to_i
+    [params[:page].to_i, 1].max
   end
 end
diff --git a/app/controllers/external_users/claims_controller.rb b/app/controllers/external_users/claims_controller.rb
@@ -253,7 +253,8 @@ def sort_defaults(defaults = {})
 
     def sort_and_paginate(options = {})
       sort_defaults(options)
-      @claims = @claims.sort_using(sort_column, sort_direction).page(current_page).per(@sort_defaults[:pagination])
+      @pagy, @claims = pagy(@claims.sort_using(sort_column, sort_direction), page: current_page,
+                                                                             limit: @sort_defaults[:pagination])
     end
 
     def scheme

diff --git a/app/controllers/users_controller.rb b/app/controllers/users_controller.rb
@@ -31,7 +31,7 @@ class UsersController < ApplicationController
   include PaginationHelpers
 
   def index
-    @users = User.order(created_at: :desc).page(current_page).per(page_size)
+    @pagy, @users = pagy(User.order(created_at: :desc), page: current_page, limit: page_size)
   end
 
   def update_settings

diff --git a/app/helpers/application_helper.rb b/app/helpers/application_helper.rb
@@ -1,5 +1,6 @@
 module ApplicationHelper
   include GOVUKDesignSystemFormBuilder::BuilderHelper
+  include Pagy::Frontend
 
   def current_user_is_caseworker?
     current_user.persona.is_a?(CaseWorker)

diff --git a/app/interfaces/api/entities/paginated_collection.rb b/app/interfaces/api/entities/paginated_collection.rb
@@ -18,20 +18,24 @@ def items
         object[:items]
       end
 
+      def pagination
+        options[:pagy]
+      end
+
       def current_page
-        items.current_page
+        pagination.page
       end
 
       def total_pages
-        items.total_pages
+        pagination.pages
       end
 
       def total_count
-        items.total_count
+        pagination.count
       end
 
       def limit_value
-        items.limit_value
+        pagination.limit
       end
     end
   end

diff --git a/app/interfaces/api/v2/case_workers/claim.rb b/app/interfaces/api/v2/case_workers/claim.rb
@@ -51,6 +51,14 @@ def value_band_id
               params[:value_band_id]
             end
 
+            def page
+              params[:page]
+            end
+
+            def limit
+              params[:limit]
+            end
+
             def current_claims
               current_user.claims.where(id: ::Claim::BaseClaim.search(
                 search_terms, Claims::StateMachine::CASEWORKER_DASHBOARD_UNDER_ASSESSMENT_STATES, *search_options
@@ -82,19 +90,21 @@ def claims_scope
             end
 
             def claims
-              claims_scope
+              @pagy, @claims = pagy(claims_scope
                 .includes(:external_user, :case_type, :injection_attempts,
                           :case_workers, :court, :messages,
                           defendants: %i[representation_orders])
-                .sort_using(params[:sorting], params[:direction])
-                .page(params[:page]).per(params[:limit])
+                .sort_using(params[:sorting], params[:direction]),
+                                    page:, limit:)
+
+              @claims
             end
           end
 
           resource :claims do
             desc 'Retrieve list of allocated, unallocated or archived claims'
             get do
-              present claims, with: API::Entities::PaginatedCollection, user: current_user
+              present claims, with: API::Entities::PaginatedCollection, user: current_user, pagy: @pagy
             end
           end
         end

diff --git a/app/interfaces/api/v2/criteria_helper.rb b/app/interfaces/api/v2/criteria_helper.rb
@@ -1,6 +1,7 @@
 module API::V2
   module CriteriaHelper
     extend Grape::API::Helpers
+    include Pagy::Backend
 
     params :pagination do
       optional :page, type: Integer, desc: 'OPTIONAL: Current page.'

diff --git a/app/views/case_workers/admin/allocations/_re_allocation.html.haml b/app/views/case_workers/admin/allocations/_re_allocation.html.haml
@@ -35,7 +35,7 @@
               .govuk-grid-column-one-half
                 = t('.re_allocation')
               .govuk-grid-column-one-half.claim-count{ class: 'govuk-!-text-align-right' }
-                = t('.number_of_claims', claim_count: @claims.total_count)
+                = pagy_info(@pagy).html_safe
 
           = govuk_table_thead do
             = govuk_table_row do

diff --git a/app/views/case_workers/admin/allocations/new.html.haml b/app/views/case_workers/admin/allocations/new.html.haml
@@ -13,4 +13,4 @@
   .js-re-allocation-page
     = render partial: 're_allocation'
 
-  = paginate @claims
+  = render partial: 'shared/pagination'
diff --git a/app/views/case_workers/claims/_claims_list.html.haml b/app/views/case_workers/claims/_claims_list.html.haml
@@ -1,7 +1,7 @@
 .govuk-grid-row{class: 'govuk-!-margin-top-9'}
   .govuk-grid-column-full
     %p.govuk-body{class: 'claim-count govuk-!-text-align-right'}
-      = t('.number_of_claims', claim_count: claims.total_count)
+      = pagy_info(@pagy).html_safe
 
   .govuk-grid-column-full
     = govuk_table do

diff --git a/app/views/case_workers/claims/archived.html.haml b/app/views/case_workers/claims/archived.html.haml
@@ -4,4 +4,5 @@
 = render partial: 'layouts/header', locals: { page_heading: t('.page_heading')}
 = render partial: 'search_form', locals: { archived: true }
 = render partial: 'claims_list', locals: { claims: @claims }
-= paginate @claims
+
+= render partial: 'shared/pagination'
diff --git a/app/views/case_workers/claims/index.html.haml b/app/views/case_workers/claims/index.html.haml
@@ -4,4 +4,5 @@
 = render partial: 'layouts/header', locals: { page_heading: t('.page_heading') }
 = render partial: 'search_form', locals: { archived: false }
 = render partial: 'claims_list', locals: { claims: @claims }
-= paginate @claims
+
+= render partial: 'shared/pagination'
diff --git a/app/views/external_users/claims/_main_claims_list.html.haml b/app/views/external_users/claims/_main_claims_list.html.haml
@@ -7,7 +7,7 @@
         - if @claims.none?
           = t('shared.no_claims_found')
         - else
-          = "Showing #{pluralize(@claims.unscope(:order).size, 'claim')} of #{@claims.total_count}"
+          = pagy_info(@pagy).html_safe
           - if params[:search].present?
             = "matching #{params[:search]}"
 

diff --git a/app/views/external_users/claims/archived.html.haml b/app/views/external_users/claims/archived.html.haml
@@ -9,4 +9,4 @@
 
 #details
   = render partial: 'main_claims_list', locals: { claims: @claims }
-  = paginate @claims
+  = render partial: 'shared/pagination'
diff --git a/app/views/external_users/claims/authorised.html.haml b/app/views/external_users/claims/authorised.html.haml
@@ -5,9 +5,9 @@
 
 %p.govuk-heading-l
   %span.govuk-caption-l
-    = t('.with_total_assessed_value_of_html', size: @claims.unscope(:order).size, total: @claims.total_count)
+    = t('.with_total_assessed_value_of_html', size: @claims.unscope(:order).size, total: @pagy.count)
   = number_to_currency(@total_value)
 
 #details#listanchor
   = render partial: 'main_claims_list', locals: { claims: @claims }
-  = paginate @claims
+  = render partial: 'shared/pagination'
diff --git a/app/views/external_users/claims/index.html.haml b/app/views/external_users/claims/index.html.haml
@@ -19,4 +19,5 @@
 .importer-results{'aria-live': 'polite'}
 
 = render partial: 'main_claims_list', locals: { claims: @claims }
-= paginate @claims
+
+= render partial: 'shared/pagination'
diff --git a/app/views/external_users/claims/outstanding.html.haml b/app/views/external_users/claims/outstanding.html.haml
@@ -5,9 +5,9 @@
 
 %p.govuk-heading-l
   %span.govuk-caption-l
-    = t('.claims_value_html', size: @claims.unscope(:order).size, total: @claims.total_count)
+    = t('.claims_value_html', size: @claims.unscope(:order).size, total: @pagy.count)
   = number_to_currency(@total_value)
 
 #details#listanchor
   = render partial: 'main_claims_list', locals: { claims: @claims }
-  = paginate @claims
+  = render partial: 'shared/pagination'
diff --git a/app/views/kaminari/_first_page.html.haml b/app/views/kaminari/_first_page.html.haml
diff --git a/app/views/kaminari/_gap.html.haml b/app/views/kaminari/_gap.html.haml
diff --git a/app/views/kaminari/_last_page.html.haml b/app/views/kaminari/_last_page.html.haml
diff --git a/app/views/kaminari/_next_page.html.haml b/app/views/kaminari/_next_page.html.haml
diff --git a/app/views/kaminari/_page.html.haml b/app/views/kaminari/_page.html.haml
diff --git a/app/views/kaminari/_paginator.html.haml b/app/views/kaminari/_paginator.html.haml
diff --git a/app/views/kaminari/_prev_page.html.haml b/app/views/kaminari/_prev_page.html.haml