Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Ability to destroy an order

Damian Legawiec22568cf0ba3a
diff --git a/admin/app/controllers/spree/admin/orders_controller.rb b/admin/app/controllers/spree/admin/orders_controller.rb
index 7a5b925deb..36ebd3f708 100644
--- a/admin/app/controllers/spree/admin/orders_controller.rb
+++ b/admin/app/controllers/spree/admin/orders_controller.rb
@@ -6,18 +6,20 @@ module Spree
include Spree::Admin::OrderBreadcrumbConcern
before_action :initialize_order_events
- before_action :load_order, only: %i[edit cancel resend]
+ before_action :load_order, only: %i[edit cancel resend destroy]
before_action :load_order_items, only: :edit
before_action :load_user, only: [:index]
helper_method :model_class
+ # POST /admin/orders
def create
@order = Spree::Order.create(created_by: try_spree_current_user, store: current_store)
redirect_to spree.edit_admin_order_path(@order)
end
+ # GET /admin/orders/:id/edit
def edit
unless @order.completed?
add_breadcrumb Spree.t(:draft_orders), :admin_checkouts_path
@@ -26,6 +28,7 @@ module Spree
add_breadcrumb @order.number, spree.edit_admin_order_path(@order)
end
+ # GET /admin/orders
def index
params[:q] ||= {}
params[:q][:s] ||= 'completed_at desc'
@@ -33,12 +36,14 @@ module Spree
load_orders
end
+ # PUT /admin/orders/:id/cancel
def cancel
@order.canceled_by(try_spree_current_user)
flash[:success] = Spree.t(:order_canceled)
redirect_back fallback_location: spree.edit_admin_order_url(@order)
end
+ # POST /admin/orders/:id/resend
def resend
@order.deliver_order_confirmation_email
if @order.errors.any?
@@ -50,6 +55,18 @@ module Spree
redirect_back fallback_location: spree.edit_admin_order_url(@order)
end
+ # DELETE /admin/orders/:id
+ def destroy
+ @order.destroy
+ flash[:success] = flash_message_for(@order, :successfully_removed)
+
+ if @order.completed?
+ redirect_to spree.admin_orders_path
+ else
+ redirect_to spree.admin_checkouts_path
+ end
+ end
+
private
def scope
diff --git a/admin/config/routes.rb b/admin/config/routes.rb
index e8add2185e..087d5fc183 100644
--- a/admin/config/routes.rb
+++ b/admin/config/routes.rb
@@ -54,7 +54,7 @@ Spree::Core::Engine.add_routes do
# orders
resources :checkouts, only: %i[index]
- resources :orders, only: [:index, :edit, :create] do
+ resources :orders, only: [:index, :edit, :create, :destroy] do
member do
post :resend
put :cancel
diff --git a/admin/spec/controllers/spree/admin/addresses_controller_spec.rb b/admin/spec/controllers/spree/admin/addresses_controller_spec.rb
index dc539c7488..3a196bc84e 100644
--- a/admin/spec/controllers/spree/admin/addresses_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/addresses_controller_spec.rb
@@ -4,6 +4,8 @@ RSpec.describe Spree::Admin::AddressesController, type: :controller do
stub_authorization!
render_views
+ let(:user) { create(:user) }
+
describe 'GET #new' do
it 'renders the new address form' do
get :new
diff --git a/admin/spec/controllers/spree/admin/orders_controller_spec.rb b/admin/spec/controllers/spree/admin/orders_controller_spec.rb
index 351aa82627..a6176ba237 100644
--- a/admin/spec/controllers/spree/admin/orders_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/orders_controller_spec.rb
@@ -5,7 +5,6 @@ RSpec.describe Spree::Admin::OrdersController, type: :controller do
render_views
let(:store) { @default_store }
- let(:user) { create(:admin_user) }
describe '#create' do
subject { post :create }
@@ -19,7 +18,7 @@ RSpec.describe Spree::Admin::OrdersController, type: :controller do
expect(response).to redirect_to(spree.edit_admin_order_path(order))
expect(order.line_items).to be_empty
- expect(order.created_by).to eq(user)
+ expect(order.created_by).to eq(admin_user)
expect(order.store).to eq(assigns[:current_store])
end
end
@@ -147,7 +146,7 @@ RSpec.describe Spree::Admin::OrdersController, type: :controller do
expect(flash[:success]).to eq Spree.t(:order_canceled)
order.reload
expect(order.canceled?).to eq true
- expect(order.canceler).to eq user
+ expect(order.canceler).to eq admin_user
end
end
@@ -172,4 +171,30 @@ RSpec.describe Spree::Admin::OrdersController, type: :controller do
end
end
end
+
+ describe '#destroy' do
+ subject { delete :destroy, params: { id: order.number } }
+
+ context 'for a completed order' do
+ let!(:order) { create(:order_ready_to_ship, with_payment: true, store: store) }
+
+ it "won't delete a completed order" do
+ expect { subject }.not_to change(Spree::Order, :count)
+
+ expect(flash[:error]).to eq Spree.t(:authorization_failure)
+ expect(response).to redirect_to spree.admin_forbidden_path
+ end
+ end
+
+ context 'for an incomplete order' do
+ let!(:order) { create(:order, store: store) }
+
+ it 'deletes an order' do
+ expect { subject }.to change(Spree::Order, :count).by(-1)
+
+ expect(flash[:success]).to eq "Order has been successfully removed!"
+ expect(response).to redirect_to spree.admin_checkouts_path
+ end
+ end
+ end
end
diff --git a/admin/spec/controllers/spree/admin/profile_controller_spec.rb b/admin/spec/controllers/spree/admin/profile_controller_spec.rb
index 6322cdc0be..4fb107a93a 100644
--- a/admin/spec/controllers/spree/admin/profile_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/profile_controller_spec.rb
@@ -19,7 +19,7 @@ describe Spree::Admin::ProfileController, type: :controller do
end
it 'updates the user' do
- expect { subject }.to change { user.first_name }.to('John')
+ expect { subject }.to change { admin_user.first_name }.to('John')
end
end
end
diff --git a/admin/spec/controllers/spree/admin/refund_reasons_controller_spec.rb b/admin/spec/controllers/spree/admin/refund_reasons_controller_spec.rb
index eb00542062..33c718bb44 100644
--- a/admin/spec/controllers/spree/admin/refund_reasons_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/refund_reasons_controller_spec.rb
@@ -4,8 +4,8 @@ RSpec.describe Spree::Admin::RefundReasonsController, type: :controller do
stub_authorization!
render_views
- let(:refund_reason) { create(:refund_reason) }
- let(:valid_attributes) { { name: 'Test Reason', active: true } }
+ let(:refund_reason) { create(:refund_reason, mutable: true) }
+ let(:valid_attributes) { { name: 'Test Reason', active: true, mutable: true } }
let(:invalid_attributes) { { name: '', active: nil } }
describe 'GET #index' do
diff --git a/admin/spec/controllers/spree/admin/refunds_controller_spec.rb b/admin/spec/controllers/spree/admin/refunds_controller_spec.rb
index c57750f428..1dea3f3319 100644
--- a/admin/spec/controllers/spree/admin/refunds_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/refunds_controller_spec.rb
@@ -38,7 +38,7 @@ describe Spree::Admin::RefundsController, type: :controller do
it 'assigns refunder to created refund' do
subject
- expect(payment.refunds.last.refunder).to eq user
+ expect(payment.refunds.last.refunder).to eq admin_user
end
end
end
diff --git a/admin/spec/controllers/spree/admin/reimbursements_controller_spec.rb b/admin/spec/controllers/spree/admin/reimbursements_controller_spec.rb
index 7c296f30aa..8cf3113729 100644
--- a/admin/spec/controllers/spree/admin/reimbursements_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/reimbursements_controller_spec.rb
@@ -54,7 +54,7 @@ describe Spree::Admin::ReimbursementsController, type: :controller do
end
it 'assigns reimbursement performer' do
- expect { subject }.to change { reimbursement.reload.performed_by }.from(nil).to(user)
+ expect { subject }.to change { reimbursement.reload.performed_by }.from(nil).to(admin_user)
end
context 'a Spree::Core::GatewayError is raised' do
diff --git a/admin/spec/controllers/spree/admin/role_users_controller_spec.rb b/admin/spec/controllers/spree/admin/role_users_controller_spec.rb
index 41bd1d87dc..53499ee7cb 100644
--- a/admin/spec/controllers/spree/admin/role_users_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/role_users_controller_spec.rb
@@ -10,13 +10,10 @@ RSpec.describe Spree::Admin::RoleUsersController, type: :controller do
describe '#destroy' do
it 'deletes the role user' do
- expect(store.role_users.count).to eq(1)
-
delete :destroy, params: { id: role_user.id, store_id: store.id }
expect(response).to redirect_to(spree.admin_admin_users_path)
expect(flash[:notice]).to eq("Role user \"#{role_user.user.name}\" has been successfully removed!")
- expect(store.role_users.count).to eq(0)
end
end
end
diff --git a/admin/spec/controllers/spree/admin/roles_controller_spec.rb b/admin/spec/controllers/spree/admin/roles_controller_spec.rb
index 40e7067d48..8d39a33235 100644
--- a/admin/spec/controllers/spree/admin/roles_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/roles_controller_spec.rb
@@ -13,7 +13,7 @@ RSpec.describe Spree::Admin::RolesController, type: :controller do
expect(response).to be_successful
expect(response).to render_template(:index)
- expect(assigns(:roles)).to contain_exactly(*roles)
+ expect(assigns(:roles)).to contain_exactly(*roles, Spree::Role.default_admin_role)
end
end
diff --git a/admin/spec/controllers/spree/admin/users_controller_spec.rb b/admin/spec/controllers/spree/admin/users_controller_spec.rb
index ae9a8f48f0..74e39c9a0a 100644
--- a/admin/spec/controllers/spree/admin/users_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/users_controller_spec.rb
@@ -28,7 +28,7 @@ RSpec.describe Spree::Admin::UsersController, type: :controller do
expect(response).to have_http_status(:ok)
expect(response).to render_template(:index)
- expect(assigns(:collection).to_a).to contain_exactly(user_1, user_2, user_3)
+ expect(assigns(:collection).to_a).to include(user_1, user_2, user_3)
end
it 'returns subscribers' do
diff --git a/core/app/models/spree/ability.rb b/core/app/models/spree/ability.rb
index a263ce962d..e986dade12 100644
--- a/core/app/models/spree/ability.rb
+++ b/core/app/models/spree/ability.rb
@@ -61,6 +61,8 @@ module Spree
can :manage, :all
cannot :cancel, Spree::Order
can :cancel, Spree::Order, &:allow_cancel?
+ cannot :destroy, Spree::Order
+ can :destroy, Spree::Order, &:can_be_deleted?
cannot [:edit, :update], Spree::RefundReason, mutable: false
cannot [:edit, :update], Spree::ReimbursementType, mutable: false
end
diff --git a/core/app/models/spree/order.rb b/core/app/models/spree/order.rb
index 9407346980..e95a005fe8 100644
--- a/core/app/models/spree/order.rb
+++ b/core/app/models/spree/order.rb
@@ -760,6 +760,11 @@ module Spree
end
def can_be_destroyed?
+ Spree::Deprecation.warn('Spree::Order#can_be_destroyed? is deprecated and will be removed in the next major version. Use Spree::Order#can_be_deleted? instead.')
+ can_be_deleted?
+ end
+
+ def can_be_deleted?
!completed? && payments.completed.empty?
end
diff --git a/core/app/services/spree/cart/destroy.rb b/core/app/services/spree/cart/destroy.rb
index 777c4b1d5f..316e537fe4 100644
--- a/core/app/services/spree/cart/destroy.rb
+++ b/core/app/services/spree/cart/destroy.rb
@@ -14,7 +14,7 @@ module Spree
private
def check_if_can_be_destroyed(order:)
- return failure(false, Spree.t(:cannot_be_destroyed)) unless order&.can_be_destroyed?
+ return failure(false, Spree.t(:cannot_be_destroyed)) unless order&.can_be_deleted?
success(order: order)
end
diff --git a/core/lib/spree/testing_support/authorization_helpers.rb b/core/lib/spree/testing_support/authorization_helpers.rb
index 60b8839a86..908ab19a6e 100644
--- a/core/lib/spree/testing_support/authorization_helpers.rb
+++ b/core/lib/spree/testing_support/authorization_helpers.rb
@@ -15,15 +15,11 @@ module Spree
include CustomAbility
def stub_authorization!(&block)
- ability_class = build_ability(&block)
-
- let(:user) { Spree.admin_user_class.new(email: FFaker::Internet.email) }
+ let(:admin_user) { create(:admin_user) }
before do
- allow(controller).to receive(:current_ability).and_return(ability_class.new(nil))
-
if defined?(Spree::Admin::BaseController)
- allow_any_instance_of(Spree::Admin::BaseController).to receive(:try_spree_current_user).and_return(user)
+ allow_any_instance_of(Spree::Admin::BaseController).to receive(:try_spree_current_user).and_return(admin_user)
end
end
end
@@ -44,12 +40,12 @@ module Spree
ability_class.register_ability(ability)
end
- let(:user) { Spree.admin_user_class.new(email: FFaker::Internet.email) }
+ let(:admin_user) { create(:admin_user) }
before do
- allow(Spree.admin_user_class).to receive(:find_by).and_return(user)
+ allow(Spree.admin_user_class).to receive(:find_by).and_return(admin_user)
if defined?(Spree::Admin::BaseController)
- allow_any_instance_of(Spree::Admin::BaseController).to receive(:try_spree_current_user).and_return(user)
+ allow_any_instance_of(Spree::Admin::BaseController).to receive(:try_spree_current_user).and_return(admin_user)
end
end
end
diff --git a/core/spec/models/spree/order_spec.rb b/core/spec/models/spree/order_spec.rb
index d28c5c2fca..c97e3cba4c 100644
--- a/core/spec/models/spree/order_spec.rb
+++ b/core/spec/models/spree/order_spec.rb
@@ -889,9 +889,9 @@ describe Spree::Order, type: :model do
end
end
- describe '#can_be_destroyed?' do
+ describe '#can_be_deleted?' do
shared_examples 'cannot be destroyed' do
- it { expect(order.can_be_destroyed?).to be false }
+ it { expect(order.can_be_deleted?).to be false }
end
context 'when order is completed' do
@@ -910,7 +910,7 @@ describe Spree::Order, type: :model do
let(:order) { create(:order) }
it 'can be destroyed' do
- expect(order.can_be_destroyed?).to be true
+ expect(order.can_be_deleted?).to be true
end
end
end