Remove JavaScript library jquery-pjax (#3435)

mshibuya · mshibuya · commit 44451f27e10d · 2022-01-16T19:10:18.000+09:00
* Remove JavaScript library jquery-pjax The library is no longer maintained and has not received a new release since May 20, 2017. See https://github.com/defunkt/jquery-pjax > Status of this project > > jquery-pjax is largely unmaintained at this point. This also removes the Ruby gem rack-pjax which is also no longer maintained and has not received a new release since Mar 24, 2019. This is work towards the goal of dropping jQuery in favor of more vanilla JavaScript solutions. As a dependency using jQuery, pjax was a barrier toward this goal. jquery-pjax was originally introduced in 645d678 (Nov 16, 2011). Presumably as a page loading optimization, however it is not strictly necessary to achieve the set of RailsAdmin features. After many years of improvements in browser caching, loading, and JavaScript evaluation it is unclear if this optimization is still necessary for a good UX. Refs #2893
diff --git a/app/assets/javascripts/rails_admin.js b/app/assets/javascripts/rails_admin.js
@@ -1,6 +1,5 @@
 //=  require 'rails-ujs'
 //=  require 'rails_admin/jquery3'
-//=  require 'rails_admin/jquery.pjax'
 //=  require 'jquery_nested_form'
 //=  require 'rails_admin/jquery-ui/effect'
 //=  require 'rails_admin/jquery-ui/widgets/sortable'
diff --git a/app/controllers/rails_admin/main_controller.rb b/app/controllers/rails_admin/main_controller.rb
@@ -4,8 +4,6 @@ class MainController < RailsAdmin::ApplicationController
     include RailsAdmin::MainHelper
     include RailsAdmin::ApplicationHelper
 
-    layout :get_layout
-
     before_action :check_for_cancel
 
     def bulk_action
@@ -56,10 +54,6 @@ def respond_to_missing?(sym, include_private)
       end
     end
 
-    def get_layout
-      "rails_admin/#{request.headers['X-PJAX'] ? 'pjax' : 'application'}"
-    end
-
     def back_or_index
       params[:return_to].presence && params[:return_to].include?(request.host) && (params[:return_to] != request.fullpath) ? params[:return_to] : index_path
     end
diff --git a/app/helpers/rails_admin/application_helper.rb b/app/helpers/rails_admin/application_helper.rb
@@ -87,7 +87,7 @@ def root_navigation
           url = rails_admin.url_for(action: node.action_name, controller: 'rails_admin/main')
           nav_icon = node.link_icon ? %(<i class="#{node.link_icon}"></i>).html_safe : ''
           content_tag :li do
-            link_to nav_icon + " " + wording_for(:menu, node), url, class: "nav-link pjax"
+            link_to nav_icon + " " + wording_for(:menu, node), url, class: "nav-link"
           end
         end.join.html_safe
         label ||= t('admin.misc.root_navigation')
@@ -114,7 +114,7 @@ def navigation(parent_groups, nodes, level = 0)
         level_class = " nav-level-#{level}" if level > 0
         nav_icon = node.navigation_icon ? %(<i class="#{node.navigation_icon}"></i>).html_safe : ''
         li = content_tag :li, data: {model: model_param} do
-          link_to nav_icon + node.label_plural, url, class: "nav-link pjax#{level_class}"
+          link_to nav_icon + node.label_plural, url, class: "nav-link#{level_class}"
         end
         child_nodes = parent_groups[abstract_model.model_name]
         child_nodes ? li + navigation(parent_groups, child_nodes, level + 1) : li
@@ -134,7 +134,7 @@ def breadcrumb(action = @action, _acc = [])
             if current_action?(a, am, o)
               wording_for(:breadcrumb, a, am, o)
             elsif a.http_methods.include?(:get)
-              link_to rails_admin.url_for(action: a.action_name, controller: 'rails_admin/main', model_name: am.try(:to_param), id: (o.try(:persisted?) && o.try(:id) || nil)), class: 'pjax' do
+              link_to rails_admin.url_for(action: a.action_name, controller: 'rails_admin/main', model_name: am.try(:to_param), id: (o.try(:persisted?) && o.try(:id) || nil)) do
                 wording_for(:breadcrumb, a, am, o)
               end
             else
@@ -162,7 +162,7 @@ def menu_for(parent, abstract_model = nil, object = nil, only_icon = false)
               else
                 'javascript:void(0)'
               end
-            content_tag(:a, label, {href: href, target: action.link_target, class: ['nav-link', action.pjax? && 'pjax', current_action?(action) && 'active', !action.enabled? && 'disabled'].compact})
+            content_tag(:a, label, {href: href, target: action.link_target, class: ['nav-link', current_action?(action) && 'active', !action.enabled? && 'disabled'].compact})
           else
             content_tag(:span, label)
           end
diff --git a/app/views/kaminari/ra-twitter-bootstrap/_next_page.html.erb b/app/views/kaminari/ra-twitter-bootstrap/_next_page.html.erb
@@ -4,6 +4,6 @@
   </li>
 <% else %>
   <li class="page-item next">
-    <%= link_to raw(t 'admin.pagination.next'), url, class: ['page-link', ('pjax' if remote)].compact %>
+    <%= link_to raw(t 'admin.pagination.next'), url, class: 'page-link' %>
   </li>
 <% end %>
diff --git a/app/views/kaminari/ra-twitter-bootstrap/_page.html.erb b/app/views/kaminari/ra-twitter-bootstrap/_page.html.erb
@@ -1,9 +1,9 @@
 <% if page.current? %>
   <li class="page-item active">
-    <%= link_to page, url, class: ['page-link', ('pjax' if remote)].compact %>
+    <%= link_to page, url, class: 'page-link' %>
   </li>
 <% else %>
   <li class="page-item">
-    <%= link_to page, url, class: ['page-link', ('pjax' if remote)].compact %>
+    <%= link_to page, url, class: 'page-link' %>
   </li>
 <% end %>
diff --git a/app/views/kaminari/ra-twitter-bootstrap/_prev_page.html.erb b/app/views/kaminari/ra-twitter-bootstrap/_prev_page.html.erb
@@ -4,6 +4,6 @@
   </li>
 <% else %>
   <li class="page-item prev">
-    <%= link_to raw(t 'admin.pagination.previous'), url, class: ['page-link', ('pjax' if remote)].compact %>
+    <%= link_to raw(t 'admin.pagination.previous'), url, class: 'page-link' %>
   </li>
 <% end %>
diff --git a/app/views/kaminari/ra-twitter-bootstrap/without_count/_next_page.html.erb b/app/views/kaminari/ra-twitter-bootstrap/without_count/_next_page.html.erb
@@ -4,6 +4,6 @@
   </li>
 <% else %>
   <li class="page-item next">
-    <%= link_to raw(t 'admin.pagination.next'), url, class: ['page-link', ('pjax' if remote)].compact %>
+    <%= link_to raw(t 'admin.pagination.next'), url, class: 'page-link' %>
   </li>
 <% end %>
diff --git a/app/views/kaminari/ra-twitter-bootstrap/without_count/_prev_page.html.erb b/app/views/kaminari/ra-twitter-bootstrap/without_count/_prev_page.html.erb
@@ -4,6 +4,6 @@
   </li>
 <% else %>
   <li class="page-item prev">
-    <%= link_to raw(t 'admin.pagination.previous'), url, class: ['page-link', ('pjax' if remote)].compact %>
+    <%= link_to raw(t 'admin.pagination.previous'), url, class: 'page-link' %>
   </li>
 <% end %>
diff --git a/app/views/layouts/rails_admin/_navigation.html.erb b/app/views/layouts/rails_admin/_navigation.html.erb
@@ -1,5 +1,5 @@
 <div class="container-fluid">
-  <a class="navbar-brand pjax" href="<%= dashboard_path %>">
+  <a class="navbar-brand" href="<%= dashboard_path %>">
     <%= _get_plugin_name[0] || 'Rails' %>
     <small>
       <%= _get_plugin_name[1] || 'Admin' %>
diff --git a/app/views/layouts/rails_admin/_secondary_navigation.html.erb b/app/views/layouts/rails_admin/_secondary_navigation.html.erb
@@ -1,7 +1,7 @@
 <ul class="navbar-nav ms-auto root_links">
   <% actions(:root).select(&:show_in_navigation).each do |action| %>
     <li class="nav-item <%= action.action_name %>_root_link">
-      <%= link_to wording_for(:menu, action), { action: action.action_name, controller: 'rails_admin/main' }, class: ['nav-link', action.pjax? && "pjax"] %>
+      <%= link_to wording_for(:menu, action), { action: action.action_name, controller: 'rails_admin/main' }, class: ['nav-link'] %>
     </li>
   <% end %>
   <% if main_app_root_path = (main_app.root_path rescue false) %>
diff --git a/app/views/layouts/rails_admin/application.html.erb b/app/views/layouts/rails_admin/application.html.erb
@@ -5,9 +5,6 @@
   </head>
   <body class="rails_admin">
     <div data-i18n-options="<%= I18n.t("admin.js").to_json %>" id="admin-js"></div>
-    <div class="label label-warning" id="loading" style="display:none; position:fixed; right:20px; bottom:20px; z-index:100000">
-      <%= t('admin.loading') %>
-    </div>
     <nav class="navbar navbar-expand-md fixed-top navbar-dark bg-primary border-bottom">
       <%= render "layouts/rails_admin/navigation" %>
     </nav>
@@ -17,8 +14,8 @@
           <%= render "layouts/rails_admin/sidebar_navigation" %>
         </div>
         <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2">
-          <div class="container" data-pjax-container="<%= true %>">
-            <%= render template: 'layouts/rails_admin/pjax' %>
+          <div class="container">
+            <%= render template: 'layouts/rails_admin/content' %>
           </div>
         </div>
       </div>
diff --git a/app/views/layouts/rails_admin/content.html.erb b/app/views/layouts/rails_admin/content.html.erb
diff --git a/app/views/rails_admin/main/_dashboard_history.html.erb b/app/views/rails_admin/main/_dashboard_history.html.erb
@@ -23,7 +23,7 @@
           <% label = o.send(abstract_model.config.object_label_method) %>
           <% if show_action = action(:show, abstract_model, o) %>
             <td>
-              <%= link_to(label, url_for(action: show_action.action_name, model_name: abstract_model.to_param, id: o.id), class: 'pjax') %>
+              <%= link_to(label, url_for(action: show_action.action_name, model_name: abstract_model.to_param, id: o.id)) %>
             </td>
           <% else %>
             <td>
diff --git a/app/views/rails_admin/main/_delete_notice.html.erb b/app/views/rails_admin/main/_delete_notice.html.erb
@@ -5,7 +5,7 @@
   </span>
   <% wording = object.send(@model_config.object_label_method) %>
   <% if show_action = action(:show, @abstract_model, object) %>
-    <%= link_to(wording, url_for(action: show_action.action_name, model_name: @abstract_model.to_param, id: object.id), class: 'pjax') %>
+    <%= link_to(wording, url_for(action: show_action.action_name, model_name: @abstract_model.to_param, id: object.id)) %>
   <% else %>
     <%= wording %>
   <% end %>
@@ -19,7 +19,7 @@
           <%= humanized_association.singularize %>
           <% wording = child.send(child_config.object_label_method) %>
           <% if child.id && (show_action = action(:show, child_config.abstract_model, child)) %>
-            <%= link_to(wording, url_for(action: show_action.action_name, model_name: child_config.abstract_model.to_param, id: child.id), class: 'pjax') %>
+            <%= link_to(wording, url_for(action: show_action.action_name, model_name: child_config.abstract_model.to_param, id: child.id)) %>
           <% else %>
             <%= wording %>
           <% end %>
diff --git a/app/views/rails_admin/main/dashboard.html.erb b/app/views/rails_admin/main/dashboard.html.erb
@@ -24,7 +24,7 @@
             <% active = last_created.try(:today?) %>
             <td>
               <span class="show">
-                <%= link_to abstract_model.config.label_plural, index_path, class: 'pjax' %>
+                <%= link_to abstract_model.config.label_plural, index_path %>
               </span>
             </td>
             <td>
diff --git a/app/views/rails_admin/main/history.html.erb b/app/views/rails_admin/main/history.html.erb
@@ -4,7 +4,7 @@
 <% sort = params[:sort] %>
 <% sort_reverse = params[:sort_reverse] %>
 <% path_method = params[:id] ? "history_show_path" : "history_index_path" %>
-<%= form_tag("", method: "get", class: "search pjax-form form-inline") do %>
+<%= form_tag("", method: "get", class: "search form-inline") do %>
   <div class="card mb-3 p-3 bg-light">
     <div class="row">
       <div class="col-sm-6">
@@ -32,7 +32,7 @@
         <% selected = (sort == property_name) %>
         <% sort_direction = (sort_reverse ? "headerSortUp" : "headerSortDown" if selected) %>
         <% sort_location = send(path_method, params.except("sort_reverse").merge(model_name: @abstract_model.to_param, sort: property_name).merge(selected && sort_reverse != "true" ? {sort_reverse: "true"} : {})) %>
-        <th class="header pjax <%= column[:css_class] %> <%= sort_direction if selected %>" data-href="<%= sort_location %>">
+        <th class="header <%= column[:css_class] %> <%= sort_direction if selected %>">
           <%= column[:link_text] %>
         </th>
       <% end %>
@@ -54,7 +54,7 @@
             <% label = o.send(@abstract_model.config.object_label_method) %>
             <% if show_action = action(:show, @abstract_model, o) %>
               <td>
-                <%= link_to(label, url_for(action: show_action.action_name, model_name: @abstract_model.to_param, id: o.id), class: 'pjax') %>
+                <%= link_to(label, url_for(action: show_action.action_name, model_name: @abstract_model.to_param, id: o.id)) %>
               </td>
             <% else %>
               <td>
@@ -75,6 +75,6 @@
   </tbody>
 </table>
 <% unless params[:all] || !@history.respond_to?(:current_page) %>
-  <%= paginate(@history, theme: 'ra-twitter-bootstrap', remote: true) %>
-  <%= link_to(t("admin.misc.show_all"), send(path_method, params.merge(all: true)), class: "show-all btn btn-light pjax") unless (tc = @history.total_count) <= @history.size || tc > 100 %>
+  <%= paginate(@history, theme: 'ra-twitter-bootstrap') %>
+  <%= link_to(t("admin.misc.show_all"), send(path_method, params.merge(all: true)), class: "show-all btn btn-light") unless (tc = @history.total_count) <= @history.size || tc > 100 %>
 <% end %>
diff --git a/app/views/rails_admin/main/index.html.erb b/app/views/rails_admin/main/index.html.erb
@@ -1,6 +1,6 @@
 <%
   query = params[:query]
-  params = request.params.except(:authenticity_token, :action, :controller, :utf8, :bulk_export, :_pjax)
+  params = request.params.except(:authenticity_token, :action, :controller, :utf8, :bulk_export)
   params.delete(:query) if params[:query].blank?
   params.delete(:sort_reverse) unless params[:sort_reverse] == 'true'
   sort_reverse = params[:sort_reverse]
@@ -67,7 +67,7 @@
 </style>
 
 <div id="list">
-  <%= form_tag(index_path(params.except(*%w[page f query])), method: :get, class: "pjax-form") do %>
+  <%= form_tag(index_path(params.except(*%w[page f query])), method: :get) do %>
     <div class="card mb-3 p-3 bg-light">
       <div class="row" data-options="<%= ordered_filter_options.to_json %>" id="filters_box"></div>
       <hr class="filters_box" style="display:<%= ordered_filters.empty? ? 'none' : 'block' %>"/>
@@ -97,7 +97,7 @@
       <% @model_config.list.scopes.each_with_index do |scope, index| %>
         <% scope = '_all' if scope.nil? %>
         <li class="<%= 'active' if scope.to_s == params[:scope] || (params[:scope].blank? && index == 0) %>">
-          <a class="pjax" href="<%= index_path(params.merge(scope: scope, page: nil)) %>">
+          <a href="<%= index_path(params.merge(scope: scope, page: nil)) %>">
             <%= I18n.t("admin.scopes.#{@abstract_model.to_param}.#{scope}", default: I18n.t("admin.scopes.#{scope}", default: scope.to_s.titleize)) %>
           </a>
         </li>
@@ -128,7 +128,7 @@
                 <% sort_location = index_path params.except('sort_reverse').except('page').merge(sort: property.name).merge(selected && sort_reverse != "true" ? {sort_reverse: "true"} : {}) %>
                 <% sort_direction = (sort_reverse == 'true' ? "headerSortUp" : "headerSortDown" if selected) %>
               <% end %>
-              <th class="<%= [property.sortable && "header pjax", property.sortable && sort_direction, property.sticky? && 'sticky', property.css_class, property.type_css_class].select(&:present?).join(' ') %>" data-href="<%= property.sortable && sort_location %>" rel="tooltip" title="<%= property.hint %>">
+              <th class="<%= [property.sortable && "header", property.sortable && sort_direction, property.sticky? && 'sticky', property.css_class, property.type_css_class].select(&:present?).join(' ') %>" data-href="<%= property.sortable && sort_location %>" rel="tooltip" title="<%= property.hint %>">
                 <%= property.label %>
               </th>
             <% end %>
@@ -169,19 +169,19 @@
     <% if @model_config.list.limited_pagination %>
       <div class="row">
         <div class="col-md-6">
-          <%= paginate(@objects, theme: 'ra-twitter-bootstrap/without_count', total_pages: Float::INFINITY, remote: true) %>
+          <%= paginate(@objects, theme: 'ra-twitter-bootstrap/without_count', total_pages: Float::INFINITY) %>
         </div>
       </div>
     <% elsif @objects.respond_to?(:total_count) %>
       <% total_count = @objects.total_count.to_i %>
       <div class="row">
         <div class="col-md-6">
-          <%= paginate(@objects, theme: 'ra-twitter-bootstrap', remote: true) %>
+          <%= paginate(@objects, theme: 'ra-twitter-bootstrap') %>
         </div>
       </div>
       <div class="row">
         <div class="col-md-6">
-          <%= link_to(t("admin.misc.show_all"), index_path(params.merge(all: true)), class: "show-all btn btn-light clearfix pjax") unless total_count > 100 || total_count <= @objects.to_a.size %>
+          <%= link_to(t("admin.misc.show_all"), index_path(params.merge(all: true)), class: "show-all btn btn-light clearfix") unless total_count > 100 || total_count <= @objects.to_a.size %>
         </div>
       </div>
       <div class="clearfix total-count">
diff --git a/config/locales/rails_admin.en.yml b/config/locales/rails_admin.en.yml
@@ -21,7 +21,6 @@ en:
       too_many_objects: "Too many objects, use search box above"
       no_objects: "No objects found"
       clear: Clear
-    loading: "Loading..."
     toggle_navigation: Toggle navigation
     home:
       name: "Home"
diff --git a/lib/rails_admin/config/actions/base.rb b/lib/rails_admin/config/actions/base.rb
@@ -73,11 +73,6 @@ class Base
           false
         end
 
-        # Render via pjax?
-        register_instance_option :pjax? do
-          link_target.blank?
-        end
-
         # Target window [_self, _blank]
         register_instance_option :link_target do
           nil
diff --git a/lib/rails_admin/config/actions/show_in_app.rb b/lib/rails_admin/config/actions/show_in_app.rb
@@ -25,10 +25,6 @@ class ShowInApp < RailsAdmin::Config::Actions::Base
         register_instance_option :link_icon do
           'fas fa-eye'
         end
-
-        register_instance_option :pjax? do
-          false
-        end
       end
     end
   end
diff --git a/lib/rails_admin/config/fields/association.rb b/lib/rails_admin/config/fields/association.rb
@@ -21,7 +21,7 @@ def method_name
             am = amc.abstract_model
             wording = associated.send(amc.object_label_method)
             can_see = !am.embedded? && (show_action = v.action(:show, am, associated))
-            can_see ? v.link_to(wording, v.url_for(action: show_action.action_name, model_name: am.to_param, id: associated.id), class: 'pjax') : ERB::Util.html_escape(wording)
+            can_see ? v.link_to(wording, v.url_for(action: show_action.action_name, model_name: am.to_param, id: associated.id)) : ERB::Util.html_escape(wording)
           end.to_sentence.html_safe.presence || '-'
         end
 
diff --git a/lib/rails_admin/engine.rb b/lib/rails_admin/engine.rb
@@ -1,6 +1,5 @@
 require 'kaminari'
 require 'nested_form'
-require 'rack-pjax'
 require 'rails'
 require 'rails_admin'
 
@@ -22,10 +21,6 @@ class Engine < Rails::Engine
       end
     end
 
-    initializer 'RailsAdmin setup middlewares' do |app|
-      app.config.middleware.use Rack::Pjax
-    end
-
     initializer 'RailsAdmin reload config in development' do |app|
       config.initializer_path = app.root.join('config/initializers/rails_admin.rb')
 
diff --git a/rails_admin.gemspec b/rails_admin.gemspec
@@ -9,7 +9,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activemodel-serializers-xml', '>= 1.0'
   spec.add_dependency 'kaminari', '>= 0.14', '< 2.0'
   spec.add_dependency 'nested_form', '~> 0.3'
-  spec.add_dependency 'rack-pjax', '>= 0.7'
   spec.add_dependency 'rails', ['>= 6.0', '< 8']
   spec.add_development_dependency 'bundler', '>= 1.0'
   spec.authors = ['Erik Michaels-Ober', 'Bogdan Gaza', 'Petteri Kaapa', 'Benoit Benezech', 'Mitsuhiro Shibuya']
diff --git a/src/rails_admin/base.js b/src/rails_admin/base.js
@@ -1,6 +1,5 @@
 import Rails from "@rails/ujs";
 import jQuery from "jquery";
-import "./vendor/jquery.pjax";
 import "./vendor/jquery_nested_form";
 import "bootstrap";
 import "flatpickr/dist/flatpickr";
diff --git a/src/rails_admin/ui.js b/src/rails_admin/ui.js
diff --git a/src/rails_admin/vendor/jquery.pjax.js b/src/rails_admin/vendor/jquery.pjax.js
diff --git a/vendor/assets/javascripts/rails_admin/jquery.pjax.js b/vendor/assets/javascripts/rails_admin/jquery.pjax.js
