solidus_core 2.8.6 → 2.9.0.rc.1

data/lib/spree/testing_support/capybara_ext.rb

@@ -12,6 +12,21 @@ module Spree
         fill_in field, options
       end
 
+      def fill_in_with_force(locator, with:)
+        if Capybara.current_driver == Capybara.javascript_driver
+          field_id = find_field(locator)[:id]
+          page.execute_script <<-JS
+            var field = document.getElementById('#{field_id}');
+            field.value = '#{with}';
+
+            var event = new Event('change', { bubbles: true });
+            field.dispatchEvent(event);
+          JS
+        else
+          fill_in locator, with: with
+        end
+      end
+
       def within_row(num, &block)
         within("table.index tbody tr:nth-of-type(#{num})", &block)
       end

data/lib/spree/testing_support/common_rake.rb

@@ -24,7 +24,7 @@ namespace :common do
     begin
       require "generators/#{ENV['LIB_NAME']}/install/install_generator"
       puts 'Running extension installation generator...'
-      "#{ENV['LIB_NAME'].camelize}::Generators::InstallGenerator".constantize.start(["--auto-run-migrations"])
+      "#{ENV['LIB_NAMESPACE'] || ENV['LIB_NAME'].camelize}::Generators::InstallGenerator".constantize.start(["--auto-run-migrations"])
     rescue LoadError
       # No extension generator to run
     end

data/lib/spree/testing_support/dummy_app.rb

@@ -12,14 +12,11 @@ Rails.env = 'test'
 
 require 'solidus_core'
 
-# @private
-def forgery_protected_by_default?
-  Gem::Version.new(Rails.version) >= Gem::Version.new('5.2')
-end
+RAILS_52_OR_ABOVE = Gem::Version.new(Rails.version) >= Gem::Version.new('5.2')
 
 # @private
 class ApplicationController < ActionController::Base
-  if !forgery_protected_by_default?
+  unless RAILS_52_OR_ABOVE
     protect_from_forgery with: :exception
   end
 end
@@ -65,12 +62,8 @@ module DummyApp
     config.active_support.deprecation                 = :stderr
     config.secret_key_base                            = 'SECRET_TOKEN'
 
-    if forgery_protected_by_default?
+    if RAILS_52_OR_ABOVE
       config.action_controller.default_protect_from_forgery = true
-    end
-
-    if config.active_record.sqlite3
-      # Rails >= 5.2
       config.active_record.sqlite3.represent_boolean_as_integer = true
     end
 

data/lib/spree/testing_support/factories/promotion_factory.rb

@@ -60,5 +60,15 @@ FactoryBot.define do
       end
     end
     factory :promotion_with_item_total_rule, traits: [:with_item_total_rule]
+    trait :with_first_order_rule do
+      after(:create) do |promotion, _evaluator|
+        rule = Spree::Promotion::Rules::FirstOrder.create!(
+          promotion: promotion,
+        )
+        promotion.rules << rule
+        promotion.save!
+      end
+    end
+    factory :promotion_with_first_order_rule, traits: [:with_first_order_rule]
   end
 end

data/lib/spree/testing_support/factories/return_item_factory.rb

@@ -6,6 +6,7 @@ require 'spree/testing_support/factories/return_authorization_factory'
 
 FactoryBot.define do
   factory :return_item, class: 'Spree::ReturnItem' do
+    skip_customer_return_processing { true }
     association(:inventory_unit, factory: :inventory_unit, state: :shipped)
     association(:return_reason, factory: :return_reason)
     return_authorization do |_return_item|

data/lib/spree/testing_support/preferences.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'spree/deprecation'
+
 module Spree
   module TestingSupport
     module Preferences
@@ -10,6 +12,7 @@ module Spree
       #   config.track_inventory_levels = false
       # end
       #
+      # @deprecated
       def reset_spree_preferences(&config_block)
         Spree::Config.instance_variables.each { |iv| Spree::Config.remove_instance_variable(iv) }
         Spree::Config.preference_store = Spree::Config.default_preferences
@@ -21,6 +24,8 @@ module Spree
         configure_spree_preferences(&config_block) if block_given?
       end
 
+      deprecate :reset_spree_preferences, deprecator: Spree::Deprecation
+
       def configure_spree_preferences
         yield(Spree::Config) if block_given?
       end
@@ -29,6 +34,63 @@ module Spree
         find("#preferences_#{preference}")['checked'].should be false
         Spree::Config[preference].should be false
       end
+
+      # This is the preferred way for changing temporarily Spree preferences during
+      # tests via stubs, without changing the actual values stored in Spree::Config.
+      #
+      # By using stubs no global preference change will leak outside the lifecycle
+      # of each spec example, avoiding possible unpredictable side effects.
+      #
+      # This method  may be used for stubbing one or more different preferences
+      # at the same time.
+      #
+      # @param [Hash] preferences names and values to be stubbed
+      #
+      # @example Stubs `currency` and `track_inventory_levels` preferences
+      #   stub_spree_preferences(currency: 'EUR', track_inventory_levels: false)
+      #   expect(Spree::Config.currency).to eql 'EUR'
+      #
+      # @see https://github.com/solidusio/solidus/issues/3219
+      #   Solidus #3219 for more details and motivations.
+      def stub_spree_preferences(preferences)
+        preferences.each do |name, value|
+          if Spree::Config.method(:[]).owner >= Spree::Config.class
+            allow(Spree::Config).to receive(:[]).and_call_original
+          end
+          allow(Spree::Config).to receive(:[]).with(name) { value }
+          allow(Spree::Config).to receive(name) { value }
+        end
+      end
+
+      # This method allows to temporarily switch to an unfrozen Spree::Config preference
+      # store with all proper preferences values set.
+      #
+      # It should be used sparingly, only when `stub_spree_preferences` would not work.
+      #
+      # @example Temporarily switch to an unfrozen store and change some preferences:
+      #   with_unfrozen_spree_preference_store do
+      #     Spree::Config.currency = 'EUR'
+      #     Spree::Config.track_inventory_levels = false
+      #
+      #     expect(Spree::Config.currency).to eql 'EUR'
+      #   end
+      # @see Spree::TestingSupport::Preferences#stub_spree_preferences
+      def with_unfrozen_spree_preference_store
+        frozen_store = Spree::Config.preference_store
+        Spree::Config.preference_store = Spree::Config[:unfrozen_preference_store].dup
+        yield
+      ensure
+        Spree::Config.preference_store = frozen_store
+      end
     end
   end
 end
+
+RSpec.configure do |config|
+  config.before :suite do
+    # keep a copy of the original unfrozen preference_store for later use:
+    Spree::AppConfiguration.preference :unfrozen_preference_store, :hash
+    Spree::Config.unfrozen_preference_store = Spree::Config.preference_store.dup
+    Spree::Config.preference_store.freeze
+  end
+end

data/lib/tasks/email.rake

@@ -3,6 +3,8 @@
 namespace :email do
   desc 'Sends test email to specified address - Example: EMAIL=spree@example.com bundle exec rake email:test'
   task test: :environment do
+    Spree::Deprecation.warn("rake email:test has been deprecated and will be removed with Solidus 3.0")
+
     raise ArgumentError, "Must pass EMAIL environment variable. Example: EMAIL=spree@example.com bundle exec rake email:test" unless ENV['EMAIL'].present?
     Spree::TestMailer.test_email(ENV['EMAIL']).deliver!
   end

data/lib/tasks/migrations/copy_order_bill_address_to_credit_card.rake

@@ -13,6 +13,8 @@ namespace 'spree:migrations:copy_order_bill_address_to_credit_card' do
   # This task should be safe to run multiple times.
 
   task up: :environment do
+    Spree::Deprecation.warn("rake spree:migrations:copy_order_bill_address_to_credit_card:up has been deprecated and will be removed with Solidus 3.0.")
+
     if Spree::CreditCard.connection.adapter_name =~ /postgres/i
       postgres_copy
     else
@@ -21,6 +23,8 @@ namespace 'spree:migrations:copy_order_bill_address_to_credit_card' do
   end
 
   task down: :environment do
+    Spree::Deprecation.warn("rake spree:migrations:copy_order_bill_address_to_credit_card:down has been deprecated and will be removed with Solidus 3.0.")
+
     Spree::CreditCard.update_all(address_id: nil)
   end
 

data/lib/tasks/migrations/migrate_shipping_rate_taxes.rake

@@ -4,6 +4,8 @@ namespace :solidus do
   namespace :migrations do
     namespace :migrate_shipping_rate_taxes do
       task up: :environment do
+        Spree::Deprecation.warn("rake spree:migrations:migrate_shipping_rate_taxes:up has been deprecated and will be removed with Solidus 3.0.")
+
         print "Adding persisted tax notes to historic shipping rates ... "
         Spree::ShippingRate.where.not(tax_rate_id: nil).find_each do |shipping_rate|
           tax_rate = Spree::TaxRate.unscoped.find(shipping_rate.tax_rate_id)

data/lib/tasks/migrations/migrate_user_addresses.rake

@@ -10,6 +10,8 @@ namespace 'spree:migrations:migrate_user_addresses' do
   # to the user's address book. This will catch up all the historical data.
 
   task up: :environment do
+    Spree::Deprecation.warn("rake spree:migrations:migrate_user_addresses:up has been deprecated and will be removed with Solidus 3.0.")
+
     Spree.user_class.find_each(batch_size: 500) do |user|
       ship_address = Spree::Address.find_by(id: user.ship_address_id)
       bill_address = Spree::Address.find_by(id: user.bill_address_id)
@@ -26,6 +28,7 @@ namespace 'spree:migrations:migrate_user_addresses' do
   end
 
   task down: :environment do
+    Spree::Deprecation.warn("rake spree:migrations:migrate_user_addresses:down has been deprecated and will be removed with Solidus 3.0.")
     Spree::UserAddress.delete_all
   end
 end

data/lib/tasks/migrations/rename_gateways.rake

@@ -4,6 +4,7 @@ require 'solidus/migrations/rename_gateways'
 
 namespace 'solidus:migrations:rename_gateways' do
   task up: :environment do
+    Spree::Deprecation.warn("rake solidus:migrations:rename_gateways:up has been deprecated and will be removed with Solidus 3.0.")
     count = Solidus::Migrations::RenameGateways.new.up
 
     unless ENV['VERBOSE'] == 'false' || !verbose
@@ -12,6 +13,7 @@ namespace 'solidus:migrations:rename_gateways' do
   end
 
   task down: :environment do
+    Spree::Deprecation.warn("rake solidus:migrations:rename_gateways:down has been deprecated and will be removed with Solidus 3.0.")
     count = Solidus::Migrations::RenameGateways.new.down
 
     unless ENV['VERBOSE'] == 'false' || !verbose

data/lib/tasks/order_capturing.rake

@@ -3,6 +3,8 @@
 namespace :order_capturing do
   desc "Looks for orders with inventory that is fully shipped/short-shipped, and captures money for it"
   task capture_payments: :environment do
+    Spree::Deprecation.warn("rake order_capturing:capture_payments has been deprecated and will be removed with Solidus 3.0.")
+
     failures = []
     orders = Spree::Order.complete.where(payment_state: 'balance_due').where('completed_at > ?', Spree::Config[:order_capturing_time_window].days.ago)
 

data/spec/helpers/base_helper_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe Spree::BaseHelper, type: :helper do
 
     context "with no checkout zone defined" do
       before do
-        Spree::Config[:checkout_zone] = nil
+        stub_spree_preferences(checkout_zone: nil)
       end
 
       it "return complete list of countries" do
@@ -33,7 +33,7 @@ RSpec.describe Spree::BaseHelper, type: :helper do
         before do
           @country_zone = create(:zone, name: "CountryZone")
           @country_zone.members.create(zoneable: country)
-          Spree::Config[:checkout_zone] = @country_zone.name
+          stub_spree_preferences(checkout_zone: @country_zone.name)
         end
 
         it "return only the countries defined by the checkout zone" do
@@ -50,7 +50,7 @@ RSpec.describe Spree::BaseHelper, type: :helper do
           state_zone = create(:zone, name: "StateZone")
           state = create(:state, country: country)
           state_zone.members.create(zoneable: state)
-          Spree::Config[:checkout_zone] = state_zone.name
+          stub_spree_preferences(checkout_zone: state_zone.name)
         end
 
         it "return complete list of countries" do

data/spec/helpers/products_helper_spec.rb

@@ -75,7 +75,7 @@ module Spree
       let(:variant_price) { 15 }
 
       before do
-        Spree::Config[:show_variant_full_price] = true
+        stub_spree_preferences(show_variant_full_price: true)
         variant
       end
 
@@ -148,7 +148,7 @@ THIS IS THE BEST PRODUCT EVER!
 
         product.description = description
 
-        Spree::Config[:show_raw_product_description] = true
+        stub_spree_preferences(show_raw_product_description: true)
         description = product_description(product)
         expect(description).to eq(description)
       end

data/spec/{models → lib}/spree/app_configuration_spec.rb

@@ -2,9 +2,15 @@
 
 require 'rails_helper'
 
-RSpec.describe Spree::AppConfiguration, type: :model do
+RSpec.describe Spree::AppConfiguration do
   let(:prefs) { Spree::Config }
 
+  around do |example|
+    with_unfrozen_spree_preference_store do
+      example.run
+    end
+  end
+
   it "should be available from the environment" do
     prefs.layout = "my/layout"
     expect(prefs.layout).to eq "my/layout"
@@ -52,4 +58,8 @@ RSpec.describe Spree::AppConfiguration, type: :model do
     expect(prefs.admin_vat_location.state_id).to eq(nil)
     expect(prefs.admin_vat_location.country_id).to eq(nil)
   end
+
+  it 'has default Event adapter' do
+    expect(prefs.events.adapter).to eq Spree::Event::Adapters::ActiveSupportNotifications
+  end
 end

data/spec/lib/spree/core/controller_helpers/pricing_spec.rb

@@ -77,5 +77,18 @@ RSpec.describe Spree::Core::ControllerHelpers::Pricing, type: :controller do
         it { is_expected.to be_nil }
       end
     end
+
+    context "from context" do
+      subject { controller.current_pricing_options }
+
+      let(:store) { FactoryBot.create :store, default_currency: 'USD' }
+
+      context "when the whole context is passed" do
+        it "receives the right object " do
+          expect(Spree::Config.pricing_options_class).to receive(:from_context).with(controller)
+          is_expected.to be_nil
+        end
+      end
+    end
   end
 end

data/spec/lib/spree/core/controller_helpers/strong_parameters_spec.rb

@@ -23,14 +23,7 @@ RSpec.describe Spree::Core::ControllerHelpers::StrongParameters, type: :controll
 
   describe '#permitted_checkout_attributes' do
     it 'returns Array class' do
-      Spree::Deprecation.silence do
-        expect(controller.permitted_checkout_attributes.class).to eq Spree::CheckoutAdditionalAttributes
-      end
-    end
-
-    it 'is deprecated' do
-      expect(Spree::Deprecation).to receive(:warn)
-      controller.permitted_checkout_attributes
+      expect(controller.permitted_checkout_attributes.class).to eq Array
     end
   end
 

data/spec/lib/spree/core/testing_support/factories/shipping_method_factory_spec.rb

@@ -17,7 +17,7 @@ RSpec.describe 'shipping method factory' do
     end
 
     context 'store using alternate currency' do
-      before { Spree::Config[:currency] = 'CAD' }
+      before { stub_spree_preferences(currency: 'CAD') }
 
       it "should configure the calculator correctly" do
         shipping_method = create(factory)

data/spec/lib/spree/core/testing_support/preferences_spec.rb

@@ -4,7 +4,16 @@ require 'rails_helper'
 
 RSpec.describe Spree::TestingSupport::Preferences do
   describe 'resetting the app configuration' do
+    around do |example|
+      with_unfrozen_spree_preference_store do
+        Spree::Deprecation.silence do
+          example.run
+        end
+      end
+    end
+
     before do
+      reset_spree_preferences
       @original_spree_mails_from = Spree::Config.mails_from
       @original_spree_searcher_class = Spree::Config.searcher_class
       class MySearcherClass; end
@@ -25,4 +34,28 @@ RSpec.describe Spree::TestingSupport::Preferences do
       expect(Spree::Config.searcher_class).to eq(@original_spree_searcher_class)
     end
   end
+
+  describe '#stub_spree_preferences' do
+    it 'stubs method calls but does not affect actual stored Spree::Config settings' do
+      stub_spree_preferences(currency: 'FOO')
+      expect(Spree::Config.currency).to eq 'FOO'
+      expect(Spree::Config.preference_store[:currency]).to eq 'USD'
+    end
+  end
+
+  describe '#with_unfrozen_spree_preference_store' do
+    it 'changes the original settings, but returns them to original values at exit' do
+      with_unfrozen_spree_preference_store do
+        Spree::Config.mails_from = 'override@example.com'
+        expect(Spree::Config.mails_from).to eq 'override@example.com'
+        expect(Spree::Config.preference_store[:mails_from]).to eq 'override@example.com'
+      end
+
+      # both the original frozen store and the unfrozen store are unaffected by changes above:
+      expect(Spree::Config.mails_from).to eq 'store@example.com'
+      with_unfrozen_spree_preference_store do
+        expect(Spree::Config.mails_from).to eq 'store@example.com'
+      end
+    end
+  end
 end

data/spec/lib/spree/event/subscriber_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'spree/event'
+
+RSpec.describe Spree::Event do
+  module M
+    include Spree::Event::Subscriber
+
+    event_action :event_name
+
+    def event_name(event)
+      # code that handles the event
+    end
+
+    def other_event(event)
+      # ...
+    end
+  end
+
+  describe '::subscribe!' do
+    before { M.unsubscribe! }
+
+    it 'adds new listeners to Spree::Event' do
+      expect { M.subscribe! }.to change { Spree::Event.listeners }
+    end
+
+    context 'when subscriptions are not registered' do
+      it 'does not trigger the event callback' do
+        expect(M).not_to receive(:event_name)
+        Spree::Event.fire 'event_name'
+      end
+    end
+
+    it 'subscribes event actions' do
+      M.subscribe!
+      expect(M).to receive(:event_name)
+      Spree::Event.fire 'event_name'
+    end
+
+    it 'does not subscribe event actions more than once' do
+      2.times { M.subscribe! }
+      expect(M).to receive(:event_name).once
+      Spree::Event.fire 'event_name'
+    end
+  end
+
+  describe '::unsubscribe' do
+    before { M.subscribe! }
+
+    it 'removes the subscription' do
+      expect(M).not_to receive(:event_name)
+      M.unsubscribe!
+      Spree::Event.fire 'event_name'
+    end
+  end
+
+  describe '::event_action' do
+    context 'when the action has not been declared' do
+      before { M.subscribe! }
+
+      it 'does not subscribe the action' do
+        expect(M).not_to receive(:other_event)
+        Spree::Event.fire 'other_event'
+      end
+    end
+
+    context 'when the action is declared' do
+      before do
+        M.event_action :other_event
+        M.subscribe!
+      end
+
+      after do
+        M.unsubscribe!
+        M.event_actions.delete(:other_event)
+      end
+
+      it 'subscribe the action' do
+        expect(M).to receive(:other_event)
+        Spree::Event.fire 'other_event'
+      end
+    end
+  end
+end