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.

Add Spree::Export support for coupon codes (#13712)

Damian Legawiecac93f1762ffb
diff --git a/spree/admin/app/controllers/spree/admin/coupon_codes_controller.rb b/spree/admin/app/controllers/spree/admin/coupon_codes_controller.rb
index bcafbc75bb..adb48a0013 100644
--- a/spree/admin/app/controllers/spree/admin/coupon_codes_controller.rb
+++ b/spree/admin/app/controllers/spree/admin/coupon_codes_controller.rb
@@ -4,6 +4,12 @@ module Spree
belongs_to 'spree/promotion', find_by: :prefix_id
include PromotionsBreadcrumbConcern
+
+ def index
+ params[:q] ||= {}
+ params[:q][:promotion_id_eq] ||= parent.id
+ super
+ end
end
end
end
diff --git a/spree/admin/app/views/spree/admin/coupon_codes/_filters.html.erb b/spree/admin/app/views/spree/admin/coupon_codes/_filters.html.erb
deleted file mode 100644
index 89b345067b..0000000000
--- a/spree/admin/app/views/spree/admin/coupon_codes/_filters.html.erb
+++ /dev/null
@@ -1,41 +0,0 @@
-<%= search_form_for [:admin, @promotion, @search], class: "filter-wrap", data: {controller: "filters"} do |f| %>
- <div class="flex flex-col lg:flex-row gap-2">
- <%= render 'spree/admin/shared/filters_search_bar', param: :code_i_cont %>
-
- <div class="flex items-center justify-between">
- <%= dropdown do %>
- <%= dropdown_toggle class: 'btn-light dropdown-toggle' do %>
- <span class="text-gray-600 font-normal mr-1">
- <%= Spree.t(:show) %>
- </span>
- <%= Spree.t(:all) if (params[:q] || {}).values_at(:state_eq).all?(&:blank?) %>
- <%= Spree.t('admin.coupon_codes.used') if params.dig(:q, :state_eq) == 'used' %>
- <%= Spree.t('admin.coupon_codes.unused') if params.dig(:q, :state_eq) == 'unused' %>
- <% end %>
- <%= dropdown_menu do %>
- <%= active_link_to Spree.t(:all),
- spree.admin_promotion_coupon_codes_path(@promotion),
- class: 'dropdown-item',
- active: (params[:q] || {}).values_at(:state_eq).all?(&:blank?) %>
- <%= link_to Spree.t('admin.coupon_codes.used'),
- spree.admin_promotion_coupon_codes_path(@promotion, q: {state_eq: :used}),
- class: "dropdown-item #{'active' if params.dig(:q, :state_eq) == 'used'}" %>
- <%= link_to Spree.t('admin.coupon_codes.unused'),
- spree.admin_promotion_coupon_codes_path(@promotion, q: {state_eq: :unused}),
- class: "dropdown-item #{'active' if params.dig(:q, :state_eq) == 'unused'}" %>
- <% end %>
- <% end %>
- </div>
-
- <div data-controller="tooltip">
- <%= link_to spree.admin_promotion_coupon_codes_path(@promotion, format: :csv), class: 'btn btn-light' do %>
- <%= icon 'download' %>
- <%= Spree.t(:download) %>
- <% end %>
- <%= tooltip(Spree.t('admin.export_coupons')) %>
- </div>
- </div>
-
- <%= render "spree/admin/shared/filter_badge_template" %>
- <div data-filters-target="badgesContainer" class="filter-badges-container"></div>
-<% end %>
\ No newline at end of file
diff --git a/spree/admin/app/views/spree/admin/coupon_codes/_table_header.html.erb b/spree/admin/app/views/spree/admin/coupon_codes/_table_header.html.erb
deleted file mode 100644
index e69de29bb2..0000000000
diff --git a/spree/admin/app/views/spree/admin/coupon_codes/_table_row.html.erb b/spree/admin/app/views/spree/admin/coupon_codes/_table_row.html.erb
deleted file mode 100644
index a0a665d4f5..0000000000
--- a/spree/admin/app/views/spree/admin/coupon_codes/_table_row.html.erb
+++ /dev/null
@@ -1,8 +0,0 @@
-<tr id="<%= spree_dom_id coupon_code %>">
- <td class="w-1/2">
- <code><%= coupon_code.code.upcase %></code>
- <%= clipboard_component(coupon_code.code.upcase) %>
- </td>
- <td class="w-1/4 text-sm"><%= active_badge(coupon_code.state == 'used') %></td>
- <td class="w-1/4 text-sm"><%= spree_time(coupon_code.created_at) %></td>
-</tr>
diff --git a/spree/admin/app/views/spree/admin/coupon_codes/index.csv.erb b/spree/admin/app/views/spree/admin/coupon_codes/index.csv.erb
deleted file mode 100644
index 7036153c85..0000000000
--- a/spree/admin/app/views/spree/admin/coupon_codes/index.csv.erb
+++ /dev/null
@@ -1,14 +0,0 @@
-<%- headers = [
- 'Coupon',
- 'State',
- 'Created at'
- ]
--%>
-<%= CSV.generate_line(headers).strip %>
-<%- @coupon_codes.pluck(:code, :state, :created_at).each do |coupon_code| -%>
-<%= CSV.generate_line([
- coupon_code[0].upcase,
- coupon_code[1],
- coupon_code[2]
- ]).strip %>
-<%- end -%>
diff --git a/spree/admin/app/views/spree/admin/coupon_codes/index.html.erb b/spree/admin/app/views/spree/admin/coupon_codes/index.html.erb
index 4626246840..5671b50e9f 100644
--- a/spree/admin/app/views/spree/admin/coupon_codes/index.html.erb
+++ b/spree/admin/app/views/spree/admin/coupon_codes/index.html.erb
@@ -2,13 +2,14 @@
<% content_for :page_actions do %>
<%= render_admin_partials(:coupon_codes_actions_partials) %>
+ <%= link_to_export_modal %>
<% end %>
<%= render_admin_partials(:coupon_codes_header_partials) %>
<div class="grid grid-cols-12 gap-6">
<div class="col-span-12 lg:col-span-8">
- <%= render 'spree/admin/shared/index_table', new_object_url: nil %>
+ <%= render_table @collection, :coupon_codes, export_type: Spree::Exports::CouponCodes %>
</div>
<div class="col-span-12 lg:col-span-4">
diff --git a/spree/admin/config/initializers/spree_admin_tables.rb b/spree/admin/config/initializers/spree_admin_tables.rb
index 2e01dc3c0a..a8c884b519 100644
--- a/spree/admin/config/initializers/spree_admin_tables.rb
+++ b/spree/admin/config/initializers/spree_admin_tables.rb
@@ -1614,4 +1614,39 @@ Rails.application.config.after_initialize do
sortable: true,
default: true,
position: 40
+
+ # ==========================================
+ # Register Coupon Codes table
+ # ==========================================
+ Spree.admin.tables.register(:coupon_codes, model_class: Spree::CouponCode, search_param: :code_i_cont, new_resource: false)
+
+ Spree.admin.tables.coupon_codes.add :code,
+ label: :code,
+ type: :string,
+ sortable: true,
+ filterable: true,
+ default: true,
+ position: 10,
+ method: ->(coupon_code) { coupon_code.display_code }
+
+ Spree.admin.tables.coupon_codes.add :state,
+ label: :status,
+ type: :status,
+ filter_type: :select,
+ sortable: true,
+ filterable: true,
+ default: true,
+ position: 20,
+ value_options: [
+ { value: 'unused', label: 'Unused' },
+ { value: 'used', label: 'Used' }
+ ]
+
+ Spree.admin.tables.coupon_codes.add :created_at,
+ label: :created_at,
+ type: :datetime,
+ sortable: true,
+ filterable: false,
+ default: true,
+ position: 30
end
diff --git a/spree/admin/spec/controllers/spree/admin/coupon_codes_controller_spec.rb b/spree/admin/spec/controllers/spree/admin/coupon_codes_controller_spec.rb
new file mode 100644
index 0000000000..701a35b2f9
--- /dev/null
+++ b/spree/admin/spec/controllers/spree/admin/coupon_codes_controller_spec.rb
@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::CouponCodesController, type: :controller do
+ stub_authorization!
+ render_views
+
+ let(:store) { @default_store }
+ let(:promotion) { create(:promotion, stores: [store]) }
+
+ describe '#index' do
+ let!(:coupon_code) { create(:coupon_code, promotion: promotion) }
+
+ subject { get :index, params: { promotion_id: promotion.to_param } }
+
+ it 'renders the index template' do
+ subject
+ expect(response).to render_template(:index)
+ expect(response).to have_http_status(:ok)
+ end
+
+ it 'assigns the collection scoped to the promotion' do
+ other_promotion = create(:promotion, stores: [store])
+ other_coupon_code = create(:coupon_code, promotion: other_promotion)
+
+ subject
+
+ expect(assigns(:collection)).to include(coupon_code)
+ expect(assigns(:collection)).not_to include(other_coupon_code)
+ end
+
+ it 'injects promotion_id_eq into ransack params' do
+ subject
+ expect(controller.params[:q][:promotion_id_eq]).to eq(promotion.id)
+ end
+
+ context 'with code search' do
+ let!(:matching_coupon) { create(:coupon_code, code: 'summer20', promotion: promotion) }
+ let!(:other_coupon) { create(:coupon_code, code: 'winter10', promotion: promotion) }
+
+ it 'filters by code' do
+ get :index, params: { promotion_id: promotion.to_param, q: { code_i_cont: 'summer' } }
+
+ expect(assigns(:collection)).to include(matching_coupon)
+ expect(assigns(:collection)).not_to include(other_coupon)
+ end
+ end
+ end
+end
diff --git a/spree/core/app/jobs/spree/exports/generate_job.rb b/spree/core/app/jobs/spree/exports/generate_job.rb
index 8fac5ca946..9ae56963c6 100644
--- a/spree/core/app/jobs/spree/exports/generate_job.rb
+++ b/spree/core/app/jobs/spree/exports/generate_job.rb
@@ -4,7 +4,7 @@ module Spree
queue_as Spree.queues.exports
def perform(export_id)
- export = Spree::Export.find(export_id)
+ export = Spree::Export.find_by_prefix_id!(export_id)
export.generate
end
end
diff --git a/spree/core/app/jobs/spree/reports/generate_job.rb b/spree/core/app/jobs/spree/reports/generate_job.rb
index 937a86edf8..b9ebe7f9e9 100644
--- a/spree/core/app/jobs/spree/reports/generate_job.rb
+++ b/spree/core/app/jobs/spree/reports/generate_job.rb
@@ -4,7 +4,7 @@ module Spree
queue_as Spree.queues.reports
def perform(report_id)
- report = Spree::Report.find(report_id)
+ report = Spree::Report.find_by_prefix_id!(report_id)
report.generate
end
end
diff --git a/spree/core/app/models/spree/coupon_code.rb b/spree/core/app/models/spree/coupon_code.rb
index 76f0999da5..2e335e0689 100644
--- a/spree/core/app/models/spree/coupon_code.rb
+++ b/spree/core/app/models/spree/coupon_code.rb
@@ -19,7 +19,8 @@ module Spree
validates :code, presence: true, uniqueness: { scope: spree_base_uniqueness_scope, conditions: -> { where(deleted_at: nil) } }
validates :state, :promotion, presence: true
- self.whitelisted_ransackable_attributes = %w[state code]
+ self.whitelisted_ransackable_attributes = %w[state code promotion_id]
+ self.whitelisted_ransackable_associations = %w[promotion]
def self.used?(code)
used_with_code(code).any?
@@ -36,5 +37,9 @@ module Spree
def display_code
code.upcase
end
+
+ def to_csv(_store = nil)
+ Spree::CSV::CouponCodePresenter.new(self).call
+ end
end
end
diff --git a/spree/core/app/models/spree/exports/coupon_codes.rb b/spree/core/app/models/spree/exports/coupon_codes.rb
new file mode 100644
index 0000000000..907506334e
--- /dev/null
+++ b/spree/core/app/models/spree/exports/coupon_codes.rb
@@ -0,0 +1,18 @@
+module Spree
+ module Exports
+ class CouponCodes < Spree::Export
+ def csv_headers
+ Spree::CSV::CouponCodePresenter::HEADERS
+ end
+
+ def scope_includes
+ [:promotion, :order]
+ end
+
+ def scope
+ model_class.joins(promotion: :stores).where(spree_stores: { id: store.id })
+ .accessible_by(current_ability)
+ end
+ end
+ end
+end
diff --git a/spree/core/app/presenters/spree/csv/coupon_code_presenter.rb b/spree/core/app/presenters/spree/csv/coupon_code_presenter.rb
new file mode 100644
index 0000000000..92a2804b3b
--- /dev/null
+++ b/spree/core/app/presenters/spree/csv/coupon_code_presenter.rb
@@ -0,0 +1,31 @@
+module Spree
+ module CSV
+ class CouponCodePresenter
+ HEADERS = [
+ 'Code',
+ 'State',
+ 'Promotion Name',
+ 'Order Number',
+ 'Created At',
+ 'Updated At'
+ ].freeze
+
+ def initialize(coupon_code)
+ @coupon_code = coupon_code
+ end
+
+ attr_accessor :coupon_code
+
+ def call
+ [
+ coupon_code.display_code,
+ coupon_code.state,
+ coupon_code.promotion&.name,
+ coupon_code.order&.number,
+ coupon_code.created_at&.strftime('%Y-%m-%d %H:%M:%S'),
+ coupon_code.updated_at&.strftime('%Y-%m-%d %H:%M:%S')
+ ]
+ end
+ end
+ end
+end
diff --git a/spree/core/lib/spree/core/engine.rb b/spree/core/lib/spree/core/engine.rb
index 2df84209f0..7af4209347 100644
--- a/spree/core/lib/spree/core/engine.rb
+++ b/spree/core/lib/spree/core/engine.rb
@@ -180,7 +180,8 @@ module Spree
Spree::Exports::Orders,
Spree::Exports::Customers,
Spree::Exports::GiftCards,
- Spree::Exports::NewsletterSubscribers
+ Spree::Exports::NewsletterSubscribers,
+ Spree::Exports::CouponCodes
]
Rails.application.config.spree.import_types = [
diff --git a/spree/core/spec/jobs/spree/exports/generate_job_spec.rb b/spree/core/spec/jobs/spree/exports/generate_job_spec.rb
index 0da3066893..55e721ae19 100644
--- a/spree/core/spec/jobs/spree/exports/generate_job_spec.rb
+++ b/spree/core/spec/jobs/spree/exports/generate_job_spec.rb
@@ -6,7 +6,7 @@ RSpec.describe Spree::Exports::GenerateJob, type: :job do
let!(:export) { create(:product_export, store: store, user: user, format: 'csv') }
describe '#perform' do
- subject(:perform_job) { described_class.perform_now(export.id) }
+ subject(:perform_job) { described_class.perform_now(export.prefixed_id) }
it 'calls generate on the export' do
expect_any_instance_of(Spree::Export).to receive(:generate)
diff --git a/spree/core/spec/presenters/spree/csv/coupon_code_presenter_spec.rb b/spree/core/spec/presenters/spree/csv/coupon_code_presenter_spec.rb
new file mode 100644
index 0000000000..e0c1354ec3
--- /dev/null
+++ b/spree/core/spec/presenters/spree/csv/coupon_code_presenter_spec.rb
@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+RSpec.describe Spree::CSV::CouponCodePresenter, type: :model do
+ let(:promotion) { create(:promotion, name: 'Summer Sale') }
+ let(:order) { create(:order, number: 'R123456') }
+ let(:coupon_code) do
+ create(:coupon_code,
+ code: 'summer20',
+ state: :used,
+ promotion: promotion,
+ order: order)
+ end
+ let(:presenter) { described_class.new(coupon_code) }
+
+ describe '#call' do
+ subject { presenter.call }
+
+ it 'returns the correct CSV data' do
+ expect(subject).to be_an(Array)
+ expect(subject[0]).to eq('SUMMER20') # Code (uppercased)
+ expect(subject[1]).to eq('used') # State
+ expect(subject[2]).to eq('Summer Sale') # Promotion Name
+ expect(subject[3]).to eq('R123456') # Order Number
+ expect(subject[4]).to be_present # Created At
+ expect(subject[5]).to be_present # Updated At
+ end
+
+ context 'when coupon code is unused' do
+ let(:coupon_code) { create(:coupon_code, state: :unused, promotion: promotion) }
+
+ it 'returns nil for order number' do
+ expect(subject[1]).to eq('unused')
+ expect(subject[3]).to be_nil
+ end
+ end
+ end
+
+ describe 'HEADERS' do
+ it 'has the correct headers' do
+ expected_headers = [
+ 'Code',
+ 'State',
+ 'Promotion Name',
+ 'Order Number',
+ 'Created At',
+ 'Updated At'
+ ]
+ expect(described_class::HEADERS).to eq(expected_headers)
+ end
+ end
+end
diff --git a/spree/core/spec/subscribers/spree/export_subscriber_spec.rb b/spree/core/spec/subscribers/spree/export_subscriber_spec.rb
index 573e4f0c59..ef6a3baffe 100644
--- a/spree/core/spec/subscribers/spree/export_subscriber_spec.rb
+++ b/spree/core/spec/subscribers/spree/export_subscriber_spec.rb
@@ -21,18 +21,18 @@ RSpec.describe Spree::ExportSubscriber do
let(:subscriber) { described_class.new }
let(:export) { create(:export, store: store, user: user) }
- it 'extracts export_id from event payload' do
+ it 'passes prefixed ID to job' do
event = Spree::Event.new(
name: 'export.created',
- payload: { 'id' => export.id }
+ payload: { 'id' => export.prefixed_id }
)
- expect(Spree::Exports::GenerateJob).to receive(:perform_later).with(export.id)
+ expect(Spree::Exports::GenerateJob).to receive(:perform_later).with(export.prefixed_id)
subscriber.generate_export_async(event)
end
- it 'does not call job if export_id is missing' do
+ it 'does not call job if id is missing' do
event = Spree::Event.new(
name: 'export.created',
payload: {}
diff --git a/spree/core/spec/subscribers/spree/report_subscriber_spec.rb b/spree/core/spec/subscribers/spree/report_subscriber_spec.rb
index 95164c44d5..53667518a4 100644
--- a/spree/core/spec/subscribers/spree/report_subscriber_spec.rb
+++ b/spree/core/spec/subscribers/spree/report_subscriber_spec.rb
@@ -30,18 +30,18 @@ RSpec.describe Spree::ReportSubscriber do
)
end
- it 'extracts report_id from event payload' do
+ it 'passes prefixed ID to job' do
event = Spree::Event.new(
name: 'report.created',
- payload: { 'id' => report.id }
+ payload: { 'id' => report.prefixed_id }
)
- expect(Spree::Reports::GenerateJob).to receive(:perform_later).with(report.id)
+ expect(Spree::Reports::GenerateJob).to receive(:perform_later).with(report.prefixed_id)
subscriber.generate_report_async(event)
end
- it 'does not call job if report_id is missing' do
+ it 'does not call job if id is missing' do
event = Spree::Event.new(
name: 'report.created',
payload: {}