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.

Enhance Store Credit management UI (#12878)

Damian Legawiece94e2c00f541
diff --git a/admin/app/assets/stylesheets/spree/admin/components/_badges.scss b/admin/app/assets/stylesheets/spree/admin/components/_badges.scss
index 9f20af8ea9..b53af238df 100644
--- a/admin/app/assets/stylesheets/spree/admin/components/_badges.scss
+++ b/admin/app/assets/stylesheets/spree/admin/components/_badges.scss
@@ -34,6 +34,7 @@
.badge-approved,
.badge-resolved,
.badge-reimbursed,
+.badge-allocation,
.bg-success {
border: 1px solid rgba($success, 0.05);
background-color: #C6F6D5 !important;
@@ -89,6 +90,8 @@
.badge-draft,
.badge-onboarding,
.badge-light,
+.badge-authorize,
+.badge-eligible,
.badge-invited {
@extend .bg-white;
@extend .text-muted;
@@ -104,6 +107,7 @@
.badge-notice,
.badge-update,
.badge-partial,
+.badge-capture,
.badge-info {
border: 1px solid rgba($info, 0.05);
background-color: #E0EFFE;
diff --git a/admin/app/assets/stylesheets/spree/admin/global/_variables.scss b/admin/app/assets/stylesheets/spree/admin/global/_variables.scss
index 8e169fde9d..9557aa28c7 100644
--- a/admin/app/assets/stylesheets/spree/admin/global/_variables.scss
+++ b/admin/app/assets/stylesheets/spree/admin/global/_variables.scss
@@ -213,4 +213,6 @@ $list-group-item-padding-x: 1rem !default;
$header-height: 52px !default;
$sidebar-width: 220px !default;
-$sidebar-bg: $body-bg !default;
\ No newline at end of file
+$sidebar-bg: $gray-25 !default;
+
+$progress-bar-bg: $blue !default;
diff --git a/admin/app/controllers/spree/admin/store_credits_controller.rb b/admin/app/controllers/spree/admin/store_credits_controller.rb
index 05a489f493..89660d2394 100644
--- a/admin/app/controllers/spree/admin/store_credits_controller.rb
+++ b/admin/app/controllers/spree/admin/store_credits_controller.rb
@@ -4,16 +4,21 @@ module Spree
class StoreCreditsController < Spree::Admin::BaseController
before_action :load_user
- before_action :load_store_credit, only: [:new, :edit, :update]
+ before_action :load_store_credit, only: [:new, :edit, :update, :destroy]
before_action :ensure_unused_store_credit, only: [:update]
def index
- @store_credits = scope.includes(:category).order(created_at: :desc)
+ @store_credits = scope.includes(:created_by).order(created_at: :desc)
@store_credits = @store_credits.page(params[:page]).per(params[:per_page])
@collection = @store_credits
end
+ def show
+ @store_credit = scope.find(params[:id])
+ @store_credit_events = @store_credit.store_credit_events.reverse_chronological.includes(:originator, :order)
+ end
+
def create
@store_credit = @user.store_credits.build(
permitted_store_credit_params.merge(
@@ -38,7 +43,7 @@ module Spree
if @store_credit.save
flash[:success] = flash_message_for(@store_credit, :successfully_updated)
- redirect_to spree.admin_user_path(@user)
+ redirect_to spree.admin_user_store_credit_path(@user, @store_credit)
else
flash[:error] = Spree.t('store_credit.errors.unable_to_update')
render :edit, status: :unprocessable_entity
@@ -46,7 +51,6 @@ module Spree
end
def destroy
- @store_credit = @user.store_credits.for_store(current_store).find(params[:id])
ensure_unused_store_credit
if @store_credit.destroy
diff --git a/admin/app/views/spree/admin/promotions/_sidebar.html.erb b/admin/app/views/spree/admin/promotions/_sidebar.html.erb
index c2f62b12d7..4efac2ad93 100644
--- a/admin/app/views/spree/admin/promotions/_sidebar.html.erb
+++ b/admin/app/views/spree/admin/promotions/_sidebar.html.erb
@@ -116,7 +116,7 @@
</li>
<li class="list-group-item d-flex justify-content-between align-items-center">
<span class="text-muted">
- <%= I18n.t('activerecord.attributes.spree/promotion.expires_at') %>
+ <%= Spree.t(:expires_at) %>
</span>
<% if @promotion.expires_at %>
<span><%= local_time(@promotion.expires_at) %></span>
diff --git a/admin/app/views/spree/admin/shared/_edit_resource_links.html.erb b/admin/app/views/spree/admin/shared/_edit_resource_links.html.erb
index 159c7bfc92..bd96f9dc04 100644
--- a/admin/app/views/spree/admin/shared/_edit_resource_links.html.erb
+++ b/admin/app/views/spree/admin/shared/_edit_resource_links.html.erb
@@ -1,6 +1,8 @@
+<% destroy_url = defined?(destroy_url) && destroy_url ? destroy_url : object_url(f.object) %>
+
<div class="form-actions">
<%= turbo_save_button_tag Spree.t('actions.update') %>
<% if f.object.can_be_deleted? && can?(:delete, f.object) %>
- <%= link_to Spree.t('actions.destroy'), object_url(f.object), data: { turbo_method: :delete, turbo_confirm: Spree.t(:are_you_sure_delete), turbo_frame: defined?(turbo_frame) ? turbo_frame : nil }, class: 'btn btn-danger ml-auto' %>
+ <%= link_to Spree.t('actions.destroy'), destroy_url, data: { turbo_method: :delete, turbo_confirm: Spree.t(:are_you_sure_delete), turbo_frame: defined?(turbo_frame) ? turbo_frame : '_top' }, class: 'btn btn-danger ml-auto' %>
<% end %>
</div>
diff --git a/admin/app/views/spree/admin/store_credit_events/_store_credit_event.html.erb b/admin/app/views/spree/admin/store_credit_events/_store_credit_event.html.erb
new file mode 100644
index 0000000000..89f8a31549
--- /dev/null
+++ b/admin/app/views/spree/admin/store_credit_events/_store_credit_event.html.erb
@@ -0,0 +1,29 @@
+<tr id="<%= spree_dom_id(store_credit_event) %>">
+ <td class="w-15">
+ <span class="badge badge-<%= store_credit_event.action %>">
+ <%= store_credit_event.display_action %>
+ </span>
+ </td>
+ <td class="w-15">
+ <%= store_credit_event.display_amount %>
+ </td>
+ <td class="w-30">
+ <% if defined?(Spree::GiftCard) && store_credit_event.originator.is_a?(Spree::GiftCard) %>
+ <%= link_to store_credit_event.originator.code.upcase, spree.admin_gift_card_path(store_credit_event.originator) %>
+ <% elsif store_credit_event.originator.is_a?(Spree.admin_user_class) %>
+ <%= link_to store_credit_event.originator.email, spree.admin_admin_user_path(store_credit_event.originator) %>
+ <% end %>
+ </td>
+ <td class="w-20">
+ <% if store_credit_event.order %>
+ <%= link_to store_credit_event.order.number, spree.edit_admin_order_path(store_credit_event.order) %>
+ <% else %>
+ <span class="text-muted">
+ <%= Spree.t(:not_available) %>
+ </span>
+ <% end %>
+ </td>
+ <td class="w-20">
+ <%= local_date(store_credit_event.created_at) %>
+ </td>
+</tr>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/store_credits/_form.html.erb b/admin/app/views/spree/admin/store_credits/_form.html.erb
index 3de6cc27b4..62f6e4f53f 100644
--- a/admin/app/views/spree/admin/store_credits/_form.html.erb
+++ b/admin/app/views/spree/admin/store_credits/_form.html.erb
@@ -1,24 +1,16 @@
-<div data-hook='admin_store_credit_form_fields'>
- <div class="row mb-3">
- <div class="col-6">
- <div class="form-group">
- <%= f.label :amount, raw(Spree.t(:amount) + required_span_tag) %>
- <%= f.number_field :amount, class: 'form-control', min: 0.01, step: 0.01, required: true, disabled: !f.object.editable? %>
- <%= f.error_message_on :amount %>
- </div>
- </div>
+<div class="form-group">
+ <%= f.label :amount, raw(Spree.t(:amount) + required_span_tag) %>
+ <%= f.number_field :amount, class: 'form-control', min: 0.01, step: 0.01, required: true, disabled: !f.object.editable? %>
+ <%= f.error_message_on :amount %>
+</div>
- <div class="col-6">
- <div class="form-group">
- <%= f.label :currency, raw(Spree.t(:currency) + required_span_tag), class: 'form-label' %>
- <%= f.select :currency, preferred_currencies_select_options, {}, { data: { controller: 'autocomplete-select', enable_button_target: 'input', store_form_target: 'currency' } } %>
- </div>
- </div>
- </div>
+<div class="form-group">
+ <%= f.label :currency, raw(Spree.t(:currency) + required_span_tag), class: 'form-label' %>
+ <%= f.select :currency, preferred_currencies_select_options, {}, { data: { controller: 'autocomplete-select', enable_button_target: 'input', store_form_target: 'currency' } } %>
+</div>
- <div class="form-group">
- <%= f.label :memo, Spree.t(:memo) %>
- <%= f.text_area :memo, class: 'form-control' %>
- <%= f.error_message_on :memo %>
- </div>
+<div class="form-group">
+<%= f.label :memo, Spree.t(:memo) %>
+<%= f.text_area :memo, class: 'form-control' %>
+<%= f.error_message_on :memo %>
</div>
diff --git a/admin/app/views/spree/admin/store_credits/_list.html.erb b/admin/app/views/spree/admin/store_credits/_list.html.erb
index 0d8843b028..c68ee42a91 100644
--- a/admin/app/views/spree/admin/store_credits/_list.html.erb
+++ b/admin/app/views/spree/admin/store_credits/_list.html.erb
@@ -9,33 +9,13 @@
<th><%= Spree.t('store_credit.remaining') %></th>
<th><%= Spree.t(:created_by) %></th>
<th><%= Spree.t(:issued_on) %></th>
- <th></th>
</thead>
<tbody>
- <% @store_credits.each do |store_credit| %>
- <tr>
- <td><%= store_credit.currency %></td>
- <td><%= store_credit.display_amount.to_html %></td>
- <td><%= store_credit.display_amount_authorized.to_html %></td>
- <td><%= store_credit.display_amount_used.to_html %></td>
- <td><%= store_credit.display_amount_remaining.to_html %></td>
- <td><%= store_credit.created_by_email %></td>
- <td><%= local_date(store_credit.created_at) %></td>
- <td class="actions">
- <% if store_credit.editable? && can?(:edit, store_credit) %>
- <%= link_to_edit store_credit, url: spree.edit_admin_user_store_credit_path(@user, store_credit), no_text: true, data: { 'turbo-frame': '_top' } %>
- <% end %>
- </td>
- </tr>
- <% end %>
+ <%= render partial: 'spree/admin/store_credits/store_credit', collection: @store_credits, as: :store_credit, cached: spree_base_cache_scope %>
</tbody>
</table>
</div>
+ <%= render partial: 'spree/admin/shared/index_table_options', locals: { collection: @store_credits } %>
<% else %>
- <div class="text-muted p-5 d-flex align-items-center w-100 justify-content-center">
- <%= Spree.t(:no_resource_found, resource: plural_resource_name(Spree::StoreCredit)) %>
- <%= link_to_with_icon 'plus', Spree.t(:add_one), spree.new_admin_user_store_credit_path(@user), class: 'btn btn-link ml-3', data: { 'turbo-frame': '_top' } if can?(:create, Spree::StoreCredit) %>
- </div>
-<% end %>
-
-<%= render partial: 'spree/admin/shared/index_table_options', locals: { collection: @collection } %>
\ No newline at end of file
+ <%= render 'spree/admin/shared/no_resource_found', model_class: Spree::StoreCredit, new_object_url: spree.new_admin_user_store_credit_path(@user) %>
+<% end %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/store_credits/_store_credit.html.erb b/admin/app/views/spree/admin/store_credits/_store_credit.html.erb
new file mode 100644
index 0000000000..d420c4ca7b
--- /dev/null
+++ b/admin/app/views/spree/admin/store_credits/_store_credit.html.erb
@@ -0,0 +1,11 @@
+<tr data-controller="row-link" id="<%= spree_dom_id(store_credit) %>">
+ <td>
+ <%= link_to store_credit.display_amount.to_html, spree.admin_user_store_credit_path(@user, store_credit), data: { row_link_target: :link } %>
+ </td>
+ <td class="cursor-pointer" data-action="click->row-link#openLink"><%= store_credit.display_amount_authorized.to_html %></td>
+ <td class="cursor-pointer" data-action="click->row-link#openLink"><%= store_credit.display_amount_used.to_html %></td>
+ <td class="cursor-pointer" data-action="click->row-link#openLink"><%= store_credit.display_amount_remaining.to_html %></td>
+ <td class="cursor-pointer" data-action="click->row-link#openLink"><%= store_credit.currency %></td>
+ <td class="cursor-pointer" data-action="click->row-link#openLink"><%= store_credit.created_by_email %></td>
+ <td class="cursor-pointer" data-action="click->row-link#openLink"><%= local_date(store_credit.created_at) %></td>
+</tr>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/store_credits/edit.html.erb b/admin/app/views/spree/admin/store_credits/edit.html.erb
index a4e766016b..df4df69535 100644
--- a/admin/app/views/spree/admin/store_credits/edit.html.erb
+++ b/admin/app/views/spree/admin/store_credits/edit.html.erb
@@ -1,36 +1,21 @@
-<% content_for :title do %>
- <%= Spree.t(:store_credits) %>
-<% end %>
+<%= turbo_frame_tag :store_credit_details do %>
+ <%= form_for @store_credit, url: spree.admin_user_store_credit_path(@user, @store_credit), method: :put do |f| %>
+ <div class="card">
+ <div class="card-header d-flex justify-content-between align-items-center">
+ <h5 class="card-title">
+ <%= Spree.t(:details) %>
+ </h5>
-<% content_for :page_title do %>
- <%= page_header_back_button spree.admin_user_path(@user) %>
- <%= @user.email %>
-<% end %>
+ <%= link_to Spree.t('actions.discard'), spree.admin_user_store_credit_path(@user, @store_credit), class: 'btn btn-sm btn-light' %>
+ </div>
-<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @store_credit } %>
-
-<%= form_for @store_credit, url: spree.admin_user_store_credit_path(@user, @store_credit) do |f| %>
- <div class="card mb-4">
- <div class="card-header">
- <h5 class="card-title">
- <%= Spree.t(:store_credits) %>
- </h5>
- </div>
-
- <div class="card-body">
- <%= render 'form', f: f %>
- </div>
- </div>
-
- <% if can? :update, @store_credit %>
- <div class="form-actions">
- <%= turbo_save_button_tag Spree.t('actions.update') %>
-
- <% if @store_credit.can_be_deleted? && can?(:delete, @store_credit) %>
- <%= link_to Spree.t('actions.destroy'), spree.admin_user_store_credit_path(@user),
- data: { turbo_method: :delete, turbo_confirm: Spree.t(:are_you_sure) },
- class: 'btn btn-danger ml-auto' %>
- <% end %>
+ <div class="card-body">
+ <%= render partial: 'spree/admin/shared/error_messages', locals: { target: @store_credit } %>
+ <%= render 'form', f: f %>
+ </div>
+ <div class="card-footer">
+ <%= render 'spree/admin/shared/edit_resource_links', f: f, destroy_url: spree.admin_user_store_credit_path(@user, @store_credit) %>
+ </div>
</div>
<% end %>
<% end %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/store_credits/show.html.erb b/admin/app/views/spree/admin/store_credits/show.html.erb
new file mode 100644
index 0000000000..b5449945ab
--- /dev/null
+++ b/admin/app/views/spree/admin/store_credits/show.html.erb
@@ -0,0 +1,145 @@
+<%= content_for :page_title do %>
+ <%= page_header_back_button(spree.admin_user_path(@user)) %>
+ <%= Spree.t(:store_credit_name) %>
+ <%= @store_credit.display_amount %>
+<% end %>
+
+<div class="row">
+ <div class="col-lg-8">
+ <div class="card">
+ <div class="card-header">
+ <h5 class="card-title">
+ <%= Spree.t(:store_credit_events) %>
+ </h5>
+ </div>
+ <div class="card-body p-0">
+ <table class="table">
+ <thead>
+ <tr>
+ <th><%= Spree.t(:action) %></th>
+ <th><%= Spree.t(:amount) %></th>
+ <th><%= Spree.t(:source) %></th>
+ <th><%= Spree.t(:order) %></th>
+ <th><%= Spree.t(:created_at) %></th>
+ </tr>
+ </thead>
+ <tbody>
+ <%= render partial: 'spree/admin/store_credit_events/store_credit_event', collection: @store_credit_events, as: :store_credit_event, cached: spree_base_cache_scope %>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ </div>
+
+ <div class="col-lg-4">
+ <%= turbo_frame_tag :store_credit_details do %>
+ <div class="card">
+ <div class="card-header d-flex justify-content-between align-items-center">
+ <h5 class="card-title">
+ <%= Spree.t(:details) %>
+ </h5>
+
+ <% if @store_credit.editable? %>
+ <%= link_to_with_icon 'edit', Spree.t(:edit), spree.edit_admin_user_store_credit_path(@user, @store_credit), class: 'btn btn-sm btn-light' %>
+ <% end %>
+ </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">
+ <%= Spree.t(:customer) %>
+ </span>
+ <span>
+ <%= link_to @store_credit.user.email, spree.admin_user_path(@store_credit.user) %>
+ </span>
+ </li>
+
+ <li class="list-group-item d-flex justify-content-between align-items-center">
+ <span class="text-muted">
+ <%= Spree.t(:created_by) %>
+ </span>
+ <% if @store_credit.created_by %>
+ <span>
+ <%= link_to @store_credit.created_by.email, spree.admin_admin_user_path(@store_credit.created_by) %>
+ </span>
+ <% else %>
+ <span class="text-muted">
+ <%= Spree.t(:not_available) %>
+ </span>
+ <% end %>
+ </li>
+
+ <li class="list-group-item d-flex justify-content-between align-items-center">
+ <span class="text-muted">
+ <%= Spree.t(:created_at) %>
+ </span>
+
+ <span>
+ <%= local_time(@store_credit.created_at) %>
+ </span>
+ </li>
+
+ <li class="list-group-item d-flex justify-content-between align-items-center">
+ <span class="text-muted">
+ <%= Spree.t(:amount) %>
+ </span>
+
+ <span>
+ <%= @store_credit.display_amount %>
+ </span>
+ </li>
+
+ <li class="list-group-item d-flex justify-content-between align-items-center">
+ <span class="text-muted">
+ <%= Spree.t(:authorized) %>
+ </span>
+
+ <span>
+ <%= @store_credit.display_amount_authorized %>
+ </span>
+ </li>
+
+ <li class="list-group-item d-flex justify-content-between align-items-center">
+ <span class="text-muted">
+ <%= Spree.t(:used) %>
+ </span>
+
+ <span>
+ <%= @store_credit.display_amount_used %>
+ </span>
+ </li>
+
+ <li class="list-group-item d-flex justify-content-between align-items-center">
+ <span class="text-muted">
+ <%= Spree.t('store_credit.remaining') %>
+ </span>
+
+ <span>
+ <%= @store_credit.display_amount_remaining %>
+ </span>
+ </li>
+
+ <li class="list-group-item d-flex justify-content-between align-items-center">
+ <span class="text-muted">
+ <%= Spree.t(:currency) %>
+ </span>
+
+ <span>
+ <%= @store_credit.currency %>
+ </span>
+ </li>
+
+ <li class="list-group-item d-flex flex-column justify-content-between align-items-start">
+ <span class="text-muted mb-2">
+ <%= Spree.t(:memo) %>
+ </span>
+
+ <span>
+ <%= @store_credit.memo %>
+ </span>
+ </ul>
+ </div>
+ </div>
+ </div>
+ <% end %>
+</div>
\ No newline at end of file
diff --git a/admin/spec/controllers/spree/admin/store_credits_controller_spec.rb b/admin/spec/controllers/spree/admin/store_credits_controller_spec.rb
index d902de0d26..dc66384762 100644
--- a/admin/spec/controllers/spree/admin/store_credits_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/store_credits_controller_spec.rb
@@ -20,6 +20,18 @@ RSpec.describe Spree::Admin::StoreCreditsController, type: :controller do
end
end
+ describe 'GET #show' do
+ let(:store_credit) { create(:store_credit, user: user) }
+ let!(:store_credit_events) { create_list(:store_credit_auth_event, 3, store_credit: store_credit) }
+
+ it 'renders the store credit show page' do
+ get :show, params: { user_id: user.id, id: store_credit.id }
+
+ expect(response).to be_successful
+ expect(response).to render_template(:show)
+ end
+ end
+
describe 'GET #new' do
it 'renders the new store credit form' do
get :new, params: { user_id: user.id }
@@ -79,7 +91,7 @@ RSpec.describe Spree::Admin::StoreCreditsController, type: :controller do
it 'updates the store credit' do
expect { subject }.to change { store_credit.reload.amount }.to(200)
- expect(response).to redirect_to(spree.admin_user_path(user))
+ expect(response).to redirect_to(spree.admin_user_store_credit_path(user, store_credit))
end
context 'when the store credit is not valid' do
diff --git a/core/app/models/spree/order/store_credit.rb b/core/app/models/spree/order/store_credit.rb
index c669d42467..c267ed6832 100644
--- a/core/app/models/spree/order/store_credit.rb
+++ b/core/app/models/spree/order/store_credit.rb
@@ -27,7 +27,7 @@ module Spree
end
def could_use_store_credit?
- return false if Spree::PaymentMethod::StoreCredit.available.empty?
+ return false if store.payment_methods.store_credit.available.empty?
total_available_store_credit > 0
end
diff --git a/core/app/models/spree/payment_method.rb b/core/app/models/spree/payment_method.rb
index 26af68d238..144feffa95 100644
--- a/core/app/models/spree/payment_method.rb
+++ b/core/app/models/spree/payment_method.rb
@@ -12,6 +12,7 @@ module Spree
scope :active, -> { where(active: true).order(position: :asc) }
scope :available, -> { active.where(display_on: [:front_end, :back_end, :both]) }
+ scope :store_credit, -> { where(type: 'Spree::PaymentMethod::StoreCredit') }
after_initialize :set_name, if: :new_record?
diff --git a/core/app/models/spree/reimbursement_type/reimbursement_helpers.rb b/core/app/models/spree/reimbursement_type/reimbursement_helpers.rb
index 0c6d622ae9..06a44d2745 100644
--- a/core/app/models/spree/reimbursement_type/reimbursement_helpers.rb
+++ b/core/app/models/spree/reimbursement_type/reimbursement_helpers.rb
@@ -49,7 +49,7 @@ module Spree
user: reimbursement.order.user,
amount: unpaid_amount,
category: category,
- created_by: Spree::StoreCredit.default_created_by,
+ created_by: reimbursement.order.store.users.first,
memo: "Refund for uncreditable payments on order #{reimbursement.order.number}",
currency: reimbursement.order.currency,
store: reimbursement.order.store
diff --git a/core/app/models/spree/store_credit.rb b/core/app/models/spree/store_credit.rb
index 59f1b2f918..aede8269a8 100644
--- a/core/app/models/spree/store_credit.rb
+++ b/core/app/models/spree/store_credit.rb
@@ -16,13 +16,12 @@ module Spree
AUTHORIZE_ACTION = 'authorize'.freeze
ALLOCATION_ACTION = 'allocation'.freeze
- DEFAULT_CREATED_BY_EMAIL = '[email protected]'.freeze
-
+ belongs_to :store, class_name: 'Spree::Store'
belongs_to :user, class_name: "::#{Spree.user_class}", foreign_key: 'user_id'
belongs_to :category, class_name: 'Spree::StoreCreditCategory', optional: true
belongs_to :created_by, class_name: "::#{Spree.admin_user_class}", foreign_key: 'created_by_id', optional: true
belongs_to :credit_type, class_name: 'Spree::StoreCreditType', foreign_key: 'type_id', optional: true
- belongs_to :store, class_name: 'Spree::Store'
+ belongs_to :originator, polymorphic: true, optional: true
has_many :store_credit_events, class_name: 'Spree::StoreCreditEvent'
has_many :payments, as: :source, class_name: 'Spree::Payment'
@@ -34,14 +33,16 @@ module Spree
validate :amount_used_less_than_or_equal_to_amount
validate :amount_authorized_less_than_or_equal_to_amount
- delegate :name, to: :category, prefix: true
- delegate :email, to: :created_by, prefix: true
+ delegate :name, to: :category, prefix: true, allow_nil: true
+ delegate :email, to: :created_by, prefix: true, allow_nil: true
scope :order_by_priority, -> { includes(:credit_type).order('spree_store_credit_types.priority ASC') }
scope :not_authorized, -> { where(amount_authorized: 0) }
scope :not_used, -> { where("#{Spree::StoreCredit.table_name}.amount_used < #{Spree::StoreCredit.table_name}.amount") }
scope :available, -> { not_authorized.not_used }
+ scope :with_gift_card, -> { where(originator_type: 'Spree::GiftCard') }
+ scope :without_gift_card, -> { where(originator_type: [nil, '']).or(where.not(originator_type: 'Spree::GiftCard')) }
after_save :store_event
before_destroy :validate_no_amount_used
@@ -184,7 +185,9 @@ module Spree
class << self
def default_created_by
- Spree.user_class.find_by(email: DEFAULT_CREATED_BY_EMAIL)
+ Spree::Deprecation.warn('StoreCredit#default_created_by is deprecated and will be removed in Spree 6.0. Please use store.users.first instead.')
+
+ Spree::Store.current.users.first
end
end
diff --git a/core/app/models/spree/store_credit_event.rb b/core/app/models/spree/store_credit_event.rb
index 41c54338e0..f8631b29eb 100644
--- a/core/app/models/spree/store_credit_event.rb
+++ b/core/app/models/spree/store_credit_event.rb
@@ -2,9 +2,15 @@ module Spree
class StoreCreditEvent < Spree.base_class
acts_as_paranoid
+ #
+ # Associations
belongs_to :store_credit
belongs_to :originator, polymorphic: true
+ has_one :payment, -> { where(source_type: Spree::StoreCredit.to_s) }, foreign_key: :response_code, primary_key: :authorization_code
+ has_one :order, through: :payment
+ #
+ # Scopes
scope :exposed_events, -> { where.not(action: [Spree::StoreCredit::ELIGIBLE_ACTION, Spree::StoreCredit::AUTHORIZE_ACTION]) }
scope :reverse_chronological, -> { order(created_at: :desc) }
@@ -21,15 +27,13 @@ module Spree
Spree.t('store_credit.authorized')
when Spree::StoreCredit::ALLOCATION_ACTION
Spree.t('store_credit.allocated')
+ when Spree::StoreCredit::ELIGIBLE_ACTION
+ Spree.t('store_credit.eligible')
when Spree::StoreCredit::VOID_ACTION, Spree::StoreCredit::CREDIT_ACTION
Spree.t('store_credit.credit')
end
end
- def order
- store.payments.find_by(response_code: authorization_code).try(:order)
- end
-
def allocation?
action == Spree::StoreCredit::ALLOCATION_ACTION
end
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index 1662da7e66..1f0ce36b15 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -53,7 +53,6 @@ en:
spree/inventory_unit:
state: State
spree/invitation:
- expires_at: Expires at
inviter: Inviter
spree/line_item:
price: Price
@@ -1031,6 +1030,7 @@ en:
expiration: Expiration
expiration_date: Expiration Date
expired: Expired
+ expires_at: Expires at
explore_taxon: Explore taxon
export: Export
export_mailer:
@@ -2014,6 +2014,7 @@ en:
available_amount: You have <strong>%{amount}</strong> in Store Credit available!
captured: Used
credit: Credit
+ eligible: Eligible
errors:
cannot_change_used_store_credit: You cannot change a store credit that has already been used
unable_to_create: Unable to create store credit
@@ -2024,6 +2025,7 @@ en:
remaining_amount: You have <strong>%{amount}</strong> remaining in your account's Store Credit.
remove: Remove
store_credit_categories: Store Credit Categories
+ store_credit_events: Store Credit Events
store_credit_name: Store Credit
store_credit_payment_method:
currency_mismatch: Store credit currency does not match order currency
diff --git a/core/spec/models/spree/reimbursement_type/store_credit_spec.rb b/core/spec/models/spree/reimbursement_type/store_credit_spec.rb
index ef1577d55c..ebec09fdbe 100644
--- a/core/spec/models/spree/reimbursement_type/store_credit_spec.rb
+++ b/core/spec/models/spree/reimbursement_type/store_credit_spec.rb
@@ -18,7 +18,7 @@ module Spree
end
let!(:primary_credit_type) { create(:primary_credit_type) }
- let!(:created_by_user) { create(:user, email: Spree::StoreCredit::DEFAULT_CREATED_BY_EMAIL) }
+ let!(:created_by_user) { create(:admin_user) }
let!(:default_reimbursement_category) { create(:store_credit_category) }
before { reimbursement.update!(total: reimbursement.calculated_total) }