Preserver the page parameter when editing #47

Author: csuhta

app/controllers/tolaria/resource_controller.rb

@@ -6,7 +6,7 @@ def index
     @search = @managed_class.klass.ransack(ransack_params)
     @resources = @search.result
     if @managed_class.paginated?
-      @resources = @resources.page(params[:page]).per(Tolaria.config.page_size)
+      @resources = @resources.page(page_param).per(Tolaria.config.page_size)
     end
     unless currently_sorting?
       @resources = @resources.order(@managed_class.default_order)
@@ -92,7 +92,7 @@ def random_blingword
   # Handles route forbidding cases.
   def form_completion_redirect_path(managed_class, resource = nil)
     if managed_class.allows?(:index) && params[:save_and_review].blank?
-      url_for(action:"index", q:ransack_params)
+      url_for(action:"index", q:ransack_params, p:page_param)
     elsif managed_class.allows?(:show) && resource.present?
       url_for(action:"show", id:resource.id)
     elsif managed_class.allows?(:edit) && resource.present?
@@ -128,6 +128,14 @@ def log_validation_errors!
     end
   end
 
+  # Returns the current `params[:p]` as an Integer if it is valid.
+  # Returns `nil` otherwise.
+  def page_param
+    integer_page = params[:p].to_i
+    return integer_page if integer_page > 0
+    return nil
+  end
+
   # Returns params[:q] as a hash if it can be converted.
   # Ransack expects this generic hash and has its own internal
   # logic for handing the many possible keys of the hash.
@@ -153,6 +161,7 @@ def currently_filtering?
     end
   end
 
+  helper_method :page_param
   helper_method :ransack_params
   helper_method :currently_sorting?
   helper_method :currently_filtering?

app/helpers/admin/table_helper.rb

@@ -137,9 +137,9 @@ def index_td(resource, method_or_content = {}, options = {}, &block)
     end
 
     if @managed_class.allows? :edit
-      link = url_for(action:"edit", id:resource.id, q:ransack_params)
+      link = url_for(action:"edit", id:resource.id, q:ransack_params, p:page_param)
     elsif @managed_class.allows? :show
-      link = url_for(action:"show", id:resource.id, q:ransack_params)
+      link = url_for(action:"show", id:resource.id, q:ransack_params, p:page_param)
     else
       link = "#" # Guh, painted ourseves into a corner here
     end
@@ -162,15 +162,15 @@ def actions_td(resource)
     links = []
 
     if @managed_class.allows?(:edit)
-      links << link_to("Edit", url_for(action:"edit", id:resource.id, q:ransack_params), class:"button -small")
+      links << link_to("Edit", url_for(action:"edit", id:resource.id, q:ransack_params, p:page_param), class:"button -small -edit")
     end
 
     if @managed_class.allows?(:show)
-      links << link_to("Inspect", url_for(action:"show", id:resource.id, q:ransack_params), class:"button -small")
+      links << link_to("Inspect", url_for(action:"show", id:resource.id, q:ransack_params, p:page_param), class:"button -small -inspect")
     end
 
     if @managed_class.allows?(:destroy)
-      links << link_to("Delete", url_for(action:"destroy", id:resource.id, q:ransack_params), class: "button -small", method: :delete, :'data-confirm' => deletion_warning(resource))
+      links << link_to("Delete", url_for(action:"destroy", id:resource.id, q:ransack_params, p:page_param), class: "button -small -delete", method: :delete, :'data-confirm' => deletion_warning(resource))
     end
 
     return content_tag(:td, links.join("").html_safe, class:"actions-td")

app/views/admin/tolaria_resource/_form_buttons.html.erb

@@ -1,5 +1,5 @@
 <% if @managed_class.allows? :index %>
-  <%= link_to url_for(action:"index", q:ransack_params), class:"button -cancel" do %>
+  <%= link_to url_for(action:"index", q:ransack_params, p:page_param), class:"button -cancel" do %>
     <%= fontawesome_icon :close %>
     Cancel
   <% end %>

app/views/admin/tolaria_resource/_index_table.html.erb

@@ -70,6 +70,6 @@
     <p class="pagination-desc"><%= page_entries_info @resources %></p>
   <% end %>
 
-  <%= paginate @resources, theme:"admin", window:2 %>
+  <%= paginate @resources, theme:"admin", window:2, param_name:"p" %>
 
 <% end %>

app/views/admin/tolaria_resource/edit.html.erb

@@ -6,20 +6,28 @@
 
 <%= form_for [:admin, @resource], url:contextual_form_url, builder:Admin::FormBuilder, html:{class:"resource-form"}  do |form_builder| %>
 
+  <% if page_param.present? %>
+
+  <% end %>
+
   <% if ransack_params.present?  %>
     <% ransack_params.each do |key, value| %>
       <% next if value.respond_to?(:keys) %>
       <%= hidden_field_tag "q[#{key}]", value %>
     <% end %>
   <% end %>
 
+  <% if page_param.present? %>
+    <%= hidden_field_tag :p, page_param %>
+  <% end %>
+
   <div class="main-controls">
     <div class="main-controls-left">
       <h1>
         <span class="crumb">
           <%= fontawesome_icon @managed_class.icon %>
           <% if @managed_class.allows? :index %>
-            <%= link_to @managed_class.model_name.human.pluralize.titleize, url_for(action:"index", controller:@managed_class.plural, q:ransack_params) %>
+            <%= link_to @managed_class.model_name.human.pluralize.titleize, url_for(action:"index", controller:@managed_class.plural, q:ransack_params, p:page_param) %>
           <% else %>
             <%= @managed_class.model_name.human.pluralize.titleize %>
           <% end %>

app/views/admin/tolaria_resource/index.html.erb

@@ -26,7 +26,7 @@
     <% end %>
 
     <% if @managed_class.allows?(:new) %>
-      <%= link_to url_for(action:"new", q:ransack_params), class:"button -primary" do %>
+      <%= link_to url_for(action:"new", q:ransack_params, p:page_param), class:"button -primary" do %>
         <%= fontawesome_icon :plus %>
         New <%= @managed_class.model_name.human.titleize %>
       <% end %>

app/views/admin/tolaria_resource/show.html.erb

@@ -7,7 +7,7 @@
       <span class="crumb">
         <%= fontawesome_icon @managed_class.icon %>
         <% if @managed_class.allows? :index %>
-          <%= link_to @managed_class.model_name.human.pluralize.titleize, url_for(action:"index", controller:@managed_class.plural, q:ransack_params) %>
+          <%= link_to @managed_class.model_name.human.pluralize.titleize, url_for(action:"index", controller:@managed_class.plural, q:ransack_params, p:page_param) %>
         <% else %>
           <%= @managed_class.model_name.human.pluralize.titleize %>
         <% end %>

test/integration/filter_preservation_test.rb

@@ -25,7 +25,7 @@ def teardown
     find_link("Organization").click
     find_link("Nintendo").click
     first(".button.-cancel").click
-    assert page.current_url.include?("q[s]=organization+asc"), "filter not retained"
+    assert page.current_url.include?("q[s]=organization+asc"), "filter should be retained"
   end
 
   test "after filtering index, should retain filter on edit and save" do

test/integration/pagination_test.rb

@@ -2,8 +2,8 @@
 
 class PaginationTest < ActionDispatch::IntegrationTest
 
-  test "shows pagination and its usable" do
-
+  def setup
+    BlogPost.destroy_all
     50.times do
       BlogPost.create!({
         title: SecureRandom.uuid,
@@ -12,20 +12,65 @@ class PaginationTest < ActionDispatch::IntegrationTest
         published_at: Time.current,
       })
     end
+  end
 
+  def teardown
+    BlogPost.destroy_all
+  end
+
+  test "shows pagination and its usable" do
     sign_in_dummy_administrator!
     visit("/admin/blog_posts")
     assert page.has_content?("Next")
     assert page.has_content?("Last")
     assert page.has_content?("3")
-    visit("/admin/blog_posts?page=3")
+    visit("/admin/blog_posts?p=3")
     assert page.has_content?("Next")
     assert page.has_content?("Last")
     assert page.has_content?("First")
     assert page.has_content?("Prev")
+  end
 
-    BlogPost.destroy_all
+  test "after paginating index, should retain page on edit and back with crumb" do
+    sign_in_dummy_administrator!
+    visit("/admin/blog_posts?p=3")
+    first(".button.-edit").click # Open the editor form for a random blog post
+    first(".crumb a").click
+    assert page.current_url.include?("p=3"), "page should be retained"
+  end
+
+  test "after paginating index, should retain page on edit and back with button" do
+    sign_in_dummy_administrator!
+    visit("/admin/blog_posts?p=3")
+    first(".button.-edit").click # Open the editor form for a random blog post
+    first(".button.-cancel").click
+    assert page.current_url.include?("p=3"), "page should be retained"
+  end
 
+  test "after paginating index, should retain page on edit and save" do
+    sign_in_dummy_administrator!
+    visit("/admin/blog_posts?p=3")
+    first(".button.-edit").click # Open the editor form for a random blog post
+    first(".button.-save").click
+    assert page.current_url.include?("p=3"), "page should be retained"
+  end
+
+  test "after paginating index, should retain page on edit and failed validation" do
+    sign_in_dummy_administrator!
+    visit("/admin/blog_posts?p=3")
+    first(".button.-edit").click # Open the editor form for a random blog post
+    fill_in("blog_post[title]", with:"")
+    first(".button.-save").click
+    first(".button.-cancel").click
+    assert page.current_url.include?("p=3"), "page should be retained"
+  end
+
+  test "after paginating index, should NOT retain page on save and review" do
+    sign_in_dummy_administrator!
+    visit("/admin/blog_posts?p=3")
+    first(".button.-edit").click # Open the editor form for a random blog post
+    first(".button.-save-and-review").click
+    assert page.current_url.exclude?("p=3"), "page should not have been retained"
   end
 
 end