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.

Add weight and item total preferences to the `Spree::Calculator::Shipping::FlatRate` calculator (#12099)

Łukasz Adamczykc33d470caadd
diff --git a/core/app/models/spree/calculator/shipping/flat_rate.rb b/core/app/models/spree/calculator/shipping/flat_rate.rb
index fcb6740648..eb0cbf660f 100644
--- a/core/app/models/spree/calculator/shipping/flat_rate.rb
+++ b/core/app/models/spree/calculator/shipping/flat_rate.rb
@@ -6,11 +6,23 @@ module Spree
preference :amount, :decimal, default: 0
preference :currency, :string, default: -> { Spree::Store.default.default_currency }
+ preference :minimum_item_total, :decimal, default: nil, nullable: true
+ preference :maximum_item_total, :decimal, default: nil, nullable: true
+
+ preference :minimum_weight, :decimal, default: nil, nullable: true
+ preference :maximum_weight, :decimal, default: nil, nullable: true
+
def self.description
Spree.t(:shipping_flat_rate_per_order)
end
- def compute_package(_package)
+ def compute_package(package)
+ return nil if preferred_minimum_weight.present? && preferred_minimum_weight >= package.weight
+ return nil if preferred_maximum_weight.present? && preferred_maximum_weight < package.weight
+
+ return nil if preferred_minimum_item_total.present? && preferred_minimum_item_total >= package.item_total
+ return nil if preferred_maximum_item_total.present? && preferred_maximum_item_total < package.item_total
+
preferred_amount
end
end
diff --git a/core/app/models/spree/shipping_method.rb b/core/app/models/spree/shipping_method.rb
index 5a77baa7c0..1bdeb5087e 100644
--- a/core/app/models/spree/shipping_method.rb
+++ b/core/app/models/spree/shipping_method.rb
@@ -18,6 +18,8 @@ module Spree
default_scope { where(deleted_at: nil) }
+ scope :with_calculator, ->(calculator) { joins(:calculator).where(calculator: { type: calculator.to_s }) }
+
has_many :shipping_method_categories, dependent: :destroy
has_many :shipping_categories, through: :shipping_method_categories
has_many :shipping_rates, inverse_of: :shipping_method
diff --git a/core/app/models/spree/stock/package.rb b/core/app/models/spree/stock/package.rb
index 8ab81d1b45..98363cf2e2 100644
--- a/core/app/models/spree/stock/package.rb
+++ b/core/app/models/spree/stock/package.rb
@@ -34,6 +34,10 @@ module Spree
contents.detect { |item| !!item.try(:inventory_unit).try(:order) }.try(:inventory_unit).try(:order)
end
+ def item_total
+ contents.sum(&:amount)
+ end
+
def weight
contents.sum(&:weight)
end
diff --git a/core/lib/spree/core/preferences/preferable.rb b/core/lib/spree/core/preferences/preferable.rb
index 81e147ecde..81c2ea6ec1 100644
--- a/core/lib/spree/core/preferences/preferable.rb
+++ b/core/lib/spree/core/preferences/preferable.rb
@@ -101,14 +101,16 @@ module Spree::Preferences::Preferable
private
- def convert_preference_value(value, type)
+ def convert_preference_value(value, type, nullable: false)
case type
when :string, :text
value.to_s
when :password
value.to_s
when :decimal
- (value.presence || 0).to_s.to_d
+ decimal_value = value.presence
+ decimal_value ||= 0 unless nullable
+ decimal_value.present? ? decimal_value.to_s.to_d : decimal_value
when :integer
value.to_i
when :boolean
diff --git a/core/lib/spree/core/preferences/preferable_class_methods.rb b/core/lib/spree/core/preferences/preferable_class_methods.rb
index c7979d1192..b5133cfbb5 100644
--- a/core/lib/spree/core/preferences/preferable_class_methods.rb
+++ b/core/lib/spree/core/preferences/preferable_class_methods.rb
@@ -2,10 +2,11 @@ module Spree::Preferences
module PreferableClassMethods
def preference(name, type, *args)
options = args.extract_options!
- options.assert_valid_keys(:default, :deprecated)
+ options.assert_valid_keys(:default, :deprecated, :nullable)
default = options[:default]
default = -> { options[:default] } unless default.is_a?(Proc)
deprecated = options[:deprecated]
+ nullable = options[:nullable]
# cache_key will be nil for new objects, then if we check if there
# is a pending preference before going to default
@@ -16,7 +17,7 @@ module Spree::Preferences
end
define_method preference_setter_method(name) do |value|
- value = convert_preference_value(value, type)
+ value = convert_preference_value(value, type, nullable: nullable)
preferences[name] = value
Spree::Deprecation.warn("`#{name}` is deprecated. #{deprecated}") if deprecated
diff --git a/core/spec/models/spree/calculator/shipping/flat_rate_spec.rb b/core/spec/models/spree/calculator/shipping/flat_rate_spec.rb
index 2dbb55b375..2e79529542 100644
--- a/core/spec/models/spree/calculator/shipping/flat_rate_spec.rb
+++ b/core/spec/models/spree/calculator/shipping/flat_rate_spec.rb
@@ -1,13 +1,103 @@
require 'spec_helper'
-module Spree
- module Calculator::Shipping
- describe FlatRate, type: :model do
- subject { Calculator::Shipping::FlatRate.new(preferred_amount: 4.00) }
-
- it 'always returns the same rate' do
- expect(subject.compute(build(:stock_package_fulfilled))).to eq(4.00)
- end
+RSpec.describe Spree::Calculator::Shipping::FlatRate, type: :model do
+ let(:variant1) { build(:variant, price: 10, weight: 0.75) }
+ let(:variant2) { build(:variant, price: 15, weight: 2.5) }
+
+ let(:line_item1) { build(:line_item, variant: variant1, price: 10) }
+ let(:line_item2) { build(:line_item, variant: variant2, price: 15) }
+
+ let(:inventory_unit1) { build(:inventory_unit, quantity: 2, variant: variant1, line_item: line_item1) }
+ let(:inventory_unit2) { build(:inventory_unit, quantity: 1, variant: variant2, line_item: line_item2) }
+ let(:inventory_units) { [inventory_unit1, inventory_unit2] }
+
+ let(:package) { build(:stock_package, contents: inventory_units.map { |iu| ::Spree::Stock::ContentItem.new(iu) }) }
+
+ context 'without any constraints' do
+ let(:calculator) { described_class.new(preferred_amount: 5) }
+
+ it 'returns the amount' do
+ expect(calculator.compute(package)).to eq(5)
+ end
+ end
+
+ context 'with weight constraints' do
+ let(:calculator_1) { described_class.new(preferred_amount: 5, preferred_minimum_weight: 2, preferred_maximum_weight: 4) }
+ let(:calculator_2) { described_class.new(preferred_amount: 5, preferred_minimum_weight: 4, preferred_maximum_weight: 8) }
+
+ let(:calculator_3) { described_class.new(preferred_amount: 5, preferred_minimum_weight: nil, preferred_maximum_weight: 4) }
+ let(:calculator_4) { described_class.new(preferred_amount: 5, preferred_minimum_weight: nil, preferred_maximum_weight: 3) }
+
+ let(:calculator_5) { described_class.new(preferred_amount: 5, preferred_minimum_weight: 3, preferred_maximum_weight: nil) }
+ let(:calculator_6) { described_class.new(preferred_amount: 5, preferred_minimum_weight: 4, preferred_maximum_weight: nil) }
+ let(:calculator_7) { described_class.new(preferred_amount: 5, preferred_minimum_weight: 5, preferred_maximum_weight: nil) }
+
+ it 'returns amount based on the contents item total' do
+ expect(calculator_1.compute(package)).to eq(5.00)
+ expect(calculator_2.compute(package)).to be_nil
+
+ expect(calculator_3.compute(package)).to eq(5.00)
+ expect(calculator_4.compute(package)).to be_nil
+
+ expect(calculator_5.compute(package)).to eq(5.00)
+ expect(calculator_6.compute(package)).to be_nil
+ expect(calculator_7.compute(package)).to be_nil
+ end
+ end
+
+ context 'with price constraints' do
+ let(:calculator_1) { described_class.new(preferred_amount: 5, preferred_minimum_item_total: 20, preferred_maximum_item_total: 35) }
+ let(:calculator_2) { described_class.new(preferred_amount: 5, preferred_minimum_item_total: 35, preferred_maximum_item_total: 80) }
+
+ let(:calculator_3) { described_class.new(preferred_amount: 5, preferred_minimum_item_total: nil, preferred_maximum_item_total: 35) }
+ let(:calculator_4) { described_class.new(preferred_amount: 5, preferred_minimum_item_total: nil, preferred_maximum_item_total: 34) }
+
+ let(:calculator_5) { described_class.new(preferred_amount: 5, preferred_minimum_item_total: 34, preferred_maximum_item_total: nil) }
+ let(:calculator_6) { described_class.new(preferred_amount: 5, preferred_minimum_item_total: 35, preferred_maximum_item_total: nil) }
+ let(:calculator_7) { described_class.new(preferred_amount: 5, preferred_minimum_item_total: 36, preferred_maximum_item_total: nil) }
+
+ it 'returns amount based on the contents weight' do
+ expect(calculator_1.compute(package)).to eq(5.00)
+ expect(calculator_2.compute(package)).to be_nil
+
+ expect(calculator_3.compute(package)).to eq(5.00)
+ expect(calculator_4.compute(package)).to be_nil
+
+ expect(calculator_5.compute(package)).to eq(5.00)
+ expect(calculator_6.compute(package)).to be_nil
+ expect(calculator_7.compute(package)).to be_nil
+ end
+ end
+
+ context 'with both weight and price constraints' do
+ let(:calculator_1) do
+ described_class.new(
+ preferred_amount: 5,
+ preferred_minimum_item_total: 20, preferred_maximum_item_total: 35,
+ preferred_minimum_weight: 2, preferred_maximum_weight: 4
+ )
+ end
+
+ let(:calculator_2) do
+ described_class.new(
+ preferred_amount: 5,
+ preferred_minimum_item_total: 35, preferred_maximum_item_total: 80,
+ preferred_minimum_weight: 2, preferred_maximum_weight: 4
+ )
+ end
+
+ let(:calculator_3) do
+ described_class.new(
+ preferred_amount: 5,
+ preferred_minimum_item_total: 20, preferred_maximum_item_total: 35,
+ preferred_minimum_weight: 4, preferred_maximum_weight: 8
+ )
+ end
+
+ it 'returns amount based on the contents weight and price' do
+ expect(calculator_1.compute(package)).to eq(5.00)
+ expect(calculator_2.compute(package)).to be_nil
+ expect(calculator_3.compute(package)).to be_nil
end
end
end