refactor: replace will_paginate with pagy

Author: Lewis Youl

Gemfile

@@ -22,9 +22,10 @@ gem 'active_model_serializers', '~> 0.10.0'
 
 gem 'byebug'
 
+gem 'pagy', '~> 3.5'
+
 gem "devise", github: "heartcombo/devise", branch: "master"
 gem "aws-sdk-s3", require: false
-gem 'will_paginate', '~> 3.1.0'
 gem 'redis'
 gem 'omniauth-github'
 gem 'omniauth-rails_csrf_protection'

Gemfile.lock

@@ -165,6 +165,7 @@ GEM
       actionpack (>= 4.2)
       omniauth (~> 2.0)
     orm_adapter (0.5.0)
+    pagy (3.11.0)
     pg (1.2.3)
     public_suffix (4.0.6)
     puma (4.3.3)
@@ -257,7 +258,6 @@ GEM
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.4)
-    will_paginate (3.1.8)
     zeitwerk (2.3.0)
 
 PLATFORMS
@@ -274,6 +274,7 @@ DEPENDENCIES
   listen (>= 3.0.5, < 3.2)
   omniauth-github
   omniauth-rails_csrf_protection
+  pagy (~> 3.5)
   pg (>= 0.18, < 2.0)
   puma (~> 4.1)
   rails (~> 6.0.2, >= 6.0.2.2)
@@ -286,7 +287,6 @@ DEPENDENCIES
   tzinfo-data
   web-console (>= 3.3.0)
   webpacker (~> 4.0)
-  will_paginate (~> 3.1.0)
 
 RUBY VERSION
    ruby 2.6.6p146

app/controllers/application_controller.rb

@@ -1,4 +1,6 @@
 class ApplicationController < ActionController::Base
+  include Pagy::Backend
+
   respond_to :html, :json
   serialization_scope :view_context
   before_action :configure_permitted_parameters, if: :devise_controller?

app/controllers/folders_controller.rb

@@ -16,18 +16,18 @@ def popover
   def index
     @snippets = Snippet.last(5)
 
-    @folders = current_user.folders
-    @folders = @folders.where('name ILIKE ?', "%#{params[:search]}%") if params[:search].present?
-    @folders = @folders
-      .order(name: :asc)
-      .paginate(page: params[:page] || 1, per_page: 30)
+    folders = current_user.folders
+    folders = folders.where('name ILIKE ?', "%#{params[:search]}%") if params[:search].present?
+    folders = folders.order(name: :asc)
+
+    @pagy, @folders = pagy(folders, items: 30)
 
     respond_to do |format|
       format.html
       format.json do
         render json: {
           entries: render_to_string(partial: 'folders/folders', locals: { folders: @folders }, formats: [:html]),
-          pagination: view_context.will_paginate(@folders)
+          pagination: view_context.pagy_nav(@pagy)
         }
       end
     end
@@ -43,14 +43,15 @@ def show
 
     @snippets = @snippets
       .order(created_at: :desc)
-      .paginate(page: params[:page] || 1, per_page: 6)
+
+      @pagy, @snippets = pagy(@snippets, items: 6)
 
     respond_to do |format|
       format.html
       format.json do
         render json: {
           entries: render_to_string(partial: 'snippets/snippets', formats: [:html]),
-          pagination: view_context.will_paginate(@snippets)
+          pagination: view_context.pagy_nav(@pagy)
         }
       end
     end

app/controllers/home_controller.rb

@@ -1,53 +1,56 @@
 class HomeController < ApplicationController
+  SNIPPETS_PER_PAGE = 6.freeze
+  CONNECT_USERS_PER_PAGE = 16.freeze
+
   def index
     @page_title = 'Home'
     @display_popover = true
 
     @languages = Language.order(name: :asc).to_json
 
-    if user_signed_in?
+    snippets = if user_signed_in?
       @snippets = current_user
         .snippets_for_feed
         .includes(:language)
-        .paginate(page: params[:page] || 1, per_page: 6)
     else
       # temp fix for when user not signed in
-      @snippets = Snippet
+      Snippet
         .public_snippets
         .includes(:user, :language)
         .order(created_at: :desc)
-        .paginate(page: params[:page] || 1, per_page: 6)
     end
 
+    @pagy, @snippets = pagy(snippets, items: SNIPPETS_PER_PAGE)
+
     respond_to do |format|
       format.html
       format.json do
         render json: {
           entries: render_to_string(partial: 'snippets/snippets', formats: [:html]),
-          pagination: view_context.will_paginate(@snippets)
+          pagination: view_context.pagy_nav(@pagy)
         }
       end
     end
   end
 
   def connect
-    @users = if user_signed_in?
+    users = if user_signed_in?
       current_user.not_following
-      .paginate(page: params[:page] || 1, per_page: 16)
     else
       User.order(updated_at: :desc)
-      .paginate(page: params[:page] || 1, per_page: 16)
     end
 
     # TODO: Extract this logic to model/service
-    @users = @users.where('name ILIKE ?', "%#{params[:search]}%") if params[:search]
+    users = users.where('name ILIKE ?', "%#{params[:search]}%") if params[:search]
+
+    @pagy, @users = pagy(users, items: CONNECT_USERS_PER_PAGE)
 
     respond_to do |format|
       format.html
       format.json do
         render json: {
           entries: render_to_string(partial: 'users/follow_previews', formats: [:html]),
-          pagination: view_context.will_paginate(@users)
+          pagination: view_context.pagy_nav(@pagy)
         }
       end
     end

app/controllers/snippets_controller.rb

@@ -2,7 +2,7 @@ class SnippetsController < ApplicationController
   before_action :authenticate_user!, except: :show
 
   def index
-    @page_title = 'Stanley / Snippet'
+    @page_title = 'Snippet'
     @user = User.find_by(id: params[:user_id]) || current_user
     @display_popover = true
     @snippets = @user.filed_snippets.includes(:user, :folders)
@@ -11,9 +11,9 @@ def index
     # TODO: Extract this logic to model/service
     @snippets = @snippets.where('description ILIKE ?', "%#{params[:search]}%") if params[:search]
 
-    @snippets = @snippets
-      .order(created_at: :desc)
-      .paginate(page: params[:page] || 1, per_page: 6)
+    @snippets = @snippets.order(created_at: :desc)
+    
+    @pagy, @snippets = pagy(@snippets, items: 6)
 
     respond_to do |format|
       format.html do
@@ -22,7 +22,7 @@ def index
       format.json do
         render json: {
           entries: render_to_string(partial: 'snippets/snippets', formats: [:html]),
-          pagination: view_context.will_paginate(@snippets)
+          pagination: view_context.pagy_nav(@pagy)
         }
       end
     end

app/controllers/users_controller.rb

@@ -6,27 +6,48 @@ def index
   end
 
   def show
-    @user = User.find_by(id: params[:id])
-    @page_title = "#{@user.name}"
-    @serialized_user = @user.serialize.to_json
-    @is_following = current_user ? current_user.following?(@user) : false
-    @followers = @user.followers
-    @following = @user.following
-    @display_popover = true
-    @languages = Language.all.to_json
-
-    # need to change current implementation to hit specific user snippets endpoint so can optionally show private ones
-    if @user == current_user
-      @snippets = @user.filed_snippets
-        .order(created_at: :desc)
-        .paginate(page: 1, per_page: 6)
-    else
-      @snippets = @user.filed_snippets.public_snippets
-        .order(created_at: :desc)
-        .paginate(page: 1, per_page: 6)
-    end
+    respond_to do |format|
+      format.html do
+        @user = User.find_by(id: params[:id])
+        @page_title = "#{@user.name}"
+        @serialized_user = @user.serialize.to_json
+        @is_following = current_user ? current_user.following?(@user) : false
+        @followers = @user.followers
+        @following = @user.following
+        @display_popover = true
+        @languages = Language.all.to_json
+    
+        # need to change current implementation to hit specific user snippets endpoint so can optionally show private ones
+        snippets = if @user == current_user
+          @user.filed_snippets
+            .order(created_at: :desc)
+        else
+          @user.filed_snippets.public_snippets
+            .order(created_at: :desc)
+        end
+    
+        @pagy, @snippets = pagy(snippets, items: 6)
+    
+        @tab_id = params[:tab_id] || :snippets
+      end
+
+      format.json do
+        @user = User.find_by(id: params[:id])
+        @snippets = @user.filed_snippets.includes(:user, :folders)
+        @languages = Language.all.to_json
 
-    @tab_id = params[:tab_id] || :snippets
+        # TODO: Extract this logic to model/service
+        @snippets = @snippets.where('description ILIKE ?', "%#{params[:search]}%") if params[:search]
+
+        @snippets = @snippets.order(created_at: :desc)
+        
+        @pagy, @snippets = pagy(@snippets, items: 6)
+        render json: {
+          entries: render_to_string(partial: 'snippets/snippets', formats: [:html]),
+          pagination: view_context.pagy_nav(@pagy)
+        }
+      end
+    end
   end
 
   def hovercard

app/helpers/application_helper.rb

@@ -1,4 +1,6 @@
 module ApplicationHelper
+  include Pagy::Frontend
+
   def tabs_class_for_active_tab(tab_id, param_tab_id)
     "tabs--header-active" if tab_id.to_sym == param_tab_id.to_sym
   end

app/views/folders/index.html.erb

@@ -46,6 +46,6 @@
   </div>
 
   <div data-infinite-scroll-window-target="pagination" class="hidden">
-    <%= will_paginate @folders, container: false %>
+    <%== pagy_nav(@pagy) %>
   </div>
 </div>

app/views/folders/show.html.erb

@@ -25,6 +25,6 @@
   </div>
 
   <div data-infinite-scroll-window-target="pagination" class="hidden">
-    <%= will_paginate @snippets, container: false %>
+    <%== pagy_nav(@pagy) %>
   </div>
 </div>

app/views/home/index.html.erb

@@ -9,6 +9,6 @@
   </div>
 
   <div data-infinite-scroll-window-target="pagination" class="hidden">
-    <%= will_paginate @snippets, container: false %>
+    <%== pagy_nav(@pagy) %>
   </div>
 </div>

app/views/infinite_scroll/_basic_list.html.erb

@@ -5,5 +5,5 @@
 <% end %>
 
 <div data-infinite-scroll-window-target="pagination" class="hidden">
-  <%= will_paginate @users, container: false %>
+  <%== pagy_nav(@pagy) %>
 </div>

app/views/snippets/index.html.erb

@@ -21,6 +21,6 @@
   </div>
 
   <div data-infinite-scroll-window-target="pagination" class="hidden">
-    <%= will_paginate @snippets, container: false %>
+    <%== pagy_nav(@pagy) %>
   </div>
 </div>

app/views/users/show.html.erb

@@ -59,7 +59,7 @@
         </div>
 
         <div data-infinite-scroll-window-target="pagination" class="hidden">
-          <%= will_paginate @snippets, container: false, params: { controller: "snippets", action: "index" } %>
+          <%== pagy_nav(@pagy) %>
         </div>
       </div>
     </div>