Merge pull request #6134 from chaimann/fix-bulk-delete

[Admin] Allow bulk delete resources

Author: tvdeyen

admin/app/controllers/solidus_admin/resources_controller.rb

@@ -56,9 +56,9 @@ def update
     end
 
     def destroy
-      @resource = resource_class.find_by!(id: params[:id])
+      @resource = resource_class.where(id: params[:id])
 
-      resource_class.transaction { @resource.destroy }
+      resource_class.transaction { @resource.destroy_all }
 
       flash[:notice] = t('.success')
       redirect_back_or_to after_destroy_path, status: :see_other

admin/lib/solidus_admin/testing_support/shared_examples/bulk_delete_resources.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples_for 'feature: bulk delete resources' do
+  it 'allows to bulk delete resources' do
+    create(resource_factory, name: 'Bulk delete item 1')
+    create(resource_factory, name: 'Bulk delete item 2')
+
+    visit index_path
+    expect(page).to have_content('Bulk delete item 1')
+    expect(page).to have_content('Bulk delete item 2')
+
+    select_row('Bulk delete item 1')
+    select_row('Bulk delete item 2')
+    click_on 'Delete'
+
+    expect(page).to have_content('were successfully removed.')
+    expect(page).not_to have_content('Bulk delete item 1')
+    expect(page).not_to have_content('Bulk delete item 2')
+  end
+end

admin/lib/solidus_admin/testing_support/shared_examples/crud_resource_requests.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples_for 'CRUD resource requests' do |resource_name|
+  let(:admin_user) { create(:admin_user) }
+  let(:resource) { create(factory) }
+
+  # Overridables
+  let(:factory) { resource_name.to_sym }
+  let(:url_helpers) { solidus_admin }
+
+  before do
+    allow_any_instance_of(SolidusAdmin::BaseController).to receive(:spree_current_user).and_return(admin_user)
+  end
+
+  describe "GET /index" do
+    it "renders the index template with a 200 OK status" do
+      get url_helpers.public_send("#{resource_name.pluralize}_path")
+      expect(response).to have_http_status(:ok)
+    end
+  end
+
+  describe "GET /new" do
+    it "renders the new template with a 200 OK status" do
+      get url_helpers.public_send("new_#{resource_name}_path")
+      expect(response).to have_http_status(:ok)
+    end
+  end
+
+  describe "POST /create" do
+    context "with valid parameters" do
+      it "creates a new #{resource_name.humanize}" do
+        expect {
+          post url_helpers.public_send("#{resource_name.pluralize}_path"), params: { resource_name => valid_attributes }
+        }.to change(resource_class, :count).by(1)
+      end
+
+      it "redirects to the index page with a 303 See Other status" do
+        post url_helpers.public_send("#{resource_name.pluralize}_path"), params: { resource_name => valid_attributes }
+        expect(response).to redirect_to(url_helpers.public_send("#{resource_name.pluralize}_path"))
+        expect(response).to have_http_status(:see_other)
+      end
+
+      it "displays a success flash message" do
+        post url_helpers.public_send("#{resource_name.pluralize}_path"), params: { resource_name => valid_attributes }
+        follow_redirect!
+        expect(response.body).to include("#{resource_name.humanize} was successfully created.")
+      end
+    end
+
+    context "with invalid parameters" do
+      let(:invalid_attributes) { { name: "", code: "", active: true } }
+
+      it "does not create a new #{resource_name.humanize}" do
+        expect {
+          post url_helpers.public_send("#{resource_name.pluralize}_path"), params: { resource_name => invalid_attributes }
+        }.not_to change(resource_class, :count)
+      end
+
+      it "renders the new template with unprocessable_entity status" do
+        post url_helpers.public_send("#{resource_name.pluralize}_path"), params: { resource_name => invalid_attributes }
+        expect(response).to have_http_status(:unprocessable_entity)
+      end
+    end
+  end
+
+  describe "GET /edit" do
+    it "renders the edit template with a 200 OK status" do
+      get url_helpers.public_send("edit_#{resource_name}_path", resource)
+      expect(response).to have_http_status(:ok)
+    end
+  end
+
+  describe "PATCH /update" do
+    context "with valid parameters" do
+      it "updates the #{resource_name.humanize}" do
+        patch url_helpers.public_send("#{resource_name}_path", resource), params: { resource_name => valid_attributes }
+        resource.reload
+        valid_attributes.each do |attr, value|
+          expect(resource.public_send(attr)).to eq(value)
+        end
+      end
+
+      it "redirects to the index page with a 303 See Other status" do
+        patch url_helpers.public_send("#{resource_name}_path", resource), params: { resource_name => valid_attributes }
+        expect(response).to redirect_to(url_helpers.public_send("#{resource_name.pluralize}_path"))
+        expect(response).to have_http_status(:see_other)
+      end
+
+      it "displays a success flash message" do
+        patch url_helpers.public_send("#{resource_name}_path", resource), params: { resource_name => valid_attributes }
+        follow_redirect!
+        expect(response.body).to include("#{resource_name.humanize} was successfully updated.")
+      end
+    end
+
+    context "with invalid parameters" do
+      it "does not update the #{resource_name.humanize}" do
+        expect {
+          patch url_helpers.public_send("#{resource_name}_path", resource), params: { resource_name => invalid_attributes }
+        }.not_to change { resource.reload }
+      end
+
+      it "renders the edit template with unprocessable_entity status" do
+        patch url_helpers.public_send("#{resource_name}_path", resource), params: { resource_name => invalid_attributes }
+        expect(response).to have_http_status(:unprocessable_entity)
+      end
+    end
+  end
+
+  describe "DELETE /destroy" do
+    it "deletes the #{resource_name.humanize} and redirects to the index page with a 303 See Other status" do
+      # This ensures resource exists prior to deletion.
+      resource
+      expect {
+        delete url_helpers.public_send("#{resource_name}_path", resource)
+      }.to change(resource_class, :count).by(-1)
+
+      expect(response).to redirect_to(url_helpers.public_send("#{resource_name.pluralize}_path"))
+      expect(response).to have_http_status(:see_other)
+    end
+
+    it "displays a success flash message after deletion" do
+      delete url_helpers.public_send("#{resource_name}_path", resource)
+      follow_redirect!
+      expect(response.body).to include("#{resource_name.humanize.pluralize} were successfully removed.")
+    end
+
+    it 'allows to bulk delete resources' do
+      ids = [create(factory), create(factory)].map(&:id)
+      expect {
+        delete url_helpers.public_send("#{resource_name.pluralize}_path", id: ids)
+      }.to change { resource_class.count }.by(-ids.size)
+
+      expect(response).to redirect_to(url_helpers.public_send("#{resource_name.pluralize}_path"))
+      expect(response).to have_http_status(:see_other)
+    end
+  end
+end

admin/lib/solidus_admin/testing_support/shared_examples/promotion_categories_features.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'solidus_admin/testing_support/shared_examples/bulk_delete_resources'
+
 RSpec.shared_examples_for 'promotion categories features' do
   before { sign_in create(:admin_user, email: "admin@example.com") }
 
@@ -28,7 +30,7 @@
     fill_in "Name", with: "Soon to expire"
     click_on "Add Promotion Category"
 
-    expect(page).to have_content("Promotion Category was successfully created.")
+    expect(page).to have_content("Promotion category was successfully created.")
     expect(page).to have_content("Soon to expire")
     expect(page).to have_content("ste.1")
     expect(model_class.count).to eq(1)
@@ -46,7 +48,7 @@
     fill_in "Code", with: "exp.2"
     click_on "Update Promotion Category"
 
-    expect(page).to have_content("Promotion Category was successfully updated.")
+    expect(page).to have_content("Promotion category was successfully updated.")
     expect(page).to have_content("Expired")
     expect(page).to have_content("exp.2")
   end
@@ -59,8 +61,12 @@
 
     select_row("Expired")
     click_on "Delete"
-    expect(page).to have_content("Promotion Categories were successfully removed.")
+    expect(page).to have_content("Promotion categories were successfully removed.")
     expect(page).not_to have_content("Expired")
     expect(model_class.count).to eq(1)
   end
+
+  include_examples 'feature: bulk delete resources' do
+    let(:resource_factory) { factory_name }
+  end
 end

admin/lib/solidus_admin/testing_support/shared_examples/promotion_categories_requests.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'solidus_admin/testing_support/shared_examples/bulk_delete_resources'
 
 describe "Adjustment Reasons", :js, type: :feature do
   before { sign_in create(:admin_user, email: 'admin@example.com') }
@@ -20,6 +21,11 @@
     expect(page).to be_axe_clean
   end
 
+  include_examples 'feature: bulk delete resources' do
+    let(:resource_factory) { :adjustment_reason }
+    let(:index_path) { "/admin/adjustment_reasons" }
+  end
+
   context "when creating a new adjustment reason" do
     let(:query) { "?page=1&q%5Bname_or_code_cont%5D=new" }
 

admin/spec/features/adjustment_reasons_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'solidus_admin/testing_support/shared_examples/bulk_delete_resources'
 
 describe "Properties", :js, type: :feature do
   before { sign_in create(:admin_user, email: 'admin@example.com') }
@@ -22,6 +23,11 @@
     expect(Spree::Property.count).to eq(1)
   end
 
+  include_examples 'feature: bulk delete resources' do
+    let(:resource_factory) { :property }
+    let(:index_path) { "/admin/properties" }
+  end
+
   context "creating a new property" do
     it "creates a new product property" do
       visit "/admin/properties"

admin/spec/features/properties_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'solidus_admin/testing_support/shared_examples/bulk_delete_resources'
 
 describe "Refund Reasons", :js, type: :feature do
   before { sign_in create(:admin_user, email: 'admin@example.com') }
@@ -20,6 +21,11 @@
     expect(page).to be_axe_clean
   end
 
+  include_examples 'feature: bulk delete resources' do
+    let(:resource_factory) { :refund_reason }
+    let(:index_path) { "/admin/refund_reasons" }
+  end
+
   context "when creating a new refund reason" do
     let(:query) { "?page=1&q%5Bname_or_description_cont%5D=Ret" }