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
align gift cards models to store credit models + more specs
Damian Legawieca45fe902b7d6
diff --git a/admin/app/controllers/spree/admin/gift_cards_controller.rb b/admin/app/controllers/spree/admin/gift_cards_controller.rbindex 761c77db04..eda64e769a 100644--- a/admin/app/controllers/spree/admin/gift_cards_controller.rb+++ b/admin/app/controllers/spree/admin/gift_cards_controller.rb@@ -37,7 +37,7 @@ module Spree@search = @search.ransack(params[:q])- @collection = @search.result.includes(:user)+ @collection = @search.result.includes(:user, :created_by)@collection = @collection.page(params[:page]).per(params[:per_page]) if params[:format] != 'csv'diff --git a/admin/app/controllers/spree/admin/resource_controller.rb b/admin/app/controllers/spree/admin/resource_controller.rbindex cb962b2ec9..38ad312993 100644--- a/admin/app/controllers/spree/admin/resource_controller.rb+++ b/admin/app/controllers/spree/admin/resource_controller.rb@@ -49,6 +49,7 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseControllerdef createinvoke_callbacks(:create, :before)+ set_created_by@object.attributes = permitted_resource_paramsif @object.saveinvoke_callbacks(:create, :after)@@ -248,6 +249,12 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseControllerensure_current_store(@object)end+ def set_created_by+ return if @object.nil?++ @object.created_by = try_spree_current_user if @object.respond_to?(:created_by_id)+ end+def set_currencyreturn if @object.nil?diff --git a/admin/app/controllers/spree/admin/store_credits_controller.rb b/admin/app/controllers/spree/admin/store_credits_controller.rbindex 89660d2394..cb55f710bf 100644--- a/admin/app/controllers/spree/admin/store_credits_controller.rb+++ b/admin/app/controllers/spree/admin/store_credits_controller.rb@@ -39,7 +39,6 @@ module Spreedef update@store_credit.assign_attributes(permitted_store_credit_params)- @store_credit.created_by = try_spree_current_userif @store_credit.saveflash[:success] = flash_message_for(@store_credit, :successfully_updated)diff --git a/admin/app/views/spree/admin/gift_cards/_gift_card.html.erb b/admin/app/views/spree/admin/gift_cards/_gift_card.html.erbindex 4316820e8f..462db3e6a8 100644--- a/admin/app/views/spree/admin/gift_cards/_gift_card.html.erb+++ b/admin/app/views/spree/admin/gift_cards/_gift_card.html.erb@@ -5,7 +5,7 @@<%= link_to gift_card.code.upcase, link, class: 'font-weight-bold d-block w-100 h-100 py-2', data: { 'turbo-frame': '_top', row_link_target: :link } %></td><td class="w-10 cursor-pointer" data-action="click->row-link#openLink"><%= gift_card.display_amount %></td>- <td class="w-10 cursor-pointer" data-action="click->row-link#openLink"><%= gift_card.display_used_amount %></td>+ <td class="w-10 cursor-pointer" data-action="click->row-link#openLink"><%= gift_card.display_amount_used %></td><td class="w-10 cursor-pointer" data-action="click->row-link#openLink"><%= gift_card.currency.upcase %></td><td class="w-10 cursor-pointer" data-action="click->row-link#openLink"><%= active_badge(gift_card.active?, label: gift_card.display_state) %></td><td class="w-10 cursor-pointer" data-action="click->row-link#openLink">diff --git a/admin/app/views/spree/admin/gift_cards/_list.html.erb b/admin/app/views/spree/admin/gift_cards/_list.html.erbindex 514e32c33a..ae660132a4 100644--- a/admin/app/views/spree/admin/gift_cards/_list.html.erb+++ b/admin/app/views/spree/admin/gift_cards/_list.html.erb@@ -20,5 +20,5 @@<%= render partial: 'spree/admin/shared/index_table_options', locals: { collection: @collection } %><% else %><% new_object_url = @user.present? ? spree.new_admin_user_gift_card_path(@user) : spree.new_admin_gift_card_path %>- <%= render 'spree/admin/shared/no_resource_found', model_class: Spree::GiftCard, new_object_url: spree.new_admin_user_gift_card_path(@user) %>+ <%= render 'spree/admin/shared/no_resource_found', model_class: Spree::GiftCard, new_object_url: new_object_url %><% end %>\ No newline at end of filediff --git a/admin/app/views/spree/admin/gift_cards/index.csv.erb b/admin/app/views/spree/admin/gift_cards/index.csv.erbindex 5b18c4ced8..095df7ab73 100644--- a/admin/app/views/spree/admin/gift_cards/index.csv.erb+++ b/admin/app/views/spree/admin/gift_cards/index.csv.erb@@ -7,7 +7,7 @@<%= CSV.generate_line([gift_card.code.upcase,gift_card.amount.to_f,- gift_card.used_amount.to_f,+ gift_card.amount_used.to_f,gift_card.display_state,gift_card.expires_at,]).strip.html_safe %>diff --git a/admin/app/views/spree/admin/gift_cards/new.html.erb b/admin/app/views/spree/admin/gift_cards/new.html.erbindex a82118cc88..fa8884dac3 100644--- a/admin/app/views/spree/admin/gift_cards/new.html.erb+++ b/admin/app/views/spree/admin/gift_cards/new.html.erb@@ -10,7 +10,9 @@<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @object } %>-<%= form_for [:admin, @user, @object] do |f| %>+<% url = @user.present? ? spree.admin_user_gift_cards_path(@user) : spree.admin_gift_cards_path %>++<%= form_for @object, url: url do |f| %><div class="row"><div class="col-lg-6 offset-lg-3"><div class="card mb-4">diff --git a/admin/app/views/spree/admin/gift_cards/show.html.erb b/admin/app/views/spree/admin/gift_cards/show.html.erbindex 832de1d669..257a96dff3 100644--- a/admin/app/views/spree/admin/gift_cards/show.html.erb+++ b/admin/app/views/spree/admin/gift_cards/show.html.erb@@ -27,10 +27,9 @@<div class="card-body border-bottom"><div class="d-flex justify-content-between align-items-center"><div class="w-75">- <%= progress_bar_component(@object.used_amount, max: @object.amount) %>+ <%= progress_bar_component(@object.amount_used, max: @object.amount) %></div><div class="w-25 text-right">- <%= @object.display_amount_remaining %> / <span class="text-muted"><%= @object.display_amount %></span></div></div></div>@@ -64,7 +63,7 @@<h5 class="card-title"><%= Spree.t(:settings) %></h5>- <%= link_to_with_icon 'edit', Spree.t(:edit), spree.edit_admin_gift_card_path(@object), icon: 'pencil', class: 'btn btn-sm btn-light' %>+ <%= link_to_with_icon 'edit', Spree.t(:edit), spree.edit_admin_gift_card_path(@object), icon: 'pencil', class: 'btn btn-sm btn-light', if: @gift_card.editable? %></div><div class="card-body p-0"><ul class="list-group list-group-flush">diff --git a/admin/app/views/spree/admin/shared/_header.html.erb b/admin/app/views/spree/admin/shared/_header.html.erbindex 7c2e40b337..f241226b48 100644--- a/admin/app/views/spree/admin/shared/_header.html.erb+++ b/admin/app/views/spree/admin/shared/_header.html.erb@@ -11,8 +11,8 @@</div><% if settings_active? %>- <div class="store-dropdown pr-2">- <%= active_link_to_with_icon('arrow-back-up', Spree.t('admin.back_to_dashboard'), spree.admin_dashboard_path, class: 'btn store-dropdown-button w-100 justify-content-start mr-1') %>+ <div class="store-dropdown px-2">+ <%= active_link_to_with_icon('arrow-left', Spree.t('admin.back_to_dashboard'), spree.admin_dashboard_path, class: 'btn store-dropdown-button w-100 justify-content-start mx-1 py-2') %></div><% else %><% if defined?(current_vendor) && current_vendor.present? %>diff --git a/admin/spec/controllers/spree/admin/gift_cards_controller_spec.rb b/admin/spec/controllers/spree/admin/gift_cards_controller_spec.rbnew file mode 100644index 0000000000..f12eb02de9--- /dev/null+++ b/admin/spec/controllers/spree/admin/gift_cards_controller_spec.rb@@ -0,0 +1,281 @@+require 'spec_helper'++describe Spree::Admin::GiftCardsController, type: :controller do+ render_views++ let(:store) { @default_store }+ let(:admin_user) { create(:admin_user) }+ let(:user) { create(:user) }+ let(:gift_card) { create(:gift_card, user: user, created_by: admin_user) }++ before do+ allow(controller).to receive(:current_store).and_return(store)+ allow(controller).to receive(:try_spree_current_user).and_return(admin_user)+ end++ describe '#index' do+ subject { get :index }++ it 'renders the index template' do+ subject+ expect(response).to render_template(:index)+ expect(response).to have_http_status(:ok)+ end++ context 'when user_id parameter is present' do+ subject { get :index, params: { user_id: user.id } }++ it 'filters gift cards by user' do+ gift_card+ other_gift_card = create(:gift_card)++ subject++ expect(assigns(:collection)).to include(gift_card)+ expect(assigns(:collection)).not_to include(other_gift_card)+ end+ end++ context 'with status filter' do+ let!(:active_gift_card) { create(:gift_card, user: user) }+ let!(:expired_gift_card) { create(:gift_card, :expired) }+ let!(:redeemed_gift_card) { create(:gift_card, :redeemed, user: user) }++ it 'filters by active status' do+ get :index, params: { q: { status_eq: 'active' } }+ expect(assigns(:collection)).to include(active_gift_card)+ expect(assigns(:collection)).not_to include(expired_gift_card, redeemed_gift_card)+ end++ it 'filters by expired status' do+ get :index, params: { q: { status_eq: 'expired' } }+ expect(assigns(:collection)).to include(expired_gift_card)+ expect(assigns(:collection)).not_to include(active_gift_card, redeemed_gift_card)+ end++ it 'filters by redeemed status' do+ get :index, params: { q: { status_eq: 'redeemed' } }+ expect(assigns(:collection)).to include(redeemed_gift_card)+ expect(assigns(:collection)).not_to include(active_gift_card, expired_gift_card)+ end++ context 'with user_id parameter' do+ it 'filters by user' do+ get :index, params: { user_id: user.id }++ expect(assigns(:collection)).to include(active_gift_card, redeemed_gift_card)+ expect(assigns(:collection)).not_to include(expired_gift_card)+ end+ end+ end+ end++ describe '#show' do+ subject { get :show, params: { id: gift_card.id } }++ it 'renders the show template' do+ subject+ expect(response).to render_template(:show)+ expect(response).to have_http_status(:ok)+ end++ it 'assigns the gift card' do+ subject+ expect(assigns(:object)).to eq(gift_card)+ end+ end++ describe '#new' do+ subject { get :new }++ it 'renders the new template' do+ subject+ expect(response).to render_template(:new)+ expect(response).to have_http_status(:ok)+ end++ it 'assigns a new gift card' do+ subject+ expect(assigns(:object)).to be_a_new(Spree::GiftCard)+ end++ context 'when user_id parameter is present' do+ subject { get :new, params: { user_id: user.id } }++ it 'loads the user' do+ subject+ expect(assigns(:user)).to eq(user)+ end+ end+ end++ describe '#create' do+ let(:valid_params) do+ {+ gift_card: {+ amount: 100,+ currency: 'USD',+ user_id: user.id,+ expires_at: 1.year.from_now.to_date,+ code: '1234567890'+ }+ }+ end++ subject { post :create, params: valid_params }++ context 'with valid parameters' do+ it 'creates a new gift card' do+ expect { subject }.to change(Spree::GiftCard, :count).by(1)++ gift_card = Spree::GiftCard.last+ expect(gift_card.created_by).to eq(admin_user)+ expect(gift_card.user).to eq(user)+ expect(gift_card.expires_at).to eq(1.year.from_now.to_date)+ expect(gift_card.store).to eq(store)+ expect(gift_card.amount).to eq(100)+ expect(gift_card.code).to eq('1234567890')+ expect(gift_card.state).to eq('active')+ end++ it 'redirects to the gift card show page' do+ subject+ expect(response).to redirect_to(spree.admin_gift_card_path(Spree::GiftCard.last))+ end++ it 'sets a success flash message' do+ subject+ expect(flash[:success]).to be_present+ end+ end++ context 'with invalid parameters' do+ let(:invalid_params) do+ {+ gift_card: {+ amount: -100,+ currency: 'USD'+ }+ }+ end++ subject { post :create, params: invalid_params }++ it 'does not create a gift card' do+ expect { subject }.not_to change(Spree::GiftCard, :count)+ end++ it 'renders the new template' do+ subject+ expect(response).to render_template(:new)+ expect(response).to have_http_status(:unprocessable_entity)+ end+ end+ end++ describe '#edit' do+ subject { get :edit, params: { id: gift_card.id } }++ it 'renders the edit template' do+ subject+ expect(response).to render_template(:edit)+ expect(response).to have_http_status(:ok)+ end++ it 'assigns the gift card' do+ subject+ expect(assigns(:object)).to eq(gift_card)+ end+ end++ describe '#update' do+ let(:update_params) do+ {+ id: gift_card.id,+ gift_card: {+ amount: 200,+ user_id: user.id,+ expires_at: 1.year.from_now.to_date+ }+ }+ end++ subject { put :update, params: update_params }++ context 'with valid parameters' do+ it 'updates the gift card' do+ subject+ gift_card.reload+ expect(gift_card.amount).to eq(200)+ expect(gift_card.user).to eq(user)+ end++ it 'redirects to the gift card show page' do+ subject+ expect(response).to redirect_to(spree.admin_gift_card_path(gift_card))+ end++ it 'sets a success flash message' do+ subject+ expect(flash[:success]).to be_present+ end+ end++ context 'with invalid parameters' do+ let(:invalid_update_params) do+ {+ id: gift_card.id,+ gift_card: {+ amount: -200+ }+ }+ end++ subject { put :update, params: invalid_update_params }++ it 'does not update the gift card' do+ original_amount = gift_card.amount+ subject+ gift_card.reload+ expect(gift_card.amount).to eq(original_amount)+ end++ it 'renders the edit template' do+ subject+ expect(response).to render_template(:edit)+ expect(response).to have_http_status(:unprocessable_entity)+ end+ end+ end++ describe '#destroy' do+ let!(:gift_card_to_destroy) { create(:gift_card) }++ subject { delete :destroy, params: { id: gift_card_to_destroy.id } }++ it 'destroys the gift card' do+ expect { subject }.to change(Spree::GiftCard, :count).by(-1)+ end++ it 'redirects to the gift cards index' do+ subject+ expect(response).to redirect_to(spree.admin_gift_cards_path)+ end++ it 'sets a success flash message' do+ subject+ expect(flash[:success]).to be_present+ end++ context 'when user_id parameter is present' do+ let!(:user_gift_card) { create(:gift_card, user: user) }++ subject { delete :destroy, params: { id: user_gift_card.id, user_id: user.id } }++ it 'redirects to the user page' do+ subject+ expect(response).to redirect_to(spree.admin_user_path(user))+ end+ end+ end+enddiff --git a/admin/spec/controllers/spree/admin/store_credits_controller_spec.rb b/admin/spec/controllers/spree/admin/store_credits_controller_spec.rbindex dc66384762..ae334daa8e 100644--- a/admin/spec/controllers/spree/admin/store_credits_controller_spec.rb+++ b/admin/spec/controllers/spree/admin/store_credits_controller_spec.rb@@ -1,11 +1,15 @@require 'spec_helper'RSpec.describe Spree::Admin::StoreCreditsController, type: :controller do- stub_authorization!render_views+ let(:admin_user) { create(:admin_user) }let(:user) { create(:user) }+ before do+ allow(controller).to receive(:try_spree_current_user).and_return(admin_user)+ end+describe 'GET #index' dolet!(:store_credits) { create_list(:store_credit, 3, user: user) }let!(:other_store_credits) { create_list(:store_credit, 3) }@@ -55,6 +59,7 @@ RSpec.describe Spree::Admin::StoreCreditsController, type: :controller doexpect(store_credit.amount).to eq(100)expect(store_credit.currency).to eq('USD')+ expect(store_credit.created_by).to eq(admin_user)endcontext 'when the store credit is not valid' dodiff --git a/core/app/models/spree/ability.rb b/core/app/models/spree/ability.rbindex 55ce550d86..e986dade12 100644--- a/core/app/models/spree/ability.rb+++ b/core/app/models/spree/ability.rb@@ -65,8 +65,6 @@ module Spreecan :destroy, Spree::Order, &:can_be_deleted?cannot [:edit, :update], Spree::RefundReason, mutable: falsecannot [:edit, :update], Spree::ReimbursementType, mutable: false- cannot %i[update delete], Spree::GiftCard, state: [:redeemed, :redeemed_by_order, :partially_redeemed]- can :edit, Spree::GiftCardenddef apply_user_permissions(user, _options)diff --git a/core/app/models/spree/gift_card.rb b/core/app/models/spree/gift_card.rbindex 8819756b30..ae22b74d29 100644--- a/core/app/models/spree/gift_card.rb+++ b/core/app/models/spree/gift_card.rb@@ -15,10 +15,7 @@ module Spreeevent :redeem dotransition active: :redeemedend-- event :redeem_by_order do- transition active: :redeemed_by_order- end+ after_transition to: :redeemed, do: :after_redeemevent :partial_redeem dotransition active: :partially_redeemed@@ -36,15 +33,15 @@ module Spreevalidates :code, presence: true, uniqueness: { scope: :store_id }validates :store, :currency, presence: truevalidates :amount, presence: true, numericality: { greater_than: 0 }- validates :amount_remaining, presence: true, numericality: { greater_than_or_equal_to: 0 }+ validates :amount_used, :amount_authorized, presence: true, numericality: { greater_than_or_equal_to: 0 }validates :expires_at, comparison: { greater_than: Date.current + 1.day }, allow_nil: true, unless: :skip_expires_at_validation- validates :user, presence: true, if: -> { user_id.present? }## Associations#belongs_to :store, class_name: 'Spree::Store'belongs_to :user, class_name: Spree.user_class.to_s, optional: true+ belongs_to :created_by, class_name: Spree.admin_user_class.to_s, optional: truebelongs_to :batch, class_name: 'Spree::GiftCardBatch', optional: true, foreign_key: :gift_card_batch_idhas_many :store_credits, class_name: 'Spree::StoreCredit', as: :originator@@ -56,7 +53,7 @@ module Spree#scope :active, -> { where(state: [:active, :partially_redeemed]).where(expires_at: [nil, Time.current..]) }scope :expired, -> { where(state: :active).where(expires_at: ..Time.current) }- scope :redeemed, -> { where(state: [:redeemed, :redeemed_by_order]) }+ scope :redeemed, -> { where(state: [:redeemed]) }## Ransack@@ -71,58 +68,64 @@ module Spree#before_validation :generate_codebefore_validation :normalize_code- before_validation :set_amount_remainingbefore_validation :set_currencybefore_destroy :ensure_can_be_deleted## Money#- money_methods :amount, :used_amount, :amount_remaining+ money_methods :amount, :amount_used, :amount_authorized, :amount_remaining+ # Sets the amount+ # @param amount [String]def amount=(amount)self[:amount] = Spree::LocalizedNumber.parse(amount)end+ # Calculates the remaining amount+ # @return [Decimal]+ def amount_remaining+ amount - amount_used - amount_authorized+ end+delegate :email, to: :user, prefix: true, allow_nil: truedef self.json_api_columns%w[code amount expires_at]end+ # Checks if the gift card is editable+ # @return [Boolean]def editable?- active? || canceled?+ active?end+ # Checks if the gift card can be deleted+ # @return [Boolean]def can_be_deleted?- editable?- end-- def generate_code- return if code.present?-- self.code = loop do- random_token = SecureRandom.hex(8).downcase- break random_token unless self.class.exists?(code: random_token, store_id: store_id)- end- end-- def normalize_code- self.code = code.downcase if code.present?+ !redeemed? && !partially_redeemed?end+ # Displays the code in uppercase, eg. ABC1234+ # @return [String]def display_codecode.upcaseend+ # Checks if the gift card is expired+ # @return [Boolean]def expired?!redeemed? && expires_at.present? && expires_at < Time.currentend+ # Checks if the gift card is active, i.e. not expired and not redeemed+ # @return [Boolean]def active?super && !expired?end+ # Displays state as expired if the gift card is expired, otherwise displays the state+ # @return [String]def display_stateif expired?:expired@@ -131,23 +134,23 @@ module Spreeend.to_send- def used_amount- @used_amount ||= amount - amount_remaining- end- alias_method :amount_used, :used_amount+ private- def redeem!- new_state = amount_remaining.positive? ? :partially_redeemed : :redeemed- update!(state: new_state)- end+ def generate_code+ return if code.present?- private+ self.code = loop do+ random_token = SecureRandom.hex(8).downcase+ break random_token unless self.class.exists?(code: random_token, store_id: store_id)+ end+ end- def set_amount_remaining- return unless active?- return if amount_remaining_changed?+ def normalize_code+ self.code = code.downcase if code.present?+ end- self.amount_remaining = amount+ def after_redeem+ update!(redeemed_at: Time.current)enddef ensure_can_be_deleteddiff --git a/core/app/models/spree/gift_card_batch.rb b/core/app/models/spree/gift_card_batch.rbindex e00e3e4556..ac7e8ed17a 100644--- a/core/app/models/spree/gift_card_batch.rb+++ b/core/app/models/spree/gift_card_batch.rb@@ -3,6 +3,14 @@ module Spreeextend DisplayMoneyinclude Spree::SingleStoreResource+ #+ # Associations+ #+ belongs_to :store, class_name: 'Spree::Store'+ belongs_to :created_by, class_name: Spree.admin_user_class.to_s, optional: true+ has_many :gift_cards, class_name: 'Spree::GiftCard', inverse_of: :batch, dependent: :destroy++## Validations#@@ -11,11 +19,6 @@ module Spreevalidates :store, :currency, presence: truevalidates :amount, numericality: { greater_than: 0 }- #- # Associations- belongs_to :store, class_name: 'Spree::Store'- has_many :gift_cards, class_name: 'Spree::GiftCard', inverse_of: :batch-## Callbacks#@@ -61,10 +64,10 @@ module Spreestate: :active,gift_card_batch_id: id,amount: amount,- amount_remaining: amount,currency: currency,code: generate_code,store_id: store_id,+ created_by_id: created_by_id,expires_at: expires_at}enddiff --git a/core/app/models/spree/order/gift_card.rb b/core/app/models/spree/order/gift_card.rbindex 4f8b749632..21497ffff4 100644--- a/core/app/models/spree/order/gift_card.rb+++ b/core/app/models/spree/order/gift_card.rb@@ -10,6 +10,8 @@ module Spreemoney_methods :gift_card_totalend+ # Returns the total amount of the gift card applied to the order+ # @return [Decimal]def gift_card_totalreturn 0.to_d unless gift_card.present?@@ -19,10 +21,15 @@ module Spreestore_credits.sum(:amount)end+ # Applies a gift card to the order+ # @param gift_card [Spree::GiftCard] the gift card to apply+ # @return [Spree::Order] the order with the gift card applieddef apply_gift_card(gift_card)Spree::Dependencies.gift_card_apply_service.constantize.call(gift_card: gift_card, order: self)end+ # Removes a gift card from the order+ # @return [Spree::Order] the order with the gift card removeddef remove_gift_cardSpree::Dependencies.gift_card_remove_service.constantize.call(order: self)enddiff --git a/core/app/models/spree/payment_method/store_credit.rb b/core/app/models/spree/payment_method/store_credit.rbindex 472c4b519e..abdecdf850 100644--- a/core/app/models/spree/payment_method/store_credit.rb+++ b/core/app/models/spree/payment_method/store_credit.rb@@ -102,7 +102,7 @@ module Spreeenddef available_for_order?(order)- order.could_use_store_credit? || order.gift_card.present?+ order.gift_card.present? || order.could_use_store_credit?endprivatediff --git a/core/app/services/spree/gift_cards/apply.rb b/core/app/services/spree/gift_cards/apply.rbindex 693895ea8a..5b1e795779 100644--- a/core/app/services/spree/gift_cards/apply.rb+++ b/core/app/services/spree/gift_cards/apply.rb@@ -1,3 +1,9 @@+# frozen_string_literal: true+# Applies a gift card to an order+# under the hood it creates a store credit payment record and updates the gift card amount used+# @param gift_card [Spree::GiftCard] the gift card to apply+# @param order [Spree::Order] the order to apply the gift card to+# @return [Spree::Order] the order with the gift card appliedmodule Spreemodule GiftCardsclass Apply@@ -27,7 +33,7 @@ module Spreeoriginator: gift_card,action_originator: gift_card)- gift_card.amount_remaining -= amount+ gift_card.amount_used += amountgift_card.save!order.update!(gift_card: gift_card)diff --git a/core/app/services/spree/gift_cards/remove.rb b/core/app/services/spree/gift_cards/remove.rbindex cb944c0b86..aeee5781a3 100644--- a/core/app/services/spree/gift_cards/remove.rb+++ b/core/app/services/spree/gift_cards/remove.rb@@ -17,14 +17,14 @@ module Spreepayments.each(&:invalidate!)gift_card.with_lock do- gift_card.amount_remaining = [gift_card.amount_remaining + payment_total, gift_card.amount].min- gift_card.state = gift_card.amount_remaining == gift_card.amount ? :active : :partially_redeemed+ gift_card.amount_used -= payment_totalgift_card.skip_expires_at_validation = truegift_card.save!end# we need to destroy the store credits here because they are not associated with the order# and we need to remove them from the gift card+ # TODO: rather than destroying the store credits, we should void thempayments.each do |payment|payment.source.destroy!enddiff --git a/core/config/locales/en.yml b/core/config/locales/en.ymlindex 48635cbd27..c818e23a89 100644--- a/core/config/locales/en.yml+++ b/core/config/locales/en.yml@@ -1097,7 +1097,6 @@ en:gift_card: Gift Cardgift_card_applied: The Gift Card was successfully applied to your order!gift_card_batch: Gift Card batch- gift_card_no_amount_remaining: You can't apply the Gift Card with no balance on it.gift_card_removed: The Gift Card was successfully removed from your ordergift_card_using_store_credit_error: You can't apply the Gift Card after you applied the store credit.gift_cards: Gift Cardsdiff --git a/core/db/migrate/20250506073057_create_spree_gift_cards_and_spree_gift_card_batches.rb b/core/db/migrate/20250506073057_create_spree_gift_cards_and_spree_gift_card_batches.rbindex 1a38b2ddaf..96bbe748be 100644--- a/core/db/migrate/20250506073057_create_spree_gift_cards_and_spree_gift_card_batches.rb+++ b/core/db/migrate/20250506073057_create_spree_gift_cards_and_spree_gift_card_batches.rb@@ -2,6 +2,7 @@ class CreateSpreeGiftCardsAndSpreeGiftCardBatches < ActiveRecord::Migration[7.2]def changecreate_table :spree_gift_card_batches, if_not_exists: true do |t|t.references :store, null: false, index: true+ t.references :created_byt.integer :codes_count, default: 1, null: falset.decimal :amount, precision: 10, scale: 2, null: falset.string :currency, null: false@@ -14,15 +15,17 @@ class CreateSpreeGiftCardsAndSpreeGiftCardBatches < ActiveRecord::Migration[7.2]create_table :spree_gift_cards, if_not_exists: true do |t|t.references :store, null: false, index: truet.references :user, index: true- t.references :store_credit, index: truet.references :gift_card_batch, index: true- t.date :expires_at, index: true+ t.references :created_by, index: truet.string :code, null: falset.string :state, null: false, index: truet.decimal :amount, precision: 10, scale: 2, null: false- t.decimal :amount_remaining, precision: 10, scale: 2, null: false+ t.decimal :amount_authorized, precision: 10, scale: 2, null: false, default: 0+ t.decimal :amount_used, precision: 10, scale: 2, null: false, default: 0t.string :currency, null: false+ t.date :expires_at, index: true+ t.datetime :redeemed_at, index: truet.timestampsenddiff --git a/core/lib/spree/testing_support/factories/gift_card_factory.rb b/core/lib/spree/testing_support/factories/gift_card_factory.rbindex 97fab91d8c..70f9ee162e 100644--- a/core/lib/spree/testing_support/factories/gift_card_factory.rb+++ b/core/lib/spree/testing_support/factories/gift_card_factory.rb@@ -4,8 +4,15 @@ FactoryBot.define doamount { 10.00 }store { Spree::Store.default || create(:store) }- trait :fully_redeemed do+ trait :redeemed dostate { :redeemed }+ redeemed_at { Time.current }+ amount_used { amount }+ end++ trait :expired do+ expires_at { 1.day.ago }+ skip_expires_at_validation { true }endendenddiff --git a/core/spec/models/spree/gift_card_batch_spec.rb b/core/spec/models/spree/gift_card_batch_spec.rbindex c2e3800e47..a0f9d42804 100644--- a/core/spec/models/spree/gift_card_batch_spec.rb+++ b/core/spec/models/spree/gift_card_batch_spec.rb@@ -10,7 +10,6 @@ RSpec.describe Spree::GiftCardBatch, type: :model doexpect(gift_card_batch.gift_cards.count).to eq 2expect(gift_card_batch.gift_cards.pluck(:amount).uniq).to eq [gift_card_batch.amount]- expect(gift_card_batch.gift_cards.pluck(:amount_remaining).uniq).to eq [gift_card_batch.amount]expect(gift_card_batch.gift_cards.pluck(:expires_at).uniq).to eq [gift_card_batch.expires_at]expect(gift_card_batch.gift_cards.take.code).to match(/batch_/)enddiff --git a/core/spec/models/spree/gift_card_spec.rb b/core/spec/models/spree/gift_card_spec.rbindex eb246f2675..296d0a04d7 100644--- a/core/spec/models/spree/gift_card_spec.rb+++ b/core/spec/models/spree/gift_card_spec.rb@@ -1,20 +1,74 @@require 'spec_helper'RSpec.describe Spree::GiftCard, type: :model do- describe 'before_destroy :ensure_can_be_deleted' do- it "ensures a used gift card can't be destroyed" do- expect(create(:gift_card, state: :redeemed, amount_remaining: 0).destroy).to be(false)- expect(create(:gift_card, state: :partially_redeemed, amount_remaining: 1).destroy).to be(false)- expect(create(:gift_card, state: :active, amount_remaining: 10).destroy).to be_destroyed- expect(create(:gift_card, state: :canceled, amount_remaining: 10).destroy).to be_destroyed+ describe 'Callbacks' do+ describe '#ensure_can_be_deleted' do+ it "ensures a used gift card can't be destroyed" do+ expect(create(:gift_card, state: :redeemed).destroy).to be(false)+ expect(create(:gift_card, state: :partially_redeemed).destroy).to be(false)+ expect(create(:gift_card, state: :active).destroy).to be_destroyed+ expect(create(:gift_card, state: :canceled).destroy).to be_destroyed+ end++ it 'adds an error' do+ gift_card = create(:gift_card, state: :redeemed)+ gift_card.destroy++ expect(gift_card).to_not be_destroyed+ expect(gift_card.errors.messages).to eq(base: ["Can't delete a used gift card"])+ end+ end+ end++ describe '#active?' do+ context 'when expired' do+ let(:gift_card) { build(:gift_card, expires_at: 1.day.ago, state: :active) }++ it 'returns false' do+ expect(gift_card.active?).to be(false)+ end+ end++ context 'when redeemed' do+ let(:gift_card) { build(:gift_card, state: :redeemed) }++ it 'returns false' do+ expect(gift_card.active?).to be(false)+ end+ end++ context 'when active' do+ let(:gift_card) { build(:gift_card, expires_at: 1.day.from_now, state: :active) }++ it 'returns true' do+ expect(gift_card.active?).to be(true)+ end+ end+ end++ describe '#amount_remaining' do+ context 'when active' do+ let(:gift_card) { build(:gift_card, amount: 100, amount_used: 0, amount_authorized: 0, state: :active) }++ it 'returns the remaining amount' do+ expect(gift_card.amount_remaining).to eq(100)+ end+ end++ context 'when redeemed' do+ let(:gift_card) { build(:gift_card, amount: 100, amount_used: 100, amount_authorized: 0, state: :redeemed) }++ it 'returns 0' do+ expect(gift_card.amount_remaining).to eq(0)+ endend- it 'adds an error' do- gift_card = create(:gift_card, state: :redeemed, amount_remaining: 0)- gift_card.destroy+ context 'when authorized' do+ let(:gift_card) { build(:gift_card, amount: 100, amount_used: 0, amount_authorized: 50, state: :partially_redeemed) }- expect(gift_card).to_not be_destroyed- expect(gift_card.errors.messages).to eq(base: ["Can't delete a used gift card"])+ it 'returns the remaining amount' do+ expect(gift_card.amount_remaining).to eq(50)+ endendenddiff --git a/core/spec/models/spree/order/gift_card_spec.rb b/core/spec/models/spree/order/gift_card_spec.rbnew file mode 100644index 0000000000..3e77bee51b--- /dev/null+++ b/core/spec/models/spree/order/gift_card_spec.rb@@ -0,0 +1,40 @@+require 'spec_helper'++describe 'Order' do+ let(:order) { create(:order_with_line_items) }++ describe '#gift_card_total' do+ context 'when there is a gift card' do+ let(:gift_card) { create(:gift_card, amount: order.total) }++ before do+ order.apply_gift_card(gift_card)+ end++ it 'returns the gift card total' do+ expect(order.gift_card_total).to eq(gift_card.amount)+ end+ end+ end++ describe '#apply_gift_card' do+ context 'when there is a gift card' do+ let(:gift_card) { create(:gift_card, amount: order.total) }++ it 'applies the gift card to the order' do+ expect { order.apply_gift_card(gift_card) }.to change(order, :gift_card).from(nil).to(gift_card)+ end+ end+ end++ describe '#remove_gift_card' do+ context 'when there is a gift card' do+ let(:order) { create(:order_with_line_items, gift_card: gift_card) }+ let(:gift_card) { create(:gift_card) }++ it 'removes the gift card from the order' do+ expect { order.remove_gift_card }.to change(order, :gift_card).from(gift_card).to(nil)+ end+ end+ end+enddiff --git a/core/spec/models/spree/order_merger_spec.rb b/core/spec/models/spree/order_merger_spec.rbindex 36aae2922e..11c26bf647 100644--- a/core/spec/models/spree/order_merger_spec.rb+++ b/core/spec/models/spree/order_merger_spec.rb@@ -159,7 +159,7 @@ module Spreecontext 'merging an order with a gift card' dolet(:order_1) { create(:order, total: 20) }let(:order_2) { create(:order, gift_card: gift_card, total: 20) }- let(:gift_card) { create(:gift_card) }+ let(:gift_card) { create(:gift_card, amount: 20, amount_used: 20) }let(:store_credit_payment_method) { create(:store_credit_payment_method) }let(:store_credit) { create(:store_credit, originator: gift_card, amount: 20) }let!(:payment) { create(:payment, order: order_2, payment_method: store_credit_payment_method, amount: 20, source: store_credit) }diff --git a/core/spec/models/spree/payment_method/store_credit_spec.rb b/core/spec/models/spree/payment_method/store_credit_spec.rbindex f0045e0cbb..dcbc3b1c18 100644--- a/core/spec/models/spree/payment_method/store_credit_spec.rb+++ b/core/spec/models/spree/payment_method/store_credit_spec.rb@@ -308,6 +308,13 @@ describe Spree::PaymentMethod::StoreCredit doit { expect(store_credit_payment_method.available_for_order?(order_without_store_credit)).to be false }end++ context 'when order has a gift card' do+ let(:order) { build(:order, store: store, gift_card: gift_card) }+ let(:gift_card) { create(:gift_card) }++ it { expect(store_credit_payment_method.available_for_order?(order)).to be true }+ endenddescribe '#source_required?' dodiff --git a/core/spec/services/spree/gift_cards/apply_spec.rb b/core/spec/services/spree/gift_cards/apply_spec.rbindex 577a618870..6127224e03 100644--- a/core/spec/services/spree/gift_cards/apply_spec.rb+++ b/core/spec/services/spree/gift_cards/apply_spec.rb@@ -56,7 +56,7 @@ RSpec.describe Spree::GiftCards::Apply doendcontext 'when the gift card has no amount remaining' do- before { gift_card.update!(amount_remaining: 0) }+ before { gift_card.update!(amount_used: gift_card.amount) }it 'responds with an error' doexpect { subject }.to_not change(Spree::StoreCredit, :count)diff --git a/storefront/app/views/themes/default/spree/account/gift_cards/_gift_card.html.erb b/storefront/app/views/themes/default/spree/account/gift_cards/_gift_card.html.erbindex 8984014b78..1f2945b5f0 100644--- a/storefront/app/views/themes/default/spree/account/gift_cards/_gift_card.html.erb+++ b/storefront/app/views/themes/default/spree/account/gift_cards/_gift_card.html.erb@@ -16,7 +16,7 @@<td class="w-full md:w-auto md:px-4 md:border-y border-accent"><span class="md:hidden font-medium mr-1"><%= Spree.t(:used) %>:</span>- <%= gift_card.display_used_amount %>+ <%= gift_card.display_amount_used %></td><td class="w-full md:w-auto md:px-4 md:border-y md:border-r border-accent">