Replace kaminari with pagy (#681)

* Replace kaminari with pagy * Update pagy_helper.rb Add newline character for rubocop * change pagy params to a class constant * Updated syntax for rubocop
RefugeRestrooms · Oct 7, 2023 · e928fc2 · e928fc2
1 parent 39b4958
commit e928fc2
Show file tree

Hide file tree

Showing 15 changed files with 280 additions and 111 deletions.
diff --git a/Gemfile b/Gemfile
@@ -12,18 +12,17 @@ gem 'country_select'
 gem 'devise', '~> 4.8.1'
 gem 'geocoder', '~> 1.6.1'
 gem 'grape', '~> 1.6.2'
+gem 'grape-pagy'
 gem 'grape-swagger'
-gem 'grape-kaminari', '~> 0.4.3'
 gem 'haml'
 gem 'high_voltage', '~> 3.0.0'
 gem 'http_accept_language'
 gem 'jbuilder', '~> 2.5'
-gem 'kaminari', '~> 1.2.2'
-gem 'kaminari-grape', '~> 1.0'
 gem 'mail_form', '>= 1.7.0'
 gem 'net-smtp', require: false
 gem 'net-imap', require: false
 gem 'net-pop', require: false
+gem 'pagy'
 gem 'pg'
 gem 'pg_search'
 gem 'puma'

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -169,9 +169,9 @@ GEM
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-    grape-kaminari (0.4.3)
-      grape (>= 1.6.1)
-      kaminari-grape
+    grape-pagy (0.6.0)
+      grape (>= 1.5)
+      pagy (>= 6.0)
     grape-swagger (1.5.0)
       grape (~> 1.3)
     haml (6.0.4)
@@ -214,9 +214,6 @@ GEM
       activerecord
       kaminari-core (= 1.2.2)
     kaminari-core (1.2.2)
-    kaminari-grape (1.0.1)
-      grape
-      kaminari-core (~> 1.0)
     loofah (2.20.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -255,6 +252,7 @@ GEM
     nokogiri (1.14.3-x86_64-linux)
       racc (~> 1.4)
     orm_adapter (0.5.0)
+    pagy (6.0.4)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
@@ -440,19 +438,18 @@ DEPENDENCIES
   factory_bot_rails (~> 4.8.2)
   geocoder (~> 1.6.1)
   grape (~> 1.6.2)
-  grape-kaminari (~> 0.4.3)
+  grape-pagy
   grape-swagger
   haml
   high_voltage (~> 3.0.0)
   http_accept_language
   i18n-debug
   jbuilder (~> 2.5)
-  kaminari (~> 1.2.2)
-  kaminari-grape (~> 1.0)
   mail_form (>= 1.7.0)
   net-imap
   net-pop
   net-smtp
+  pagy
   pg
   pg_search
   poltergeist

diff --git a/app/controllers/api/v1/restrooms.rb b/app/controllers/api/v1/restrooms.rb
@@ -1,8 +1,9 @@
 module API
   module V1
     class Restrooms < Grape::API
-      include Grape::Kaminari
-      paginate per_page: 10, max_per_page: 100
+      PAGY_OPTIONS = { items_param: :per_page, items: 10, max_items: 100 }.freeze
+
+      helpers Grape::Pagy::Helpers
 
       version 'v1'
       format :json
@@ -11,6 +12,7 @@ class Restrooms < Grape::API
       resource :restrooms do
         desc "Get all restroom records ordered by date descending."
         params do
+          use :pagy, **PAGY_OPTIONS
           optional :ada, type: Boolean, desc: "Only return restrooms that are ADA accessible."
           optional :unisex, type: Boolean, desc: "Only return restrooms that are unisex."
         end
@@ -20,11 +22,12 @@ class Restrooms < Grape::API
           r = r.accessible if params[:ada].present?
           r = r.unisex if params[:unisex].present?
 
-          paginate(r.order(created_at: :desc))
+          pagy(r.order(created_at: :desc))
         end
 
         desc "Perform full-text search of restroom records."
         params do
+          use :pagy, **PAGY_OPTIONS
           optional :ada, type: Boolean, desc: "Only return restrooms that are ADA accessible."
           optional :unisex, type: Boolean, desc: "Only return restrooms that are unisex."
           requires :query, type: String, desc: "Your search query."
@@ -35,11 +38,12 @@ class Restrooms < Grape::API
           r = r.accessible if params[:ada].present?
           r = r.unisex if params[:unisex].present?
 
-          paginate(r.text_search(params[:query]))
+          pagy(r.text_search(params[:query]))
         end
 
         desc "Search by location."
         params do
+          use :pagy, **PAGY_OPTIONS
           optional :ada, type: Boolean, desc: "Only return restrooms that are ADA accessible."
           optional :unisex, type: Boolean, desc: "Only return restrooms that are unisex."
           requires :lat, type: Float, desc: "latitude"
@@ -50,11 +54,12 @@ class Restrooms < Grape::API
           r = r.current
           r = r.accessible if params[:ada].present?
           r = r.unisex if params[:unisex]
-          paginate(r.near([params[:lat], params[:lng]], 20, order: 'distance'))
+          pagy(r.near([params[:lat], params[:lng]], 20, order: 'distance'))
         end
 
         desc "Search for restroom records updated or created on or after a given date"
         params do
+          use :pagy, **PAGY_OPTIONS
           optional :ada, type: Boolean, desc: "Only return restrooms that are ADA accessible."
           optional :unisex, type: Boolean, desc: "Only return restrooms that are unisex."
           optional(
@@ -77,7 +82,7 @@ class Restrooms < Grape::API
               end
           r = r.accessible if params[:ada].present?
           r = r.unisex if params[:unisex].present?
-          paginate(r.order(created_at: :desc))
+          pagy(r.order(created_at: :desc))
         end
       end
       # rubocop:enable Metrics/BlockLength

diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
@@ -1,6 +1,8 @@
 class ApplicationController < ActionController::Base
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.
+  include Pagy::Backend
+
   protect_from_forgery with: :exception
 
   around_action :switch_locale

diff --git a/app/controllers/restrooms_controller.rb b/app/controllers/restrooms_controller.rb
@@ -104,15 +104,14 @@ def restrooms_filters
 
   # rubocop:disable Metrics/AbcSize
   def list_restrooms
-    @restrooms = Restroom.current.where(@filters).page(params[:page])
+    @restrooms = Restroom.current.where(@filters)
     @restrooms =
       if params[:search].present? || params[:map] == "1"
         @restrooms.near([params[:lat], params[:long]], 20, order: 'distance')
       else
         @restrooms.reverse_order
       end
-
-    @restrooms = @restrooms.out_of_range? ? @restrooms.page(1) : @restrooms
+    @pagy, @restrooms = pagy(@restrooms)[0].overflow? ? pagy(@restrooms, page: 1) : pagy(@restrooms)
   end
   # rubocop:enable Metrics/AbcSize
 

diff --git a/app/helpers/pagy_helper.rb b/app/helpers/pagy_helper.rb
@@ -0,0 +1,3 @@
+module PagyHelper
+  include Pagy::Frontend
+end
diff --git a/app/views/kaminari/_first_page.html.erb b/app/views/kaminari/_first_page.html.erb
diff --git a/app/views/kaminari/_gap.html.erb b/app/views/kaminari/_gap.html.erb
diff --git a/app/views/kaminari/_last_page.html.erb b/app/views/kaminari/_last_page.html.erb
diff --git a/app/views/kaminari/_next_page.html.erb b/app/views/kaminari/_next_page.html.erb
diff --git a/app/views/kaminari/_page.html.erb b/app/views/kaminari/_page.html.erb
diff --git a/app/views/kaminari/_paginator.html.erb b/app/views/kaminari/_paginator.html.erb
diff --git a/app/views/kaminari/_prev_page.html.erb b/app/views/kaminari/_prev_page.html.erb
diff --git a/app/views/restrooms/index.html.haml b/app/views/restrooms/index.html.haml
@@ -26,20 +26,20 @@
     .col-sm-12.headroom
       %ul{:class => "restrooms-list", :id => "list"}
         = render @restrooms
-        = paginate @restrooms
+        != pagy_nav @pagy
 / .row
 /   .col-xs-12.headroom
 /     .restrooms-index-content
 /       = content_tag 'div', id: 'map-container', data: { latitude: params[:lat], longitude: params[:long] } do
 /         #map-content
 /       .restrooms-list
 /         = render @restrooms
-/         = paginate @restrooms
+/         != pagy_nav @pagy
 
 
 / #results.headroom
 /   = content_tag 'div', id: 'mapContainer', data: { latitude: params[:lat], longitude: params[:long] } do
 /     #mapArea
 /   #list.restrooms-list
 /     = render @restrooms
-/     = paginate @restrooms
+/     != pagy_nav @pagy