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.

Feature(admin): Add payment state filter to orders page (#12954)

Jawaria Waris3aa4ec8570f9
diff --git a/admin/app/helpers/spree/admin/orders_filters_helper.rb b/admin/app/helpers/spree/admin/orders_filters_helper.rb
index 6cc3168de7..03599c9661 100644
--- a/admin/app/helpers/spree/admin/orders_filters_helper.rb
+++ b/admin/app/helpers/spree/admin/orders_filters_helper.rb
@@ -14,40 +14,49 @@ module Spree
if search_params[:created_at_gt].present?
search_params[:created_at_gt] = begin
- # Firstly we parse to date to avoid issues with timezones because frontend sends time in local timezone
- search_params[:created_at_gt].to_date&.in_time_zone(current_timezone)
- rescue StandardError
- ''
- end
+ # Firstly we parse to date to avoid issues with timezones because frontend sends time in local timezone
+ search_params[:created_at_gt].to_date&.in_time_zone(current_timezone)
+ rescue StandardError
+ ''
+ end
end
if search_params[:created_at_lt].present?
search_params[:created_at_lt] = begin
- search_params[:created_at_lt].to_date&.in_time_zone(current_timezone)&.end_of_day
- rescue StandardError
- ''
- end
+ search_params[:created_at_lt].to_date&.in_time_zone(current_timezone)&.end_of_day
+ rescue StandardError
+ ''
+ end
end
if search_params[:completed_at_gt].present?
search_params[:completed_at_gt] = begin
- search_params[:completed_at_gt].to_date&.in_time_zone(current_timezone)
- rescue StandardError
- ''
- end
+ search_params[:completed_at_gt].to_date&.in_time_zone(current_timezone)
+ rescue StandardError
+ ''
+ end
end
if search_params[:completed_at_lt].present?
search_params[:completed_at_lt] = begin
- search_params[:completed_at_lt].to_date&.in_time_zone(current_timezone)&.end_of_day
- rescue StandardError
- ''
- end
+ search_params[:completed_at_lt].to_date&.in_time_zone(current_timezone)&.end_of_day
+ rescue StandardError
+ ''
+ end
end
search_params[:vendor_orders_vendor_id_eq] = vendor.id if vendor.present?
search_params[:user_id_eq] = user.id if user.present?
+ # Handle refunded and partially_refunded payment state filters
+ if search_params[:payment_state_eq] == 'refunded'
+ search_params[:refunded] = '1'
+ search_params.delete(:payment_state_eq)
+ elsif search_params[:payment_state_eq] == 'partially_refunded'
+ search_params[:partially_refunded] = '1'
+ search_params.delete(:payment_state_eq)
+ end
+
search_params
end
diff --git a/admin/app/views/spree/admin/orders/_filters.html.erb b/admin/app/views/spree/admin/orders/_filters.html.erb
index 2cd277a6a0..8446888f89 100644
--- a/admin/app/views/spree/admin/orders/_filters.html.erb
+++ b/admin/app/views/spree/admin/orders/_filters.html.erb
@@ -42,10 +42,7 @@
<%= render 'spree/admin/shared/filters_button' %>
</div>
<div data-dropdown-target="menu" id="table-filter">
- <%= f.hidden_field :payment_state_eq, value: params.dig(:q, :payment_state_eq) %>
<%= f.hidden_field :payment_state_not_eq, value: params.dig(:q, :payment_state_not_eq) %>
- <%= f.hidden_field :refunded, value: params.dig(:q, :refunded) %>
- <%= f.hidden_field :partially_refunded, value: params.dig(:q, :partially_refunded) %>
<%= f.hidden_field :state_not_eq, value: params.dig(:q, :state_not_eq) %>
<%= f.hidden_field :user_id_eq, value: @user.try(:id) %>
@@ -78,6 +75,18 @@
filters_target: :input,
} %>
</div>
+ <div class="form-group">
+ <%= label_tag :q_payment_state_eq, Spree.t(:payment_state) %>
+ <% payment_state_options = Spree::Order::PAYMENT_STATES.map { |state| [Spree.t("payment_states.#{state}"), state] } %>
+ <% payment_state_options += [
+ [Spree.t('payment_states.refunded'), 'refunded'],
+ [Spree.t('payment_states.partially_refunded'), 'partially_refunded']
+ ] %>
+ <%= f.select :payment_state_eq,
+ payment_state_options,
+ { include_blank: true },
+ { class: "custom-select", data: { filters_target: :input } } %>
+ </div>
<%= render_admin_partials(:orders_filters_partials, f: f) %>
<%= render 'spree/admin/shared/filter_submit' %>
diff --git a/admin/spec/controllers/spree/admin/orders_controller_spec.rb b/admin/spec/controllers/spree/admin/orders_controller_spec.rb
index 596c59c30c..1865b9a5de 100644
--- a/admin/spec/controllers/spree/admin/orders_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/orders_controller_spec.rb
@@ -24,15 +24,33 @@ RSpec.describe Spree::Admin::OrdersController, type: :controller do
end
describe '#index' do
+ # Helper method to ensure payment states are correctly calculated after refunds
+ # This is necessary because refunds affect payment_total calculation:
+ # payment_total = payments.amount - refunds.amount
+ def update_payment_state_after_refund(order)
+ order.updater.update_payment_total
+ order.updater.update_payment_state
+ order.save!
+ order
+ end
+
let!(:shipped_order) { create(:shipped_order, with_payment: false, total: 100, store: store) }
let!(:order) { create(:completed_order_with_totals, line_items_count: 2, total: 100, store: store) }
- let(:line_item) { order.line_items.first }
- let!(:cancelled_order) { create(:completed_order_with_totals, state: 'canceled', total: 100, store: store) }
+ let!(:cancelled_order) do
+ order = create(:completed_order_with_totals, state: 'canceled', total: 100, store: store)
+ create(:payment, state: 'completed', amount: order.total, order: order)
+ update_payment_state_after_refund(order)
+ end
let!(:payment) { create(:payment, state: 'completed', amount: shipped_order.total, order: shipped_order) }
- let!(:cancelled_order_payment) { create(:payment, state: 'completed', amount: cancelled_order.total, order: cancelled_order) }
- let!(:refund) { create(:refund, payment: payment, amount: payment.amount) }
+ let!(:refund) do
+ create(:refund, payment: payment, amount: payment.amount)
+ update_payment_state_after_refund(shipped_order)
+ end
let!(:payment_one) { create(:payment, state: 'completed', amount: order.total, order: order) }
- let!(:partial_refund) { create(:refund, payment: payment_one, amount: (payment_one.amount - 10)) }
+ let!(:partial_refund) do
+ create(:refund, payment: payment_one, amount: (payment_one.amount - 10))
+ update_payment_state_after_refund(order)
+ end
it 'renders index' do
get :index
@@ -45,30 +63,68 @@ RSpec.describe Spree::Admin::OrdersController, type: :controller do
expect(assigns(:orders).to_a).to include(shipped_order)
end
- it "returns all fulfilled orders" do
+ it 'returns all fulfilled orders' do
get :index, params: { q: { shipment_state_eq: :shipped } }
expect(assigns(:orders).to_a).to eq([shipped_order])
end
- it "returns all cancelled orders" do
+ it 'returns all cancelled orders by shipment state' do
get :index, params: { q: { state_eq: :canceled } }
expect(assigns(:orders).to_a).to eq([cancelled_order])
end
- it "returns all refunded orders" do
+ it 'returns all refunded orders' do
get :index, params: { q: { refunded: '1' } }
expect(assigns(:orders).to_a).to eq([shipped_order])
end
- it "returns all partially refunded orders" do
+ it 'returns all partially refunded orders' do
get :index, params: { q: { partially_refunded: '1' } }
expect(assigns(:orders).to_a).to eq([order])
end
+ context 'filtering by payment state' do
+ let!(:balance_due_order) do
+ order = create(:completed_order_with_totals, line_items_count: 2, total: 100, store: store)
+ update_payment_state_after_refund(order)
+ end
+ let!(:paid_order) { create(:shipped_order, store: store) }
+
+ it 'returns all paid orders' do
+ get :index, params: { q: { payment_state_eq: :paid } }
+
+ expect(assigns(:orders).to_a).to contain_exactly(paid_order)
+ end
+
+ it 'returns all orders with credit owed' do
+ get :index, params: { q: { payment_state_eq: :credit_owed } }
+
+ expect(assigns(:orders).to_a).to contain_exactly(cancelled_order)
+ end
+
+ it 'returns all orders with balance due' do
+ get :index, params: { q: { payment_state_eq: :balance_due } }
+
+ expect(assigns(:orders).to_a).to contain_exactly(balance_due_order, order, shipped_order)
+ end
+
+ it 'returns all refunded orders via payment_state filter' do
+ get :index, params: { q: { payment_state_eq: :refunded } }
+
+ expect(assigns(:orders).to_a).to eq([shipped_order])
+ end
+
+ it 'returns all partially refunded orders via payment_state filter' do
+ get :index, params: { q: { payment_state_eq: :partially_refunded } }
+
+ expect(assigns(:orders).to_a).to eq([order])
+ end
+ end
+
context 'filtering by date' do
subject { get :index, params: { q: q } }
@@ -195,7 +251,7 @@ RSpec.describe Spree::Admin::OrdersController, type: :controller do
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
+ it 'does not delete a completed order' do
expect { subject }.not_to change(Spree::Order, :count)
expect(flash[:error]).to eq Spree.t(:authorization_failure)
@@ -209,7 +265,7 @@ RSpec.describe Spree::Admin::OrdersController, type: :controller do
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(flash[:success]).to eq 'Order has been successfully removed!'
expect(response).to redirect_to spree.admin_checkouts_path
end
end