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.

CHG to state machine and string

Michał Brożeke630dc9fb98f
diff --git a/admin/app/views/spree/admin/gift_cards/_form.html.erb b/admin/app/views/spree/admin/gift_cards/_form.html.erb
index cd2510216d..956338efdf 100644
--- a/admin/app/views/spree/admin/gift_cards/_form.html.erb
+++ b/admin/app/views/spree/admin/gift_cards/_form.html.erb
@@ -51,7 +51,7 @@
<%= f.number_field :minimum_order_amount, class: 'form-control', min: 0, step: 0.01, disabled: !f.object.editable? %>
<span class="text-muted form-text">
<% if !f.object.editable? %>
- You can't change the amount of a redeemed gift card
+ You can't change the minimum order amount of a redeemed gift card
<% end %>
</span>
<%= f.error_message_on :minimum_order_amount %>
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.erb
index 9d34685bcf..e6130fa0dd 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
@@ -22,10 +22,13 @@
</td>
<% else %>
<td class="actions">
- <%= link_to_edit(
- spree.edit_admin_user_gift_card_path(gift_card, user_id: params[:user_id]),
- data: { 'turbo-frame': '_top' }
- ) if can? :edit, gift_card %>
+ <% if can?(:edit, gift_card) %>
+ <%= link_to_edit(
+ gift_card,
+ url: spree.edit_admin_user_gift_card_path(gift_card, user_id: params[:user_id]),
+ data: { 'turbo-frame': '_top' }
+ ) %>
+ <% end %>
</td>
<% end %>
</tr>
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.erb
index 298911572e..a8f94bdfd0 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
@@ -9,15 +9,15 @@
<%= 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][:status_eq] == 'active'}" %>
+ class: "dropdown-item #{'active' if params[:q] && params[:q][:status_eq] == 'active'}" %>
<%= link_to params.to_unsafe_h.deep_merge({page: nil, q: {status_eq: :expired}}),
- class: "dropdown-item #{'active' if params[:q][:status_eq] == 'expired'}" do %>
+ class: "dropdown-item #{'active' if params[:q] && params[:q][:status_eq] == 'expired'}" do %>
<%= Spree.t('admin.gift_cards.expired') %>
<% end %>
<%= link_to params.to_unsafe_h.deep_merge({page: nil, q: {status_eq: :redeemed}}),
- class: "dropdown-item #{'active' if params[:q][:status_eq] == 'redeemed'}" do %>
+ class: "dropdown-item #{'active' if params[:q] && params[:q][:status_eq] == 'redeemed'}" do %>
<%= Spree.t('admin.gift_cards.redeemed') %>
<% end %>
diff --git a/admin/app/views/spree/admin/gift_cards/edit.html.erb b/admin/app/views/spree/admin/gift_cards/edit.html.erb
index 99d645d855..5d23bf9937 100644
--- a/admin/app/views/spree/admin/gift_cards/edit.html.erb
+++ b/admin/app/views/spree/admin/gift_cards/edit.html.erb
@@ -11,7 +11,7 @@
</span>
<% end %>
-<% if @object.redeemed? || @object.redeemed_by_order? || @object.partialy_redeemed? %>
+<% if @object.redeemed? || @object.redeemed_by_order? || @object.partially_redeemed? %>
<div class="card mb-4">
<div class="card-header">
<h5 class="card-title">
diff --git a/admin/app/views/spree/admin/gift_cards/index.html.erb b/admin/app/views/spree/admin/gift_cards/index.html.erb
index 10e567cc0c..b7e675c90d 100644
--- a/admin/app/views/spree/admin/gift_cards/index.html.erb
+++ b/admin/app/views/spree/admin/gift_cards/index.html.erb
@@ -4,7 +4,7 @@
<% end %>
<% content_for :page_actions do %>
- <%= link_to spree.admin_gift_cards_path(q: params[:q].to_unsafe_hash, per_page: Spree::GiftCardBatch::LIMIT, 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 %>
+ <%= 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' %>
Export codes
<% end %>
diff --git a/api/app/controllers/spree/api/v2/storefront/checkout_controller.rb b/api/app/controllers/spree/api/v2/storefront/checkout_controller.rb
index 126af1a8fd..a3d4200ecc 100644
--- a/api/app/controllers/spree/api/v2/storefront/checkout_controller.rb
+++ b/api/app/controllers/spree/api/v2/storefront/checkout_controller.rb
@@ -113,9 +113,9 @@ module Spree
def validate_gift_card_data
if params[:gift_card_code].present? && spree_current_order.gift_card.nil?
- render json: { error: 'Gift card is not found' }, status: 422
+ render json: { error: Spree.t('api.v2.gift_card.not_found') }, status: 422
elsif params[:gift_card_amount].to_d != spree_current_order.gift_card_total.to_d
- render json: { error: 'Gift card amount is not valid' }, status: 422
+ render json: { error: Spree.t('api.v2.gift_card.amount_not_valid') }, status: 422
else
render json: { success: true }, status: 200
end
diff --git a/api/config/locales/en.yml b/api/config/locales/en.yml
index ec3f61effb..f47a3a923b 100644
--- a/api/config/locales/en.yml
+++ b/api/config/locales/en.yml
@@ -29,6 +29,9 @@ en:
digitals:
missing_file: 'Missing Digital Item: attachment'
unauthorized: Error, you are not authorized to access this asset
+ gift_card:
+ amount_not_valid: Gift card amount is not valid
+ not_found: Gift card is not found
metadata:
invalid_params: Public and private metadata parameters should be objects
wishlist:
diff --git a/core/app/models/spree/ability.rb b/core/app/models/spree/ability.rb
index 330fcfbcd1..55ce550d86 100644
--- a/core/app/models/spree/ability.rb
+++ b/core/app/models/spree/ability.rb
@@ -65,7 +65,7 @@ module Spree
can :destroy, Spree::Order, &:can_be_deleted?
cannot [:edit, :update], Spree::RefundReason, mutable: false
cannot [:edit, :update], Spree::ReimbursementType, mutable: false
- cannot %i[update delete], Spree::GiftCard, state: [:redeemed, :redeemed_by_order, :partialy_redeemed]
+ cannot %i[update delete], Spree::GiftCard, state: [:redeemed, :redeemed_by_order, :partially_redeemed]
can :edit, Spree::GiftCard
end
diff --git a/core/app/models/spree/gift_card.rb b/core/app/models/spree/gift_card.rb
index 4797d2fc1d..359c2d5773 100644
--- a/core/app/models/spree/gift_card.rb
+++ b/core/app/models/spree/gift_card.rb
@@ -4,7 +4,23 @@ module Spree
include Spree::SingleStoreResource
include Spree::Security::GiftCards if defined?(Spree::Security::GiftCards)
- enum :state, { active: 0, redeemed: 1, canceled: 2, redeemed_by_order: 3, partialy_redeemed: 4 }
+ state_machine :state, initial: :active do
+ event :cancel do
+ transition active: :canceled
+ end
+
+ event :redeem do
+ transition active: :redeemed
+ end
+
+ event :redeem_by_order do
+ transition active: :redeemed_by_order
+ end
+
+ event :partial_redeem do
+ transition active: :partially_redeemed
+ end
+ end
validates :code, presence: true, uniqueness: true
validates :amount, numericality: { greater_than: 0 }
@@ -25,7 +41,7 @@ module Spree
has_many :users, through: :orders, class_name: Spree.user_class.to_s
- scope :active, -> { where(state: [:active, :partialy_redeemed]).where(expires_at: [nil, Time.current..]) }
+ 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]) }
@@ -117,7 +133,7 @@ module Spree
def undo_apply!(amount:)
transaction do
self.amount_remaining = [amount_remaining + amount, self.amount].min
- self.state = amount_remaining == self.amount ? :active : :partialy_redeemed
+ self.state = amount_remaining == self.amount ? :active : :partially_redeemed
self.skip_expires_at_validation = true
save!
@@ -129,7 +145,7 @@ module Spree
end
def redeem!
- new_state = amount_remaining.positive? ? :partialy_redeemed : :redeemed
+ new_state = amount_remaining.positive? ? :partially_redeemed : :redeemed
update!(state: new_state)
end
diff --git a/core/app/models/spree/gift_card_batch.rb b/core/app/models/spree/gift_card_batch.rb
index e7faf250e5..d40e018246 100644
--- a/core/app/models/spree/gift_card_batch.rb
+++ b/core/app/models/spree/gift_card_batch.rb
@@ -42,7 +42,7 @@ module Spree
def generate_code
loop do
code = "#{prefix.downcase}#{SecureRandom.hex(3).downcase}"
- break code unless Spree::GiftCard.exists?(code: code) && @gift_cards_to_insert.detect { |gc| gc[:code] == code }
+ break code unless Spree::GiftCard.exists?(code: code) || @gift_cards_to_insert.detect { |gc| gc[:code] == code }
end
end
@@ -50,6 +50,7 @@ module Spree
def gift_card_hash
{
+ state: :active,
gift_card_batch_id: id,
amount: amount,
amount_remaining: amount,
diff --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.rb
index 887668af17..fad2478d38 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
@@ -17,7 +17,7 @@ class CreateSpreeGiftCardsAndSpreeGiftCardBatches < ActiveRecord::Migration[7.2]
t.references :store_credit
t.date :expires_at
t.string :code, null: false
- t.integer :state, default: 0, null: false
+ t.string :state, null: false
t.decimal :amount, precision: 10, scale: 2, null: false
t.decimal :amount_remaining, precision: 10, scale: 2, default: '0.0', null: false
t.references :gift_card_batch
diff --git a/core/spec/models/spree/gift_card_spec.rb b/core/spec/models/spree/gift_card_spec.rb
index 4ee50604e0..eaebc5b815 100644
--- a/core/spec/models/spree/gift_card_spec.rb
+++ b/core/spec/models/spree/gift_card_spec.rb
@@ -23,7 +23,7 @@ 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).destroy).to be(false)
- expect(create(:gift_card, state: :partialy_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
diff --git a/core/spec/models/spree/promotion_handler/coupon_spec_with_gift_card.rb b/core/spec/models/spree/promotion_handler/coupon_with_gift_card_spec.rb
similarity index 100%
rename from core/spec/models/spree/promotion_handler/coupon_spec_with_gift_card.rb
rename to core/spec/models/spree/promotion_handler/coupon_with_gift_card_spec.rb