solidus_core 2.10.5 → 3.0.8

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

@@ -1,8 +1,14 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories/order_factory'
-require 'spree/testing_support/factories/stock_location_factory'
-require 'spree/testing_support/factories/shipping_method_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/factories/order_factory'
+  require 'spree/testing_support/factories/stock_location_factory'
+  require 'spree/testing_support/factories/shipping_method_factory'
+end
+
 
 FactoryBot.define do
   factory :shipment, class: 'Spree::Shipment' do

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+end
+
 FactoryBot.define do
   factory :shipping_category, class: 'Spree::ShippingCategory' do
     sequence(:name) { |n| "ShippingCategory ##{n}" }

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

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories/calculator_factory'
-require 'spree/testing_support/factories/shipping_category_factory'
-require 'spree/testing_support/factories/zone_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/factories/calculator_factory'
+  require 'spree/testing_support/factories/shipping_category_factory'
+  require 'spree/testing_support/factories/zone_factory'
+end
 
 FactoryBot.define do
   factory(

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

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories/shipping_method_factory'
-require 'spree/testing_support/factories/shipment_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/factories/shipping_method_factory'
+  require 'spree/testing_support/factories/shipment_factory'
+end
 
 FactoryBot.define do
   factory :shipping_rate, class: 'Spree::ShippingRate' do

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

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories/country_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/factories/country_factory'
+end
+
 
 FactoryBot.define do
   factory :state, class: 'Spree::State' do

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

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories/stock_location_factory'
-require 'spree/testing_support/factories/variant_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/factories/stock_location_factory'
+  require 'spree/testing_support/factories/variant_factory'
+end
 
 FactoryBot.define do
   factory :stock_item, class: 'Spree::StockItem' do

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

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories/country_factory'
-require 'spree/testing_support/factories/state_factory'
-require 'spree/testing_support/factories/product_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/factories/country_factory'
+  require 'spree/testing_support/factories/state_factory'
+  require 'spree/testing_support/factories/product_factory'
+end
 
 FactoryBot.define do
   factory :stock_location, class: 'Spree::StockLocation' do

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

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories/stock_item_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/factories/stock_item_factory'
+end
 
 FactoryBot.define do
   factory :stock_movement, class: 'Spree::StockMovement' do

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

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories/inventory_unit_factory'
-require 'spree/testing_support/factories/variant_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/factories/inventory_unit_factory'
+  require 'spree/testing_support/factories/variant_factory'
+end
 
 FactoryBot.define do
   factory :stock_package, class: 'Spree::Stock::Package' do

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

@@ -1,7 +1,20 @@
 # frozen_string_literal: true
 
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+end
+
 FactoryBot.define do
   factory :store_credit_category, class: 'Spree::StoreCreditCategory' do
     name { "Exchange" }
+
+    trait :reimbursement do
+      name { Spree::StoreCreditCategory::REIMBURSEMENT }
+    end
+
+    trait :gift_card do
+      name { Spree::StoreCreditCategory::GIFT_CARD }
+    end
   end
 end

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

@@ -1,13 +1,19 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories/store_credit_factory'
-require 'spree/testing_support/factories/store_credit_reason_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/factories/store_credit_factory'
+  require 'spree/testing_support/factories/store_credit_reason_factory'
+end
 
 FactoryBot.define do
   factory :store_credit_event, class: 'Spree::StoreCreditEvent' do
     store_credit
     amount             { 100.00 }
     authorization_code { "#{store_credit.id}-SC-20140602164814476128" }
+    action               { Spree::StoreCredit::AUTHORIZE_ACTION }
 
     factory :store_credit_auth_event, class: 'Spree::StoreCreditEvent' do
       action             { Spree::StoreCredit::AUTHORIZE_ACTION }

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

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories/store_credit_category_factory'
-require 'spree/testing_support/factories/store_credit_type_factory'
-require 'spree/testing_support/factories/user_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/factories/store_credit_category_factory'
+  require 'spree/testing_support/factories/store_credit_type_factory'
+  require 'spree/testing_support/factories/user_factory'
+end
 
 FactoryBot.define do
   factory :store_credit, class: 'Spree::StoreCredit' do

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

@@ -1,7 +1,14 @@
 # frozen_string_literal: true
 
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+end
+
 FactoryBot.define do
   factory :store_credit_reason, class: 'Spree::StoreCreditReason' do
-    name { "Input error" }
+    sequence :name do |n|
+      "Input error #{n}"
+    end
   end
 end

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+end
+
 FactoryBot.define do
   factory :primary_credit_type, class: 'Spree::StoreCreditType' do
     name      { Spree::StoreCreditType::DEFAULT_TYPE_NAME }

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

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+end
+
 FactoryBot.define do
   factory :store, class: 'Spree::Store' do
     sequence(:code) { |i| "spree_#{i}" }
     sequence(:name) { |i| "Spree Test Store #{i}" }
     sequence(:url) { |i| "www.example#{i}.com" }
-    mail_from_address { 'spree@example.org' }
+    mail_from_address { 'solidus@example.org' }
   end
 end

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

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/sequences'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/sequences'
+end
+
 
 FactoryBot.define do
   factory :tax_category, class: 'Spree::TaxCategory' do

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

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories/calculator_factory'
-require 'spree/testing_support/factories/tax_category_factory'
-require 'spree/testing_support/factories/zone_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/factories/calculator_factory'
+  require 'spree/testing_support/factories/tax_category_factory'
+  require 'spree/testing_support/factories/zone_factory'
+end
 
 FactoryBot.define do
   factory :tax_rate, class: 'Spree::TaxRate' do

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

@@ -1,11 +1,20 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories/taxonomy_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/factories/taxonomy_factory'
+end
 
 FactoryBot.define do
   factory :taxon, class: 'Spree::Taxon' do
     name { 'Ruby on Rails' }
     taxonomy
     parent_id { nil }
+
+    trait :with_icon do
+      icon { Spree::Core::Engine.root.join('lib', 'spree', 'testing_support', 'fixtures', 'blank.jpg').open }
+    end
   end
 end

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+end
+
 FactoryBot.define do
   factory :taxonomy, class: 'Spree::Taxonomy' do
     name { 'Brand' }

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

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/sequences'
-require 'spree/testing_support/factories/role_factory'
-require 'spree/testing_support/factories/address_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/sequences'
+  require 'spree/testing_support/factories/role_factory'
+  require 'spree/testing_support/factories/address_factory'
+end
 
 FactoryBot.define do
   factory :user, class: Spree::UserClassHandle.new do
@@ -16,6 +21,12 @@ FactoryBot.define do
       end
     end
 
+    trait :with_orders do
+      after(:create) do |user, _|
+        create(:order, user: user)
+      end
+    end
+
     factory :admin_user do
       after(:create) do |user, _|
         admin_role = Spree::Role.find_by(name: 'admin') || create(:role, name: 'admin')

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

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/sequences'
-require 'spree/testing_support/factories/option_value_factory'
-require 'spree/testing_support/factories/option_type_factory'
-require 'spree/testing_support/factories/product_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/sequences'
+  require 'spree/testing_support/factories/option_value_factory'
+  require 'spree/testing_support/factories/option_type_factory'
+  require 'spree/testing_support/factories/product_factory'
+end
 
 FactoryBot.define do
   sequence(:random_float) { BigDecimal("#{rand(200)}.#{rand(99)}") }

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

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories/option_value_factory'
-require 'spree/testing_support/factories/variant_property_rule_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/factories/option_value_factory'
+  require 'spree/testing_support/factories/variant_property_rule_factory'
+end
 
 FactoryBot.define do
   factory :variant_property_rule_condition, class: 'Spree::VariantPropertyRuleCondition' do

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

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories/product_factory'
-require 'spree/testing_support/factories/property_factory'
-require 'spree/testing_support/factories/option_value_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/factories/product_factory'
+  require 'spree/testing_support/factories/property_factory'
+  require 'spree/testing_support/factories/option_value_factory'
+end
 
 FactoryBot.define do
   factory :variant_property_rule, class: 'Spree::VariantPropertyRule' do

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

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factories/variant_property_rule_factory'
-require 'spree/testing_support/factories/property_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/factories/variant_property_rule_factory'
+  require 'spree/testing_support/factories/property_factory'
+end
 
 FactoryBot.define do
   factory :variant_property_rule_value, class: 'Spree::VariantPropertyRuleValue' do

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

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/sequences'
-require 'spree/testing_support/factories/country_factory'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+
+  require 'spree/testing_support/sequences'
+  require 'spree/testing_support/factories/country_factory'
+end
 
 FactoryBot.define do
   factory :global_zone, class: 'Spree::Zone' do
-    name { 'GlobalZone' }
+    initialize_with { Spree::Zone.find_or_initialize_by(name: 'GlobalZone') }
     zone_members do |proxy|
       zone = proxy.instance_eval { @instance }
       Spree::Country.all.map do |c|

data/lib/spree/testing_support/factories.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
-require 'factory_bot'
+require 'spree/testing_support/factory_bot'
 
-Dir["#{File.dirname(__FILE__)}/factories/**"].each do |f|
-  require File.expand_path(f)
-end
+Spree::Deprecation.warn(
+  "Please do not try to load factories directly. " \
+  'Use factory_bot_rails and rely on the default configuration instead.', caller(1)
+)
+
+Spree::TestingSupport::FactoryBot.check_version
+Spree::TestingSupport::FactoryBot::PATHS.each { |path| require path }

data/lib/spree/testing_support/factory_bot.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "factory_bot"
+begin
+  require "factory_bot_rails"
+rescue LoadError
+end
+
+module Spree
+  module TestingSupport
+    module FactoryBot
+      SEQUENCES = ["#{::Spree::Core::Engine.root}/lib/spree/testing_support/sequences.rb"]
+      FACTORIES = Dir["#{::Spree::Core::Engine.root}/lib/spree/testing_support/factories/**/*_factory.rb"].sort
+      PATHS = SEQUENCES + FACTORIES
+
+      def self.definition_file_paths
+        @paths ||= PATHS.map { |path| path.sub(/.rb\z/, '') }
+      end
+
+      def self.when_cherry_picked
+        callsites = caller
+
+        # All good if the factory is being loaded by FactoryBot or from `testing_support/factories.rb`.
+        return if callsites.find do |line|
+          line.include?("/factory_bot/find_definitions.rb") ||
+          line.include?("/spree/testing_support/factories.rb")
+        end
+
+        yield
+      end
+
+      def self.deprecate_cherry_picking
+        callsites = caller
+        core_root = Spree::Core::Engine.root.to_s
+        index = callsites.index { |line| !line.start_with? core_root }
+
+        Spree::Deprecation.warn(
+          "Please do not cherry-pick factories, this is not well supported by FactoryBot, " \
+          'follow the changelog instructions on how to migrate your current setup.',
+          callsites[index..-1]
+        )
+      end
+
+      def self.check_version
+        require "factory_bot/version"
+
+        requirement = Gem::Requirement.new("~> 4.8")
+        version = Gem::Version.new(::FactoryBot::VERSION)
+
+        unless requirement.satisfied_by? version
+          Spree::Deprecation.warn(
+            "Please be aware that the supported version of FactoryBot is #{requirement}, " \
+            "using version #{version} could lead to factory loading issues.", caller(2)
+          )
+        end
+      end
+
+      def self.add_definitions!
+        ::FactoryBot.definition_file_paths.unshift(*definition_file_paths).uniq!
+      end
+
+      def self.add_paths_and_load!
+        add_definitions!
+        ::FactoryBot.reload
+      end
+    end
+  end
+end

data/lib/spree/testing_support/fixtures/file.txt

@@ -0,0 +1 @@
+This is a text file

data/lib/spree/testing_support/job_helpers.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Spree
+  module TestingSupport
+    module JobHelpers
+      def perform_enqueued_jobs
+        adapter = ActiveJob::Base.queue_adapter
+
+        old = adapter.perform_enqueued_jobs
+        old_at = adapter.perform_enqueued_at_jobs
+
+        begin
+          adapter.perform_enqueued_jobs = true
+          adapter.perform_enqueued_at_jobs = true
+
+          yield
+        ensure
+          adapter.perform_enqueued_jobs = old
+          adapter.perform_enqueued_at_jobs = old_at
+        end
+      end
+    end
+  end
+end

data/lib/spree/testing_support/order_walkthrough.rb

@@ -9,22 +9,22 @@ module Spree
 
       def up_to(state)
         # Need to create a valid zone too...
-        @zone = FactoryBot.create(:zone)
-        @country = FactoryBot.create(:country)
-        @state = FactoryBot.create(:state, country: @country)
+        @zone = ::FactoryBot.create(:zone)
+        @country = ::FactoryBot.create(:country)
+        @state = ::FactoryBot.create(:state, country: @country)
 
         @zone.members << Spree::ZoneMember.create(zoneable: @country)
 
         # A shipping method must exist for rates to be displayed on checkout page
-        FactoryBot.create(:shipping_method, zones: [@zone]).tap do |sm|
+        ::FactoryBot.create(:shipping_method, zones: [@zone]).tap do |sm|
           sm.calculator.preferred_amount = 10
           sm.calculator.preferred_currency = Spree::Config[:currency]
           sm.calculator.save
         end
 
         order = Spree::Order.create!(
-          email: "spree@example.com",
-          store: Spree::Store.first || FactoryBot.create(:store)
+          email: "solidus@example.com",
+          store: Spree::Store.first || ::FactoryBot.create(:store)
         )
         add_line_item!(order)
         order.next!
@@ -46,13 +46,13 @@ module Spree
       private
 
       def add_line_item!(order)
-        FactoryBot.create(:line_item, order: order)
+        ::FactoryBot.create(:line_item, order: order)
         order.reload
       end
 
       def address(order)
-        order.bill_address = FactoryBot.create(:address, country: @country, state: @state)
-        order.ship_address = FactoryBot.create(:address, country: @country, state: @state)
+        order.bill_address = ::FactoryBot.create(:address, country: @country, state: @state)
+        order.ship_address = ::FactoryBot.create(:address, country: @country, state: @state)
         order.next!
       end
 
@@ -61,7 +61,7 @@ module Spree
       end
 
       def payment(order)
-        credit_card = FactoryBot.create(:credit_card)
+        credit_card = ::FactoryBot.create(:credit_card)
         order.payments.create!(payment_method: credit_card.payment_method, amount: order.total, source: credit_card)
         # TODO: maybe look at some way of making this payment_state change automatic
         order.payment_state = 'paid'
@@ -82,6 +82,3 @@ module Spree
     end
   end
 end
-
-# @private
-OrderWalkthrough = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('OrderWalkthrough', 'Spree::TestingSupport::OrderWalkthrough')

data/lib/spree/testing_support/precompiled_assets.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.when_first_matching_example_defined(type: :feature) do
+    config.before :suite do
+      Rails.application.precompiled_assets
+    end
+  end
+
+  config.when_first_matching_example_defined(type: :system) do
+    config.before :suite do
+      Rails.application.precompiled_assets
+    end
+  end
+end