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.

Rebuild gift cards UI, drop minimum order amount rule

Damian Legawiec4c1badbbe25b
diff --git a/admin/app/controllers/spree/admin/gift_card_batches_controller.rb b/admin/app/controllers/spree/admin/gift_card_batches_controller.rb
index 0b3923b8a3..7da50cf438 100644
--- a/admin/app/controllers/spree/admin/gift_card_batches_controller.rb
+++ b/admin/app/controllers/spree/admin/gift_card_batches_controller.rb
@@ -1,6 +1,10 @@
module Spree
module Admin
class GiftCardBatchesController < ResourceController
+ add_breadcrumb_icon 'discount'
+ add_breadcrumb Spree.t(:promotions), :admin_promotions_path
+ add_breadcrumb Spree.t(:gift_cards), :admin_gift_cards_path
+
private
def location_after_save
diff --git a/admin/app/controllers/spree/admin/gift_cards_controller.rb b/admin/app/controllers/spree/admin/gift_cards_controller.rb
index f1ad478f2f..761c77db04 100644
--- a/admin/app/controllers/spree/admin/gift_cards_controller.rb
+++ b/admin/app/controllers/spree/admin/gift_cards_controller.rb
@@ -1,7 +1,7 @@
module Spree
module Admin
class GiftCardsController < ResourceController
- before_action :load_user, only: [:new, :create, :edit, :update, :destroy]
+ before_action :load_user
before_action :add_breadcrumbs
helper_method :gift_cards_filter_dropdown_value
@@ -35,11 +35,9 @@ module Spree
@search = @search.active if params[:q][:status_eq] == 'active'
@search = @search.redeemed if params[:q][:status_eq] == 'redeemed'
- @search = @search.where(code: params[:q][:code_eq].strip) if params[:q][:code_eq].present?
-
@search = @search.ransack(params[:q])
- @collection = @search.result
+ @collection = @search.result.includes(:user)
@collection = @collection.page(params[:page]).per(params[:per_page]) if params[:format] != 'csv'
@@ -55,15 +53,11 @@ module Spree
end
def location_after_save
- if @user.present?
- spree.edit_admin_user_gift_card_path(@object, user_id: @user.id)
- else
- spree.edit_admin_gift_card_path(@object.id)
- end
+ spree.admin_gift_card_path(@object.id)
end
def load_user
- @user = Spree.user_class.find_by(id: params[:user_id])
+ @user = Spree.user_class.find_by(id: params[:user_id]) if params[:user_id].present?
end
def gift_cards_filter_dropdown_value
diff --git a/admin/app/controllers/spree/admin/resource_controller.rb b/admin/app/controllers/spree/admin/resource_controller.rb
index 4782520453..cb962b2ec9 100644
--- a/admin/app/controllers/spree/admin/resource_controller.rb
+++ b/admin/app/controllers/spree/admin/resource_controller.rb
@@ -60,7 +60,7 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
end
format.html do
flash[:success] = message_after_create
- redirect_to location_after_save, status: :see_other
+ redirect_to location_after_create, status: :see_other
end
end
else
@@ -226,6 +226,10 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
collection_url
end
+ def location_after_create
+ location_after_save
+ end
+
def location_after_save
edit_object_url(@object)
end
diff --git a/admin/app/views/spree/admin/gift_card_batches/_form.html.erb b/admin/app/views/spree/admin/gift_card_batches/_form.html.erb
index c9c8d75092..5e54e44017 100644
--- a/admin/app/views/spree/admin/gift_card_batches/_form.html.erb
+++ b/admin/app/views/spree/admin/gift_card_batches/_form.html.erb
@@ -3,7 +3,7 @@
<div class="card mb-4">
<div class="card-header">
<h5 class="card-title">
- <%= Spree.t('admin.gift_card_batches.gift_card_batch') %>
+ <%= Spree.t(:gift_card_batch) %>
</h5>
</div>
@@ -24,7 +24,7 @@
<%= f.error_message_on :codes_count %>
</div>
<div class="form-group">
- <%= f.label :expires_at, Spree.t(:expires_at) %>
+ <%= f.label :expires_at, I18n.t('activerecord.attributes.spree/gift_card.expires_at') %>
<%= f.date_field :expires_at, class: 'form-control', disabled: f.object.persisted? %>
<%= f.error_message_on :expires_at %>
</div>
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 956338efdf..e7be65ae4e 100644
--- a/admin/app/views/spree/admin/gift_cards/_form.html.erb
+++ b/admin/app/views/spree/admin/gift_cards/_form.html.erb
@@ -1,92 +1,30 @@
-<div data-hook="admin_brand_form_fields">
- <div class="row">
- <div class="col-12">
- <div class="card mb-4" data-hook="brands_form">
- <div class="card-header">
- <h5 class="card-title">
- <%= Spree.t(:gift_card) %>
- </h5>
- </div>
-
- <div class="card-body">
- <div class="form-group" data-controller="clipboard">
- <%= f.label :code do %>
- <%= Spree.t(:code) %>
- <% if f.object.persisted? %>
- <button class="btn btn-sm text-muted with-tip mx-1" title="Copy" data-action="clipboard#copy" data-clipboard-target="button">
- <%= icon 'files', class: 'mr-0' %>
- </button>
- <% end %>
- <% end %>
- <% unless f.object.persisted? %>
- <%= help_bubble('If you leave it blank, we will generate code for you') %>
- <% end %>
- <%= f.text_field :code, class: 'form-control', disabled: f.object.persisted?, data: { clipboard_target: 'source' } %>
- <%= f.error_message_on :code %>
- <span class="text-muted form-text">
- <% if f.object.persisted? %>
- You can't change the code of an existing gift card
- <% else %>
- Your code will appear here after saving the conditions
- <% end %>
- </span>
- </div>
-
- <div class="row mb-3">
- <div class="col-6">
- <div class="form-group">
- <%= f.label :amount, raw(Spree.t(:amount) + required_span_tag) %>
- <%= f.text_field :amount, class: 'form-control', required: true, 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
- <% end %>
- </span>
- <%= f.error_message_on :amount %>
- </div>
- </div>
- <div class="col-6">
- <div class="form-group">
- <%= f.label :minimum_order_amount, raw(Spree.t(:minimum_order_amount) + required_span_tag) %>
- <%= 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 minimum order amount of a redeemed gift card
- <% end %>
- </span>
- <%= f.error_message_on :minimum_order_amount %>
- </div>
- </div>
- </div>
-
- <div class="row">
- <div class="col-6">
- <div class="form-group">
- <%= f.label :user_id, Spree.t(:customer), class: 'form-label' %>
- <%= tom_select_tag 'gift_card[user_id]',
- active_option: @user&.id || @object.user_id,
- include_blank: true,
- options: users_for_select_options,
- disabled: !f.object.editable? || @user.present? %>
+<% unless f.object.persisted? %>
+ <div class="form-group">
+ <%= f.label :code do %>
+ <%= Spree.t(:code) %>
+ <%= help_bubble(Spree.t('admin.gift_cards.code_help_text')) %>
+ <% end %>
+ <%= f.text_field :code, class: 'form-control' %>
+ <%= f.error_message_on :code %>
+ </div>
+<% end %>
- <% if !f.object.editable? %>
- <span class="text-muted form-text">
- You can't change the assigned customer of a redeemed gift card
- </span>
- <% end %>
- </div>
- </div>
+<div class="form-group">
+ <%= f.label :amount, raw(Spree.t(:amount) + required_span_tag) %>
+ <%= f.text_field :amount, class: 'form-control', required: true %>
+ <%= f.error_message_on :amount %>
+</div>
- <div class="col-6">
- <div class="form-group">
- <%= f.label :expires_at, Spree.t(:expires_at) %>
- <%= f.date_field :expires_at, class: 'form-control', disabled: !f.object.editable? %>
- <%= f.error_message_on :expires_at %>
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
- </div>
+<div class="form-group">
+ <%= f.label :user_id, Spree.t(:customer) %>
+ <%= tom_select_tag 'gift_card[user_id]',
+ active_option: @user&.id || @object.user_id,
+ include_blank: true,
+ options: users_for_select_options %>
</div>
+<div class="form-group">
+ <%= f.label :expires_at, Spree.t(:expires_at) %>
+ <%= f.date_field :expires_at, class: 'form-control' %>
+ <%= f.error_message_on :expires_at %>
+</div>
+
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 e6130fa0dd..64ce6b1332 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
@@ -1,34 +1,27 @@
-<tr id="<%= spree_dom_id gift_card %>" data-hook="gift_cards_row">
- <td data-controller="clipboard">
- <%= hidden_field_tag :code, gift_card.code.upcase, data: { clipboard_target: 'source' } %>
- <%= link_to gift_card.code.upcase, spree.edit_admin_gift_card_path(gift_card), class: 'font-weight-bold', data: { 'turbo-frame': '_top' } %>
- <button class="btn btn-sm text-muted with-tip mx-1" title="Copy" data-action="clipboard#copy" data-clipboard-target="button">
- <%= icon 'files', class: 'mr-0' %>
- </button>
+<% link = @user.present? ? spree.admin_user_gift_card_path(gift_card, user_id: @user.id) : spree.admin_gift_card_path(gift_card) %>
+
+<tr id="<%= spree_dom_id gift_card %>" data-controller="row-link">
+ <td class="w-25 py-0">
+ <%= 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><%= gift_card.display_amount %></td>
- <td><%= gift_card.display_minimum_order_amount %></td>
- <td>
- <%= gift_card.display_used_amount %>
+ <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"><%= active_badge(gift_card.active?, label: gift_card.display_state) %></td>
+ <td class="w-10 cursor-pointer" data-action="click->row-link#openLink">
+ <% if gift_card.expires_at.present? %>
+ <%= local_date(gift_card.expires_at) %>
+ <% else %>
+ <span class="text-muted">
+ <%= Spree.t(:not_available) %>
+ </span>
+ <% end %></td>
+ <td class="w-15 cursor-pointer" data-action="click->row-link#openLink">
+ <% if gift_card.user.present? %>
+ <%= gift_card.user.email %>
+ <% else %>
+ <span class="text-muted">
+ <%= Spree.t(:not_available) %>
+ </span>
+ <% end %>
</td>
- <td><%= active_badge(gift_card.active?, label: gift_card.display_state) %></td>
- <td><%= local_date(gift_card.expires_at) if gift_card.expires_at.present? %></td>
-
- <% if params[:user_id].blank? %>
- <td><%= gift_card.user_email %></td>
-
- <td class="actions">
- <%= link_to_edit(gift_card, data: { 'turbo-frame': '_top' }) if can? :edit, gift_card %>
- </td>
- <% else %>
- <td class="actions">
- <% 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/_list.html.erb b/admin/app/views/spree/admin/gift_cards/_list.html.erb
index d7eb929481..73655b4ae2 100644
--- a/admin/app/views/spree/admin/gift_cards/_list.html.erb
+++ b/admin/app/views/spree/admin/gift_cards/_list.html.erb
@@ -5,15 +5,10 @@
<tr>
<th><%= Spree.t(:code) %></th>
<th><%= Spree.t(:amount) %></th>
- <th><%= Spree.t(:minimum_order_amount) %></th>
<th><%= Spree.t(:used) %></th>
<th><%= Spree.t(:status) %></th>
<th><%= Spree.t(:expires_at) %></th>
-
- <% if params[:user_id].blank? %>
- <th><%= Spree.t('admin.gift_cards.issued_to') %></th>
- <th></th>
- <% end %>
+ <th><%= Spree.t('admin.gift_cards.issued_to') %></th>
</tr>
</thead>
<tbody>
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 5d23bf9937..f4daa179f3 100644
--- a/admin/app/views/spree/admin/gift_cards/edit.html.erb
+++ b/admin/app/views/spree/admin/gift_cards/edit.html.erb
@@ -1,64 +1,6 @@
-<% content_for :page_title do %>
- <% if @user.present? %>
- <%= page_header_back_button spree.admin_user_path(@user) %>
- <% else %>
- <%= page_header_back_button spree.admin_gift_cards_path %>
- <% end %>
-
- <%= @object.code.upcase %>
- <span class="badge ml-4">
- <%= active_badge(@object.active?, label: @object.state) %>
- </span>
-<% end %>
-
-<% if @object.redeemed? || @object.redeemed_by_order? || @object.partially_redeemed? %>
- <div class="card mb-4">
- <div class="card-header">
- <h5 class="card-title">
- Gift card usage details
- <span class="text-muted small">
- <%= @object.display_amount %>
- (<%= @object.display_amount_remaining %> left)
- </span>
- </h5>
- </div>
- <div class="card-body">
- <ul class="list-group pb-4">
- <% @object.orders.each do |order| %>
- <li class="list-group-item d-flex justify-content-between align-items-center">
- <% if order %>
- <%= link_to order.number, spree.edit_admin_order_path(order), class: 'text-dark font-weight-bold d-block w-20' %>
- <% end %>
- <div class="w-40 align-items-center">
- <% if order.user %>
- <%= order.user.email %>
- <% end %>
- </div>
- <span class="text-right w-20">
- <%= order.display_total_applicable_store_credit %>
- </span>
- </li>
- <% end %>
- </ul>
- </div>
- </div>
-<% end %>
-
-
-<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @object } %>
-<%= form_for [:admin, @user, @object] do |f| %>
- <fieldset>
+<%= turbo_frame_tag :gift_card_settings do %>
+ <%= render partial: 'spree/admin/shared/error_messages', locals: { target: @object } %>
+ <%= form_for [:admin, @user, @object] do |f| %>
<%= render 'form', f: f %>
-
- <% if can? :update, @object %>
- <div class="form-actions">
- <%= turbo_save_button_tag Spree.t('actions.update') %>
-
- <% if f.object.can_be_deleted? && can?(:delete, f.object) %>
- <% gift_card_delete_url = @user.present? ? admin_user_gift_card_path(@object, user_id: @user.id) : object_url(f.object) %>
- <%= link_to Spree.t('actions.destroy'), gift_card_delete_url , data: { turbo_method: :delete, turbo_confirm: Spree.t(:are_you_sure), turbo_frame: defined?(turbo_frame) ? turbo_frame : nil }, class: 'btn btn-danger ml-auto' %>
- <% end %>
- </div>
- <% end %>
- </fieldset>
+ <% end %>
<% end %>
diff --git a/admin/app/views/spree/admin/gift_cards/index.csv.erb b/admin/app/views/spree/admin/gift_cards/index.csv.erb
index a59ea6b66f..5b18c4ced8 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,6 @@
<%= CSV.generate_line([
gift_card.code.upcase,
gift_card.amount.to_f,
- gift_card.minimum_order_amount.to_f,
gift_card.used_amount.to_f,
gift_card.display_state,
gift_card.expires_at,
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 b7e675c90d..a64125418a 100644
--- a/admin/app/views/spree/admin/gift_cards/index.html.erb
+++ b/admin/app/views/spree/admin/gift_cards/index.html.erb
@@ -1,29 +1,27 @@
<% unless turbo_frame_request? %>
<% content_for :page_title do %>
- Gift Cards
+ <%= Spree.t(:gift_cards) %>
<% 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' %>
- Export codes
+ <%= Spree.t(:export) %>
<% end %>
- <div class="dropdown ml-2" id="page_actions_dropdown">
- <%= button_link_to 'Add a new gift card', '#', icon: 'plus', class: 'text-nowrap btn btn-primary align-self-center', no_text: true, data: { toggle: 'dropdown' }, id: 'more-actions-link' %>
+ <div class="dropdown" id="page_actions_dropdown">
+ <%= link_to_with_icon 'plus', 'Add a new gift card', '#', class: 'text-nowrap btn btn-primary align-self-center', data: { toggle: 'dropdown' }, id: 'more-actions-link' %>
<div class="dropdown-menu dropdown-menu-right">
-
-
<%= link_to spree.new_admin_gift_card_path,
class: 'text-left dropdown-item' do %>
<%= icon 'add' %>
- One gift card
+ <%= Spree.t(:gift_card) %>
<% end %>
<%= link_to spree.new_admin_gift_card_batch_path,
class: 'text-left dropdown-item' do %>
<%= icon 'add' %>
- A batch of gift cards
+ <%= Spree.t(:gift_card_batch) %>
<% end %>
</div>
</div>
diff --git a/admin/app/views/spree/admin/gift_cards/new.html.erb b/admin/app/views/spree/admin/gift_cards/new.html.erb
index 44069a3848..a82118cc88 100644
--- a/admin/app/views/spree/admin/gift_cards/new.html.erb
+++ b/admin/app/views/spree/admin/gift_cards/new.html.erb
@@ -11,9 +11,19 @@
<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @object } %>
<%= form_for [:admin, @user, @object] do |f| %>
- <fieldset>
- <%= render 'form', f: f %>
-
- <%= render 'spree/admin/shared/new_resource_links' %>
- </fieldset>
+ <div class="row">
+ <div class="col-lg-6 offset-lg-3">
+ <div class="card mb-4">
+ <div class="card-header">
+ <h5 class="card-title">
+ <%= Spree.t(:gift_card) %>
+ </h5>
+ </div>
+ <div class="card-body">
+ <%= render 'form', f: f %>
+ </div>
+ </div>
+ <%= render 'spree/admin/shared/new_resource_links' %>
+ </div>
+ </div>
<% end %>
diff --git a/admin/app/views/spree/admin/gift_cards/show.html.erb b/admin/app/views/spree/admin/gift_cards/show.html.erb
new file mode 100644
index 0000000000..a9fae856b4
--- /dev/null
+++ b/admin/app/views/spree/admin/gift_cards/show.html.erb
@@ -0,0 +1,86 @@
+<% content_for :page_title do %>
+ <% if @user.present? %>
+ <%= page_header_back_button spree.admin_user_path(@user) %>
+ <% else %>
+ <%= page_header_back_button spree.admin_gift_cards_path %>
+ <% end %>
+
+ <%= @object.code.upcase %>
+ <span class="badge">
+ <%= active_badge(@object.active?, label: @object.display_state) %>
+ </span>
+<% end %>
+
+<% content_for :title do %>
+ <%= @object.code.upcase %>
+<% end %>
+
+<div class="row">
+ <div class="col-md-8">
+
+ <div class="card mb-4">
+ <div class="card-header d-flex justify-content-between align-items-center">
+ <h5 class="card-title">
+ Gift card usage details
+ </h5>
+ </div>
+ <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) %>
+ </div>
+ <div class="w-25 text-right">
+ <%= @object.display_amount_remaining %> / <span class="text-muted"><%= @object.display_amount %></span>
+ </div>
+ </div>
+ </div>
+ <div class="card-body">
+ <ul class="list-group pb-4">
+ <% @object.orders.each do |order| %>
+ <li class="list-group-item d-flex justify-content-between align-items-center">
+ <% if order %>
+ <%= link_to order.number, spree.edit_admin_order_path(order), class: 'text-dark font-weight-bold d-block w-20' %>
+ <% end %>
+ <div class="w-40 align-items-center">
+ <% if order.user %>
+ <%= order.user.email %>
+ <% end %>
+ </div>
+ <span class="text-right w-20">
+ <%= order.display_total_applicable_store_credit %>
+ </span>
+ </li>
+ <% end %>
+ </ul>
+ </div>
+ </div>
+
+ </div>
+
+ <div class="col-md-4">
+ <%= turbo_frame_tag :gift_card_settings do %>
+ <div class="card">
+ <div class="card-header d-flex justify-content-between">
+ <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' %>
+ </div>
+ <div class="card-body p-0">
+ <ul class="list-group list-group-flush">
+ <li class="list-group-item d-flex justify-content-between align-items-center">
+ <span class="text-muted">
+ <%= I18n.t('activerecord.attributes.spree/gift_card.expires_at') %>
+ </span>
+ <% if @object.expires_at %>
+ <span><%= local_time(@object.expires_at) %></span>
+ <% else %>
+ <span class="text-muted"><%= Spree.t(:not_available) %></span>
+ <% end %>
+ </li>
+ </ul>
+ </div>
+ </div>
+ <% end %>
+ </div>
+</div>
\ No newline at end of file
diff --git a/admin/config/locales/en.yml b/admin/config/locales/en.yml
index 8749e28539..dd157ec9a2 100644
--- a/admin/config/locales/en.yml
+++ b/admin/config/locales/en.yml
@@ -79,7 +79,6 @@ en:
getting_started: Getting started
gift_card_batches:
codes_count: Codes count
- gift_card_batch: Gift card batch
new_gift_card_batch: New Gift Card Batch
prefix: Prefix
gift_cards:
@@ -90,6 +89,7 @@ en:
issued_to: Issued to
new_gift_card: New gift card
redeemed: Redeemed
+ code_help_text: If you leave it blank, we will generate code for you
integrations:
invalid_integration_type: This integration is not allowed
page_subtitle: Connect your store to third-party services to enhance customer experience.
diff --git a/admin/config/routes.rb b/admin/config/routes.rb
index e1aae1e9c1..4e88308b5e 100644
--- a/admin/config/routes.rb
+++ b/admin/config/routes.rb
@@ -121,7 +121,6 @@ Spree::Core::Engine.add_routes do
# gift cards
resources :gift_cards
-
# gift card batches
resources :gift_card_batches, only: [:new, :create]
diff --git a/api/app/serializers/spree/api/v2/platform/gift_card_serializer.rb b/api/app/serializers/spree/api/v2/platform/gift_card_serializer.rb
index 7332b687da..f1d57e2144 100644
--- a/api/app/serializers/spree/api/v2/platform/gift_card_serializer.rb
+++ b/api/app/serializers/spree/api/v2/platform/gift_card_serializer.rb
@@ -6,8 +6,8 @@ module Spree
set_type :gift_card
attributes :state, :code, :expires_at,
- :amount, :amount_remaining, :minimum_order_amount,
- :display_amount, :display_amount_remaining, :display_minimum_order_amount
+ :amount, :amount_remaining,
+ :display_amount, :display_amount_remaining
belongs_to :user
end
diff --git a/api/spec/requests/spree/api/v2/storefront/cart_spec.rb b/api/spec/requests/spree/api/v2/storefront/cart_spec.rb
index fef0a625f6..10c7895076 100644
--- a/api/spec/requests/spree/api/v2/storefront/cart_spec.rb
+++ b/api/spec/requests/spree/api/v2/storefront/cart_spec.rb
@@ -708,45 +708,10 @@ describe 'API V2 Storefront Cart Spec', type: :request do
let(:coupon_code) { gift_card.code }
let(:params) { { coupon_code: coupon_code, include: 'gift_card' } }
- before do
- # create(:stripe_gateway, stores: [store])
- end
-
it 'applies the gift card' do
apply_gift_card
expect(json_response['included']).to include(have_type('gift_card').and(have_attribute(:code).with_value(gift_card.code)))
end
-
- context 'for a gift card with minimal order amount' do
- let(:order_total) { order.total }
- let(:gift_card) { create(:gift_card, store: store, amount: 10, minimum_order_amount: minimal_order_amount) }
-
- context 'when the condition is met' do
- let(:minimal_order_amount) { order.total }
-
- it 'applies the gift card' do
- apply_gift_card
-
- expect(json_response['included']).to include(have_type('gift_card').and(have_attribute(:code).with_value(gift_card.code)))
-
- expect(order.reload.gift_card).to eq(gift_card)
- expect(order.total_applied_store_credit).to eq(gift_card.amount)
- end
- end
-
- context 'when the condition is not met' do
- let(:minimal_order_amount) { order.total + 1 }
-
- it 'skips applying the gift card' do
- apply_gift_card
-
- expect(json_response['error']).to eq("You can't apply the gift card. The order total must be at least #{gift_card.display_minimum_order_amount}, excluding shipping cost.")
-
- expect(order.reload.gift_card).to be(nil)
- expect(order.total_applied_store_credit).to eq(0)
- end
- end
- end
end
end
diff --git a/core/app/models/spree/gift_card.rb b/core/app/models/spree/gift_card.rb
index 359c2d5773..d25aea3248 100644
--- a/core/app/models/spree/gift_card.rb
+++ b/core/app/models/spree/gift_card.rb
@@ -22,46 +22,61 @@ module Spree
end
end
- validates :code, presence: true, uniqueness: true
- validates :amount, numericality: { greater_than: 0 }
- validates :minimum_order_amount, numericality: { greater_than_or_equal_to: 0 }
+ #
+ # Validations
+ #
+ validates :code, presence: true, uniqueness: { scope: :store_id }
+ validates :amount, presence: true, numericality: { greater_than: 0 }
+ validates :amount_remaining, 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? }
- belongs_to :user, class_name: Spree.user_class.to_s, optional: true
+ #
+ # Associations
+ #
belongs_to :store, class_name: 'Spree::Store'
+ belongs_to :user, class_name: Spree.user_class.to_s, optional: true
belongs_to :batch, class_name: 'Spree::GiftCardBatch', optional: true, foreign_key: :gift_card_batch_id
has_many :store_credits, class_name: 'Spree::StoreCredit'
-
- if defined?(Spree::Vendor)
- has_many :orders, -> { without_vendor }, through: :store_credits, source: :orders
- else
- has_many :orders, through: :store_credits, source: :orders
- end
-
+ has_many :orders, through: :store_credits, source: :orders
has_many :users, through: :orders, class_name: Spree.user_class.to_s
+ #
+ # 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 :redeemed, -> { where(state: [:redeemed, :redeemed_by_order]) }
+ #
+ # Ransack
+ #
self.whitelisted_ransackable_attributes = %w[code user_id]
self.whitelisted_ransackable_associations = %w[users orders batch]
auto_strip_attributes :code
+ #
+ # Callbacks
+ #
before_validation :generate_code
before_validation :normalize_code
- after_validation :set_amount_remaining
-
+ before_validation :set_amount_remaining
before_destroy :ensure_can_be_deleted
- money_methods :amount, :used_amount, :amount_remaining, :minimum_order_amount
+ #
+ # Money
+ #
+ money_methods :amount, :used_amount, :amount_remaining
+
+ def amount=(amount)
+ self[:amount] = Spree::LocalizedNumber.parse(amount)
+ end
delegate :email, to: :user, prefix: true, allow_nil: true
def self.json_api_columns
- %w[code amount minimum_order_amount expires_at]
+ %w[code amount expires_at]
end
def editable?
@@ -108,6 +123,7 @@ module Spree
def used_amount
@used_amount ||= amount - amount_remaining
end
+ alias_method :amount_used, :used_amount
def apply!(amount:, user:, currency:)
amount_applied = [amount, amount_remaining].min
diff --git a/core/app/models/spree/gift_card_batch.rb b/core/app/models/spree/gift_card_batch.rb
index 7715f4fb24..488324e09e 100644
--- a/core/app/models/spree/gift_card_batch.rb
+++ b/core/app/models/spree/gift_card_batch.rb
@@ -3,25 +3,31 @@ module Spree
extend DisplayMoney
include Spree::SingleStoreResource
+ #
+ # Validations
+ #
validates :codes_count, :amount, :prefix, presence: true
validates :codes_count, numericality: { greater_than: 0, less_than_or_equal_to: Spree::Config[:gift_card_batch_limit].to_i }
validates :amount, numericality: { greater_than: 0 }
- validates :minimum_order_amount, numericality: { greater_than_or_equal_to: 0 }
+ #
+ # Associations
belongs_to :store, class_name: 'Spree::Store'
-
has_many :gift_cards, class_name: 'Spree::GiftCard', inverse_of: :batch
+ #
+ # Callbacks
+ #
after_create :generate_gift_cards
auto_strip_attributes :prefix
- money_methods :amount, :minimum_order_amount
+ money_methods :amount
self.whitelisted_ransackable_attributes = %w[prefix]
def generate_gift_cards
- if codes_count < 500
+ if codes_count < Spree::Config[:gift_card_batch_web_limit].to_i
create_gift_cards
else
Spree::GiftCards::BulkGenerateJob.perform_later(id)
@@ -56,8 +62,7 @@ module Spree
amount_remaining: amount,
code: generate_code,
store_id: store_id,
- expires_at: expires_at,
- minimum_order_amount: minimum_order_amount
+ expires_at: expires_at
}
end
end
diff --git a/core/app/services/spree/gift_cards/apply.rb b/core/app/services/spree/gift_cards/apply.rb
index e8c2b07604..b9b5cf93ea 100644
--- a/core/app/services/spree/gift_cards/apply.rb
+++ b/core/app/services/spree/gift_cards/apply.rb
@@ -6,11 +6,6 @@ module Spree
def call(gift_card:, order:)
return failure(:gift_card_using_store_credit_error) if order.using_store_credit?
- if order_total_below_minimum?(order.total, gift_card)
- minimum_order_amount = gift_card.display_minimum_order_amount
- return failure(:gift_card_minimum_order_value_error, minimum_order_amount: minimum_order_amount)
- end
-
amount_applied = [gift_card.amount_remaining, order.total].min
store = order.store
@@ -35,25 +30,13 @@ module Spree
private
- def can_apply_gift_card?(order)
- !order.using_store_credit?
- end
-
- def order_total_below_minimum?(order_total, gift_card)
- gift_card.minimum_order_amount.present? && gift_card.minimum_order_amount > order_total
- end
-
def ensure_store_credit_payment_method!(store)
- payment_method = Spree::PaymentMethod::StoreCredit.find_or_initialize_by(
- name: 'Store Credit',
- description: 'Store Credit',
- active: true
+ payment_method = store.payment_methods.find_or_initialize_by(
+ type: 'Spree::PaymentMethod::StoreCredit'
)
-
- if payment_method.new_record?
- payment_method.stores << store
- payment_method.save!
- end
+ payment_method.name ||= Spree.t(:store_credit_name)
+ payment_method.active = true
+ payment_method.save! if payment_method.new_record?
payment_method
end
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index f3757d27d7..8b1dffd129 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -50,6 +50,8 @@ en:
number: Number
verification_value: Verification Value
year: Year
+ spree/gift_card:
+ expires_at: Expires at
spree/inventory_unit:
state: State
spree/invitation:
@@ -1037,7 +1039,6 @@ en:
expiration: Expiration
expiration_date: Expiration Date
expired: Expired
- expires_at: Expires At
explore_taxon: Explore taxon
export: Export
export_mailer:
@@ -1093,8 +1094,8 @@ en:
generate_code: Generate coupon code
get_back_to_the: Get back to the
gift_card: Gift card
+ gift_card_batch: Gift card batch
gift_card_applied: The gift card was successfully applied to your order!
- gift_card_minimum_order_value_error: You can't apply the gift card. The order total must be at least %{minimum_order_amount}, excluding shipping cost.
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 order
gift_card_using_store_credit_error: You can't apply the gift card after you applied the store credit.
@@ -1262,7 +1263,6 @@ en:
metadata: Metadata
min: Min
minimal_amount: Minimal Amount
- minimum_order_amount: Minimum Order Amount
minimum_password_length:
one: "(%{count} character minimum)"
other: "(%{count} characters minimum)"
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 fad2478d38..e533be71e8 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
@@ -1,32 +1,30 @@
class CreateSpreeGiftCardsAndSpreeGiftCardBatches < ActiveRecord::Migration[7.2]
def change
create_table :spree_gift_card_batches, if_not_exists: true do |t|
- t.references :store, null: false
+ t.references :store, null: false, index: true
t.integer :codes_count, default: 1, null: false
t.decimal :amount, precision: 10, scale: 2, default: '10.0', null: false
t.string :prefix
t.date :expires_at
- t.decimal :minimum_order_amount, precision: 10, scale: 2, default: '0.0'
t.timestamps
end
create_table :spree_gift_cards, if_not_exists: true do |t|
- t.references :store, null: false
- t.references :user
- t.references :store_credit
- t.date :expires_at
+ t.references :store, null: false, index: true
+ t.references :user, index: true
+ t.references :store_credit, index: true
+ t.references :gift_card_batch, index: true
+ t.date :expires_at, index: true
t.string :code, null: false
- t.string :state, null: false
+ t.string :state, null: false, index: true
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
- t.decimal :minimum_order_amount, precision: 10, scale: 2, default: '0.0'
+ t.decimal :amount_remaining, precision: 10, scale: 2, null: false
t.timestamps
end
- add_index :spree_gift_cards, :code, unique: true
+ add_index :spree_gift_cards, :code, unique: { scope: :store_id }
add_column :spree_store_credits, :gift_card_id, :bigint, if_not_exists: true
add_column :spree_store_credits, :expires_at, :datetime, if_not_exists: true
diff --git a/core/lib/spree/core/configuration.rb b/core/lib/spree/core/configuration.rb
index 9eefe99227..7255c79c9a 100644
--- a/core/lib/spree/core/configuration.rb
+++ b/core/lib/spree/core/configuration.rb
@@ -45,7 +45,6 @@ module Spree
preference :expedited_exchanges, :boolean, default: false # NOTE this requires payment profiles to be supported on your gateway of choice as well as a delayed job handler to be configured with activejob. kicks off an exchange shipment upon return authorization save. charge customer if they do not return items within timely manner.
preference :expedited_exchanges_days_window, :integer, default: 14 # the amount of days the customer has to return their item after the expedited exchange is shipped in order to avoid being charged
preference :geocode_addresses, :boolean, default: true
- preference :gift_card_batch_limit, :integer, default: 50_000
preference :layout, :string, deprecated: 'Please use Spree::Frontend::Config[:layout] instead'
preference :logo, :string, deprecated: true
preference :mailer_logo, :string, deprecated: true
@@ -75,6 +74,10 @@ module Spree
preference :coupon_codes_web_limit, :integer, default: 500 # number of coupon codes to be generated in the web process, more than this will be generated in a background job
preference :coupon_codes_total_limit, :integer, default: 5000 # the maximum number of coupon codes to be generated
+ # gift cards
+ preference :gift_card_batch_web_limit, :integer, default: 500 # number of gift card codes to be generated in the web process, more than this will be generated in a background job
+ preference :gift_card_batch_limit, :integer, default: 50_000
+
attr_writer :searcher_class
end
end
diff --git a/core/lib/spree/permitted_attributes.rb b/core/lib/spree/permitted_attributes.rb
index d535333c89..c99ace677a 100644
--- a/core/lib/spree/permitted_attributes.rb
+++ b/core/lib/spree/permitted_attributes.rb
@@ -107,9 +107,9 @@ module Spree
@@export_attributes = [:type, :format, :record_selection, :search_params]
- @@gift_card_attributes = [:code, :amount, :minimum_order_amount, :expires_at, :user_id]
+ @@gift_card_attributes = [:code, :amount, :expires_at, :user_id]
- @@gift_card_batch_attributes = [:prefix, :codes_count, :amount, :minimum_order_amount, :expires_at]
+ @@gift_card_batch_attributes = [:prefix, :codes_count, :amount, :expires_at]
@@image_attributes = [:alt, :attachment, :position, :viewable_type, :viewable_id]
diff --git a/core/spec/models/spree/gift_card_spec.rb b/core/spec/models/spree/gift_card_spec.rb
index 45fa081051..eb246f2675 100644
--- a/core/spec/models/spree/gift_card_spec.rb
+++ b/core/spec/models/spree/gift_card_spec.rb
@@ -3,14 +3,14 @@ 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).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
+ 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
end
it 'adds an error' do
- gift_card = create(:gift_card, state: :redeemed)
+ gift_card = create(:gift_card, state: :redeemed, amount_remaining: 0)
gift_card.destroy
expect(gift_card).to_not be_destroyed
diff --git a/core/spec/services/spree/gift_cards/apply_spec.rb b/core/spec/services/spree/gift_cards/apply_spec.rb
index de8bde7d7e..b449d41d49 100644
--- a/core/spec/services/spree/gift_cards/apply_spec.rb
+++ b/core/spec/services/spree/gift_cards/apply_spec.rb
@@ -3,10 +3,10 @@ require 'spec_helper'
RSpec.describe Spree::GiftCards::Apply do
subject { described_class.call(gift_card: gift_card, order: order) }
- let(:order) { create(:order) }
+ let(:store) { Spree::Store.default }
+ let(:order) { create(:order, store: store) }
- let(:gift_card) { create(:gift_card, amount: 50, minimum_order_amount: minimum_order_amount, store: Spree::Store.default) }
- let(:minimum_order_amount) { 30 }
+ let(:gift_card) { create(:gift_card, amount: 50, store: store) }
let(:store_credit_payment) { order.payments.store_credits.last }
let(:store_credit) { store_credit_payment.source }
@@ -35,23 +35,9 @@ RSpec.describe Spree::GiftCards::Apply do
expect(store_credit.gift_card).to eq(gift_card)
end
- context 'when the order total is below minimum' do
- let(:minimum_order_amount) { 35 }
-
- it 'responds with an error' do
- expect { subject }.to_not change(Spree::StoreCredit, :count)
-
- expect(subject).to be_failure
- expect(subject.value).to eq(:gift_card_minimum_order_value_error)
- expect(subject.error.value).to eq(minimum_order_amount: Spree::Money.new(minimum_order_amount))
-
- expect(order.reload.gift_card).to eq(nil)
- end
- end
-
context 'when the order has applied store credit' do
- let!(:store_credit_payment_method) { create(:store_credit_payment_method, stores: [order.store]) }
- let!(:store_credit) { create(:store_credit, user: order.user, amount: 10) }
+ let!(:store_credit_payment_method) { create(:store_credit_payment_method, stores: [store]) }
+ let!(:store_credit) { create(:store_credit, user: order.user, amount: 10, store: store) }
before do
order.add_store_credit_payments
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.erb
index 7d925e8e84..2781e99b8c 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
@@ -19,13 +19,8 @@
<%= gift_card.display_used_amount %>
</td>
- <td class="mb-4 w-full md:w-auto md:px-4 md:border-y border-accent">
- <span class="md:hidden font-medium mr-1"><%= Spree.t(:minimum_order_amount) %>:</span>
- <%= gift_card.display_minimum_order_amount %>
- </td>
-
<td class="w-full md:w-auto md:px-4 md:border-y md:border-r border-accent">
- <span class="md:hidden font-medium mr-1"><%= Spree.t(:expires_at) %>:</span>
+ <span class="md:hidden font-medium mr-1"><%= I18n.t('activerecord.attributes.spree/gift_card.expires_at') %>:</span>
<%= gift_card.expires_at.present? ? local_date(gift_card.expires_at) : '-' %>
</td>
</tr>
diff --git a/storefront/app/views/themes/default/spree/account/gift_cards/index.html.erb b/storefront/app/views/themes/default/spree/account/gift_cards/index.html.erb
index e2514ba53a..779a46d911 100644
--- a/storefront/app/views/themes/default/spree/account/gift_cards/index.html.erb
+++ b/storefront/app/views/themes/default/spree/account/gift_cards/index.html.erb
@@ -14,7 +14,6 @@
<th class="font-normal px-4"><%= Spree.t(:status) %></th>
<th class="font-normal px-4"><%= Spree.t(:amount) %></th>
<th class="font-normal px-4"><%= Spree.t(:used) %></th>
- <th class="font-normal px-4"><%= Spree.t(:minimum_order_amount) %></th>
<th class="font-normal px-4"><%= Spree.t(:expires_at) %></th>
</tr>
</thead>
diff --git a/storefront/spec/controllers/spree/checkout_controller_spec.rb b/storefront/spec/controllers/spree/checkout_controller_spec.rb
index 006ea3158a..ebb507e07f 100644
--- a/storefront/spec/controllers/spree/checkout_controller_spec.rb
+++ b/storefront/spec/controllers/spree/checkout_controller_spec.rb
@@ -1097,7 +1097,7 @@ describe Spree::CheckoutController, type: :controller do
end
end
- xdescribe 'apply gift card' do
+ describe 'apply gift card' do
let(:user) { create(:user) }
let(:gift_card) { create :gift_card, store: store, user: user }
let(:coupon_code) { gift_card.code.upcase }
@@ -1116,52 +1116,7 @@ describe Spree::CheckoutController, type: :controller do
end
end
- xcontext 'for a gift card with minimal order amount' do
- let(:user) { create(:user) }
- let(:gift_card) { create(:gift_card, store: store, minimum_order_amount: minimal_order_amount, user: user) }
-
- context 'when the condition is met' do
- let(:minimal_order_amount) { order.total }
-
- it 'applies the gift card' do
- expect(controller).to receive(:track_event).with('coupon_entered', hash_including(order: order, coupon_code: gift_card.code.upcase))
- expect(controller).to receive(:track_event).with('coupon_applied', hash_including(order: order, coupon_code: gift_card.code.upcase))
-
- subject
-
- expect(assigns[:result].status_code).to eq(:gift_card_applied)
- expect(assigns[:result].error).to be(nil)
-
- expect(order.reload.gift_card).to eq(gift_card)
- expect(order.gift_card_total).to eq(gift_card.amount)
- expect(order.total_applied_store_credit).to eq(gift_card.amount)
- end
- end
-
- context 'when the condition is not met' do
- let(:minimal_order_amount) { order.total + 1 }
-
- it 'skips applying the gift card' do
- subject
-
- expect(assigns[:result].status_code).to eq(:gift_card_minimum_order_value_error)
- expect(assigns[:result].error).to eq("You can't apply the gift card. The order total must be at least #{gift_card.display_minimum_order_amount}, excluding shipping cost.")
-
- expect(order.reload.gift_card).to be(nil)
- expect(order.gift_card_total).to eq(0)
- expect(order.total_applied_store_credit).to eq(0)
- end
-
- it 'tracks the denied gift card' do
- expect(controller).to receive(:track_event).with('coupon_entered', hash_including(order: order, coupon_code: gift_card.code.upcase))
- expect(controller).to receive(:track_event).with('coupon_denied', hash_including(order: order, coupon_code: gift_card.code.upcase))
-
- subject
- end
- end
- end
-
- xcontext 'applying a gift card already redeemed by order' do
+ context 'applying a gift card already redeemed by order' do
let!(:old_order) { create(:order_with_totals, store: store, user: user) }
let(:gift_card) { create :gift_card, store: store, amount: 50 }
let(:coupon_code) { gift_card.code.upcase }