Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Added ability to manage promotion rules
Damian Legawiec73f92865e2b4
diff --git a/admin/app/controllers/spree/admin/promotions_controller.rb b/admin/app/controllers/spree/admin/promotions_controller.rbindex dfe505ed59..cdb9111cd1 100644--- a/admin/app/controllers/spree/admin/promotions_controller.rb+++ b/admin/app/controllers/spree/admin/promotions_controller.rb@@ -1,6 +1,8 @@module Spreemodule Adminclass PromotionsController < ResourceController+ before_action :load_form_data, except: :index+# POST /admin/promotions/:id/clonedef clonepromotion = current_store.promotions.find(params[:id])@@ -23,6 +25,13 @@ module Spreespree.admin_promotion_path(@promotion)end+ 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]+ end+ end+def collectionreturn @collection if defined?(@collection)diff --git a/admin/app/helpers/spree/admin/promotion_rules_helper.rb b/admin/app/helpers/spree/admin/promotion_rules_helper.rbnew file mode 100644index 0000000000..211a7aae92--- /dev/null+++ b/admin/app/helpers/spree/admin/promotion_rules_helper.rb@@ -0,0 +1,19 @@+module Spree+ module Admin+ module PromotionRulesHelper+ def options_for_promotion_rule_types(promotion)+ existing = promotion.rules.map { |rule| rule.class.name }+ rule_names = Rails.application.config.spree.promotions.rules.map(&:name).reject { |r| existing.include? r }+ options = rule_names.map { |name| [Spree.t("promotion_rule_types.#{name.demodulize.underscore}.name"), name] }+ options_for_select(options)+ end++ def active_options_for_option_value_promotion_rule(promotion_rule)+ eligible_values = promotion_rule.preferred_eligible_values || []+ return [] if eligible_values.empty?++ Spree::OptionValueVariant.where(id: eligible_values).to_tom_select_json+ end+ end+ end+enddiff --git a/admin/app/views/spree/admin/promotions/_form.html.erb b/admin/app/views/spree/admin/promotions/_form.html.erbindex 220094d768..8618b679df 100644--- a/admin/app/views/spree/admin/promotions/_form.html.erb+++ b/admin/app/views/spree/admin/promotions/_form.html.erb@@ -1,4 +1,4 @@-<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @promotion } %>+<%= render 'spree/admin/shared/error_messages', target: @promotion %><div class="row"><div class="col-12 col-lg-8">diff --git a/admin/app/views/spree/admin/promotions/_rule_form.html.erb b/admin/app/views/spree/admin/promotions/_rule_form.html.erbnew file mode 100644index 0000000000..5fd835fe8a--- /dev/null+++ b/admin/app/views/spree/admin/promotions/_rule_form.html.erb@@ -0,0 +1,27 @@+<div class="bg-gray-25 border rounded p-3 nested-form-wrapper border-bottom mb-3 pb-3" data-controller="rule-form" data-new-record="<%= rf.object.new_record? %>">+ <% if rf.object.new_record? %>+ <% @promotion_rules.each do |promotion_rule| %>+ <template id="rule-form-template-<%= promotion_rule.to_s.demodulize %>" data-rule-form-target="template">+ <%= render "spree/admin/promotions/rules/#{promotion_rule.to_s.demodulize.underscore}", rule_form: rf %>+ </template>+ <% end %>++ <div class="form-group">+ <%= rf.select :type, @rule_types, {}, { class: 'custom-select', data: { action: 'rule-form#replace' } } %>+ </div>+ <% else %>+ <h6 class="mb-3"><%= Spree.t("admin.promotion_rules.#{rf.object.type.demodulize.underscore}") %></h6>++ <%= rf.hidden_field :type, value: rf.object.type %>+ <% end %>+ <div class="form-group" data-rule-form-target="value">+ <% if rf.object.type.present? %>+ <%= render "spree/admin/promotions/rules/#{rf.object.type.demodulize.underscore}", rule_form: rf %>+ <% end %>+ </div>+ <button type="button" data-action="nested-form#remove" class="btn btn-sm btn-danger">+ <%= icon('x', class: 'mr-0') %>+ <%= Spree.t(:remove_condition) %>+ </button>+ <%= rf.hidden_field :_destroy if rf.object.persisted? %>+</div>diff --git a/admin/app/views/spree/admin/promotions/_rules_form.html.erb b/admin/app/views/spree/admin/promotions/_rules_form.html.erbnew file mode 100644index 0000000000..a8bf5dafc4--- /dev/null+++ b/admin/app/views/spree/admin/promotions/_rules_form.html.erb@@ -0,0 +1,39 @@+<div class="card mb-4">+ <div class="card-header d-flex justify-content-between">+ <h5 class="card-title">+ <%= Spree.t(:rules) %>+ </h5>+ </div>+ <div class="card-body">+ <div class="form-group mb-4">+ <div class="d-block d-lg-flex gap-3">+ <% Spree::Promotion::MATCH_POLICIES.each do |policy| %>+ <div class="custom-control custom-radio custom-control-inline">+ <%= f.radio_button :match_policy, policy, class: 'custom-control-input' %>+ <%= f.label "match_policy_#{policy}", class: 'custom-control-label' %>+ </div>+ <% end %>+ </div>+ </div>++ <div data-controller="nested-form">+ <template data-nested-form-target="template">+ <%= f.fields_for :promotion_rules, Spree::PromotionRule.new(type: @promotion_rules.first.to_s), child_index: 'NEW_RECORD' do |rf, index| %>+ <%= render 'spree/admin/promotions/rule_form', rf: rf %>+ <% end %>+ </template>++ <%= f.fields_for :promotion_rules, @promotion.promotion_rules do |rf, index| %>+ <%= render 'spree/admin/promotions/rule_form', rf: rf %>+ <% end %>++ <!-- Inserted elements will be injected before that target. -->+ <div data-nested-form-target="target" class="mb-2"></div>++ <button type="button" class="btn btn-link w-100 py-3" data-action="nested-form#add">+ <%= icon('plus', class: 'mr-2') %>+ <%= Spree.t(:add_one)%>+ </button>+ </div>+ </div>+</div>\ No newline at end of filediff --git a/admin/app/views/spree/admin/promotions/actions/_create_adjustment.html.erb b/admin/app/views/spree/admin/promotions/actions/_create_adjustment.html.erbnew file mode 100644index 0000000000..1a668bd270--- /dev/null+++ b/admin/app/views/spree/admin/promotions/actions/_create_adjustment.html.erb@@ -0,0 +1,30 @@+<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.erbnew file mode 100644index 0000000000..8eca840e97--- /dev/null+++ b/admin/app/views/spree/admin/promotions/actions/_create_item_adjustments.html.erb@@ -0,0 +1,29 @@+<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/actions/_create_line_items.html.erb b/admin/app/views/spree/admin/promotions/actions/_create_line_items.html.erbnew file mode 100644index 0000000000..ca85765b70--- /dev/null+++ b/admin/app/views/spree/admin/promotions/actions/_create_line_items.html.erb@@ -0,0 +1,27 @@+<div class="card-body calculator-fields">+ <% promotion_action.promotion_action_line_items.each do |item| %>+ <% variant = item.variant %>++ <strong><%= item.quantity %> x <%= variant.name %></strong>+ <%= variant.options_text %>+ <% end %>++ <% if promotion_action.promotion_action_line_items.empty? %>+ <% line_items = promotion_action.promotion_action_line_items %>+ <% line_items.build %>++ <% line_items.each_with_index do |line_item, index| %>+ <div class="add-line-item">+ <% line_item_prefix = "#{param_prefix}[promotion_action_line_items_attributes][#{index}]" %>+ <div class="form-group">+ <%= label_tag "#{line_item_prefix}_variant_id", Spree.t(:variant) %>+ <%= select_tag "#{line_item_prefix}[variant_id]", line_item.variant_id, class: 'variant_autocomplete d-block w-100' %>+ </div>+ <div class="form-group mb-0">+ <%= label_tag "#{line_item_prefix}_quantity", Spree.t(:quantity) %>+ <%= number_field_tag "#{line_item_prefix}[quantity]", line_item.quantity, min: 1, class: 'form-control' %>+ </div>+ </div>+ <% end %>+ <% end %>+</div>diff --git a/admin/app/views/spree/admin/promotions/actions/_free_shipping.html.erb b/admin/app/views/spree/admin/promotions/actions/_free_shipping.html.erbnew file mode 100644index 0000000000..e69de29bb2diff --git a/admin/app/views/spree/admin/promotions/calculators/_default_fields.html.erb b/admin/app/views/spree/admin/promotions/calculators/_default_fields.html.erbnew file mode 100644index 0000000000..736b2d45dc--- /dev/null+++ b/admin/app/views/spree/admin/promotions/calculators/_default_fields.html.erb@@ -0,0 +1,11 @@+<% calculator.preferences.keys.map do |key| %>+ <div class="form-group">+ <% field_name = "#{prefix}[calculator_attributes][preferred_#{key}]" %>+ <%= label_tag field_name, Spree.t(key.to_s) %>+ <%= preference_field_tag(+ field_name,+ calculator.get_preference(key),+ type: calculator.preference_type(key),+ key: key) %>+ </div>+<% end %>diff --git a/admin/app/views/spree/admin/promotions/calculators/tiered_flat_rate/_fields.html.erb b/admin/app/views/spree/admin/promotions/calculators/tiered_flat_rate/_fields.html.erbnew file mode 100644index 0000000000..ea44c29b67--- /dev/null+++ b/admin/app/views/spree/admin/promotions/calculators/tiered_flat_rate/_fields.html.erb@@ -0,0 +1,46 @@+<div class="form-group">+ <%= label_tag "#{prefix}[calculator_attributes][preferred_base_amount]",+ Spree.t(:base_amount) %>+ <%= preference_field_tag(+ "#{prefix}[calculator_attributes][preferred_base_amount]",+ calculator.preferred_base_amount,+ type: calculator.preference_type(:base_amount)) %>+</div>++<div class="form-group mb-0">+ <%= label_tag nil, Spree.t(:tiers) %>+ <%= content_tag :div, nil, class: "hidden js-original-tiers",+ data: { :'original-tiers' => Hash[calculator.preferred_tiers.sort] } %>+</div>++<div class="js-tiers"></div>+<button class="btn btn-primary js-add-tier"><%= Spree.t(:add) %></button>++<script type="text/x-handlebars-template" id="tier-input-name">+ <%= prefix %>[calculator_attributes][preferred_tiers][{{base}}]+</script>++<script type="text/x-handlebars-template" id="tier-fields-template">+ <div class="tier card mb-4">+ <div class="card-body p-3">+ <div class="form-group">+ <div class="input-group">+ <div class="input-group-prepend">+ <div class="input-group-text">$</div>+ </div>+ <input class="js-base-input form-control" type="text" value={{baseField.value}}>+ </div>+ </div>+ <div class="form-group">+ <div class="input-group">+ <div class="input-group-prepend">+ <div class="input-group-text">$</div>+ </div>+ <input class="js-value-input form-control"+ name="{{valueField.name}}" type="text" value={{valueField.value}}>+ </div>+ </div>+ <a class="js-remove-tier btn btn-light btn-sm"><span class="icon icon-delete"></span></a>+ </div>+ </div>+</script>diff --git a/admin/app/views/spree/admin/promotions/calculators/tiered_percent/_fields.html.erb b/admin/app/views/spree/admin/promotions/calculators/tiered_percent/_fields.html.erbnew file mode 100644index 0000000000..184b17153b--- /dev/null+++ b/admin/app/views/spree/admin/promotions/calculators/tiered_percent/_fields.html.erb@@ -0,0 +1,46 @@+<div class="form-group">+ <%= label_tag "#{prefix}[calculator_attributes][preferred_base_percent]",+ Spree.t(:base_percent) %>+ <%= preference_field_tag(+ "#{prefix}[calculator_attributes][preferred_base_percent]",+ calculator.preferred_base_percent,+ type: calculator.preference_type(:base_percent)) %>+</div>++<div class="form-group mb-0">+ <%= label_tag nil, Spree.t(:tiers) %>+ <%= content_tag :div, nil, class: "hidden js-original-tiers",+ data: { :'original-tiers' => Hash[calculator.preferred_tiers.sort] } %>+</div>++<div class="js-tiers"></div>+<button class="btn btn-primary js-add-tier"><%= Spree.t(:add) %></button>++<script type="text/x-handlebars-template" id="tier-input-name">+ <%= prefix %>[calculator_attributes][preferred_tiers][{{base}}]+</script>++<script type="text/x-handlebars-template" id="tier-fields-template">+ <div class="tier card mb-4">+ <div class="card-body p-3">+ <div class="form-group">+ <div class="input-group">+ <div class="input-group-prepend">+ <div class="input-group-text">$</div>+ </div>+ <input class="js-base-input form-control" type="text" value={{baseField.value}}>+ </div>+ </div>+ <div class="form-group">+ <div class="input-group">+ <div class="input-group-prepend">+ <div class="input-group-text">%</div>+ </div>+ <input class="js-value-input form-control"+ name="{{valueField.name}}" type="text" value={{valueField.value}}>+ </div>+ </div>+ <a class="js-remove-tier btn btn-light btn-sm"><span class="icon icon-delete"></span></a>+ </div>+ </div>+</script>diff --git a/admin/app/views/spree/admin/promotions/edit.html.erb b/admin/app/views/spree/admin/promotions/edit.html.erbindex 98588034de..f5cfb7b609 100644--- a/admin/app/views/spree/admin/promotions/edit.html.erb+++ b/admin/app/views/spree/admin/promotions/edit.html.erb@@ -9,6 +9,7 @@</h5></div><div class="card-body">+ <%= render 'spree/admin/shared/error_messages', target: @promotion %><div class="form-group"><%= f.label :name %><%= f.text_field :name, class: 'form-control', required: true, autofocus: true %>@@ -37,6 +38,7 @@</h5></div><div class="card-body">+ <%= render 'spree/admin/shared/error_messages', target: @promotion %><%= render 'spree/admin/promotions/form/settings', f: f %></div><div class="card-footer d-flex justify-content-between">diff --git a/admin/app/views/spree/admin/promotions/rules/_country.html.erb b/admin/app/views/spree/admin/promotions/rules/_country.html.erbnew file mode 100644index 0000000000..981c876f6e--- /dev/null+++ b/admin/app/views/spree/admin/promotions/rules/_country.html.erb@@ -0,0 +1,9 @@++<% active_option ||= current_store.default_country_iso %>+<% active_option = rule_form.object.preferred_country_iso if rule_form.object.persisted? && rule_form.object.respond_to?(:preferred_country_iso) %>++<div class="form-group">+ <%= rule_form.label Spree.t('country_rule.label') %>+ <%= rule_form.country_select('preferred_country_iso', { selected: active_option }, { data: { controller: 'autocomplete-select' } }) %>+</div>+diff --git a/admin/app/views/spree/admin/promotions/rules/_first_order.html.erb b/admin/app/views/spree/admin/promotions/rules/_first_order.html.erbnew file mode 100644index 0000000000..e69de29bb2diff --git a/admin/app/views/spree/admin/promotions/rules/_item_total.html.erb b/admin/app/views/spree/admin/promotions/rules/_item_total.html.erbnew file mode 100644index 0000000000..9d759ddf28--- /dev/null+++ b/admin/app/views/spree/admin/promotions/rules/_item_total.html.erb@@ -0,0 +1,16 @@+<div class="row mb-3">+ <div class="col-6">+ <%= rule_form.select :preferred_operator_min, options_for_select(Spree::Promotion::Rules::ItemTotal::OPERATORS_MIN.map{|o| [Spree.t("item_total_rule.operators.#{o}"),o]}, rule_form.object.try(:preferred_operator_min)), {}, { class: 'custom-select' } %>+ </div>+ <div class="col-6">+ <%= rule_form.text_field :preferred_amount_min, class: 'form-control' %>+ </div>+</div>+<div class="row">+ <div class="col-6">+ <%= rule_form.select :preferred_operator_max, options_for_select(Spree::Promotion::Rules::ItemTotal::OPERATORS_MAX.map{|o| [Spree.t("item_total_rule.operators.#{o}"),o]}, rule_form.object.try(:preferred_operator_max)), {}, { class: 'custom-select' } %>+ </div>+ <div class="col-6">+ <%= rule_form.text_field :preferred_amount_max, class: 'form-control' %>+ </div>+</div>\ No newline at end of filediff --git a/admin/app/views/spree/admin/promotions/rules/_one_use_per_user.html.erb b/admin/app/views/spree/admin/promotions/rules/_one_use_per_user.html.erbnew file mode 100644index 0000000000..e69de29bb2diff --git a/admin/app/views/spree/admin/promotions/rules/_option_value.html.erb b/admin/app/views/spree/admin/promotions/rules/_option_value.html.erbnew file mode 100644index 0000000000..0457ecc0b6--- /dev/null+++ b/admin/app/views/spree/admin/promotions/rules/_option_value.html.erb@@ -0,0 +1,11 @@+<% active_options = [] %>+<% active_options = active_options_for_option_value_promotion_rule(rule_form.object) if rule_form.object.persisted? && rule_form.object.respond_to?(:eligible_values) %>++<%= tom_select_tag "[preferred_eligible_values][]",+ placeholder: Spree.t(:type_to_search),+ url: spree.admin_promotion_rules_option_values_search_path,+ remote_search: true,+ remote_search_active_option: active_options,+ multiple: true,+ class: 'w-100 mr-2' %>+diff --git a/admin/app/views/spree/admin/promotions/rules/_product.html.erb b/admin/app/views/spree/admin/promotions/rules/_product.html.erbnew file mode 100644index 0000000000..9ec553ce34--- /dev/null+++ b/admin/app/views/spree/admin/promotions/rules/_product.html.erb@@ -0,0 +1,7 @@+<% active_options = [] %>+<% active_options = rule_form.object.product_ids if rule_form.object.persisted? && rule_form.object.respond_to?(:product_ids) %>++<div class="form-group">+ <%= rule_form.label "product_ids_string", Spree.t('product_rule.choose_products') %>+ <%= tom_select_tag "product_ids_string", multiple: true, url: select_options_admin_products_path, active_option: active_options %>+</div>diff --git a/admin/app/views/spree/admin/promotions/rules/_taxon.html.erb b/admin/app/views/spree/admin/promotions/rules/_taxon.html.erbnew file mode 100644index 0000000000..c73c716d05--- /dev/null+++ b/admin/app/views/spree/admin/promotions/rules/_taxon.html.erb@@ -0,0 +1,9 @@+<% active_options = [] %>+<% active_options = rule_form.object.taxon_ids if rule_form.object.persisted? && rule_form.object.respond_to?(:taxon_ids) %>++<div class="form-group">+ <%= rule_form.label "taxon_ids", Spree.t('taxon_rule.choose_taxons') %>+ <%= tom_select_tag "taxon_ids", multiple: true, url: spree.admin_taxons_select_options_path, active_option: active_options %>+</div>++diff --git a/admin/app/views/spree/admin/promotions/rules/_user.html.erb b/admin/app/views/spree/admin/promotions/rules/_user.html.erbnew file mode 100644index 0000000000..dae782510d--- /dev/null+++ b/admin/app/views/spree/admin/promotions/rules/_user.html.erb@@ -0,0 +1,7 @@+<% active_options = [] %>+<% active_options = rule_form.object.user_ids if rule_form.object.persisted? && rule_form.object.respond_to?(:user_ids) %>++<div class="form-group mb-0">+ <%= rule_form.label Spree.t('user_rule.choose_users') %>+ <%= tom_select_tag "promotion[promotion_rules_attributes][#{rule_form.index}][user_ids]", multiple: true, options: users_for_select_options, active_option: active_options %>+</div>diff --git a/admin/app/views/spree/admin/promotions/rules/_user_logged_in.html.erb b/admin/app/views/spree/admin/promotions/rules/_user_logged_in.html.erbnew file mode 100644index 0000000000..e69de29bb2diff --git a/admin/app/views/spree/admin/promotions/show.html.erb b/admin/app/views/spree/admin/promotions/show.html.erbindex 124ca1c7a5..98c6802bbd 100644--- a/admin/app/views/spree/admin/promotions/show.html.erb+++ b/admin/app/views/spree/admin/promotions/show.html.erb@@ -2,6 +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 %></div><div class="col-12 col-lg-4">diff --git a/admin/config/routes.rb b/admin/config/routes.rbindex 3e49095909..5fa4e0e422 100644--- a/admin/config/routes.rb+++ b/admin/config/routes.rb@@ -101,12 +101,10 @@ Spree::Core::Engine.add_routes do# promotionsresources :promotions do- resources :promotion_rules- resources :promotion_actionsmember dopost :cloneend- resources :coupon_codes+ resources :coupon_codes, only: :indexendget 'promotion_rules/option_values_search', defaults: { format: :json }