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.

Added UI to manage Price Rules

Damian Legawiec3268c460cb4a
diff --git a/admin/app/controllers/spree/admin/price_rules_controller.rb b/admin/app/controllers/spree/admin/price_rules_controller.rb
new file mode 100644
index 0000000000..e12bfcb5e5
--- /dev/null
+++ b/admin/app/controllers/spree/admin/price_rules_controller.rb
@@ -0,0 +1,54 @@
+module Spree
+ module Admin
+ class PriceRulesController < ResourceController
+ belongs_to 'spree/price_list', find_by: :id
+
+ helper_method :allowed_rule_types
+
+ private
+
+ def model_class
+ @model_class = if params.dig(:price_rule, :type).present?
+ rule_type = params.dig(:price_rule, :type)
+ rule_class = allowed_rule_types.find { |type| type.to_s == rule_type }
+
+ if rule_class
+ rule_class.constantize
+ else
+ raise 'Unknown price rule type'
+ end
+ else
+ Spree::PriceRule
+ end
+ end
+
+ def build_resource
+ model_class.new(price_list: parent)
+ end
+
+ def allowed_rule_types
+ Rails.application.config.spree.pricing.rules
+ end
+
+ def location_after_save
+ collection_url
+ end
+
+ def collection_url
+ spree.admin_price_list_path(parent)
+ end
+
+ def permitted_resource_params
+ permitted_preference_keys = @object.preferences.map do |key, value|
+ if value.is_a?(Array)
+ { "preferred_#{key}" => [] }
+ else
+ "preferred_#{key}"
+ end
+ end
+
+ params.require(:price_rule).permit(:type, *permitted_preference_keys)
+ end
+ end
+ end
+end
diff --git a/admin/app/views/spree/admin/price_lists/_rules.html.erb b/admin/app/views/spree/admin/price_lists/_rules.html.erb
new file mode 100644
index 0000000000..77c5ecdc4d
--- /dev/null
+++ b/admin/app/views/spree/admin/price_lists/_rules.html.erb
@@ -0,0 +1,32 @@
+<div class="card mb-6">
+ <div class="card-header flex justify-between">
+ <h5 class="card-title">
+ <%= icon('checklist', class: 'mr-2') %>
+ <%= Spree.t(:rules) %>
+ </h5>
+ <% if can?(:create, Spree::PriceRule.new(price_list: @price_list)) %>
+ <%= link_to_with_icon 'plus', Spree.t(:add_one), spree.new_admin_price_list_price_rule_path(@price_list), class: 'btn btn-secondary btn-sm', data: { turbo_frame: 'dialog', action: 'dialog#open' } %>
+ <% end %>
+ </div>
+ <div class="card-body pb-0">
+ <%= form_with model: @price_list, url: spree.admin_price_list_path(@price_list), method: :put, data: { controller: 'auto-submit' }, html: { class: 'flex gap-x-6' } do |f| %>
+ <% Spree::PriceList::MATCH_POLICIES.each do |policy| %>
+ <%= f.spree_radio_button :match_policy, policy, { data: { action: 'click->auto-submit#submit' }, label: Spree.t("price_list_form.match_policies.#{policy}") } %>
+ <% end %>
+ <% end %>
+ </div>
+ <div class="card-body p-2 flex flex-col gap-2">
+ <% if @price_list.price_rules.empty? %>
+ <div class="text-gray-600 p-12 flex items-center w-full justify-center">
+ <%= Spree.t(:no_resource_found, resource: plural_resource_name(Spree::PriceRule)) %>
+ <% if can?(:create, Spree::PriceRule.new(price_list: @price_list)) %>
+ <%= link_to_with_icon 'plus', Spree.t(:add_one), spree.new_admin_price_list_price_rule_path(@price_list), class: 'btn btn-light btn-sm ml-6', data: { turbo_frame: 'dialog', action: 'dialog#open' } %>
+ <% end %>
+ </div>
+ <% else %>
+ <%= render collection: @price_list.price_rules,
+ partial: 'spree/admin/price_rules/price_rule',
+ as: :price_rule %>
+ <% end %>
+ </div>
+</div>
diff --git a/admin/app/views/spree/admin/price_lists/show.html.erb b/admin/app/views/spree/admin/price_lists/show.html.erb
index 7efcef6064..c5a19bf9c2 100644
--- a/admin/app/views/spree/admin/price_lists/show.html.erb
+++ b/admin/app/views/spree/admin/price_lists/show.html.erb
@@ -5,6 +5,7 @@
<div class="grid grid-cols-12 gap-6">
<div class="col-span-12 lg:col-span-8">
+ <%= render 'rules' %>
<%= turbo_frame_tag :price_list_products, src: spree.admin_price_list_products_path(@price_list) %>
</div>
diff --git a/admin/app/views/spree/admin/price_rules/_price_rule.html.erb b/admin/app/views/spree/admin/price_rules/_price_rule.html.erb
new file mode 100644
index 0000000000..6662172c52
--- /dev/null
+++ b/admin/app/views/spree/admin/price_rules/_price_rule.html.erb
@@ -0,0 +1,28 @@
+<%= turbo_frame_tag price_rule do %>
+ <div class="card" id="<%= spree_dom_id(price_rule) %>">
+ <div class="card-header flex justify-between items-center py-3">
+ <h5 class="card-title text-base"><%= price_rule.class.human_name %></h5>
+
+ <% if can?(:update, price_rule) || can?(:destroy, price_rule) %>
+ <%= dropdown portal: false do %>
+ <%= dropdown_toggle class: 'btn-light btn-sm px-1' do %>
+ <%= icon('dots-vertical', class: 'mr-0') %>
+ <% end %>
+ <%= dropdown_menu do %>
+ <%= link_to_with_icon 'pencil', Spree.t('actions.edit'), spree.edit_admin_price_list_price_rule_path(price_rule.price_list, price_rule), class: 'dropdown-item' if can?(:update, price_rule) %>
+ <%= link_to_with_icon 'trash', Spree.t('actions.destroy'), spree.admin_price_list_price_rule_path(price_rule.price_list, price_rule), class: 'dropdown-item text-red-600 hover:bg-red-100', data: { turbo_method: :delete, turbo_confirm: Spree.t(:are_you_sure), turbo_frame: '_top' } if can?(:destroy, price_rule) %>
+ <% end %>
+ <% end %>
+ <% end %>
+ </div>
+ <div class="card-body">
+ <p class="text-gray-600 mb-3">
+ <%= price_rule.class.description %>
+ </p>
+
+ <% if price_rule.preferences.present? %>
+ <%= render 'spree/admin/shared/preferences', object: price_rule %>
+ <% end %>
+ </div>
+ </div>
+<% end %>
diff --git a/admin/app/views/spree/admin/price_rules/edit.html.erb b/admin/app/views/spree/admin/price_rules/edit.html.erb
new file mode 100644
index 0000000000..697534e2bc
--- /dev/null
+++ b/admin/app/views/spree/admin/price_rules/edit.html.erb
@@ -0,0 +1,20 @@
+<%= turbo_frame_tag @price_rule do %>
+ <%= form_with model: @price_rule, url: spree.admin_price_list_price_rule_path(@price_list, @price_rule), method: :put, scope: :price_rule do |f| %>
+ <div class="card" id="<%= spree_dom_id(@price_rule) %>">
+ <div class="card-header flex justify-between items-center">
+ <h5 class="card-title text-base"><%= @price_rule.class.human_name %></h5>
+ </div>
+ <div class="card-body">
+ <%= render partial: 'spree/admin/shared/error_messages', locals: { target: @price_rule } %>
+ <p class="text-gray-600 mb-3">
+ <%= @price_rule.class.description %>
+ </p>
+ <%= render "spree/admin/price_rules/forms/#{@price_rule.class.name.demodulize.underscore}", f: f %>
+ </div>
+ <div class="card-footer flex justify-between">
+ <%= turbo_save_button_tag Spree.t('actions.update') %>
+ <%= link_to Spree.t('actions.discard'), spree.admin_price_list_path(@price_list), class: 'btn btn-light' %>
+ </div>
+ </div>
+ <% end %>
+<% end %>
diff --git a/admin/app/views/spree/admin/price_rules/forms/_user_rule.html.erb b/admin/app/views/spree/admin/price_rules/forms/_user_rule.html.erb
new file mode 100644
index 0000000000..b65d0e881a
--- /dev/null
+++ b/admin/app/views/spree/admin/price_rules/forms/_user_rule.html.erb
@@ -0,0 +1,7 @@
+<div class="form-group">
+ <%= f.label :preferred_user_ids, Spree.t(:users) %>
+ <%= f.select :preferred_user_ids,
+ Spree.user_class.order(:email).pluck(:email, :id),
+ { selected: f.object.preferred_user_ids },
+ { multiple: true, data: { controller: 'autocomplete-select' } } %>
+</div>
diff --git a/admin/app/views/spree/admin/price_rules/forms/_volume_rule.html.erb b/admin/app/views/spree/admin/price_rules/forms/_volume_rule.html.erb
new file mode 100644
index 0000000000..b89921ee8b
--- /dev/null
+++ b/admin/app/views/spree/admin/price_rules/forms/_volume_rule.html.erb
@@ -0,0 +1,11 @@
+<div class="grid grid-cols-2 gap-4">
+ <div class="form-group">
+ <%= f.label :preferred_min_quantity, Spree.t(:min_quantity) %>
+ <%= f.number_field :preferred_min_quantity, class: 'form-control', min: 1, value: f.object.preferred_min_quantity || 1 %>
+ </div>
+
+ <div class="form-group">
+ <%= f.label :preferred_max_quantity, Spree.t(:max_quantity) %>
+ <%= f.number_field :preferred_max_quantity, class: 'form-control', min: 1, value: f.object.preferred_max_quantity, placeholder: Spree.t(:unlimited) %>
+ </div>
+</div>
diff --git a/admin/app/views/spree/admin/price_rules/forms/_zone_rule.html.erb b/admin/app/views/spree/admin/price_rules/forms/_zone_rule.html.erb
new file mode 100644
index 0000000000..29e40d7161
--- /dev/null
+++ b/admin/app/views/spree/admin/price_rules/forms/_zone_rule.html.erb
@@ -0,0 +1,7 @@
+<div class="form-group">
+ <%= f.label :preferred_zone_ids, Spree.t(:zones) %>
+ <%= f.select :preferred_zone_ids,
+ Spree::Zone.order(:name).pluck(:name, :id),
+ { selected: f.object.preferred_zone_ids },
+ { multiple: true, data: { controller: 'autocomplete-select' } } %>
+</div>
diff --git a/admin/app/views/spree/admin/price_rules/new.html.erb b/admin/app/views/spree/admin/price_rules/new.html.erb
new file mode 100644
index 0000000000..c1e9ddc95c
--- /dev/null
+++ b/admin/app/views/spree/admin/price_rules/new.html.erb
@@ -0,0 +1,37 @@
+<%= turbo_frame_tag :dialog do %>
+ <%= form_with model: @price_rule, url: spree.admin_price_list_price_rules_path(@price_list), method: :post, scope: :price_rule do |f| %>
+ <% if @price_rule.type.nil? %>
+ <%= dialog_header(Spree.t(:add_rule_of_type)) %>
+ <% else %>
+ <%= dialog_header(@price_rule.class.human_name) %>
+ <% end %>
+ <div class="dialog-body">
+ <%= render partial: 'spree/admin/shared/error_messages', locals: { target: @price_rule } %>
+ <% if @price_rule.type.nil? %>
+ <% allowed_rule_types.each do |rule_type| %>
+ <% rule_class = rule_type.constantize %>
+ <% key = rule_class.name.demodulize.underscore %>
+ <%= link_to spree.new_admin_price_list_price_rule_path(@price_list, price_rule: { type: rule_type }), class: 'flex align-items-top w-full py-2 px-4 hover:bg-gray-100 rounded-xl mb-2 no-underline', data: { turbo_prefetch: false } do %>
+ <%= radio_button_tag :type, rule_type, class: 'hidden' %>
+ <div class="">
+ <h6 class="font-bold mb-1"><%= rule_class.human_name %></h6>
+ <p class="text-gray-600 mb-0"><%= rule_class.description %></p>
+ </div>
+ <% end %>
+ <% end %>
+ <% else %>
+ <p class="text-gray-600 mb-3">
+ <%= @price_rule.class.description %>
+ </p>
+ <%= f.hidden_field :type, value: @price_rule.type %>
+ <%= render "spree/admin/price_rules/forms/#{@price_rule.class.name.demodulize.underscore}", f: f %>
+ <% end %>
+ </div>
+ <% if @price_rule.type.present? %>
+ <div class="dialog-footer">
+ <%= dialog_discard_button %>
+ <%= turbo_save_button_tag Spree.t('actions.create'), data: { turbo_frame: '_top' } %>
+ </div>
+ <% end %>
+ <% end %>
+<% end %>
diff --git a/admin/spec/controllers/spree/admin/price_lists_controller_spec.rb b/admin/spec/controllers/spree/admin/price_lists_controller_spec.rb
index 1ed54ab7c5..a4b51b9566 100644
--- a/admin/spec/controllers/spree/admin/price_lists_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/price_lists_controller_spec.rb
@@ -20,6 +20,26 @@ RSpec.describe Spree::Admin::PriceListsController, type: :controller do
end
end
+ describe 'GET #show' do
+ subject(:show) { get :show, params: { id: price_list.id } }
+
+ it 'renders the show page' do
+ show
+
+ expect(response).to render_template(:show)
+ end
+
+ context 'with price rules' do
+ let!(:price_rule) { create(:volume_price_rule, price_list: price_list) }
+
+ it 'displays the price rules' do
+ show
+
+ expect(response.body).to include(price_rule.class.human_name)
+ end
+ end
+ end
+
describe 'GET #edit_prices' do
subject(:edit_prices) { get :edit_prices, params: { id: price_list.id, currency: currency } }
diff --git a/admin/spec/controllers/spree/admin/price_rules_controller_spec.rb b/admin/spec/controllers/spree/admin/price_rules_controller_spec.rb
new file mode 100644
index 0000000000..3e7e6985f8
--- /dev/null
+++ b/admin/spec/controllers/spree/admin/price_rules_controller_spec.rb
@@ -0,0 +1,128 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::PriceRulesController, type: :controller do
+ stub_authorization!
+ render_views
+
+ let(:store) { @default_store }
+ let(:price_list) { create(:price_list, store: store) }
+
+ describe 'GET #new' do
+ context 'without type parameter' do
+ subject { get :new, params: { price_list_id: price_list.id } }
+
+ it 'renders the rule type selection' do
+ subject
+
+ expect(response).to render_template(:new)
+ expect(assigns[:price_rule]).to be_a(Spree::PriceRule)
+ expect(assigns[:price_rule].type).to be_nil
+ end
+ end
+
+ context 'with type parameter' do
+ subject { get :new, params: { price_list_id: price_list.id, price_rule: { type: 'Spree::PriceRules::ZoneRule' } } }
+
+ it 'renders the form for the selected type' do
+ subject
+
+ expect(response).to render_template(:new)
+ expect(assigns[:price_rule]).to be_a(Spree::PriceRules::ZoneRule)
+ end
+ end
+ end
+
+ describe 'POST #create' do
+ subject { post :create, params: params }
+
+ let(:params) do
+ {
+ price_list_id: price_list.id,
+ price_rule: {
+ type: 'Spree::PriceRules::VolumeRule',
+ preferred_min_quantity: 10,
+ preferred_max_quantity: 100,
+ preferred_apply_to: 'line_item'
+ }
+ }
+ end
+
+ it 'creates a new price rule' do
+ expect { subject }.to change(Spree::PriceRule, :count).by(1)
+ end
+
+ it 'creates the correct rule type' do
+ subject
+
+ rule = Spree::PriceRule.last
+ expect(rule).to be_a(Spree::PriceRules::VolumeRule)
+ expect(rule.price_list).to eq(price_list)
+ expect(rule.preferred_min_quantity).to eq(10)
+ expect(rule.preferred_max_quantity).to eq(100)
+ end
+
+ it 'redirects to the price list' do
+ subject
+
+ expect(response).to redirect_to(spree.admin_price_list_path(price_list))
+ end
+ end
+
+ describe 'GET #edit' do
+ subject { get :edit, params: { price_list_id: price_list.id, id: price_rule.id } }
+
+ let!(:price_rule) { create(:volume_price_rule, price_list: price_list) }
+
+ it 'renders the edit form' do
+ subject
+
+ expect(response).to render_template(:edit)
+ expect(assigns[:price_rule]).to eq(price_rule)
+ end
+ end
+
+ describe 'PUT #update' do
+ subject { put :update, params: params }
+
+ let!(:price_rule) { create(:volume_price_rule, price_list: price_list, preferred_min_quantity: 5) }
+
+ let(:params) do
+ {
+ price_list_id: price_list.id,
+ id: price_rule.id,
+ price_rule: {
+ preferred_min_quantity: 20
+ }
+ }
+ end
+
+ it 'updates the price rule' do
+ subject
+ price_rule.reload
+
+ expect(price_rule.preferred_min_quantity).to eq(20)
+ end
+
+ it 'redirects to the price list' do
+ subject
+
+ expect(response).to redirect_to(spree.admin_price_list_path(price_list))
+ end
+ end
+
+ describe 'DELETE #destroy' do
+ subject { delete :destroy, params: { price_list_id: price_list.id, id: price_rule.id } }
+
+ let!(:price_rule) { create(:volume_price_rule, price_list: price_list) }
+
+ it 'destroys the price rule' do
+ expect { subject }.to change(Spree::PriceRule, :count).by(-1)
+ end
+
+ it 'redirects to the price list' do
+ subject
+
+ expect(response).to redirect_to(spree.admin_price_list_path(price_list))
+ end
+ end
+end
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index b742afeb3d..4632e2aafc 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -1693,6 +1693,10 @@ en:
active: Active
inactive: Inactive
scheduled: Scheduled
+ price_list_form:
+ match_policies:
+ all: Match all of these rules
+ any: Match any of these rules
price_lists: Price Lists
price_range: Price Range
price_rule_types:
@@ -1706,6 +1710,12 @@ en:
description: Apply pricing based on geographic zone
name: Zone
price_sack: Price Sack
+ min_quantity: Min Quantity
+ max_quantity: Max Quantity
+ unlimited: Unlimited
+ volume_rule:
+ line_item: Line Item Quantity
+ cart_total: Cart Total Quantity
prices: Prices
pricing: Pricing
privacy_policy: Privacy Policy