# frozen_string_literal: true require 'spec_helper' RSpec.describe Spree::LineItem do let(:order) { create :order_with_line_items, line_items_count: 1 } let(:line_item) { order.line_items.first } describe "associations" do it { is_expected.to belong_to(:order).required } it { is_expected.to have_one(:order_cycle).through(:order) } it { is_expected.to belong_to(:variant).required } it { is_expected.to have_one(:product).through(:variant) } it { is_expected.to have_one(:supplier).through(:variant) } it { is_expected.to belong_to(:tax_category).optional } it { is_expected.to have_many(:adjustments) } end context '#save' do it 'should update inventory, totals, and tax' do # Regression check for Spree #1481 expect(line_item.order).to receive(:create_tax_charge!) line_item.quantity = 2 line_item.save end end context '#destroy' do # Regression test for Spree #1481 it "applies tax adjustments" do expect(line_item.order).to receive(:create_tax_charge!) line_item.destroy end it "fetches deleted products" do line_item.product.destroy expect(line_item.reload.product).to be_a Spree::Product end it "fetches deleted variants" do line_item.variant.destroy expect(line_item.reload.variant).to be_a Spree::Variant end end # Test for Spree #3391 context '#copy_price' do it "copies over a variant's prices" do line_item.price = nil line_item.currency = nil line_item.copy_price variant = line_item.variant expect(line_item.price).to eq variant.price expect(line_item.currency).to eq variant.currency end end # Test for Spree #3481 context '#copy_tax_category' do it "copies over a variant's tax category" do line_item.tax_category = nil line_item.copy_tax_category expect(line_item.tax_category).to eq line_item.variant.tax_category end end describe '.currency' do it 'returns the globally configured currency' do line_item.currency == 'USD' end end describe ".money" do before do line_item.price = 3.50 line_item.quantity = 2 end it "returns a Spree::Money representing the total for this line item" do expect(line_item.money.to_s).to eq "$7.00" end end describe '.single_money' do before { line_item.price = 3.50 } it "returns a Spree::Money representing the price for one variant" do expect(line_item.single_money.to_s).to eq "$3.50" end end context "has inventory (completed order so items were already unstocked)" do let(:order) { Spree::Order.create } let(:variant) { create(:variant) } context "nothing left on stock" do before do variant.stock_items.update_all count_on_hand: 5, backorderable: false order.contents.add(variant, 5) order.create_proposed_shipments order.finalize! end it "allows to decrease item quantity" do line_item = order.line_items.first line_item.quantity -= 1 line_item.target_shipment = order.shipments.first line_item.save expect(line_item.errors[:quantity]).to be_empty end it "doesnt allow to increase item quantity" do line_item = order.line_items.first line_item.quantity += 2 line_item.target_shipment = order.shipments.first line_item.save expect(line_item.errors[:quantity].first).to include "is out of stock" end end context "2 items left on stock" do before do variant.stock_items.update_all count_on_hand: 7, backorderable: false order.contents.add(variant, 5) order.create_proposed_shipments order.finalize! end it "allows to increase quantity up to stock availability" do line_item = order.line_items.first line_item.quantity += 2 line_item.target_shipment = order.shipments.first line_item.save expect(line_item.errors[:quantity]).to be_empty end it "doesnt allow to increase quantity over stock availability" do line_item = order.line_items.first line_item.quantity += 3 line_item.target_shipment = order.shipments.first line_item.save expect(line_item.errors[:quantity].first).to include "is out of stock" end end end describe "scopes" do let(:o) { create(:order) } let(:s1) { create(:supplier_enterprise) } let(:s2) { create(:supplier_enterprise) } let(:variant1) { create(:variant, supplier: s1) } let(:variant2) { create(:variant, supplier: s2) } let(:li1) { create(:line_item, order: o, variant: variant1) } let(:li2) { create(:line_item, order: o, variant: variant2) } let(:p3) { create(:product, name: 'Clear Honey') } let(:p4) { create(:product, name: 'Apricots') } let(:v1) { create(:variant, product: p3, unit_value: 500) } let(:v2) { create(:variant, product: p3, unit_value: 250) } let(:v3) { create(:variant, product: p4, unit_value: 500, display_name: "ZZ") } let(:v4) { create(:variant, product: p4, unit_value: 500, display_name: "aa") } let(:li3) { create(:line_item, order: o, product: p3, variant: v1) } let(:li4) { create(:line_item, order: o, product: p3, variant: v2) } let(:li5) { create(:line_item, order: o, product: p4, variant: v3) } let(:li6) { create(:line_item, order: o, product: p4, variant: v4) } let(:oc_order) { create :order_with_totals_and_distribution } it "finds line items for products supplied by one of a number of enterprises" do li1; li2 expect(described_class.supplied_by_any([s1])).to eq([li1]) expect(described_class.supplied_by_any([s2])).to eq([li2]) expect(described_class.supplied_by_any([s1, s2])).to match_array [li1, li2] end describe "finding line items with and without tax" do let(:tax_rate) { create(:tax_rate, calculator: Calculator::DefaultTax.new) } let!(:adjustment1) { create(:adjustment, originator: tax_rate, label: "TR", amount: 123, included_tax: 10.00) } before do li1 li2.reload li1.adjustments << adjustment1 end it "finds line items with tax" do expect(described_class.with_tax.to_a).to eq([li1]) end it "finds line items without tax" do expect(described_class.without_tax).to eq([li2]) end end describe "#sorted_by_name_and_unit_value" do it "finds line items sorted by name and unit_value" do expect(o.line_items.sorted_by_name_and_unit_value).to eq([li6, li5, li4, li3]) end it "includes soft-deleted products/variants" do li3.variant.product.destroy expect(o.line_items.reload.sorted_by_name_and_unit_value).to eq([li6, li5, li4, li3]) expect(o.line_items.sorted_by_name_and_unit_value.to_sql).not_to match "deleted_at" end end it "finds line items from a given order cycle" do expect(described_class.from_order_cycle(oc_order.order_cycle).first.id) .to eq oc_order.line_items.first.id end end describe "capping quantity at stock level" do let!(:v) { create(:variant, on_demand: false, on_hand: 10) } let!(:li) { create(:line_item, variant: v, quantity: 10, max_quantity: 10) } before do v.update! on_hand: 5 end it "caps quantity" do li.cap_quantity_at_stock! expect(li.reload.quantity).to eq 5 end it "does not cap max_quantity" do li.cap_quantity_at_stock! expect(li.reload.max_quantity).to eq 10 end it "works for products without max_quantity" do li.update_column :max_quantity, nil li.cap_quantity_at_stock! li.reload expect(li.quantity).to eq 5 expect(li.max_quantity).to be nil end it "does nothing for on_demand items" do v.update! on_demand: true li.cap_quantity_at_stock! li.reload expect(li.quantity).to eq 10 expect(li.max_quantity).to eq 10 end it "caps at zero when stock is negative" do v.__send__(:stock_item).update_column(:count_on_hand, -2) li.cap_quantity_at_stock! expect(li.reload.quantity).to eq 0 end context "when a variant override is in place", feature: :inventory do let!(:hub) { create(:distributor_enterprise) } let!(:vo) { create(:variant_override, hub:, variant: v, count_on_hand: 2) } before do li.order.update(distributor_id: hub.id) # li#scoper is memoised, and this makes it difficult to update test conditions # so we reset it after the line_item is created for each spec li.remove_instance_variable(:@scoper) end it "caps quantity to override stock level" do li.cap_quantity_at_stock! expect(li.quantity).to eq 2 end end end describe "reducing stock levels on order completion" do context "when the item is on_demand" do let!(:hub) { create(:distributor_enterprise) } let(:bill_address) { create(:address) } let!(:variant_on_demand) { create(:variant, on_demand: true, on_hand: 1) } let!(:order) { create(:order, distributor: hub, order_cycle: create(:simple_order_cycle), bill_address:, ship_address: bill_address) } let!(:shipping_method) { create(:shipping_method, distributors: [hub]) } let!(:line_item) { create(:line_item, variant: variant_on_demand, quantity: 10, order:) } before do order.reload order.update_totals order.payments << create(:payment, amount: order.total) Orders::WorkflowService.new(order).complete! order.payment_state = 'paid' order.select_shipping_method(shipping_method.id) order.shipment.update!(order) end it "creates a shipment without backordered items" do expect(order.shipment.manifest.count).to eq 1 expect(order.shipment.manifest.first.quantity).to eq 10 expect(order.shipment.manifest.first.states).to eq 'on_hand' => 10 expect(order.shipment.manifest.first.variant).to eq line_item.variant end it "reduces the variant's stock level" do expect(variant_on_demand.reload.on_hand).to eq(-9) end it "does not mark inventory units as backorderd" do backordered_units = order.shipments.first.inventory_units.any?(&:backordered?) expect(backordered_units).to be false end it "does not mark the shipment as backorderd" do expect(order.shipments.first.backordered?).to be false end it "allows the order to be shipped" do expect(order.ready_to_ship?).to be true end it "does not change stock levels when cancelled" do order.cancel! expect(variant_on_demand.reload.on_hand).to eq 1 end end end describe "tracking stock when quantity is changed" do context "when the order is already complete" do let(:shop) { create(:distributor_enterprise) } let(:order) { create(:completed_order_with_totals, distributor: shop) } let!(:line_item) { order.reload.line_items.first } let!(:variant) { line_item.variant } context "when a variant override applies", feature: :inventory do let!(:vo) { create(:variant_override, hub: shop, variant:, count_on_hand: 3 ) } it "draws stock from the variant override" do expect(vo.reload.count_on_hand).to eq 3 expect{ line_item.update!(quantity: line_item.quantity + 1) } .not_to change{ Spree::Variant.find(variant.id).on_hand } expect(vo.reload.count_on_hand).to eq 2 end end context "when a variant override does not apply" do it "draws stock from the variant" do expect{ line_item.update!(quantity: line_item.quantity + 1) }.to change{ Spree::Variant.find(variant.id).on_hand }.by(-1) end end end end describe "tracking stock when a line item is destroyed" do context "when the order is already complete" do let(:shop) { create(:distributor_enterprise) } let(:order) { create(:completed_order_with_totals, distributor: shop) } let!(:line_item) { order.reload.line_items.first } let!(:variant) { line_item.variant } context "when a variant override applies", feature: :inventory do let!(:vo) { create(:variant_override, hub: shop, variant:, count_on_hand: 3 ) } it "restores stock to the variant override" do expect(vo.reload.count_on_hand).to eq 3 expect{ line_item.destroy }.not_to change{ Spree::Variant.find(variant.id).on_hand } expect(vo.reload.count_on_hand).to eq 4 end end context "when a variant override does not apply" do it "restores stock to the variant" do expect{ line_item.destroy }.to change{ Spree::Variant.find(variant.id).on_hand }.by(1) end end end end describe "determining if sufficient stock is present" do let!(:hub) { create(:distributor_enterprise) } let!(:o) { create(:order, distributor: hub) } let!(:v) { create(:variant, on_demand: false, on_hand: 10) } let!(:v_on_demand) { create(:variant, on_demand: true, on_hand: 1) } let(:li) { build_stubbed(:line_item, variant: v, order: o, quantity: 5, max_quantity: 5) } let(:li_on_demand) { build_stubbed(:line_item, variant: v_on_demand, order: o, quantity: 99, max_quantity: 99) } context "when the variant is on_demand" do it { expect(li_on_demand.sufficient_stock?).to be true } end context "when stock on the variant is sufficient" do it { expect(li.sufficient_stock?).to be true } end context "when the stock on the variant is not sufficient" do before { v.update(on_hand: 4) } context "when no variant override is in place" do it { expect(li.sufficient_stock?).to be false } end context "when a variant override is in place", feature: :inventory do let!(:vo) { create(:variant_override, hub:, variant: v, count_on_hand: 5) } context "and stock on the variant override is sufficient" do it { expect(li.sufficient_stock?).to be true } end context "and stock on the variant override is not sufficient" do before { vo.update(count_on_hand: 4) } it { expect(li.sufficient_stock?).to be false } end end end end describe "calculating price with adjustments" do it "does not return fractional cents" do li = described_class.new allow(li).to receive(:price) { 55.55 } allow(li).to receive_message_chain(:adjustments, :enterprise_fee, :sum) { 11.11 } allow(li).to receive(:quantity) { 2 } expect(li.price_with_adjustments).to eq(61.11) end end describe "calculating amount with adjustments" do it "returns a value consistent with price_with_adjustments" do li = described_class.new allow(li).to receive(:price) { 55.55 } allow(li).to receive_message_chain(:adjustments, :enterprise_fee, :sum) { 11.11 } allow(li).to receive(:quantity) { 2 } expect(li.amount_with_adjustments).to eq(122.22) end end describe "tax" do let(:li_no_tax) { create(:line_item) } let(:li_tax) { create(:line_item) } let(:tax_rate) { create(:tax_rate, calculator: Calculator::DefaultTax.new) } let!(:adjustment) { create(:adjustment, adjustable: li_tax, originator: tax_rate, label: "TR", amount: 10.00, included: true) } context "checking if a line item has tax included" do it "returns true when it does" do expect(li_tax).to have_tax end it "returns false otherwise" do expect(li_no_tax).not_to have_tax end end context "calculating the amount of included tax" do it "returns the included tax when present" do expect(li_tax.included_tax).to eq 10.00 end it "returns 0.00 otherwise" do expect(li_no_tax.included_tax).to eq 0.00 end end end describe "unit value/description" do describe "inheriting units" do let!(:p) { create(:product, variant_unit: "weight", variant_unit_scale: 1, unit_value: 1000 ) } let!(:v) { p.variants.first } let!(:o) { create(:order) } context "on create" do context "when no final_weight_volume is set" do let(:li) { build(:line_item, order: o, variant: v, quantity: 3) } it "initializes final_weight_volume from the variant's unit_value" do expect(li.final_weight_volume).to be nil li.save expect(li.final_weight_volume).to eq 3000 end end context "when a final_weight_volume has been set" do let(:li) { build(:line_item, order: o, variant: v, quantity: 3, final_weight_volume: 2000) } it "uses the changed value" do expect(li.final_weight_volume).to eq 2000 li.save expect(li.final_weight_volume).to eq 2000 end end end context "on save" do let!(:li) { create(:line_item, order: o, variant: v, quantity: 3) } before do expect(li.final_weight_volume).to eq 3000 end context "when final_weight_volume is changed" do let(:attrs) { { final_weight_volume: 2000 } } context "and quantity is not changed" do before do li.update(attrs) end it "uses the value given" do expect(li.final_weight_volume).to eq 2000 end end context "and quantity is changed" do before do attrs[:quantity] = 4 li.update(attrs) end it "uses the value given" do expect(li.final_weight_volume).to eq 2000 end end end context "when final_weight_volume is not changed" do let(:attrs) { { price: 3.00 } } context "and quantity is not changed" do before do li.update(attrs) end it "does not change final_weight_volume" do expect(li.final_weight_volume).to eq 3000 end end context "and quantity is changed" do context "from > 0" do context "and a final_weight_volume has been set" do before do expect(li.final_weight_volume).to eq 3000 attrs[:quantity] = 4 li.update(attrs) end it "scales the final_weight_volume based on the change in quantity" do expect(li.final_weight_volume).to eq 4000 end end context "and a final_weight_volume has not been set" do before do li.update(final_weight_volume: nil) attrs[:quantity] = 1 li.update(attrs) end it "calculates a final_weight_volume from the variants unit_value" do expect(li.final_weight_volume).to eq 1000 end end end context "from 0" do before { li.update(quantity: 0) } context "and a final_weight_volume has been set" do before do expect(li.final_weight_volume).to eq 0 attrs[:quantity] = 4 li.update(attrs) end it "recalculates a final_weight_volume from the variants unit_value" do expect(li.final_weight_volume).to eq 4000 end end context "and a final_weight_volume has not been set" do before do li.update(final_weight_volume: nil) attrs[:quantity] = 1 li.update(attrs) end it "calculates a final_weight_volume from the variants unit_value" do expect(li.final_weight_volume).to eq 1000 end end end end end end end describe "generating the full name" do let(:li) { described_class.new } context "when display_name is blank" do before do allow(li).to receive(:unit_to_display) { 'unit_to_display' } allow(li).to receive(:display_name) { '' } end it "returns unit_to_display" do expect(li.full_name).to eq('unit_to_display') end end context "when unit_to_display contains display_name" do before do allow(li).to receive(:unit_to_display) { '1kg Jar' } allow(li).to receive(:display_name) { '1kg' } end it "returns unit_to_display" do expect(li.full_name).to eq('1kg Jar') end end context "when display_name contains unit_to_display" do before do allow(li).to receive(:unit_to_display) { '10kg' } allow(li).to receive(:display_name) { '10kg Box' } end it "returns display_name" do expect(li.full_name).to eq('10kg Box') end end context "otherwise" do before do allow(li).to receive(:unit_to_display) { '1 Loaf' } allow(li).to receive(:display_name) { 'Spelt Sourdough' } end it "returns unit_to_display" do expect(li.full_name).to eq('Spelt Sourdough (1 Loaf)') end end end describe "generating the product and variant name" do let(:li) { described_class.new } let(:p) { double(:product, name: 'product') } before { allow(li).to receive(:product) { p } } context "when full_name starts with the product name" do before { allow(li).to receive(:full_name) { "#{p.name} - something" } } it "does not show the product name twice" do expect(li.product_and_full_name).to eq('product - something') end end context "when full_name does not start with the product name" do before { allow(li).to receive(:full_name) { "display_name (unit)" } } it "prepends the product name to the full name" do expect(li.product_and_full_name).to eq('product - display_name (unit)') end end end describe "getting name for display" do it "returns product name" do li = build_stubbed(:line_item) expect(li.name_to_display).to eq(li.product.name) end end describe "getting unit for display" do let(:o) { create(:order) } let(:p1) { create(:product, name: 'Clear Honey') } let(:v1) { create(:variant, product: p1, variant_unit_scale: 1, unit_value: 500) } let(:li1) { create(:line_item, order: o, product: p1, variant: v1) } let(:p2) { create(:product, name: 'Clear United States Honey') } let(:v2) { create(:variant, product: p2, variant_unit_scale: 453.6, unit_value: 453.6) } let(:li2) { create(:line_item, order: o, product: p2, variant: v2) } before do allow(Spree::Config).to receive(:available_units).and_return("g,lb,oz,kg,T,mL,L,kL") end it "returns options_text" do li = build_stubbed(:line_item) allow(li).to receive(:options_text).and_return "ponies" expect(li.unit_to_display).to eq("ponies") end it "returns options_text based on configured units" do expect(li1.options_text).to eq("500g") expect(li2.options_text).to eq("1lb") end end context "when the line_item has a final_weight_volume set" do let!(:p0) { create(:simple_product) } let!(:v) { create(:variant, product: p0, variant_unit: 'weight', variant_unit_scale: 1, unit_value: 10, unit_description: 'bar') } let!(:p) { create(:simple_product, variant_unit: 'weight', variant_unit_scale: 1) } let!(:li) { create(:line_item, product: p, final_weight_volume: 5) } it "assigns the new value" do expect(li.unit_presentation).to eq "5g" expect(v.unit_presentation).to eq "10g bar" allow(li).to receive(:unit_description) { 'foo' } li.update_attribute(:final_weight_volume, 10) expect(li.unit_presentation).to eq "10g foo" end end context "when the variant already has a value set" do let!(:p0) { create(:simple_product) } let!(:v) { create(:variant, product: p0, variant_unit: 'weight', variant_unit_scale: 1, unit_value: 10, unit_description: 'bar') } let!(:p) { create(:simple_product, variant_unit: 'weight', variant_unit_scale: 1) } let!(:li) { create(:line_item, product: p, final_weight_volume: 5) } it "assigns the new value" do expect(li.unit_presentation).to eq "5g" expect(v.unit_presentation).to eq "10g bar" allow(li).to receive(:unit_description) { 'bar' } li.update_attribute(:final_weight_volume, 10) expect(li.unit_presentation).to eq "10g bar" end end describe "calculating unit_value" do let(:v) { build_stubbed(:variant, unit_value: 10) } let(:li) { build_stubbed(:line_item, variant: v, quantity: 5) } context "when the quantity is greater than zero" do context "and final_weight_volume has not been changed" do it "returns the unit_value of the variant" do # Though note that this has been calculated # backwards from the final_weight_volume expect(li.unit_value).to eq 10 end end context "and final_weight_volume has been changed" do before { li.final_weight_volume = 35 } it "returns the unit_value of the variant" do expect(li.unit_value).to eq 7 end end context "and final_weight_volume is nil" do before { li.final_weight_volume = nil } it "returns the unit_value of the variant" do expect(li.unit_value).to eq 10 end end end context "when the quantity is zero" do before { li.quantity = 0 } it "returns the unit_value of the variant" do expect(li.unit_value).to eq 10 end end end end describe "when the associated variant is soft-deleted" do let!(:variant) { create(:variant) } let!(:line_item) { create(:line_item, variant:) } it "returns the associated variant or product" do line_item.variant.delete expect(line_item.variant).to eq variant expect(line_item.product).to eq variant.product end end end RSpec.describe "searching with ransack" do let(:order_cycle1) { create(:order_cycle) } let(:order_cycle2) { create(:order_cycle) } let(:variant1) { create(:variant, supplier: supplier1) } let(:variant2) { create(:variant, supplier: supplier2) } let(:supplier1) { create(:supplier_enterprise) } let(:supplier2) { create(:supplier_enterprise) } let!(:line_item1) { create(:line_item, variant: variant1) } let!(:line_item2) { create(:line_item, variant: variant2) } let(:search_result) { Spree::LineItem.ransack(query).result } before do line_item1.order.update_attribute :order_cycle, order_cycle1 line_item2.order.update_attribute :order_cycle, order_cycle2 end context "searching by supplier" do let(:query) { { supplier_id_eq: line_item1.variant.supplier_id } } it "filters results" do expect(search_result.to_a).to eq [line_item1] end end context "searching by order_cycle" do let(:query) { { order_cycle_id_eq: order_cycle1.id } } it "filters results" do expect(search_result.to_a).to eq [line_item1] end end end