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
Handle `GiftCard#expires_at` properly, also better messages on checko… (#12905)
Damian Legawiec325544aa83b8
diff --git a/core/app/models/spree/gift_card.rb b/core/app/models/spree/gift_card.rbindex ae22b74d29..55cf2ea3d2 100644--- a/core/app/models/spree/gift_card.rb+++ b/core/app/models/spree/gift_card.rb@@ -22,11 +22,6 @@ module Spreeendend- #- # Attributes- #- attribute :skip_expires_at_validation, :boolean, default: false-## Validations#@@ -34,7 +29,6 @@ module Spreevalidates :store, :currency, presence: truevalidates :amount, presence: true, numericality: { greater_than: 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## Associations@@ -51,9 +45,10 @@ module Spree## Scopes#- scope :active, -> { where(state: [:active, :partially_redeemed]).where(expires_at: [nil, Time.current..]) }- scope :expired, -> { where(state: :active).where(expires_at: ..Time.current) }+ scope :active, -> { where(state: [:active, :partially_redeemed]).where(expires_at: [nil, Date.tomorrow..]) }+ scope :expired, -> { where(state: :active).where(expires_at: ..Date.current) }scope :redeemed, -> { where(state: [:redeemed]) }+ scope :partially_redeemed, -> { where(state: [:partially_redeemed]) }## Ransack@@ -115,7 +110,7 @@ module Spree# Checks if the gift card is expired# @return [Boolean]def expired?- !redeemed? && expires_at.present? && expires_at < Time.current+ !redeemed? && expires_at.present? && expires_at <= Date.currentend# Checks if the gift card is active, i.e. not expired and not redeemeddiff --git a/core/app/models/spree/promotion_handler/coupon.rb b/core/app/models/spree/promotion_handler/coupon.rbindex 82e70d08a7..87c75f8f0d 100644--- a/core/app/models/spree/promotion_handler/coupon.rb+++ b/core/app/models/spree/promotion_handler/coupon.rb@@ -12,6 +12,15 @@ module Spreedef applyif load_gift_card_code++ if @gift_card.expired?+ set_error_code :gift_card_expired+ return self+ elsif @gift_card.redeemed?+ set_error_code :gift_card_already_redeemed+ return self+ end+result = order.apply_gift_card(@gift_card)if result.success?@@ -207,7 +216,7 @@ module Spreedef load_gift_card_codereturn unless order.coupon_code.present?- @gift_card = order.store.gift_cards.active.find_by(code: order.coupon_code.downcase)+ @gift_card = order.store.gift_cards.find_by(code: order.coupon_code.downcase)endendenddiff --git a/core/app/services/spree/gift_cards/remove.rb b/core/app/services/spree/gift_cards/remove.rbindex aeee5781a3..a79b7f61e0 100644--- a/core/app/services/spree/gift_cards/remove.rb+++ b/core/app/services/spree/gift_cards/remove.rb@@ -18,7 +18,6 @@ module Spreegift_card.with_lock dogift_card.amount_used -= payment_total- gift_card.skip_expires_at_validation = truegift_card.save!enddiff --git a/core/config/locales/en.yml b/core/config/locales/en.ymlindex 3f0758e007..f38cd960c2 100644--- a/core/config/locales/en.yml+++ b/core/config/locales/en.yml@@ -1095,8 +1095,10 @@ en:generate_code: Generate coupon codeget_back_to_the: Get back to thegift_card: Gift Card+ gift_card_already_redeemed: The Gift Card has already been redeemed.gift_card_applied: The Gift Card was successfully applied to your order!gift_card_batch: Gift Card Batch+ gift_card_expired: The Gift Card has expired.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/lib/spree/testing_support/factories/gift_card_factory.rb b/core/lib/spree/testing_support/factories/gift_card_factory.rbindex 70f9ee162e..35982762ce 100644--- a/core/lib/spree/testing_support/factories/gift_card_factory.rb+++ b/core/lib/spree/testing_support/factories/gift_card_factory.rb@@ -12,7 +12,6 @@ FactoryBot.define dotrait :expired doexpires_at { 1.day.ago }- skip_expires_at_validation { true }endendenddiff --git a/core/spec/models/spree/gift_card_spec.rb b/core/spec/models/spree/gift_card_spec.rbindex 296d0a04d7..23fd9d6d06 100644--- a/core/spec/models/spree/gift_card_spec.rb+++ b/core/spec/models/spree/gift_card_spec.rb@@ -20,9 +20,40 @@ RSpec.describe Spree::GiftCard, type: :model doendend+ describe 'Scopes' do+ let(:active_gift_card) { create(:gift_card, state: :active) }+ let(:redeemed_gift_card) { create(:gift_card, state: :redeemed) }+ let(:partially_redeemed_gift_card) { create(:gift_card, state: :partially_redeemed) }+ let(:expired_gift_card) { create(:gift_card, expires_at: Date.current, state: :active) }++ describe '#active' do+ it 'returns active gift cards' do+ expect(described_class.active).to contain_exactly(active_gift_card)+ end+ end++ describe '#expired' do+ it 'returns expired gift cards' do+ expect(described_class.expired).to contain_exactly(expired_gift_card)+ end+ end++ describe '#redeemed' do+ it 'returns redeemed gift cards' do+ expect(described_class.redeemed).to contain_exactly(redeemed_gift_card)+ end+ end++ describe '#partially_redeemed' do+ it 'returns partially redeemed gift cards' do+ expect(described_class.partially_redeemed).to contain_exactly(partially_redeemed_gift_card)+ end+ end+ end+describe '#active?' docontext 'when expired' do- let(:gift_card) { build(:gift_card, expires_at: 1.day.ago, state: :active) }+ let(:gift_card) { build(:gift_card, expires_at: Date.current, state: :active) }it 'returns false' doexpect(gift_card.active?).to be(false)diff --git a/core/spec/models/spree/promotion_handler/coupon_with_gift_card_spec.rb b/core/spec/models/spree/promotion_handler/coupon_with_gift_card_spec.rbindex 8c0476de20..11475a05b6 100644--- a/core/spec/models/spree/promotion_handler/coupon_with_gift_card_spec.rb+++ b/core/spec/models/spree/promotion_handler/coupon_with_gift_card_spec.rb@@ -43,6 +43,34 @@ describe Spree::PromotionHandler::Coupon, type: :model doexpect(order.total_applied_store_credit).to eq(0)endend++ context 'when gift card is expired' do+ let(:gift_card) { create(:gift_card, :expired) }++ it 'returns error code' do+ order.coupon_code = gift_card.code+ handler = described_class.new(order)+ handler.apply++ expect(order.reload.gift_card).to eq(nil)+ expect(order.total_applied_store_credit).to eq(0)+ expect(handler.status_code).to eq(:gift_card_expired)+ end+ end++ context 'when gift card is already redeemed' do+ let(:gift_card) { create(:gift_card, :redeemed) }++ it 'returns error code' do+ order.coupon_code = gift_card.code+ handler = described_class.new(order)+ handler.apply++ expect(order.reload.gift_card).to eq(nil)+ expect(order.total_applied_store_credit).to eq(0)+ expect(handler.status_code).to eq(:gift_card_already_redeemed)+ end+ endendend