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.

Admin promotions: actions management

Damian Legawiecb038592f7d07
diff --git a/admin/app/controllers/spree/admin/promotion_actions_controller.rb b/admin/app/controllers/spree/admin/promotion_actions_controller.rb
new file mode 100644
index 0000000000..8e0c85631a
--- /dev/null
+++ b/admin/app/controllers/spree/admin/promotion_actions_controller.rb
@@ -0,0 +1,39 @@
+module Spree
+ module Admin
+ class PromotionActionsController < ResourceController
+ belongs_to 'spree/promotion', find_by: :id
+
+ helper_method :allowed_action_types
+
+ private
+
+ def model_class
+ @model_class = if params.dig(:promotion_action, :type).present?
+ if allowed_action_types.map(&:to_s).include?(params.dig(:promotion_action, :type))
+ params.dig(:promotion_action, :type).safe_constantize
+ else
+ raise 'Unknown promotion action type'
+ end
+ else
+ Spree::PromotionAction
+ end
+ end
+
+ def build_resource
+ model_class.new(promotion: parent)
+ end
+
+ def allowed_action_types
+ Rails.application.config.spree.promotions.actions
+ end
+
+ def location_after_save
+ collection_url
+ end
+
+ def collection_url
+ spree.admin_promotion_path(parent)
+ end
+ end
+ end
+end
diff --git a/admin/app/controllers/spree/admin/promotions_controller.rb b/admin/app/controllers/spree/admin/promotions_controller.rb
index cdb9111cd1..150e868b88 100644
--- a/admin/app/controllers/spree/admin/promotions_controller.rb
+++ b/admin/app/controllers/spree/admin/promotions_controller.rb
@@ -28,7 +28,7 @@ module Spree
def load_form_data
@promotion_rules = Rails.application.config.spree.promotions.rules
@rule_types = @promotion_rules.map do |promotion_rule|
- [Spree.t("admin.promotion_rules.#{promotion_rule.to_s.demodulize.underscore}"), promotion_rule.to_s]
+ [Spree.t("promotion_rule_types.#{promotion_rule.to_s.demodulize.underscore}.name"), promotion_rule.to_s]
end
end
diff --git a/admin/app/helpers/spree/admin/base_helper.rb b/admin/app/helpers/spree/admin/base_helper.rb
index 3a89ac64e9..e39f2fac04 100644
--- a/admin/app/helpers/spree/admin/base_helper.rb
+++ b/admin/app/helpers/spree/admin/base_helper.rb
@@ -176,7 +176,7 @@ module Spree
class: 'form-group', id: [object.class.to_s.parameterize, 'preference', key].join('-'))
else
if object.preference_type(key).to_sym == :boolean
- content_tag(:div, class: 'custom-control custom-checkbox') do
+ content_tag(:div, class: 'form-group custom-control custom-checkbox') do
preference_field_for(form, "preferred_#{key}", type: object.preference_type(key)) +
form.label(
"preferred_#{key}",
diff --git a/admin/app/views/spree/admin/promotion_actions/_action.html.erb b/admin/app/views/spree/admin/promotion_actions/_action.html.erb
new file mode 100644
index 0000000000..1c86ffa5d3
--- /dev/null
+++ b/admin/app/views/spree/admin/promotion_actions/_action.html.erb
@@ -0,0 +1,19 @@
+<li class="list-group-item p-0" id="<%= spree_dom_id(promotion_action) %>">
+ <%= turbo_frame_tag promotion_action do %>
+ <div class="d-flex justify-content-between align-items-center p-3">
+ <div>
+ <h6><%= promotion_action.human_name %></h6>
+ <p class="text-muted mb-0"><%= promotion_action.human_description %></p>
+ </div>
+ <div class="dropdown">
+ <button class="btn btn-light btn-sm" type="button" data-toggle="dropdown" aria-expanded="false">
+ <%= icon('dots', class: 'mr-0') %>
+ </button>
+ <div class="dropdown-menu">
+ <%= link_to_with_icon 'pencil', Spree.t('actions.edit'), spree.edit_admin_promotion_action_path(promotion_action.promotion, promotion_action), class: 'dropdown-item' %>
+ <%= link_to_with_icon 'trash', Spree.t('actions.destroy'), spree.admin_promotion_action_path(promotion_action.promotion, promotion_action), class: 'dropdown-item text-danger', data: { turbo_method: :delete, turbo_confirm: Spree.t(:are_you_sure), turbo_frame: '_top' } %>
+ </div>
+ </div>
+ </div>
+ <% end %>
+</li>
diff --git a/admin/app/views/spree/admin/promotion_actions/edit.html.erb b/admin/app/views/spree/admin/promotion_actions/edit.html.erb
new file mode 100644
index 0000000000..4cbc3907d8
--- /dev/null
+++ b/admin/app/views/spree/admin/promotion_actions/edit.html.erb
@@ -0,0 +1,12 @@
+<%= turbo_frame_tag @promotion_action do %>
+ <h6 class="border-bottom p-3"><%= @promotion_action.human_name %></h6>
+ <%= form_with model: @promotion_action, url: spree.admin_promotion_action_path(@promotion, @promotion_action), method: :put, scope: :promotion_action do |f| %>
+ <div class="p-3">
+ <%= render "spree/admin/promotion_actions/forms/#{@promotion_action.key}", f: f %>
+ </div>
+ <div class="form-actions d-flex justify-content-between p-3">
+ <%= turbo_save_button_tag Spree.t('actions.update') %>
+ <%= link_to Spree.t('actions.discard'), spree.admin_promotion_path(@promotion), class: 'btn btn-light' %>
+ </div>
+ <% end %>
+<% end %>
diff --git a/admin/app/views/spree/admin/promotion_actions/forms/_create_adjustment.html.erb b/admin/app/views/spree/admin/promotion_actions/forms/_create_adjustment.html.erb
new file mode 100644
index 0000000000..db021beab7
--- /dev/null
+++ b/admin/app/views/spree/admin/promotion_actions/forms/_create_adjustment.html.erb
@@ -0,0 +1 @@
+<%= render 'spree/admin/shared/calculator_fields', f: f, calculators: Spree::Promotion::Actions::CreateAdjustment.calculators %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/promotion_actions/forms/_create_item_adjustments.html.erb b/admin/app/views/spree/admin/promotion_actions/forms/_create_item_adjustments.html.erb
new file mode 100644
index 0000000000..455dcaef0c
--- /dev/null
+++ b/admin/app/views/spree/admin/promotion_actions/forms/_create_item_adjustments.html.erb
@@ -0,0 +1 @@
+<%= render 'spree/admin/shared/calculator_fields', f: f, calculators: Spree::Promotion::Actions::CreateItemAdjustments.calculators %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/promotions/actions/_free_shipping.html.erb b/admin/app/views/spree/admin/promotion_actions/forms/_free_shipping.html.erb
similarity index 100%
rename from admin/app/views/spree/admin/promotions/actions/_free_shipping.html.erb
rename to admin/app/views/spree/admin/promotion_actions/forms/_free_shipping.html.erb
diff --git a/admin/app/views/spree/admin/promotion_actions/new.html.erb b/admin/app/views/spree/admin/promotion_actions/new.html.erb
new file mode 100644
index 0000000000..4b7950cd49
--- /dev/null
+++ b/admin/app/views/spree/admin/promotion_actions/new.html.erb
@@ -0,0 +1,46 @@
+<%= turbo_frame_tag :dialog_modal do %>
+ <%= form_with model: @promotion_action, url: spree.admin_promotion_actions_path(@promotion), method: :post, scope: :promotion_action do |f| %>
+ <div class="modal-content" data-controller="search-picker">
+ <div class="modal-header">
+ <h5 class="modal-title">
+ <% if @promotion_action.type.nil? %>
+ <%= Spree.t(:add_action_of_type) %>
+ <% else %>
+ <%= @promotion_action.human_name %>
+ <% end %>
+ </h5>
+ <button type="button" class="btn-close" data-dismiss="modal" aria-label="<%= Spree.t(:close) %>" />
+ </div>
+ <div class="modal-body border-bottom pb-3">
+ <% if @promotion_action.type.nil? %>
+ <ul class="list-group">
+ <% allowed_action_types.each do |action_type| %>
+ <% key = action_type.to_s.demodulize.underscore %>
+ <li class="list-group-item p-0">
+ <%= link_to spree.new_admin_promotion_action_path(@promotion, promotion_action: { type: action_type }), class: 'd-flex align-items-top w-100 p-3 hover-light', data: { turbo_prefetch: false } do %>
+ <%= radio_button_tag :type, action_type, checked: @promotion_action.type == action_type %>
+ <div class="ml-3">
+ <h6><%= Spree.t("promotion_action_types.#{key}.name") %></h6>
+ <p class="text-muted mb-0"><%= Spree.t("promotion_action_types.#{key}.description") %></p>
+ </div>
+ <% end %>
+ </li>
+ <% end %>
+ </ul>
+ <% else %>
+ <p class="text-muted">
+ <%= @promotion_action.human_description %>
+ </p>
+ <%= f.hidden_field :type, value: @promotion_action.type %>
+ <%= render "spree/admin/promotion_actions/forms/#{@promotion_action.key}", f: f %>
+ <% end %>
+ </div>
+ <% if @promotion_action.type.present? %>
+ <div class="modal-footer d-flex justify-content-between">
+ <%= turbo_save_button_tag Spree.t('actions.create'), data: { turbo_frame: '_top' } %>
+ <%= link_to Spree.t('actions.discard'), spree.admin_promotion_path(@promotion), class: 'btn btn-light' %>
+ </div>
+ <% end %>
+ </div>
+ <% end %>
+<% end %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/promotions/_actions.html.erb b/admin/app/views/spree/admin/promotions/_actions.html.erb
index 30eaec0cfa..ee241734ad 100644
--- a/admin/app/views/spree/admin/promotions/_actions.html.erb
+++ b/admin/app/views/spree/admin/promotions/_actions.html.erb
@@ -1,34 +1,20 @@
-<div class="card-header">
- <h5 class="card-title">
- <%= Spree.t(:promotion_actions) %>
- </h5>
-</div>
-<div id="action_fields" class="card-body">
- <%= form_tag spree.admin_promotion_promotion_actions_path(@promotion), remote: true, id: 'new_promotion_action_form', class: 'mb-3' do %>
- <% options = options_for_select( @actions.map(&:name).map {|name| [ Spree.t("promotion_action_types.#{name.demodulize.underscore}.name"), name] } ) %>
+<div class="card mb-4">
+ <div class="card-header d-flex justify-content-between">
+ <h5 class="card-title">
+ <%= Spree.t(:promotion_actions) %>
+ </h5>
- <div class="form-group">
- <%= label_tag :action_type, Spree.t(:add_action_of_type) %>
- <%= select_tag 'action_type', options, class: 'custom-select' %>
- </div>
- <div class="form-actions">
- <%= button Spree.t(:add), 'plus', 'submit', class: "btn-light" %>
- </div>
-
- <% end %>
-
- <%= form_for @promotion, url: spree.admin_promotion_path(@promotion), method: :put do |f| %>
- <div id="actions" class="filter_list mt-3">
- <% if @promotion.actions.any? %>
- <%= render partial: 'promotion_action', collection: @promotion.actions %>
- <% else %>
- <div class="alert alert-warning">
- <%= Spree.t(:no_actions_added) %>
- </div>
- <% end %>
- </div>
- <div class="actions promotion-update">
- <%= turbo_save_button_tag Spree.t('actions.update') %>
- </div>
- <% end %>
-</div>
+ <span data-toggle="modal" data-target="#modal">
+ <%= link_to_with_icon 'plus', Spree.t(:add_one), spree.new_admin_promotion_action_path(@promotion), class: 'btn btn-light btn-sm', data: { turbo_frame: 'dialog_modal' } %>
+ </span>
+ </div>
+ <div class="card-body">
+ <% if @promotion.promotion_actions.empty? %>
+ <%= render 'spree/admin/shared/no_resource_found', resource_name: Spree.t(:promotion_actions), model_class: Spree::PromotionAction, new_object_url: spree.new_admin_promotion_action_path(@promotion) %>
+ <% else %>
+ <ul class="list-group">
+ <%= render collection: @promotion.promotion_actions, partial: 'spree/admin/promotion_actions/action', as: :promotion_action %>
+ </ul>
+ <% end %>
+ </div>
+</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/promotions/actions/_create_adjustment.html.erb b/admin/app/views/spree/admin/promotions/actions/_create_adjustment.html.erb
deleted file mode 100644
index 1a668bd270..0000000000
--- a/admin/app/views/spree/admin/promotions/actions/_create_adjustment.html.erb
+++ /dev/null
@@ -1,30 +0,0 @@
-<div class="card-body calculator-fields">
- <div class="row mb-0">
- <div class="form-group col-12 col-md-6 mb-0">
- <% field_name = "#{param_prefix}[calculator_type]" %>
- <%= label_tag field_name, Spree.t(:calculator) %>
- <%= select_tag field_name,
- options_from_collection_for_select(@calculators, :to_s, :description, promotion_action.calculator.type),
- class: 'type-select custom-select' %>
- </div>
- <% unless promotion_action.new_record? %>
- <div class="form-group col-12 col-md-6 mb-0 settings">
- <% type_name = promotion_action.calculator.type.demodulize.underscore %>
- <% if lookup_context.exists?("fields",
- ["spree/admin/promotions/calculators/#{type_name}"], true) %>
- <%= render "spree/admin/promotions/calculators/#{type_name}/fields",
- calculator: promotion_action.calculator, prefix: param_prefix %>
- <% else %>
- <%= render "spree/admin/promotions/calculators/default_fields",
- calculator: promotion_action.calculator, prefix: param_prefix %>
- <% end %>
- <%= hidden_field_tag "#{param_prefix}[calculator_attributes][id]", promotion_action.calculator.id %>
- </div>
- <% end %>
- </div>
- <% if promotion_action.calculator.respond_to?(:preferences) %>
- <div class="alert alert-info js-warning mt-3 mb-0">
- <%= Spree.t(:calculator_settings_warning) %>
- </div>
- <% end %>
-</div>
diff --git a/admin/app/views/spree/admin/promotions/actions/_create_item_adjustments.html.erb b/admin/app/views/spree/admin/promotions/actions/_create_item_adjustments.html.erb
deleted file mode 100644
index 8eca840e97..0000000000
--- a/admin/app/views/spree/admin/promotions/actions/_create_item_adjustments.html.erb
+++ /dev/null
@@ -1,29 +0,0 @@
-<div class="card-body calculator-fields">
- <div class="row mb-0">
- <div class="form-group col-12 col-md-6 mb-0">
- <% field_name = "#{param_prefix}[calculator_type]" %>
- <%= label_tag field_name, Spree.t(:calculator) %>
- <%= select_tag field_name,
- options_from_collection_for_select(Spree::Promotion::Actions::CreateItemAdjustments.calculators, :to_s, :description, promotion_action.calculator.type),
- class: 'type-select custom-select' %>
- </div>
- <% unless promotion_action.new_record? %>
- <div class="form-group col-12 col-md-6 mb-0 settings">
- <% promotion_action.calculator.preferences.keys.map do |key| %>
- <% field_name = "#{param_prefix}[calculator_attributes][preferred_#{key}]" %>
- <%= label_tag field_name, Spree.t(key.to_s) %>
- <%= preference_field_tag(field_name,
- promotion_action.calculator.get_preference(key),
- key: key,
- type: promotion_action.calculator.preference_type(key)) %>
- <% end %>
- <%= hidden_field_tag "#{param_prefix}[calculator_attributes][id]", promotion_action.calculator.id %>
- </div>
- <% end %>
- </div>
- <% if promotion_action.calculator.respond_to?(:preferences) %>
- <div class="alert alert-info js-warning mt-3 mb-0">
- <%= Spree.t(:calculator_settings_warning) %>
- </div>
- <% end %>
-</div>
diff --git a/admin/app/views/spree/admin/promotions/show.html.erb b/admin/app/views/spree/admin/promotions/show.html.erb
index 98c6802bbd..41a1eaa28a 100644
--- a/admin/app/views/spree/admin/promotions/show.html.erb
+++ b/admin/app/views/spree/admin/promotions/show.html.erb
@@ -2,14 +2,11 @@
<div class="row">
<div class="col-12 col-lg-8">
- <%= form_for @promotion, url: object_url, method: :put do |f| %>
- <%= render 'spree/admin/promotions/rules_form', f: f %>
-
- <%= render 'spree/admin/shared/edit_resource_links', f: f %>
- <% end %>
+ <%= render 'rules' %>
+ <%= render 'actions' %>
</div>
<div class="col-12 col-lg-4">
- <%= render 'spree/admin/promotions/sidebar' %>
+ <%= render 'sidebar' %>
</div>
</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/shared/_calculator_fields.html.erb b/admin/app/views/spree/admin/shared/_calculator_fields.html.erb
index 83cfd16023..b8dd63522f 100644
--- a/admin/app/views/spree/admin/shared/_calculator_fields.html.erb
+++ b/admin/app/views/spree/admin/shared/_calculator_fields.html.erb
@@ -1,5 +1,5 @@
<div data-controller="calculator-fields">
- <% @calculators.each do |calculator| %>
+ <% calculators.each do |calculator| %>
<template id="<%= calculator.name.demodulize.underscore %>_fields">
<div class="calculator-settings">
<%= f.fields_for :calculator, calculator.new do |calc_form| %>
@@ -18,8 +18,8 @@
</div>
<div id="preference-settings" class="card-body">
<div class="form-group">
- <%= f.label(:calculator_type, Spree.t(:calculator), for: 'calc_type') %>
- <%= select_tag(:calculator_type, options_for_select(@calculators.map { |c| [c.description, c.name] }, @object.calculator_type), {id: 'calc_type', class: 'custom-select', data: { action: 'calculator-fields#replaceFields' }}) %>
+ <%= f.label(:calculator_type, Spree.t(:calculator), for: 'calculator_type') %>
+ <%= select_tag(:calculator_type, options_for_select(calculators.map { |c| [c.description, c.name] }, @object.calculator_type), {id: 'calculator_type', class: 'custom-select', data: { action: 'calculator-fields#replaceFields' }}) %>
</div>
<div class="form-group" data-calculator-fields-target="container">
<div class="calculator-settings">
diff --git a/admin/app/views/spree/admin/shipping_methods/_form.html.erb b/admin/app/views/spree/admin/shipping_methods/_form.html.erb
index 7754331d08..2ec272b1a0 100644
--- a/admin/app/views/spree/admin/shipping_methods/_form.html.erb
+++ b/admin/app/views/spree/admin/shipping_methods/_form.html.erb
@@ -112,7 +112,7 @@
<% end %>
</div>
<div class="col-lg-6">
- <%= render partial: 'spree/admin/shared/calculator_fields', locals: { f: f } %>
+ <%= render partial: 'spree/admin/shared/calculator_fields', locals: { f: f, calculators: @calculators } %>
<div class="card mb-4 tax_categories">
<div class="card-header">
diff --git a/admin/app/views/spree/admin/tax_rates/_form.html.erb b/admin/app/views/spree/admin/tax_rates/_form.html.erb
index a061e0a84f..fbf226e3ed 100644
--- a/admin/app/views/spree/admin/tax_rates/_form.html.erb
+++ b/admin/app/views/spree/admin/tax_rates/_form.html.erb
@@ -45,4 +45,4 @@
</div>
</div>
-<%= render 'spree/admin/shared/calculator_fields', f: f %>
+<%= render 'spree/admin/shared/calculator_fields', f: f, calculators: @calculators %>
diff --git a/admin/config/routes.rb b/admin/config/routes.rb
index 5fa4e0e422..9fe114381c 100644
--- a/admin/config/routes.rb
+++ b/admin/config/routes.rb
@@ -104,6 +104,8 @@ Spree::Core::Engine.add_routes do
member do
post :clone
end
+ resources :promotion_actions, as: :actions, except: [:index, :show]
+ resources :promotion_rules, as: :rules, except: [:index, :show]
resources :coupon_codes, only: :index
end
get 'promotion_rules/option_values_search', defaults: { format: :json }
diff --git a/core/app/models/spree/promotion/actions/create_adjustment.rb b/core/app/models/spree/promotion/actions/create_adjustment.rb
index 194888530a..f36e9b8a33 100644
--- a/core/app/models/spree/promotion/actions/create_adjustment.rb
+++ b/core/app/models/spree/promotion/actions/create_adjustment.rb
@@ -5,7 +5,7 @@ module Spree
include Spree::CalculatedAdjustments
include Spree::AdjustmentSource
- before_validation -> { self.calculator ||= Calculator::FlatPercentItemTotal.new }
+ after_initialize -> { self.calculator ||= Calculator::FlatPercentItemTotal.new }
def perform(options = {})
order = options[:order]
diff --git a/core/app/models/spree/promotion/actions/create_item_adjustments.rb b/core/app/models/spree/promotion/actions/create_item_adjustments.rb
index b572e49109..0aaa9650ad 100644
--- a/core/app/models/spree/promotion/actions/create_item_adjustments.rb
+++ b/core/app/models/spree/promotion/actions/create_item_adjustments.rb
@@ -5,7 +5,7 @@ module Spree
include Spree::CalculatedAdjustments
include Spree::AdjustmentSource
- before_validation -> { self.calculator ||= Calculator::PercentOnLineItem.new }
+ after_initialize -> { self.calculator ||= Calculator::PercentOnLineItem.new }
def perform(options = {})
order = options[:order]
diff --git a/core/app/models/spree/promotion_action.rb b/core/app/models/spree/promotion_action.rb
index 2dec273490..4ffd70737c 100644
--- a/core/app/models/spree/promotion_action.rb
+++ b/core/app/models/spree/promotion_action.rb
@@ -6,7 +6,7 @@ module Spree
belongs_to :promotion, class_name: 'Spree::Promotion'
- validates :promotion, presence: true
+ validates :promotion, :type, presence: true
scope :of_type, ->(t) { where(type: t) }
@@ -25,6 +25,18 @@ module Spree
type == 'Spree::Promotion::Actions::FreeShipping'
end
+ def human_name
+ Spree.t("promotion_action_types.#{key}.name")
+ end
+
+ def human_description
+ Spree.t("promotion_action_types.#{key}.description")
+ end
+
+ def key
+ type.demodulize.underscore
+ end
+
protected
def label