solidus_core 2.8.6 → 2.9.0.rc.1

data/spec/lib/spree/event_spec.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'spree/event'
+
+RSpec.describe Spree::Event do
+  let(:subscription_name) { 'foo_bar' }
+  let(:item) { spy('object') }
+  let(:notifier) { ActiveSupport::Notifications.notifier }
+
+  subject { described_class }
+
+  it 'has default adapter' do
+    expect(subject.adapter).to eql Spree::Event::Adapters::ActiveSupportNotifications
+  end
+
+  before do
+    # ActiveSupport::Notifications does not provide an interface to clean all
+    # subscribers at once, so some low level brittle code is required
+    @old_subscribers = notifier.instance_variable_get('@subscribers').dup
+    @old_listeners = notifier.instance_variable_get('@listeners_for').dup
+    notifier.instance_variable_get('@subscribers').clear
+    notifier.instance_variable_get('@listeners_for').clear
+  end
+
+  after do
+    notifier.instance_variable_set '@subscribers', @old_subscribers
+    notifier.instance_variable_set '@listeners_for', @old_listeners
+  end
+
+  context 'with the default adapter' do
+    describe '#listeners' do
+      context 'when there is no subscription' do
+        it { expect(subject.listeners).to be_empty }
+
+        context 'after adding a subscription' do
+          before do
+            Spree::Event.subscribe(subscription_name) { item.do_something }
+          end
+
+          it 'includes the new subscription with custom suffix' do
+            expect(subject.listeners).to be_present
+            subscription_listeners = subject.listeners["#{subscription_name}.spree"]
+            expect(subscription_listeners).to be_a Array
+            expect(subscription_listeners.first).to be_a ActiveSupport::Notifications::Fanout::Subscribers::Timed
+          end
+        end
+      end
+    end
+
+    context 'subscriptions' do
+      describe '#subscribe' do
+        it 'can subscribe to events' do
+          Spree::Event.subscribe(subscription_name) { item.do_something }
+          Spree::Event.fire subscription_name
+          expect(item).to have_received :do_something
+        end
+      end
+
+      describe '#unsubscribe' do
+        context 'when unsubscribing using a subscription object as reference' do
+          let!(:subscription) { Spree::Event.subscribe(subscription_name) { item.do_something } }
+
+          before do
+            Spree::Event.subscribe(subscription_name) { item.do_something_else }
+          end
+
+          it 'can unsubscribe from single event by object' do
+            subject.unsubscribe subscription
+            Spree::Event.fire subscription_name
+            expect(item).not_to have_received :do_something
+            expect(item).to have_received :do_something_else
+          end
+        end
+
+        context 'when unsubscribing using a string as reference' do
+          before do
+            Spree::Event.subscribe(subscription_name) { item.do_something }
+            Spree::Event.subscribe(subscription_name) { item.do_something_else }
+          end
+
+          it 'can unsubscribe from multiple events with the same name' do
+            subject.unsubscribe subscription_name
+            Spree::Event.fire subscription_name
+            expect(item).not_to have_received :do_something
+            expect(item).not_to have_received :do_something_else
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/spree/money_spec.rb

@@ -4,9 +4,7 @@ require 'rails_helper'
 
 RSpec.describe Spree::Money do
   before do
-    configure_spree_preferences do |config|
-      config.currency = "USD"
-    end
+    stub_spree_preferences(currency: "USD")
   end
 
   describe '#initialize' do
@@ -155,9 +153,7 @@ RSpec.describe Spree::Money do
 
   context "JPY" do
     before do
-      configure_spree_preferences do |config|
-        config.currency = "JPY"
-      end
+      stub_spree_preferences(currency: "JPY")
     end
 
     it "formats correctly" do
@@ -168,9 +164,7 @@ RSpec.describe Spree::Money do
 
   context "EUR" do
     before do
-      configure_spree_preferences do |config|
-        config.currency = "EUR"
-      end
+      stub_spree_preferences(currency: "EUR")
     end
 
     # Regression test for https://github.com/spree/spree/issues/2634

data/spec/lib/tasks/migrations/migrate_shipping_rate_taxes_spec.rb

@@ -11,9 +11,11 @@ RSpec.describe 'solidus:migrations:migrate_shipping_rate_taxes' do
     )
 
     it 'runs' do
-      expect { task.invoke }.to output(
-        "Adding persisted tax notes to historic shipping rates ... Success.\n"
-      ).to_stdout
+      Spree::Deprecation.silence do
+        expect { task.invoke }.to output(
+          "Adding persisted tax notes to historic shipping rates ... Success.\n"
+        ).to_stdout
+      end
     end
   end
 end

data/spec/mailers/order_mailer_spec.rb

@@ -109,7 +109,7 @@ RSpec.describe Spree::OrderMailer, type: :mailer do
 
   context "with preference :send_core_emails set to false" do
     it "sends no email" do
-      Spree::Config.send_core_emails = false
+      stub_spree_preferences(send_core_emails: false)
       message = Spree::OrderMailer.confirm_email(order)
       expect(message.body).to be_blank
     end

data/spec/mailers/test_mailer_spec.rb

@@ -6,6 +6,8 @@ RSpec.describe Spree::TestMailer, type: :mailer do
   let(:user) { create(:user) }
 
   it "confirm_email accepts a user id as an alternative to a User object" do
-    Spree::TestMailer.test_email('test@example.com')
+    Spree::Deprecation.silence do
+      Spree::TestMailer.test_email('test@example.com')
+    end
   end
 end

data/spec/models/spree/address_spec.rb

@@ -28,8 +28,9 @@ RSpec.describe Spree::Address, type: :model do
 
     context 'address does not require state' do
       before do
-        Spree::Config.address_requires_state = false
+        stub_spree_preferences(address_requires_state: false)
       end
+
       it "address_requires_state preference is false" do
         address.state = nil
         address.state_name = nil
@@ -39,7 +40,7 @@ RSpec.describe Spree::Address, type: :model do
 
     context 'address requires state' do
       before do
-        Spree::Config.address_requires_state = true
+        stub_spree_preferences(address_requires_state: true)
       end
 
       it "state_name is not nil and country does not have any states" do
@@ -145,7 +146,7 @@ RSpec.describe Spree::Address, type: :model do
 
       context 'has a default country' do
         before do
-          Spree::Config[:default_country_iso] = default_country.iso
+          stub_spree_preferences(default_country_iso: default_country.iso)
         end
 
         it "sets up a new record with Spree::Config[:default_country_iso]" do
@@ -155,7 +156,7 @@ RSpec.describe Spree::Address, type: :model do
 
       # Regression test for https://github.com/spree/spree/issues/1142
       it "raises ActiveRecord::RecordNotFound if :default_country_iso is set to an invalid value" do
-        Spree::Config[:default_country_iso] = "00"
+        stub_spree_preferences(default_country_iso: "00")
         expect {
           Spree::Address.build_default.country
         }.to raise_error(ActiveRecord::RecordNotFound)

data/spec/models/spree/concerns/user_address_book_spec.rb

@@ -256,7 +256,7 @@ module Spree
 
       context "when automatic_default_address preference is at a default of true" do
         before do
-          Spree::Config.automatic_default_address = true
+          stub_spree_preferences(automatic_default_address: true)
           expect(user).to receive(:save_in_address_book).with(kind_of(Hash), true)
           expect(user).to receive(:save_in_address_book).with(kind_of(Hash), false)
         end
@@ -269,7 +269,7 @@ module Spree
 
       context "when automatic_default_address preference is false" do
         before do
-          Spree::Config.automatic_default_address = false
+          stub_spree_preferences(automatic_default_address: false)
           expect(user).to receive(:save_in_address_book).with(kind_of(Hash), false).twice
           # and not the optional 2nd argument
         end
@@ -283,7 +283,7 @@ module Spree
       context "when address is nil" do
         context "when automatic_default_address preference is at a default of true" do
           before do
-            Spree::Config.automatic_default_address = true
+            stub_spree_preferences(automatic_default_address: true)
             expect(user).to receive(:save_in_address_book).with(kind_of(Hash), true).once
           end
 
@@ -305,7 +305,7 @@ module Spree
 
       context "when automatic_default_address preference is false" do
         before do
-          Spree::Config.automatic_default_address = false
+          stub_spree_preferences(automatic_default_address: false)
           expect(user).to receive(:save_in_address_book).with(kind_of(Hash), false).once
         end
 

data/spec/models/spree/country_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe Spree::Country, type: :model do
 
     context 'with the configuration setting an existing legacy default country ID' do
       before do
-        Spree::Config[:default_country_id] = 2
+        stub_spree_preferences(default_country_id: 2)
       end
 
       subject(:default_country) do
@@ -32,7 +32,7 @@ RSpec.describe Spree::Country, type: :model do
 
     context 'with the configuration setting a non-existing legacy default country ID' do
       before do
-        Spree::Config[:default_country_id] = 0
+        stub_spree_preferences(default_country_id: 0)
       end
 
       subject(:default_country) do
@@ -52,7 +52,7 @@ RSpec.describe Spree::Country, type: :model do
     end
 
     context 'with the configuration setting an non-existing ISO code' do
-      before { Spree::Config[:default_country_iso] = "ZZ" }
+      before { stub_spree_preferences(default_country_iso: "ZZ") }
 
       it 'raises a Record not Found error' do
         expect { described_class.default }.to raise_error(ActiveRecord::RecordNotFound)
@@ -71,7 +71,7 @@ RSpec.describe Spree::Country, type: :model do
         let!(:checkout_zone) { create(:zone, name: 'Checkout Zone', countries: [united_states, canada]) }
 
         before do
-          Spree::Config.checkout_zone = checkout_zone.name
+          stub_spree_preferences(checkout_zone: checkout_zone.name)
         end
 
         context 'with no arguments' do
@@ -104,7 +104,7 @@ RSpec.describe Spree::Country, type: :model do
         let!(:checkout_zone) { create(:zone, name: 'Checkout Zone', states: [state]) }
 
         before do
-          Spree::Config[:checkout_zone] = checkout_zone.name
+          stub_spree_preferences(checkout_zone: checkout_zone.name)
         end
 
         context 'with no arguments' do

data/spec/models/spree/customer_return_spec.rb

@@ -189,7 +189,7 @@ RSpec.describe Spree::CustomerReturn, type: :model do
 
       context 'with Config.track_inventory_levels == false' do
         before do
-          Spree::Config.track_inventory_levels = false
+          stub_spree_preferences(track_inventory_levels: false)
           expect(Spree::StockItem).not_to receive(:find_by)
           expect(Spree::StockMovement).not_to receive(:create!)
         end

data/spec/models/spree/order/checkout_spec.rb

@@ -359,6 +359,7 @@ RSpec.describe Spree::Order, type: :model do
 
       before do
         user = create(:user, email: 'spree@example.org', bill_address: user_bill_address)
+        default_credit_card.update(user: user)
         wallet_payment_source = user.wallet.add(default_credit_card)
         user.wallet.default_wallet_payment_source = wallet_payment_source
         order.user = user
@@ -497,12 +498,7 @@ RSpec.describe Spree::Order, type: :model do
 
     context "with a payment in the pending state" do
       let(:order) { create :order_ready_to_complete }
-      let(:payment) { create :payment, state: "pending", amount: order.total }
-
-      before do
-        order.payments = [payment]
-        order.save!
-      end
+      let(:payment) { create :payment, order: order, state: "pending", amount: order.total }
 
       it "allows the order to complete" do
         expect { order.complete! }.
@@ -542,7 +538,7 @@ RSpec.describe Spree::Order, type: :model do
         order.user = FactoryBot.create(:user)
         order.store = FactoryBot.create(:store)
         order.email = 'spree@example.org'
-        order.payments << FactoryBot.create(:payment)
+        order.payments << FactoryBot.create(:payment, order: order)
 
         # make sure we will actually capture a payment
         allow(order).to receive_messages(payment_required?: true)

data/spec/models/spree/order/finalizing_spec.rb

@@ -44,7 +44,7 @@ RSpec.describe Spree::Order, type: :model do
     end
 
     it "should not send duplicate confirmation emails" do
-      allow(order).to receive_messages(confirmation_delivered?: true)
+      order.update(confirmation_delivered: true)
       expect(Spree::OrderMailer).not_to receive(:confirm_email)
       order.finalize!
     end

data/spec/models/spree/order/payment_spec.rb

@@ -12,7 +12,7 @@ module Spree
 
       before do
         # So that Payment#purchase! is called during processing
-        Spree::Config[:auto_capture] = true
+        stub_spree_preferences(auto_capture: true)
       end
 
       let(:payment_method) { create(:credit_card_payment_method) }
@@ -147,12 +147,12 @@ module Spree
         before { expect(payment).to receive(:process!).and_raise(Spree::Core::GatewayError) }
 
         it "should return true when configured to allow checkout on gateway failures" do
-          Spree::Config.set allow_checkout_on_gateway_error: true
+          stub_spree_preferences(allow_checkout_on_gateway_error: true)
           expect(order.process_payments!).to be true
         end
 
         it "should return false when not configured to allow checkout on gateway failures" do
-          Spree::Config.set allow_checkout_on_gateway_error: false
+          stub_spree_preferences(allow_checkout_on_gateway_error: false)
           expect(order.process_payments!).to be false
         end
       end

data/spec/models/spree/order_inventory_spec.rb

@@ -72,7 +72,7 @@ RSpec.describe Spree::OrderInventory, type: :model do
     context "store doesnt track inventory" do
       let(:new_quantity) { 1 }
 
-      before { Spree::Config.track_inventory_levels = false }
+      before { stub_spree_preferences(track_inventory_levels: false) }
 
       it "creates on hand inventory units" do
         variant.stock_items.each(&:really_destroy!)

data/spec/models/spree/order_spec.rb

@@ -15,6 +15,53 @@ RSpec.describe Spree::Order, type: :model do
   end
   let(:code) { promotion.codes.first }
 
+  describe '#finalize!' do
+    context 'with event notifications' do
+      it 'sends an email' do
+        expect(Spree::Config.order_mailer_class).to receive(:confirm_email).and_call_original
+        order.finalize!
+      end
+
+      it 'marks the order as confirmation_delivered' do
+        expect do
+          order.finalize!
+        end.to change(order, :confirmation_delivered).to true
+      end
+
+      # These specs show how notifications can be removed, one at a time or
+      # all the ones set by MailerProcessor module
+      context 'when removing the default email notification subscription' do
+        before do
+          Spree::Event.unsubscribe Spree::Event::Processors::MailerProcessor.order_finalized_handler
+        end
+
+        after do
+          Spree::Event::Processors::MailerProcessor.subscribe!
+        end
+
+        it 'does not send the email' do
+          expect(Spree::Config.order_mailer_class).not_to receive(:confirm_email)
+          order.finalize!
+        end
+      end
+
+      context 'when removing all the email notification subscriptions' do
+        before do
+          Spree::Event::Processors::MailerProcessor.unsubscribe!
+        end
+
+        after do
+          Spree::Event::Processors::MailerProcessor.subscribe!
+        end
+
+        it 'does not send the email' do
+          expect(Spree::Config.order_mailer_class).not_to receive(:confirm_email)
+          order.finalize!
+        end
+      end
+    end
+  end
+
   context '#store' do
     it { is_expected.to respond_to(:store) }
 
@@ -135,7 +182,6 @@ RSpec.describe Spree::Order, type: :model do
     before { allow(order).to receive_messages shipments: [shipment] }
 
     it "update and persist totals" do
-      expect(shipment).to receive :update_amounts
       expect(order.updater).to receive :update
 
       Spree::Deprecation.silence do
@@ -462,7 +508,7 @@ RSpec.describe Spree::Order, type: :model do
     let(:order) { build(:order, ship_address: ship_address, bill_address: bill_address, store: store) }
     let(:store) { build(:store) }
 
-    before { Spree::Config[:tax_using_ship_address] = tax_using_ship_address }
+    before { stub_spree_preferences(tax_using_ship_address: tax_using_ship_address) }
     subject { order.tax_address }
 
     context "when the order has no addresses" do
@@ -1470,6 +1516,25 @@ RSpec.describe Spree::Order, type: :model do
       end
     end
 
+    describe "#record_ip_address" do
+      let(:ip_address) { "127.0.0.1" }
+
+      subject { -> { order.record_ip_address(ip_address) } }
+
+      it "updates the last used IP address" do
+        expect(subject).to change(order, :last_ip_address).to(ip_address)
+      end
+
+      # IP address tracking should not raise validation exceptions
+      context "with an invalid order" do
+        before { allow(order).to receive(:valid?).and_return(false) }
+
+        it "updates the IP address" do
+          expect(subject).to change(order, :last_ip_address).to(ip_address)
+        end
+      end
+    end
+
     describe "#display_order_total_after_store_credit" do
       let(:order_total_after_store_credit) { 10.00 }