solidus_core 2.11.2 → 2.11.7

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

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,7 +1,12 @@
 # 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

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/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'

data/lib/spree/testing_support/sequences.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
-require 'factory_bot'
+require 'spree/testing_support/factory_bot'
+Spree::TestingSupport::FactoryBot.when_cherry_picked do
+  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
+end
 
 FactoryBot.define do
   sequence(:sku) { |n| "SKU-#{n}" }

data/lib/tasks/email.rake

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 namespace :email do
-  desc 'Sends test email to specified address - Example: EMAIL=spree@example.com bundle exec rake email:test'
+  desc 'Sends test email to specified address - Example: EMAIL=solidus@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?
+    raise ArgumentError, "Must pass EMAIL environment variable. Example: EMAIL=solidus@example.com bundle exec rake email:test" if ENV['EMAIL'].blank?
+
     Spree::TestMailer.test_email(ENV['EMAIL']).deliver!
   end
 end

data/lib/tasks/migrations/migrate_address_names.rake

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+namespace :solidus do
+  namespace :migrations do
+    namespace :migrate_address_names do
+      desc 'Backfills Spree::Address name attribute using firstname and lastname
+        concatenation in order to retain historical data when upgrading to new
+        address name format'
+      task up: :environment do
+        puts "Combining addresses' firstname and lastname into name ... "
+        class Spree::AddressForMigration < ApplicationRecord
+          self.table_name = 'spree_addresses'
+        end
+
+        records = Spree::AddressForMigration.unscoped.where(name: [nil, ''])
+        count = records.count
+        connection = ActiveRecord::Base.connection
+        adapter_name = connection.adapter_name.downcase
+        shell = Thor::Shell::Basic.new
+        puts "  Your DB contains #{count} addresses that may be affected by this task."
+        # `trim` is not needed for pg or mysql when using `concat_ws`:
+        # select concat_ws('joinstring', 'foo', null);
+        #  concat_ws
+        # -----------
+        #  foo
+        # (1 row)
+        # select concat_ws('joinstring', 'foo', null) = trim(concat_ws('joinstring', 'foo', null));
+        #  ?column?
+        # ----------
+        #  t
+        # (1 row)
+        unless count.zero?
+          concat_statement = begin
+            case adapter_name
+            when /sqlite/
+              "name = TRIM(COALESCE(firstname, '') || ' ' || COALESCE(lastname, ''))"
+            when /postgres/, /mysql2/
+              "name = CONCAT_WS(' ', firstname, lastname)"
+            else
+              abort "  No migration path available for adapter #{adapter_name}. Please write your own."
+            end
+          end
+
+          # The batch size should be limited to avoid locking the table records for too long. These are
+          # the numbers I got with 1_000_000 records in `spree_addresses`, all with different name and
+          # surname, with postgresql:
+          #
+          # Updating 1000000 records in one shot
+          # batch took 178 seconds
+          #
+          # Updating 1000000 addresses in batches of 200000
+          # batch took 36 seconds
+          # batch took 31 seconds
+          # batch took 31 seconds
+          # batch took 31 seconds
+          # batch took 30 seconds
+          #
+          # Updating 1000000 addresses in batches of 150000
+          # batch took 29 seconds
+          # batch took 27 seconds
+          # batch took 27 seconds
+          # batch took 27 seconds
+          # batch took 26 seconds
+          # batch took 26 seconds
+          # batch took 19 seconds
+          #
+          # Updating 1000000 addresses in batches of 100000
+          # batch took 17 seconds
+          # batch took 15 seconds
+          # batch took 17 seconds
+          # batch took 17 seconds
+          # batch took 17 seconds
+          # batch took 17 seconds
+          # batch took 17 seconds
+          # batch took 17 seconds
+          # batch took 17 seconds
+          # batch took 17 seconds
+          #
+          # This is with mysql:
+          # Updating 1000000 records in one shot
+          # batch updated in 153 seconds
+          #
+          # Updating 1000000 records in batches of 200000, this may take a while...
+          # batch took 41 seconds
+          # batch took 37 seconds
+          # batch took 35 seconds
+          # batch took 28 seconds
+          # batch took 27 seconds
+          #
+          # Updating 1000000 records in batches of 150000, this may take a while...
+          # batch took 30 seconds
+          # batch took 29 seconds
+          # batch took 18 seconds
+          # batch took 18 seconds
+          # batch took 17 seconds
+          # batch took 29 seconds
+          # batch took 12 seconds
+          #
+          # Updating 1000000 records in batches of 100000, this may take a while...
+          # batch took 10 seconds
+          # batch took 11 seconds
+          # batch took 12 seconds
+          # batch took 13 seconds
+          # batch took 12 seconds
+          # batch took 12 seconds
+          # batch took 14 seconds
+          # batch took 19 seconds
+          # batch took 20 seconds
+          # batch took 21 seconds
+          #
+          # Please note that the migration will be much faster when there's no index
+          # on the `name` column. For example, with mysql each batch takes exactly
+          # the same time:
+          #
+          # Updating 1000000 records in batches of 200000, this may take a while...
+          # batch took 17 seconds
+          # batch took 17 seconds
+          # batch took 17 seconds
+          # batch took 16 seconds
+          # batch took 17 seconds
+          #
+          # So, if special need arise, one can drop the index added with migration
+          # 20210122110141_add_name_to_spree_addresses.rb and add the index later,
+          # in non blocking ways. For postgresql:
+          # add_index(:spree_addresses, :name, algorithm: :concurrently)
+          #
+          # For mysql 5.6:
+          # sql = "ALTER TABLE spree_addresses ADD INDEX index_spree_addresses_on_name (name), ALGORITHM=INPLACE, LOCK=NONE;"
+          # ActiveRecord::Base.connection.execute sql
+          #
+          puts '  Data migration will happen in batches. The default value is 100_000, which should take less than 20 seconds on mysql or postgresql.'
+          size = shell.ask('  Please enter a different batch size, or press return to confirm the default: ')
+          size = (size.presence || 100_000).to_i
+
+          abort "  Invalid batch size number #{size}, please run the task again." unless size.positive?
+
+          batches_total = (count / size).ceil
+          puts "  We're going to migrate #{count} records in #{batches_total} batches of #{size}."
+
+          answer = shell.ask('  Do you want to proceed?', limited_to: ['Y', 'N'], case_insensitive: true)
+          if answer == 'Y'
+            puts "  Updating #{count} records in batches of #{size}, this may take a while..."
+
+            records.in_batches(of: size).each.with_index(1) do |batch, index|
+              now = Time.zone.now
+              batch.update_all(concat_statement)
+              puts "  Batch #{index}/#{batches_total} done in #{(Time.zone.now - now).to_i} seconds."
+            end
+          else
+            puts "  Database not migrated. Please, make sure to fill address's name field on your own."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tasks/migrations/migrate_default_billing_addresses_to_address_book.rake

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+namespace :solidus do
+  namespace :migrations do
+    namespace :migrate_default_billing_addresses_to_address_book do
+      task up: :environment do
+        print "Migrating default billing addresses to address book ... "
+        if Spree::UserAddress.where(default_billing: true).any?
+          Spree.user_class.joins(:bill_address).update_all(bill_address_id: nil) # rubocop:disable Rails/SkipsModelValidations
+        end
+        adapter_type = Spree::Base.connection.adapter_name.downcase.to_sym
+        if adapter_type == :mysql2
+          sql = <<~SQL
+            UPDATE spree_user_addresses
+            JOIN spree_users ON spree_user_addresses.user_id = spree_users.id
+              AND spree_user_addresses.address_id = spree_users.bill_address_id
+            SET spree_user_addresses.default_billing = true
+          SQL
+        else
+          sql = <<~SQL
+            UPDATE spree_user_addresses
+            SET default_billing = true
+            FROM spree_users
+            WHERE spree_user_addresses.address_id = spree_users.bill_address_id
+              AND spree_user_addresses.user_id = spree_users.id;
+          SQL
+        end
+        Spree::Base.connection.execute sql
+        puts "Success"
+      end
+
+      task down: :environment do
+        Spree::UserAddress.update_all(default_billing: false) # rubocop:disable Rails/SkipsModelValidations
+        puts "Rolled back default billing address migration to address book"
+      end
+    end
+  end
+end