solidus_core 2.11.4 → 2.11.5

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/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::LegacyUser.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

data/lib/tasks/upgrade.rake

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+namespace :solidus do
+  namespace :upgrade do
+    desc "Upgrade Solidus to version 2.11"
+    task two_point_eleven: [
+        'solidus:migrations:migrate_default_billing_addresses_to_address_book:up',
+        'solidus:migrations:migrate_address_names:up'
+      ] do
+      puts "Your Solidus install is ready for Solidus 2.11"
+    end
+  end
+end

data/solidus_core.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activemerchant', '~> 1.66'
   s.add_dependency 'acts_as_list', '< 2.0'
-  s.add_dependency 'awesome_nested_set', '~> 3.2'
+  s.add_dependency 'awesome_nested_set', '~> 3.3'
   s.add_dependency 'cancancan', ['>= 2.2', '< 4.0']
   s.add_dependency 'carmen', '~> 1.1.0'
   s.add_dependency 'discard', '~> 1.0'
@@ -43,4 +43,26 @@ Gem::Specification.new do |s|
   s.add_dependency 'paranoia', '~> 2.4'
   s.add_dependency 'ransack', '~> 2.0'
   s.add_dependency 'state_machines-activerecord', '~> 0.6'
+
+  s.post_install_message = <<-MSG
+-------------------------------------------------------------
+                Thank you for using Solidus
+-------------------------------------------------------------
+If this is a fresh install, don't forget to run the Solidus
+installer with the following command:
+
+$ bin/rails g solidus:install
+
+If you are updating Solidus from an older version, please run
+the following commands to complete the update:
+
+$ bin/rails railties:install:migrations
+$ bin/rails db:migrate
+$ bin/rails solidus:upgrade:two_point_eleven
+
+Please report any issues at:
+- https://github.com/solidusio/solidus/issues
+- http://slack.solidus.io/
+-------------------------------------------------------------
+MSG
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_core
 version: !ruby/object:Gem::Version
-  version: 2.11.4
+  version: 2.11.5
 platform: ruby
 authors:
 - Solidus Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -204,14 +204,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: cancancan
   requirement: !ruby/object:Gem::Requirement
@@ -729,6 +729,7 @@ files:
 - db/migrate/20200320144521_add_default_billng_flag_to_user_addresses.rb
 - db/migrate/20200530111458_add_bcc_email_to_spree_stores.rb
 - db/migrate/20201008213609_add_discontinue_on_to_spree_products.rb
+- db/migrate/20210122110141_add_name_to_spree_addresses.rb
 - db/seeds.rb
 - lib/generators/solidus/install/install_generator.rb
 - lib/generators/solidus/install/templates/config/initializers/spree.rb.tt
@@ -751,7 +752,6 @@ files:
 - lib/solidus/migrations/rename_gateways.rb
 - lib/solidus_core.rb
 - lib/spree/app_configuration.rb
-- lib/spree/awesome_nested_set_override.rb
 - lib/spree/config.rb
 - lib/spree/core.rb
 - lib/spree/core/active_merchant_dependencies.rb
@@ -851,6 +851,7 @@ files:
 - lib/spree/testing_support/dummy_app/assets/stylesheets/spree/backend/all.css
 - lib/spree/testing_support/dummy_app/assets/stylesheets/spree/frontend/all.css
 - lib/spree/testing_support/dummy_app/database.yml
+- lib/spree/testing_support/dummy_app/mailer_previews/test_mailer_preview.rb
 - lib/spree/testing_support/dummy_app/migrations.rb
 - lib/spree/testing_support/dummy_app/rake_tasks.rb
 - lib/spree/testing_support/dummy_app/routes.rb
@@ -915,6 +916,7 @@ files:
 - lib/spree/testing_support/factories/variant_property_rule_factory.rb
 - lib/spree/testing_support/factories/variant_property_rule_value_factory.rb
 - lib/spree/testing_support/factories/zone_factory.rb
+- lib/spree/testing_support/factory_bot.rb
 - lib/spree/testing_support/fixtures/blank.jpg
 - lib/spree/testing_support/flash.rb
 - lib/spree/testing_support/job_helpers.rb
@@ -932,10 +934,13 @@ files:
 - lib/tasks/core.rake
 - lib/tasks/email.rake
 - lib/tasks/migrations/copy_order_bill_address_to_credit_card.rake
+- lib/tasks/migrations/migrate_address_names.rake
+- lib/tasks/migrations/migrate_default_billing_addresses_to_address_book.rake
 - lib/tasks/migrations/migrate_shipping_rate_taxes.rake
 - lib/tasks/migrations/migrate_user_addresses.rake
 - lib/tasks/migrations/rename_gateways.rake
 - lib/tasks/order_capturing.rake
+- lib/tasks/upgrade.rake
 - solidus_core.gemspec
 - vendor/assets/javascripts/jquery.payment.js
 - vendor/assets/javascripts/jsuri.js
@@ -944,7 +949,26 @@ homepage: http://solidus.io
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message:
+post_install_message: |
+  -------------------------------------------------------------
+                  Thank you for using Solidus
+  -------------------------------------------------------------
+  If this is a fresh install, don't forget to run the Solidus
+  installer with the following command:
+
+  $ bin/rails g solidus:install
+
+  If you are updating Solidus from an older version, please run
+  the following commands to complete the update:
+
+  $ bin/rails railties:install:migrations
+  $ bin/rails db:migrate
+  $ bin/rails solidus:upgrade:two_point_eleven
+
+  Please report any issues at:
+  - https://github.com/solidusio/solidus/issues
+  - http://slack.solidus.io/
+  -------------------------------------------------------------
 rdoc_options: []
 require_paths:
 - lib

data/lib/spree/awesome_nested_set_override.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module AwesomeNestedSetOvveride
-  # Add :polimorphic key option only when used to make it work with Rails 6.1+,
-  # required since rails/rails@2c008d9
-  # This can be removed when upgrading to an awesome_nested_set version
-  # compliant with Rails 6.1+, already addressed in
-  # collectiveidea/awesome_nested_set#421
-  module RelateParent
-    def acts_as_nested_set_relate_parent!
-      # Disable Rubocop to keep original code for diffs
-      # rubocop:disable
-      options = {
-        :class_name => self.base_class.to_s,
-        :foreign_key => parent_column_name,
-        :primary_key => primary_column_name,
-        :counter_cache => acts_as_nested_set_options[:counter_cache],
-        :inverse_of => (:children unless acts_as_nested_set_options[:polymorphic]),
-        :touch => acts_as_nested_set_options[:touch]
-      }
-      options[:polymorphic] = true if acts_as_nested_set_options[:polymorphic]
-      options[:optional] = true if ActiveRecord::VERSION::MAJOR >= 5
-      belongs_to :parent, options
-      # rubocop:enable
-    end
-
-    CollectiveIdea::Acts::NestedSet.prepend self
-  end
-
-  # Skip breaking model reload before update depth. Already addressed in
-  # collectiveidea/awesome_nested_set#413
-  # This can be removed when a new version of awesome_nested_set is released.
-  module Model
-    def set_depth!
-      return unless has_depth_column?
-
-      in_tenacious_transaction do
-        update_depth(level)
-      end
-    end
-
-    CollectiveIdea::Acts::NestedSet::Model.prepend self
-  end
-end