Migrate FactoryBot helpers out of the TestingSupport module

solidusio · Feb 5, 2021 · 640d52d · 640d52d
1 parent 70aa414
commit 640d52d
Show file tree

Hide file tree

Showing 67 changed files with 197 additions and 160 deletions.
diff --git a/api/spec/spec_helper.rb b/api/spec/spec_helper.rb
@@ -26,7 +26,7 @@
 # in spec/support/ and its subdirectories.
 Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each { |f| require f }
 
-require 'spree/testing_support'
+require 'spree/testing_support/factory_bot'
 require 'spree/testing_support/partial_double_verification'
 require 'spree/testing_support/preferences'
 require 'spree/testing_support/authorization_helpers'
@@ -38,7 +38,7 @@
 
 ActiveJob::Base.queue_adapter = :test
 
-Spree::TestingSupport.load_all_factories
+Spree::TestingSupport::FactoryBot.add_paths_and_load!
 
 RSpec.configure do |config|
   config.backtrace_exclusion_patterns = [/gems\/activesupport/, /gems\/actionpack/, /gems\/rspec/]

diff --git a/backend/spec/spec_helper.rb b/backend/spec/spec_helper.rb
@@ -27,7 +27,7 @@
 require 'database_cleaner'
 require 'with_model'
 
-require 'spree/testing_support'
+require 'spree/testing_support/factory_bot'
 require 'spree/testing_support/partial_double_verification'
 require 'spree/testing_support/authorization_helpers'
 require 'spree/testing_support/preferences'
@@ -63,7 +63,7 @@
 
 ActiveJob::Base.queue_adapter = :test
 
-Spree::TestingSupport.load_all_factories
+Spree::TestingSupport::FactoryBot.add_paths_and_load!
 
 RSpec.configure do |config|
   config.color = true

diff --git a/core/lib/spree/core/engine.rb b/core/lib/spree/core/engine.rb
@@ -70,10 +70,10 @@ class Engine < ::Rails::Engine
       end
 
       if defined?(FactoryBotRails)
-        initializer after: "factory_bot.set_factory_paths" do
-          require "spree/testing_support"
-          Spree::TestingSupport.check_factory_bot_version
-          FactoryBot.definition_file_paths.unshift(*Spree::TestingSupport.factory_bot_paths)
+        initializer "spree.factory_bot.set_factory_paths", after: "factory_bot.set_factory_paths" do
+          require "spree/testing_support/factory_bot"
+          Spree::TestingSupport::FactoryBot.check_factory_bot_version
+          FactoryBot.definition_file_paths.unshift(*Spree::TestingSupport::FactoryBot.definition_file_paths)
         end
       end
     end

diff --git a/core/lib/spree/testing_support.rb b/core/lib/spree/testing_support.rb
@@ -1,43 +1,31 @@
 # frozen_string_literal: true
 
+require 'spree/testing_support/factory_bot'
+
 module Spree
   module TestingSupport
-    SEQUENCES = ["#{::Spree::Core::Engine.root}/lib/spree/testing_support/sequences.rb"]
-    FACTORIES = Dir["#{::Spree::Core::Engine.root}/lib/spree/testing_support/factories/**/*_factory.rb"]
-
-    def self.factory_bot_paths
-      @paths ||= (SEQUENCES + FACTORIES).sort.map { |path| path.sub(/.rb\z/, '') }
-    end
+    autoload :FactoryBot, "spree/testing_support/factory_bot"
 
-    def self.deprecate_cherry_picking_factory_bot_files
-      # All good if the factory is being loaded by FactoryBot.
-      return if caller.find { |line| line.include? "/factory_bot/find_definitions.rb" }
+    autoload :SEQUENCES, "spree/testing_support/factory_bot"
+    autoload :FACTORIES, "spree/testing_support/factory_bot"
 
-      Spree::Deprecation.warn(
-        "Please do not cherry-pick factories, this is not well supported by FactoryBot. " \
-        'Use `require "spree/testing_support/factories"` instead.', caller(2)
-      )
+    def factory_bot_paths
+      Spree::TestingSupport::FactoryBot.definition_file_paths
     end
 
-    def self.check_factory_bot_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
+    def check_factory_bot_version
+      Spree::TestingSupport::FactoryBot.check_version
     end
 
-    def self.load_all_factories
-      require 'factory_bot'
-
-      FactoryBot.definition_file_paths.unshift(*factory_bot_paths).uniq!
-      FactoryBot.reload
+    def load_all_factories
+      Spree::TestingSupport::FactoryBot.add_paths_and_load!
     end
+
+    deprecate(
+      factory_bot_paths: "Spree::TestingSupport::FactoryBot.definition_file_paths",
+      check_factory_bot_version: "Spree::TestingSupport::FactoryBot.check_version",
+      load_all_factories: "Spree::TestingSupport::FactoryBot.add_paths_and_load!",
+      deprecator: Spree::Deprecator
+    )
   end
 end
diff --git a/core/lib/spree/testing_support/factories.rb b/core/lib/spree/testing_support/factories.rb
@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
+require 'spree/testing_support/factory_bot'
 
 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.check_factory_bot_version
-Spree::TestingSupport.load_all_factories
+Spree::TestingSupport::FactoryBot.check_factory_bot_version
+Spree::TestingSupport::FactoryBot::PATHS.each { |path| require path }
diff --git a/core/lib/spree/testing_support/factories/address_factory.rb b/core/lib/spree/testing_support/factories/address_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :address, class: 'Spree::Address' do

diff --git a/core/lib/spree/testing_support/factories/adjustment_factory.rb b/core/lib/spree/testing_support/factories/adjustment_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :adjustment, class: 'Spree::Adjustment' do

diff --git a/core/lib/spree/testing_support/factories/adjustment_reason_factory.rb b/core/lib/spree/testing_support/factories/adjustment_reason_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :adjustment_reason, class: 'Spree::AdjustmentReason' do

diff --git a/core/lib/spree/testing_support/factories/calculator_factory.rb b/core/lib/spree/testing_support/factories/calculator_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :calculator, aliases: [:flat_rate_calculator], class: 'Spree::Calculator::FlatRate' do

diff --git a/core/lib/spree/testing_support/factories/carton_factory.rb b/core/lib/spree/testing_support/factories/carton_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :carton, class: 'Spree::Carton' do

diff --git a/core/lib/spree/testing_support/factories/country_factory.rb b/core/lib/spree/testing_support/factories/country_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 require 'carmen'
 

diff --git a/core/lib/spree/testing_support/factories/credit_card_factory.rb b/core/lib/spree/testing_support/factories/credit_card_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :credit_card, class: 'Spree::CreditCard' do

diff --git a/core/lib/spree/testing_support/factories/customer_return_factory.rb b/core/lib/spree/testing_support/factories/customer_return_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :customer_return, class: 'Spree::CustomerReturn' do

diff --git a/core/lib/spree/testing_support/factories/image_factory.rb b/core/lib/spree/testing_support/factories/image_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :image, class: 'Spree::Image' do

diff --git a/core/lib/spree/testing_support/factories/inventory_unit_factory.rb b/core/lib/spree/testing_support/factories/inventory_unit_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :inventory_unit, class: 'Spree::InventoryUnit' do

diff --git a/core/lib/spree/testing_support/factories/line_item_factory.rb b/core/lib/spree/testing_support/factories/line_item_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :line_item, class: 'Spree::LineItem' do

diff --git a/core/lib/spree/testing_support/factories/option_type_factory.rb b/core/lib/spree/testing_support/factories/option_type_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :option_type, class: 'Spree::OptionType' do

diff --git a/core/lib/spree/testing_support/factories/option_value_factory.rb b/core/lib/spree/testing_support/factories/option_value_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :option_value, class: 'Spree::OptionValue' do

diff --git a/core/lib/spree/testing_support/factories/order_factory.rb b/core/lib/spree/testing_support/factories/order_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :order, class: 'Spree::Order' do

diff --git a/core/lib/spree/testing_support/factories/order_promotion_factory.rb b/core/lib/spree/testing_support/factories/order_promotion_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :order_promotion, class: 'Spree::OrderPromotion' do

diff --git a/core/lib/spree/testing_support/factories/payment_factory.rb b/core/lib/spree/testing_support/factories/payment_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :payment, aliases: [:credit_card_payment], class: 'Spree::Payment' do

diff --git a/core/lib/spree/testing_support/factories/payment_method_factory.rb b/core/lib/spree/testing_support/factories/payment_method_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :payment_method, aliases: [:credit_card_payment_method], class: 'Spree::PaymentMethod::BogusCreditCard' do

diff --git a/core/lib/spree/testing_support/factories/price_factory.rb b/core/lib/spree/testing_support/factories/price_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :price, class: 'Spree::Price' do

diff --git a/core/lib/spree/testing_support/factories/product_factory.rb b/core/lib/spree/testing_support/factories/product_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :base_product, class: 'Spree::Product' do

diff --git a/core/lib/spree/testing_support/factories/product_option_type_factory.rb b/core/lib/spree/testing_support/factories/product_option_type_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :product_option_type, class: 'Spree::ProductOptionType' do

diff --git a/core/lib/spree/testing_support/factories/product_property_factory.rb b/core/lib/spree/testing_support/factories/product_property_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :product_property, class: 'Spree::ProductProperty' do

diff --git a/core/lib/spree/testing_support/factories/promotion_category_factory.rb b/core/lib/spree/testing_support/factories/promotion_category_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :promotion_category, class: 'Spree::PromotionCategory' do

diff --git a/core/lib/spree/testing_support/factories/promotion_code_factory.rb b/core/lib/spree/testing_support/factories/promotion_code_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :promotion_code, class: 'Spree::PromotionCode' do

diff --git a/core/lib/spree/testing_support/factories/promotion_factory.rb b/core/lib/spree/testing_support/factories/promotion_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :promotion, class: 'Spree::Promotion' do

diff --git a/core/lib/spree/testing_support/factories/property_factory.rb b/core/lib/spree/testing_support/factories/property_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :property, class: 'Spree::Property' do

diff --git a/core/lib/spree/testing_support/factories/refund_factory.rb b/core/lib/spree/testing_support/factories/refund_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   sequence(:refund_transaction_id) { |n| "fake-refund-transaction-#{n}" }

diff --git a/core/lib/spree/testing_support/factories/refund_reason_factory.rb b/core/lib/spree/testing_support/factories/refund_reason_factory.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support'
-Spree::TestingSupport.deprecate_cherry_picking_factory_bot_files
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
 
 FactoryBot.define do
   factory :refund_reason, class: 'Spree::RefundReason' do