openfoodnetwork/spec/models/spree/variant_spec.rb

# frozen_string_literal: false

require 'spec_helper'
require 'spree/localized_number'

describe Spree::Variant do
  subject(:variant) { build(:variant) }

  it { is_expected.to have_many :semantic_links }

  context "validations" do
    it "should validate price is greater than 0" do
      variant.price = -1
      expect(variant).to be_invalid
    end

    it "should validate price is 0" do
      variant.price = 0
      expect(variant).to be_valid
    end

    it "should validate unit_value is greater than 0" do
      variant.unit_value = 0
      expect(variant).to be_invalid
    end

    describe "tax category" do
      # `build_stubbed` avoids creating a tax category in the database.
      subject(:variant) { build_stubbed(:variant) }

      it "is valid when empty by default" do
        expect(variant.tax_category).to eq nil
        expect(variant).to be_valid
      end

      it "loads the default tax category" do
        default = create(:tax_category, is_default: true)

        expect(variant.tax_category).to eq default
        expect {
          variant.tax_category = nil
        }.not_to change {
          variant.tax_category
        }
        expect(variant).to be_valid
      end

      it "doesn't load any tax category" do
        non_default = create(:tax_category, is_default: false)
        expect(variant.tax_category).to eq nil
      end

      context "when a tax category is required" do
        before { Spree::Config.products_require_tax_category = true }

        it { is_expected.to validate_presence_of :tax_category }
      end
    end
  end

  context "price parsing" do
    before(:each) do
      I18n.locale = I18n.default_locale
      I18n.backend.store_translations(:de,
                                      { number: { currency: { format: { delimiter: '.',
                                                                        separator: ',' } } } })
    end

    after do
      I18n.locale = I18n.default_locale
    end

    context "price=" do
      context "with decimal point" do
        it "captures the proper amount for a formatted price" do
          variant.price = '1,599.99'
          expect(variant.price).to eq 1599.99
        end
      end

      context "with decimal comma" do
        it "captures the proper amount for a formatted price" do
          I18n.locale = :es
          variant.price = '1.599,99'
          expect(variant.price).to eq 1599.99
        end
      end

      context "with a numeric price" do
        it "uses the price as is" do
          I18n.locale = :es
          variant.price = 1599.99
          expect(variant.price).to eq 1599.99
        end
      end
    end
  end

  context "#currency" do
    it "returns the globally configured currency" do
      variant.save!
      expect(variant.currency).to eq Spree::Config[:currency]
    end
  end

  context "#display_amount" do
    it "returns a Spree::Money" do
      variant.price = 21.22
      expect(variant.display_amount.to_s).to eq "$21.22"
    end
  end

  context "#cost_currency" do
    context "when cost currency is nil" do
      before { variant.cost_currency = nil }

      it "populates cost currency with the default value on save" do
        variant.save!
        expect(variant.cost_currency).to eq Spree::Config[:currency]
      end
    end
  end

  describe '.price_in' do
    before do
      variant.prices << create(:price, variant:, currency: "EUR", amount: 33.33)
    end
    subject { variant.price_in(currency).display_amount }

    context "when currency is not specified" do
      let(:currency) { nil }

      it "returns 0" do
        expect(subject.to_s).to eq "$0.00"
      end
    end

    context "when currency is EUR" do
      let(:currency) { 'EUR' }

      it "returns the value in EUR" do
        expect(subject.to_s).to eq "€33.33"
      end
    end

    context "when currency is AUD" do
      let(:currency) { 'AUD' }

      it "returns the value in AUD" do
        expect(subject.to_s).to eq "$19.99"
      end
    end
  end

  describe '.amount_in' do
    before do
      variant.prices << create(:price, variant:, currency: "EUR", amount: 33.33)
    end

    subject { variant.amount_in(currency) }

    context "when currency is not specified" do
      let(:currency) { nil }

      it "returns nil" do
        expect(subject).to be_nil
      end
    end

    context "when currency is EUR" do
      let(:currency) { 'EUR' }

      it "returns the value in EUR" do
        expect(subject).to eq 33.33
      end
    end

    context "when currency is AUD" do
      let(:currency) { 'AUD' }

      it "returns the value in AUD" do
        expect(subject).to eq 19.99
      end
    end
  end

  describe '#in_stock?' do
    # Stock data can only be stored against a persisted variant.
    subject(:variant) { create(:variant) }

    context 'when stock_items are not backorderable' do
      before do
        allow_any_instance_of(Spree::StockItem).to receive_messages(backorderable: false)
      end

      context 'when stock_items in stock' do
        before do
          allow_any_instance_of(Spree::StockItem).to receive_messages(count_on_hand: 10)
        end

        it 'returns true if stock_items in stock' do
          expect(variant.in_stock?).to be_truthy
        end
      end

      context 'when stock_items out of stock' do
        before do
          allow_any_instance_of(Spree::StockItem).to receive_messages(backorderable: false)
          allow_any_instance_of(Spree::Stock::Quantifier).to receive_messages(total_on_hand: 0)
        end

        it 'return false if stock_items out of stock' do
          expect(variant.in_stock?).to be_falsy
        end
      end

      context 'when providing quantity param' do
        before do
          variant.stock_items.first.update_attribute(:count_on_hand, 10)
        end

        it 'returns correct value' do
          expect(variant.in_stock?).to be_truthy
          expect(variant.in_stock?(2)).to be_truthy
          expect(variant.in_stock?(10)).to be_truthy
          expect(variant.in_stock?(11)).to be_falsy
        end
      end
    end

    context 'when stock_items are backorderable' do
      before do
        allow_any_instance_of(Spree::StockItem).to receive_messages(backorderable?: true)
      end

      context 'when stock_items out of stock' do
        before do
          allow_any_instance_of(Spree::StockItem).to receive_messages(count_on_hand: 0)
        end

        it 'returns true if stock_items in stock' do
          expect(variant.in_stock?).to be_truthy
        end
      end
    end
  end

  describe '#total_on_hand' do
    it 'matches quantifier total_on_hand' do
      variant = build(:variant)
      expect(variant.total_on_hand).to eq(Spree::Stock::Quantifier.new(variant).total_on_hand)
    end
  end

  describe "scopes" do
    describe "finding variants in a distributor" do
      let!(:d1) { create(:distributor_enterprise) }
      let!(:d2) { create(:distributor_enterprise) }
      let!(:p1) { create(:simple_product) }
      let!(:p2) { create(:simple_product) }
      let!(:oc1) { create(:simple_order_cycle, distributors: [d1], variants: [p1.variants.first]) }
      let!(:oc2) { create(:simple_order_cycle, distributors: [d2], variants: [p2.variants.first]) }

      it "shows variants in an order cycle distribution" do
        expect(Spree::Variant.in_distributor(d1)).to eq([p1.variants.first])
      end

      it "doesn't show duplicates" do
        oc_dup = create(:simple_order_cycle, distributors: [d1], variants: [p1.variants.first])
        expect(Spree::Variant.in_distributor(d1)).to eq([p1.variants.first])
      end
    end

    describe "finding variants in an order cycle" do
      let!(:d1) { create(:distributor_enterprise) }
      let!(:d2) { create(:distributor_enterprise) }
      let!(:p1) { create(:product) }
      let!(:p2) { create(:product) }
      let!(:oc1) { create(:simple_order_cycle, distributors: [d1], variants: [p1.variants.first]) }
      let!(:oc2) { create(:simple_order_cycle, distributors: [d2], variants: [p2.variants.first]) }

      it "shows variants in an order cycle" do
        expect(Spree::Variant.in_order_cycle(oc1)).to eq([p1.variants.first])
      end

      it "doesn't show duplicates" do
        ex = create(:exchange, order_cycle: oc1, sender: oc1.coordinator, receiver: d2)
        ex.variants << p1.variants.first

        expect(Spree::Variant.in_order_cycle(oc1)).to eq([p1.variants.first])
      end
    end

    describe "finding variants for an order cycle and hub" do
      let(:oc) { create(:simple_order_cycle) }
      let(:s) { create(:supplier_enterprise) }
      let(:d1) { create(:distributor_enterprise) }
      let(:d2) { create(:distributor_enterprise) }

      let(:p1) { create(:simple_product) }
      let(:p2) { create(:simple_product) }
      let(:v1) { create(:variant, product: p1) }
      let(:v2) { create(:variant, product: p2) }

      let(:p_external) { create(:simple_product) }
      let(:v_external) { create(:variant, product: p_external) }

      let!(:ex_in) {
        create(:exchange, order_cycle: oc, sender: s, receiver: oc.coordinator,
                          incoming: true, variants: [v1, v2])
      }
      let!(:ex_out1) {
        create(:exchange, order_cycle: oc, sender: oc.coordinator, receiver: d1,
                          incoming: false, variants: [v1])
      }
      let!(:ex_out2) {
        create(:exchange, order_cycle: oc, sender: oc.coordinator, receiver: d2,
                          incoming: false, variants: [v2])
      }

      it "returns variants in the order cycle and distributor" do
        expect(p1.variants.for_distribution(oc, d1)).to eq([v1])
        expect(p2.variants.for_distribution(oc, d2)).to eq([v2])
      end

      it "does not return variants in the order cycle but not the distributor" do
        expect(p1.variants.for_distribution(oc, d2)).to be_empty
        expect(p2.variants.for_distribution(oc, d1)).to be_empty
      end

      it "does not return variants not in the order cycle" do
        expect(p_external.variants.for_distribution(oc, d1)).to be_empty
      end
    end

    describe "finding variants based on visiblity in inventory" do
      let(:enterprise) { create(:distributor_enterprise) }
      let!(:new_variant) { create(:variant) }
      let!(:hidden_variant) { create(:variant) }
      let!(:visible_variant) { create(:variant) }

      let!(:hidden_inventory_item) {
        create(:inventory_item, enterprise:, variant: hidden_variant, visible: false )
      }
      let!(:visible_inventory_item) {
        create(:inventory_item, enterprise:, variant: visible_variant, visible: true )
      }

      context "finding variants that are not hidden from an enterprise's inventory" do
        context "when the enterprise given is nil" do
          let!(:variants) { Spree::Variant.not_hidden_for(nil) }

          it "returns an empty list" do
            expect(variants).to eq []
          end
        end

        context "when an enterprise is given" do
          let!(:variants) { Spree::Variant.not_hidden_for(enterprise) }

          it "lists any variants that are not listed as visible=false" do
            expect(variants).to include new_variant, visible_variant
            expect(variants).not_to include hidden_variant
          end

          context "when inventory items exist for other enterprises" do
            let(:other_enterprise) { create(:distributor_enterprise) }

            let!(:new_inventory_item) {
              create(:inventory_item, enterprise: other_enterprise, variant: new_variant,
                                      visible: true )
            }
            let!(:hidden_inventory_item2) {
              create(:inventory_item, enterprise: other_enterprise, variant: visible_variant,
                                      visible: false )
            }
            let!(:visible_inventory_item2) {
              create(:inventory_item, enterprise: other_enterprise, variant: hidden_variant,
                                      visible: true )
            }

            it "lists any variants not listed as visible=false only for the relevant enterprise" do
              expect(variants).to include new_variant, visible_variant
              expect(variants).not_to include hidden_variant
            end
          end
        end
      end

      context "finding variants that are visible in an enterprise's inventory" do
        let!(:variants) { Spree::Variant.visible_for(enterprise) }

        it "lists any variants that are listed as visible=true" do
          expect(variants).to include visible_variant
          expect(variants).not_to include new_variant, hidden_variant
        end
      end
    end

    describe 'stockable_by' do
      let(:shop) { create(:distributor_enterprise) }
      let(:add_to_oc_producer) { create(:supplier_enterprise) }
      let(:other_producer) { create(:supplier_enterprise) }
      let!(:v1) { create(:variant, product: create(:simple_product, supplier: shop ) ) }
      let!(:v2) {
        create(:variant, product: create(:simple_product, supplier: add_to_oc_producer ) )
      }
      let!(:v3) { create(:variant, product: create(:simple_product, supplier: other_producer ) ) }

      before do
        create(:enterprise_relationship, parent: add_to_oc_producer, child: shop,
                                         permissions_list: [:add_to_order_cycle])
        create(:enterprise_relationship, parent: other_producer, child: shop,
                                         permissions_list: [:manage_products])
      end

      it 'shows variants produced by the enterprise and any producers granting P-OC' do
        stockable_variants = Spree::Variant.stockable_by(shop)
        expect(stockable_variants).to include v1, v2
        expect(stockable_variants).not_to include v3
      end
    end
  end

  describe "indexing variants by id" do
    let!(:v1) { create(:variant) }
    let!(:v2) { create(:variant) }
    let!(:v3) { create(:variant) }

    it "indexes variants by id" do
      expect(Spree::Variant.where(id: [v1, v2, v3]).indexed).to eq(
        v1.id => v1, v2.id => v2, v3.id => v3
      )
    end
  end

  describe "generating the product and variant name" do
    let(:product) { variant.product }

    context "when full_name starts with the product name" do
      before do
        product.name = "Apple"
        variant.display_as = "Apple Pink Lady"
      end

      it "does not show the product name twice" do
        expect(variant.product_and_full_name).to eq "Apple Pink Lady"
      end
    end

    context "when full_name does not start with the product name" do
      before do
        product.name = "Apple"
        variant.display_as = "Pink Lady"
      end

      it "prepends the product name to the full name" do
        expect(variant.product_and_full_name).to eq "Apple - Pink Lady"
      end
    end

    context "handling nil values for related naming attributes" do
      it "returns empty string or product name" do
        product.name = "Apple"
        product.variant_unit = "items"
        product.display_as = nil
        variant.display_as = nil
        variant.display_name = nil

        expect(variant.full_name).to eq ""
        expect(variant.product_and_full_name).to eq product.name
      end

      it "uses the display name correctly" do
        product.name = "Apple"
        product.variant_unit = "items"
        product.display_as = nil
        variant.display_as = nil
        variant.unit_presentation = nil
        variant.display_name = "Green"

        expect(variant.full_name).to eq "Green"
        expect(variant.product_and_full_name).to eq "Apple - Green"
      end
    end
  end

  describe "calculating the price with enterprise fees" do
    it "returns the price plus the fees" do
      distributor = double(:distributor)
      order_cycle = double(:order_cycle)

      variant = Spree::Variant.new price: 100
      expect(variant).to receive(:fees_for).with(distributor, order_cycle) { 23 }
      expect(variant.price_with_fees(distributor, order_cycle)).to eq(123)
    end
  end

  describe "calculating the fees" do
    it "delegates to EnterpriseFeeCalculator" do
      distributor = double(:distributor)
      order_cycle = double(:order_cycle)
      variant = Spree::Variant.new

      expect_any_instance_of(OpenFoodNetwork::EnterpriseFeeCalculator)
        .to receive(:fees_for).with(variant) { 23 }

      expect(variant.fees_for(distributor, order_cycle)).to eq(23)
    end
  end

  describe "calculating fees broken down by fee type" do
    it "delegates to EnterpriseFeeCalculator" do
      distributor = double(:distributor)
      order_cycle = double(:order_cycle)
      variant = Spree::Variant.new
      fees = double(:fees)

      expect_any_instance_of(OpenFoodNetwork::EnterpriseFeeCalculator)
        .to receive(:fees_by_type_for).with(variant) { fees }

      expect(variant.fees_by_type_for(distributor, order_cycle)).to eq(fees)
    end
  end

  context "when the product has variants" do
    let!(:product) { create(:simple_product) }
    let!(:variant) { create(:variant, product:) }

    %w(weight volume).each do |unit|
      context "when the product's unit is #{unit}" do
        before do
          product.update_attribute :variant_unit, unit
          product.reload
        end

        it "is valid when unit value is set and unit description is not" do
          variant.unit_value = 1
          variant.unit_description = nil
          expect(variant).to be_valid
        end

        it "is invalid when unit value is not set" do
          variant.unit_value = nil
          expect(variant).not_to be_valid
        end
      end
    end

    context "when the product's unit is items" do
      before do
        product.update_attribute :variant_unit, 'items'
        product.reload
        variant.reload
      end

      it "is valid with only unit value set" do
        variant.unit_value = 1
        variant.unit_description = nil
        expect(variant).to be_valid
      end

      it "is valid with only unit description set" do
        variant.unit_value = nil
        variant.unit_description = 'Medium'
        expect(variant).to be_valid
      end

      it "sets unit_value to 1.0 before validation if it's nil" do
        variant.unit_value = nil
        variant.unit_description = nil
        expect(variant).to be_valid
        expect(variant.unit_value).to eq 1.0
      end
    end

    context "when the product's unit is non-weight" do
      before do
        product.update_attribute :variant_unit, 'volume'
        product.reload
        variant.reload
      end

      it "sets weight to decimal before save if it's integer" do
        variant.weight = 1
        variant.save!
        expect(variant.weight).to eq 1.0
      end

      it "sets weight to 0.0 before save if it's nil" do
        variant.weight = nil
        variant.save!
        expect(variant.weight).to eq 0.0
      end

      it "sets weight to 0.0 if input is a non numerical string" do
        variant.weight = "BANANAS!"
        variant.save!
        expect(variant.weight).to eq 0.0
      end

      it "sets weight to correct decimal value if input is numerical string" do
        variant.weight = "2"
        variant.save!
        expect(variant.weight).to eq 2.0
      end
    end
  end

  describe "unit value/description" do
    let(:v) { Spree::Variant.new(unit_presentation: "small" ) }

    describe "generating the full name" do
      it "returns unit_to_display when display_name is blank" do
        v.display_name = ""
        expect(v.full_name).to eq("small")
      end

      it "returns display_name when it contains unit_to_display" do
        v.display_name = "a small apple"
        expect(v.full_name).to eq "a small apple"
      end

      it "returns unit_to_display when it contains display_name" do
        v.display_name = "small"
        v.unit_presentation = "small size"
        expect(v.full_name).to eq "small size"
      end

      it "returns a combination otherwise" do
        v.display_name = "apple"
        expect(v.full_name).to eq "apple (small)"
      end

      it "is resilient to regex chars" do
        v.display_name = ")))"
        v.unit_presentation = ")))"
        expect(v.full_name).to eq(")))")
      end
    end

    describe "getting name for display" do
      it "returns display_name if present" do
        v.display_name = "foo"
        expect(v.name_to_display).to eq("foo")
      end

      it "returns product name if display_name is empty" do
        v.product = Spree::Product.new(name: "Apple")
        v.display_name = nil
        expect(v.name_to_display).to eq "Apple"

        v.display_name = ""
        expect(v.name_to_display).to eq "Apple"
      end
    end

    describe "getting unit for display" do
      it "returns display_as if present" do
        v.display_as = "foo"
        expect(v.unit_to_display).to eq("foo")
      end

      it "returns options_text if display_as is blank" do
        v.display_as = nil
        expect(v.unit_to_display).to eq("small")

        v.display_as = ""
        expect(v.unit_to_display).to eq("small")
      end
    end

    describe "setting the variant's weight from the unit value" do
      it "sets the variant's weight when unit is weight" do
        p = create(:simple_product, variant_unit: 'volume')
        v = create(:variant, product: p, weight: 0)

        p.update! variant_unit: 'weight', variant_unit_scale: 1
        v.update! unit_value: 10, unit_description: 'foo'

        expect(v.reload.weight).to eq(0.01)
      end

      it "does nothing when unit is not weight" do
        p = create(:simple_product, variant_unit: 'volume')
        v = create(:variant, product: p, weight: 123)

        p.update! variant_unit: 'volume', variant_unit_scale: 1
        v.update! unit_value: 10, unit_description: 'foo'

        expect(v.reload.weight).to eq(123)
      end

      it "does nothing when unit_value is not set" do
        p = create(:simple_product, variant_unit: 'volume')
        v = create(:variant, product: p, weight: 123)

        p.update! variant_unit: 'weight', variant_unit_scale: 1

        # Although invalid, this calls the before_validation callback, which would
        # error if not handling unit_value == nil case
        expect(v.update(unit_value: nil, unit_description: 'foo')).to be false

        expect(v.reload.weight).to eq(123)
      end
    end

    context "when the variant already has a value set" do
      let!(:p) { create(:simple_product, variant_unit: 'weight', variant_unit_scale: 1) }
      let!(:v) { create(:variant, product: p, unit_value: 5, unit_description: 'bar') }

      it "assigns the new option value" do
        expect(v.unit_presentation).to eq "5g bar"

        v.update!(unit_value: 10, unit_description: 'foo')

        expect(v.unit_presentation).to eq "10g foo"
      end
    end

    context "when the variant does not have a display_as value set" do
      let!(:p) { create(:simple_product, variant_unit: 'weight', variant_unit_scale: 1) }
      let!(:v) {
        create(:variant, product: p, unit_value: 5, unit_description: 'bar', display_as: '')
      }

      it "requests the new value from OptionValueName" do
        expect_any_instance_of(VariantUnits::OptionValueNamer)
          .to receive(:name).exactly(1).times.and_call_original
        v.update(unit_value: 10, unit_description: 'foo')
        expect(v.unit_presentation).to eq "10g foo"
      end
    end

    context "when the variant has a display_as value set" do
      let!(:p) { create(:simple_product, variant_unit: 'weight', variant_unit_scale: 1) }
      let!(:v) {
        create(:variant, product: p, unit_value: 5, unit_description: 'bar', display_as: 'FOOS!')
      }

      it "does not request the new value from OptionValueName" do
        expect_any_instance_of(VariantUnits::OptionValueNamer).not_to receive(:name)
        v.update!(unit_value: 10, unit_description: 'foo')
        expect(v.unit_presentation).to eq("FOOS!")
      end
    end
  end

  context "extends LocalizedNumber" do
    subject! { build_stubbed(:variant) }

    it_behaves_like "a model using the LocalizedNumber module", [:price, :weight]
  end

  context "in a circular order cycle setup" do
    let(:enterprise1) { create(:distributor_enterprise, is_primary_producer: true) }
    let(:enterprise2) { create(:distributor_enterprise, is_primary_producer: true) }
    let(:variant1) { create(:variant) }
    let(:variant2) { create(:variant) }
    let!(:order_cycle) do
      enterprise1.supplied_products << variant1.product
      enterprise2.supplied_products << variant2.product
      create(
        :simple_order_cycle,
        coordinator: enterprise1,
        suppliers: [enterprise1, enterprise2],
        distributors: [enterprise1, enterprise2],
        variants: [variant1, variant2]
      )
    end

    it "saves without infinite loop" do
      expect(variant1.update(price: 1)).to be_truthy
    end
  end

  describe "destruction" do
    it "destroys exchange variants" do
      v = create(:variant)
      e = create(:exchange, variants: [v])

      v.destroy
      expect(e.reload.variant_ids).to be_empty
    end
  end

  describe "#ensure_unit_value" do
    let(:product) { create(:product, variant_unit: "weight") }
    let(:variant) { create(:variant, product_id: product.id) }

    context "when a product's variant_unit value is changed from weight to items" do
      it "sets the variant's unit_value to 1" do
        product.update(variant_unit: "items")

        expect(variant.unit_value).to eq 1
      end
    end

    context "trying to set an invalid unit_value" do
      it "does not allow NaN" do
        variant.update(unit_value: Float::NAN)

        expect(variant.reload.unit_value).to eq(1.0)
      end
    end
  end

  describe "#default_price" do
    let(:variant) { create(:variant) }
    let(:default_price) { variant.default_price }

    context "when the default price is soft-deleted" do
      it "can access the default price" do
        price_id = default_price.id

        default_price.destroy

        expect(variant.reload.default_price).to be_a Spree::Price
        expect(variant.default_price.id).to eq price_id
      end
    end
  end
end