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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Fix/improve Gift Card exporter (#12958)
Damian Legawiec552d41aba35c
diff --git a/.claude/settings.local.json b/.claude/settings.local.jsonnew file mode 100644index 0000000000..7ab249f7d3--- /dev/null+++ b/.claude/settings.local.json@@ -0,0 +1,11 @@+{+ "permissions": {+ "allow": [+ "Bash(rm:*)",+ "Bash(find:*)",+ "Bash(bundle exec rspec:*)",+ "Bash(bundle exec rails c:*)"+ ],+ "deny": []+ }+}\ No newline at end of filediff --git a/admin/app/controllers/spree/admin/gift_cards_controller.rb b/admin/app/controllers/spree/admin/gift_cards_controller.rbindex 5a69cae5a1..7c860e10cd 100644--- a/admin/app/controllers/spree/admin/gift_cards_controller.rb+++ b/admin/app/controllers/spree/admin/gift_cards_controller.rb@@ -31,16 +31,11 @@ module Spreeparams[:q][:user_id_eq] = params[:user_id] if params[:user_id].present?@search = @collection-- @search = @search.expired if params[:q][:status_eq] == 'expired'- @search = @search.active if params[:q][:status_eq] == 'active'- @search = @search.redeemed if params[:q][:status_eq] == 'redeemed'-@search = @search.ransack(params[:q])@collection = @search.result.includes(:user, :created_by)- @collection = @collection.page(params[:page]).per(params[:per_page]) if params[:format] != 'csv'+ @collection = @collection.page(params[:page]).per(params[:per_page])@collectionend@@ -62,15 +57,14 @@ module Spreeenddef gift_cards_filter_dropdown_value- case params.dig(:q, :status_eq)- when 'active'+ if params.dig(:q, :active).present?Spree.t('admin.gift_cards.active')- when 'expired'+ elsif params.dig(:q, :expired).present?Spree.t(:expired)- when 'redeemed'+ elsif params.dig(:q, :redeemed).present?Spree.t('admin.gift_cards.redeemed')else- Spree.t('admin.gift_cards.all')+ Spree.t('admin.gift_cards.all_statuses')endenddiff --git a/admin/app/views/spree/admin/gift_cards/_filters.html.erb b/admin/app/views/spree/admin/gift_cards/_filters.html.erbindex c8911caae9..fcac5f3588 100644--- a/admin/app/views/spree/admin/gift_cards/_filters.html.erb+++ b/admin/app/views/spree/admin/gift_cards/_filters.html.erb@@ -11,7 +11,7 @@<%= hidden_field_tag :frame_name, frame_name if frame_name.present? %><div class="d-flex flex-column flex-lg-row gap-2">- <%= render 'spree/admin/shared/filters_search_bar', param: :code_eq, label: Spree.t(:code) %>+ <%= render 'spree/admin/shared/filters_search_bar', param: :code_i_cont, label: Spree.t(:code) %><%= render "table_filter_dropdown" %><%= render "spree/admin/shared/filters_button" %></div>diff --git a/admin/app/views/spree/admin/gift_cards/_table_filter_dropdown.html.erb b/admin/app/views/spree/admin/gift_cards/_table_filter_dropdown.html.erbindex 047c0b1e51..4b1487ea0f 100644--- a/admin/app/views/spree/admin/gift_cards/_table_filter_dropdown.html.erb+++ b/admin/app/views/spree/admin/gift_cards/_table_filter_dropdown.html.erb@@ -5,19 +5,19 @@</button><div class="dropdown-menu w-100" style="min-width: 200px">- <%= active_link_to Spree.t('admin.gift_cards.all_statuses'), params.to_unsafe_h.deep_merge({page: nil, q: {status_eq: nil}}), class: 'dropdown-item', active: (params[:q] || {}).values_at(*%w[status_eq in_stock_items out_of_stock_items] ).all?(&:blank?) %>+ <%= active_link_to Spree.t('admin.gift_cards.all_statuses'), params.to_unsafe_h.deep_merge({page: nil, q: {active: nil, expired: nil, redeemed: nil, partially_redeemed: nil}}), class: 'dropdown-item', active: (params[:q] || {}).values_at(*%w[active expired redeemed partially_redeemed] ).all?(&:blank?) %><%= link_to Spree.t('admin.gift_cards.active'),- params.to_unsafe_h.deep_merge({page: nil, q: {status_eq: :active}}),- class: "dropdown-item #{'active' if params[:q] && params[:q][:status_eq] == 'active'}" %>+ params.to_unsafe_h.deep_merge({page: nil, q: {active: true, expired: nil, redeemed: nil, partially_redeemed: nil}}),+ class: "dropdown-item #{'active' if params[:q] && params[:q][:active].present?}" %>- <%= link_to params.to_unsafe_h.deep_merge({page: nil, q: {status_eq: :expired}}),- class: "dropdown-item #{'active' if params[:q] && params[:q][:status_eq] == 'expired'}" do %>+ <%= link_to params.to_unsafe_h.deep_merge({page: nil, q: {expired: true, active: nil, redeemed: nil, partially_redeemed: nil}}),+ class: "dropdown-item #{'active' if params[:q] && params[:q][:expired].present?}" do %><%= Spree.t(:expired) %><% end %>- <%= link_to params.to_unsafe_h.deep_merge({page: nil, q: {status_eq: :redeemed}}),- class: "dropdown-item #{'active' if params[:q] && params[:q][:status_eq] == 'redeemed'}" do %>+ <%= link_to params.to_unsafe_h.deep_merge({page: nil, q: {redeemed: true, active: nil, expired: nil, partially_redeemed: nil}}),+ class: "dropdown-item #{'active' if params[:q] && params[:q][:redeemed].present?}" do %><%= Spree.t('admin.gift_cards.redeemed') %><% end %>diff --git a/admin/app/views/spree/admin/gift_cards/index.csv.erb b/admin/app/views/spree/admin/gift_cards/index.csv.erbdeleted file mode 100644index 941fe209fb..0000000000--- a/admin/app/views/spree/admin/gift_cards/index.csv.erb+++ /dev/null@@ -1,22 +0,0 @@-<%- headers = [- Spree.t(:code),- Spree.t(:amount),- Spree.t(:used),- Spree.t(:currency),- Spree.t(:status),- Spree.t(:expires_at),- Spree.t(:customer)- ]--%>-<%= CSV.generate_line(headers).strip %>-<%- @collection.find_each do |gift_card| -%>- <%= CSV.generate_line([- gift_card.display_code,- gift_card.display_amount,- gift_card.display_amount_used,- gift_card.currency,- gift_card.display_state,- gift_card.expires_at,- gift_card.user&.email,- ]).strip %>-<%- end -%>diff --git a/admin/app/views/spree/admin/gift_cards/index.html.erb b/admin/app/views/spree/admin/gift_cards/index.html.erbindex cd9aa0a1d3..ce10f118e8 100644--- a/admin/app/views/spree/admin/gift_cards/index.html.erb+++ b/admin/app/views/spree/admin/gift_cards/index.html.erb@@ -4,10 +4,7 @@<% end %><% content_for :page_actions do %>- <%= link_to spree.admin_gift_cards_path(q: params[:q].to_unsafe_hash, per_page: params[:per_page], format: :csv), id: 'gift-card-batch-export-link', class: 'btn btn-light bg-transparent with-tip', title: 'Export gift cards to a CSV file' do %>- <%= icon 'table-export', class: 'mr-2' %>- <%= Spree.t(:export) %>- <% end %>+ <%= link_to_export_modal %><div class="dropdown" id="page_actions_dropdown"><%= link_to_with_icon 'plus', Spree.t(:new_gift_card), '#', class: 'text-nowrap btn btn-primary align-self-center', data: { toggle: 'dropdown' }, id: 'more-actions-link' %>@@ -36,6 +33,7 @@<% end %><% else %><%= turbo_frame_tag "gift_cards", autoscroll: true, data: { autoscroll_behavior: :smooth, turbo_action: 'advance' } do %>+ <%= render 'spree/admin/shared/export_modal', export_type: Spree::Exports::GiftCards %><%= render 'filters' %><%= render 'list' %><% end %>diff --git a/admin/config/locales/en.yml b/admin/config/locales/en.ymlindex 1afd65222b..596c682770 100644--- a/admin/config/locales/en.yml+++ b/admin/config/locales/en.yml@@ -83,7 +83,6 @@ en:prefix: Prefixgift_cards:active: Active- all: Allall_statuses: All statusescode_help_text: If you leave it blank, we will generate code for youredeemed: Redeemeddiff --git a/admin/spec/controllers/spree/admin/gift_cards_controller_spec.rb b/admin/spec/controllers/spree/admin/gift_cards_controller_spec.rbindex 17afa9ac8e..c7c3bf5d7b 100644--- a/admin/spec/controllers/spree/admin/gift_cards_controller_spec.rb+++ b/admin/spec/controllers/spree/admin/gift_cards_controller_spec.rb@@ -38,19 +38,19 @@ describe Spree::Admin::GiftCardsController, type: :controller dolet!(:redeemed_gift_card) { create(:gift_card, :redeemed, user: user) }it 'filters by active status' do- get :index, params: { q: { status_eq: 'active' } }+ get :index, params: { q: { active: true } }expect(assigns(:collection)).to include(active_gift_card)expect(assigns(:collection)).not_to include(expired_gift_card, redeemed_gift_card)endit 'filters by expired status' do- get :index, params: { q: { status_eq: 'expired' } }+ get :index, params: { q: { expired: true } }expect(assigns(:collection)).to include(expired_gift_card)expect(assigns(:collection)).not_to include(active_gift_card, redeemed_gift_card)endit 'filters by redeemed status' do- get :index, params: { q: { status_eq: 'redeemed' } }+ get :index, params: { q: { redeemed: true } }expect(assigns(:collection)).to include(redeemed_gift_card)expect(assigns(:collection)).not_to include(active_gift_card, expired_gift_card)end@@ -64,22 +64,6 @@ describe Spree::Admin::GiftCardsController, type: :controller doendendend-- context 'with CSV format' do- it 'renders the CSV template' do- gift_cards = create_list(:gift_card, 3)- get :index, params: { format: :csv }- expect(response).to render_template(:index)- expect(response).to have_http_status(:ok)- expect(response.body).to include("Code,Amount,Used,Currency,Status,Expires at,Customer")- gift_cards.each do |gift_card|- expect(response.body).to include(gift_card.display_code)- expect(response.body).to include(gift_card.display_amount.to_html)- expect(response.body).to include(gift_card.display_amount_used.to_html)- expect(response.body).to include(gift_card.currency)- end- end- endenddescribe '#show' dodiff --git a/core/app/models/spree/exports/gift_cards.rb b/core/app/models/spree/exports/gift_cards.rbnew file mode 100644index 0000000000..1c4c29d3f2--- /dev/null+++ b/core/app/models/spree/exports/gift_cards.rb@@ -0,0 +1,13 @@+module Spree+ module Exports+ class GiftCards < Spree::Export+ def scope_includes+ [:user]+ end++ def csv_headers+ Spree::CSV::GiftCardPresenter::HEADERS+ end+ end+ end+end\ No newline at end of filediff --git a/core/app/models/spree/gift_card.rb b/core/app/models/spree/gift_card.rbindex 55cf2ea3d2..f34416b907 100644--- a/core/app/models/spree/gift_card.rb+++ b/core/app/models/spree/gift_card.rb@@ -53,8 +53,9 @@ module Spree## Ransack#- self.whitelisted_ransackable_attributes = %w[code user_id]+ self.whitelisted_ransackable_attributes = %w[code user_id state]self.whitelisted_ransackable_associations = %w[users orders batch]+ self.whitelisted_ransackable_scopes = %w[active expired redeemed partially_redeemed]auto_strip_attributes :code@@ -129,6 +130,10 @@ module Spreeend.to_send+ def to_csv(_store = nil)+ Spree::CSV::GiftCardPresenter.new(self).call+ end+privatedef generate_codediff --git a/core/app/presenters/spree/csv/gift_card_presenter.rb b/core/app/presenters/spree/csv/gift_card_presenter.rbnew file mode 100644index 0000000000..3b9aa748d9--- /dev/null+++ b/core/app/presenters/spree/csv/gift_card_presenter.rb@@ -0,0 +1,43 @@+module Spree+ module CSV+ class GiftCardPresenter+ HEADERS = [+ 'Code',+ 'Amount',+ 'Amount Used',+ 'Amount Remaining',+ 'Currency',+ 'Status',+ 'Expires At',+ 'Customer Email',+ 'Customer First Name',+ 'Customer Last Name',+ 'Created At',+ 'Updated At'+ ].freeze++ def initialize(gift_card)+ @gift_card = gift_card+ end++ attr_accessor :gift_card++ def call+ [+ gift_card.display_code,+ gift_card.display_amount,+ gift_card.display_amount_used,+ gift_card.display_amount_remaining,+ gift_card.currency,+ gift_card.display_state,+ gift_card.expires_at&.strftime('%Y-%m-%d'),+ gift_card.user&.email,+ gift_card.user&.first_name,+ gift_card.user&.last_name,+ gift_card.created_at&.strftime('%Y-%m-%d %H:%M:%S'),+ gift_card.updated_at&.strftime('%Y-%m-%d %H:%M:%S')+ ]+ end+ end+ end+end\ No newline at end of filediff --git a/core/lib/spree/core/engine.rb b/core/lib/spree/core/engine.rbindex 398a7b596f..acc752c817 100644--- a/core/lib/spree/core/engine.rb+++ b/core/lib/spree/core/engine.rb@@ -151,7 +151,8 @@ module SpreeRails.application.config.spree.export_types = [Spree::Exports::Products,Spree::Exports::Orders,- Spree::Exports::Customers+ Spree::Exports::Customers,+ Spree::Exports::GiftCards]Rails.application.config.spree.taxon_rules = [diff --git a/core/spec/models/spree/exports/gift_cards_spec.rb b/core/spec/models/spree/exports/gift_cards_spec.rbnew file mode 100644index 0000000000..ac28d345e5--- /dev/null+++ b/core/spec/models/spree/exports/gift_cards_spec.rb@@ -0,0 +1,50 @@+require 'spec_helper'++RSpec.describe Spree::Exports::GiftCards, type: :model do+ let(:store) { @default_store }+ let(:admin_user) { create(:admin_user) }+ let(:export) { described_class.new(store: store, user: admin_user) }++ describe '#records_to_export' do+ context 'when search_params is nil' do+ let!(:gift_card_1) { create(:gift_card, store: store) }+ let!(:gift_card_2) { create(:gift_card, store: store) }++ it 'includes all gift cards for the store' do+ expect(export.records_to_export).to include(gift_card_1)+ expect(export.records_to_export).to include(gift_card_2)+ end+ end++ context 'when search_params filters by status' do+ let!(:active_gift_card) { create(:gift_card, store: store) }+ let!(:redeemed_gift_card) { create(:gift_card, :redeemed, store: store) }+ let(:export) { described_class.new(store: store, user: admin_user, search_params: { active: true }) }++ it 'includes only active gift cards' do+ expect(export.records_to_export).to include(active_gift_card)+ expect(export.records_to_export).not_to include(redeemed_gift_card)+ end+ end+ end++ describe '#csv_headers' do+ it 'returns the correct headers' do+ expected_headers = [+ 'Code',+ 'Amount',+ 'Amount Used',+ 'Amount Remaining',+ 'Currency',+ 'Status',+ 'Expires At',+ 'Customer Email',+ 'Customer First Name',+ 'Customer Last Name',+ 'Created At',+ 'Updated At'+ ]+ expect(export.csv_headers).to eq(expected_headers)+ end+ end+enddiff --git a/core/spec/models/spree/gift_card_spec.rb b/core/spec/models/spree/gift_card_spec.rbindex 23fd9d6d06..0764c393fe 100644--- a/core/spec/models/spree/gift_card_spec.rb+++ b/core/spec/models/spree/gift_card_spec.rb@@ -1,6 +1,8 @@require 'spec_helper'RSpec.describe Spree::GiftCard, type: :model do+ let(:store) { @default_store }+describe 'Callbacks' dodescribe '#ensure_can_be_deleted' doit "ensures a used gift card can't be destroyed" do@@ -120,4 +122,31 @@ RSpec.describe Spree::GiftCard, type: :model doendendend++ describe '#to_csv' do+ let(:user) { create(:user, first_name: 'John', last_name: 'Doe', email: '[email protected]') }+ let(:gift_card) { create(:gift_card, store: store, user: user, amount: 50.00) }++ subject { gift_card.to_csv }++ it 'returns an array' do+ expect(subject).to be_an(Array)+ end++ it 'returns the correct number of fields' do+ expect(subject.length).to eq(12)+ end++ it 'includes the gift card code' do+ expect(subject[0]).to eq(gift_card.display_code)+ end++ it 'includes the currency' do+ expect(subject[4]).to eq(gift_card.currency)+ end++ it 'includes the user email' do+ expect(subject[7]).to eq(user.email)+ end+ endenddiff --git a/core/spec/presenters/spree/csv/gift_card_presenter_spec.rb b/core/spec/presenters/spree/csv/gift_card_presenter_spec.rbnew file mode 100644index 0000000000..da32112e4b--- /dev/null+++ b/core/spec/presenters/spree/csv/gift_card_presenter_spec.rb@@ -0,0 +1,72 @@+require 'spec_helper'++RSpec.describe Spree::CSV::GiftCardPresenter, type: :model do+ let(:store) { create(:store) }+ let(:user) { create(:user, first_name: 'John', last_name: 'Doe', email: '[email protected]') }+ let(:gift_card) do+ create(:gift_card,+ code: 'ABC123',+ amount: 50.00,+ amount_used: 10.00,+ currency: 'USD',+ state: 'active',+ expires_at: Date.new(2025, 12, 31),+ user: user,+ store: store)+ end+ let(:presenter) { described_class.new(gift_card) }++ describe '#call' do+ subject { presenter.call }++ it 'returns the correct CSV data' do+ expect(subject).to be_an(Array)+ expect(subject.length).to eq(12)+ expect(subject[0]).to eq('ABC123') # Code+ expect(subject[4]).to eq('USD') # Currency+ expect(subject[5]).to eq('active') # Status+ expect(subject[6]).to eq('2025-12-31') # Expires At+ expect(subject[7]).to eq('[email protected]') # Customer Email+ expect(subject[8]).to eq('John') # Customer First Name+ expect(subject[9]).to eq('Doe') # Customer Last Name+ end++ context 'when gift card has no user' do+ let(:gift_card) { create(:gift_card, user: nil, store: store) }++ it 'returns nil for customer fields' do+ expect(subject[7]).to be_nil # Customer Email+ expect(subject[8]).to be_nil # Customer First Name+ expect(subject[9]).to be_nil # Customer Last Name+ end+ end++ context 'when gift card has no expiration date' do+ let(:gift_card) { create(:gift_card, expires_at: nil, store: store) }++ it 'returns nil for expires at' do+ expect(subject[6]).to be_nil # Expires At+ end+ end+ end++ describe 'HEADERS' do+ it 'has the correct headers' do+ expected_headers = [+ 'Code',+ 'Amount',+ 'Amount Used',+ 'Amount Remaining',+ 'Currency',+ 'Status',+ 'Expires At',+ 'Customer Email',+ 'Customer First Name',+ 'Customer Last Name',+ 'Created At',+ 'Updated At'+ ]+ expect(Spree::CSV::GiftCardPresenter::HEADERS).to eq(expected_headers)+ end+ end+end\ No newline at end of file