spree_core 6.0.0.beta4 → 6.0.0.rc1

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

@@ -31,7 +31,7 @@ FactoryBot.define do
           country = Spree::Country.by_iso('US')
 
           if Spree::DeliveryMethod.none?
-            create(:shipping_method).tap do |delivery_method|
+            create(:delivery_method).tap do |delivery_method|
               delivery_method.calculator.preferred_amount = evaluator.shipping_cost
               delivery_method.calculator.preferred_currency = cart.store.default_currency
               delivery_method.calculator.save!

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

@@ -0,0 +1,28 @@
+FactoryBot.define do
+  factory :email_template, class: Spree::EmailTemplate do
+    store { Spree::Store.default || create(:store) }
+    key { 'spree/admin_user_mailer/password_reset_email' }
+    locale { 'any' }
+    subject { 'Reset {{ store.name }}' }
+    body { '<mj-section><mj-column><mj-text>Hello</mj-text></mj-column></mj-section>' }
+    base_subject { 'Reset {{ store.name }}' }
+    base_body { '<mj-section><mj-column><mj-text>Default</mj-text></mj-column></mj-section>' }
+    published_at { Time.current }
+  end
+
+  factory :email_template_draft, class: Spree::EmailTemplateDraft do
+    store { Spree::Store.default || create(:store) }
+    key { 'spree/admin_user_mailer/password_reset_email' }
+    locale { 'any' }
+    subject { 'Reset {{ store.name }}' }
+    body { '<mj-section><mj-column><mj-text>Draft</mj-text></mj-column></mj-section>' }
+    base_subject { 'Reset {{ store.name }}' }
+    base_body { '<mj-section><mj-column><mj-text>Default</mj-text></mj-column></mj-section>' }
+  end
+
+  factory :email_template_revision, class: Spree::EmailTemplateRevision do
+    email_template
+    subject { 'Reset {{ store.name }}' }
+    body { '<mj-section><mj-column><mj-text>Hello</mj-text></mj-column></mj-section>' }
+  end
+end

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

@@ -39,7 +39,7 @@ FactoryBot.define do
         create(:line_item, order: order, price: evaluator.line_items_price)
         order.line_items.reload # to ensure order.line_items is accessible after
 
-        order.update_column(:item_count, order.line_items.count)
+        order.update_column(:total_quantity, order.line_items.count)
         order.reload
       end
     end
@@ -78,7 +78,7 @@ FactoryBot.define do
         end
 
         stock_location = order.line_items&.first&.variant&.stock_levels&.first&.stock_location || create(:stock_location)
-        create(:shipment, order: order, cost: evaluator.shipment_cost, stock_location: stock_location)
+        create(:fulfillment, order: order, cost: evaluator.shipment_cost, stock_location: stock_location)
         order.fulfillments.reload
 
         order.recalculate_totals!

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

@@ -4,7 +4,7 @@ FactoryBot.define do
   factory :refund, class: Spree::Refund do
     amount         { 100.00 }
     transaction_id { generate(:refund_transaction_id) }
-    association(:payment, state: 'completed')
+    association(:payment, status: 'completed')
     association(:reason, factory: :refund_reason)
   end
 

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

@@ -20,7 +20,7 @@ FactoryBot.define do
 
     after(:build) do |package, evaluator|
       evaluator.variants_contents.each do |variant, count|
-        package.add_multiple build_list(:inventory_unit, count, variant: variant)
+        package.add_multiple build_list(:fulfillment_item, count, variant: variant)
       end
     end
 

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

@@ -45,7 +45,7 @@ FactoryBot.define do
       product { |p| p.association(:product) }
 
       factory :with_image_variant do
-        images { create_list(:image, 1) }
+        images { create_list(:media, 1) }
       end
 
       trait :with_no_price do

data/lib/spree/testing_support/i18n.rb

@@ -1,94 +1,3 @@
-# This file exists solely to test whether or not there are missing translations
-# within the code that Spree's test suite covers.
-#
-# If there is a translation referenced which has no corresponding key within the
-# .yml file, then there will be a message output at the end of the suite showing
-# that.
-#
-# If there is a translation within the locale file which *isn't* used in the
-# test, this will also be shown at the end of the suite run.
-module Spree
-  class << self
-    attr_accessor :used_translations, :missing_translation_messages,
-                  :unused_translations, :unused_translation_messages
-    alias normal_t t
-  end
-
-  def self.t(*args)
-    original_args = args.dup
-    options = args.extract_options!
-    self.used_translations ||= []
-    [*args.first].each do |translation_key|
-      key = ([*options[:scope]] << translation_key).join('.')
-      self.used_translations << key
-    end
-    normal_t(*original_args)
-  end
-
-  def self.check_missing_translations
-    self.missing_translation_messages = []
-    self.used_translations ||= []
-    used_translations.map { |a| a.split('.') }.each do |translation_keys|
-      root = translations
-      processed_keys = []
-      translation_keys.each do |key|
-        root = root.fetch(key.to_sym)
-        processed_keys << key.to_sym
-      rescue KeyError
-        error = "#{(processed_keys << key).join('.')} (#{I18n.locale})"
-        unless Spree.missing_translation_messages.include?(error)
-          Spree.missing_translation_messages << error
-        end
-      end
-    end
-  end
-
-  def self.check_unused_translations
-    self.used_translations ||= []
-    self.unused_translation_messages = []
-    self.unused_translations = []
-    load_translations(translations)
-    translation_diff = unused_translations - used_translations
-    translation_diff.each do |translation|
-      Spree.unused_translation_messages << "#{translation} (#{I18n.locale})"
-    end
-  end
-
-  private
-
-  def self.load_translations(hash, root = [])
-    hash.each do |k, v|
-      if v.is_a?(Hash)
-        load_translations(v, root.dup << k)
-      else
-        key = (root + [k]).join('.')
-        unused_translations << key
-      end
-    end
-  end
-
-  def self.translations
-    @translations ||= I18n.backend.send(:translations)[I18n.locale][:spree]
-  end
-end
-
-RSpec.configure do |config|
-  # Need to check here again because this is used in i18n_spec too.
-  if ENV['CHECK_TRANSLATIONS']
-    config.after :suite do
-      Spree.check_missing_translations
-      if Spree.missing_translation_messages.any?
-        puts "\nThere are missing translations within Spree:"
-        puts Spree.missing_translation_messages.sort
-        exit(1)
-      end
-
-      Spree.check_unused_translations
-      if Spree.unused_translation_messages.any?
-        puts "\nThere are unused translations within Spree:"
-        puts Spree.unused_translation_messages.sort
-        exit(1)
-      end
-    end
-  end
-end
+# Deprecated: Spree's specs now catch missing keys through Rails'
+# config.i18n.raise_on_missing_translations. Removed in Spree 6.1.
+Spree::Deprecation.warn("spree/testing_support/i18n is deprecated and does nothing; set config.i18n.raise_on_missing_translations = true in your test environment instead. It will be removed in Spree 6.1.") if defined?(Spree::Deprecation)

data/lib/spree/testing_support/lifecycle_events.rb

@@ -21,7 +21,7 @@ shared_examples_for 'lifecycle events' do |factory: nil, event_prefix: nil|
         expect(record).to receive(:publish_event).with("#{lifecycle_event_prefix}.updated")
         allow(record).to receive(:publish_event).with(anything)
 
-        # update_attribute, not update!: Spree::Shipment#update! shadows the
+        # update_attribute, not update!: Spree::Fulfillment#update! shadows the
         # Active Record method with the legacy state-recalculation API.
         Timecop.travel(1.minute.from_now) do
           record.update_attribute(:updated_at, Time.current)

data/lib/spree/testing_support/order_walkthrough.rb

@@ -21,7 +21,7 @@ class OrderWalkthrough
 
     # A delivery method must exist for rates to be displayed on checkout page
     unless Spree::DeliveryMethod.exists?
-      FactoryBot.create(:shipping_method).tap do |delivery_method|
+      FactoryBot.create(:delivery_method).tap do |delivery_method|
         delivery_method.calculator.preferred_amount = 10
         delivery_method.calculator.preferred_currency = store.default_currency
         delivery_method.calculator.save

data/lib/spree/testing_support/preferences.rb

@@ -18,11 +18,6 @@ module Spree
         yield(config) if block_given?
       end
 
-      def assert_preference_unset(preference)
-        find("#preferences_#{preference}")['checked'].should be false
-        Spree::Config[preference].should be false
-      end
-
       # Stubs store-scoped commerce settings for the duration of one example.
       #
       #   stub_store_preferences(track_inventory_levels: false)

data/lib/spree/testing_support/store.rb

@@ -29,6 +29,15 @@ RSpec.configure do |config|
     end
   end
 
+  # Reloaded before each example rather than after: the after hooks run
+  # inside the example's transaction, so a reload there still sees the
+  # example's writes, and the next example would start from values the
+  # database no longer holds. Setting a preference to such a stale value is
+  # no change to Rails, so it would never be saved.
+  config.before(:each) do
+    @default_store&.reload unless self.class.metadata[:without_global_store]
+  end
+
   config.after(:each) do
     unless self.class.metadata[:without_global_store]
       @default_store&.products = []
@@ -43,7 +52,6 @@ RSpec.configure do |config|
         @default_store.association(:default_market).reset if @default_store.association_cached?(:default_market)
         @default_store.association(:markets).reset if @default_store.association_cached?(:markets)
         @default_store.remove_instance_variable(:@has_markets) if @default_store.instance_variable_defined?(:@has_markets)
-        @default_store.reload
       end
     end
   end

data/lib/spree/upgrades/5_6_to_6_0/manifest.yml

@@ -35,6 +35,22 @@ steps:
 
       Idempotent, and a no-op on an already-consolidated schema.
 
+  - id: preferences_json
+    name: "Check for preferences still stored as YAML"
+    task: "spree:upgrade:preferences_json"
+    notes: |
+      Spree 6.0 stores preferences as JSON instead of YAML, and keeps secrets
+      (preferences declared as passwords, such as gateway API keys) in a
+      separate secret_preferences column. The migration converts every row and
+      moves every secret itself, so a normal db:migrate needs nothing from this
+      step.
+
+      This is a safety net: it converts any row still holding YAML, and moves
+      the secrets of a class that was not loaded when the migration ran, such
+      as one from an extension gem installed afterwards.
+
+      Idempotent, and a no-op once everything is converted.
+
   - id: migrate_media_class_names
     name: "Rewrite stored Spree::Asset and Spree::Image class names"
     task: "spree:migrate_media_class_names"
@@ -288,6 +304,20 @@ steps:
       with one statement scoped to the rows still missing a code, so an
       interrupted run picks up where it stopped.
 
+  - id: migrate_checkout_zones
+    name: "Convert checkout zones to markets"
+    task: "spree:markets:migrate_checkout_zones"
+    notes: |
+      Markets replace the store's checkout zone in Spree 6. Stores that have
+      no market yet get a default one covering their checkout zone's
+      countries, or their default country when no zone was set, and the
+      checkout zone is cleared.
+
+      Run before migrate_tax_zones, which matches zone price rules against a
+      store's markets, and before backfill_order_markets, which assigns each
+      store's default market to its orders. Idempotent: stores that already
+      have a market are skipped.
+
   - id: migrate_promotion_option_value_rules
     name: "Rewrite Option Value promotion rules to stable option value ids"
     task: "spree:upgrade:migrate_promotion_option_value_rules"
@@ -715,3 +745,18 @@ steps:
       predates the upgrade.
 
       Idempotent, and safe to re-run at any time to repair drift.
+
+  - id: encrypt_secret_preferences
+    name: "Encrypt gateway and integration secrets"
+    task: "spree:upgrade:encrypt_secret_preferences"
+    notes: |
+      The 6.0 migration moves existing secrets into the secret_preferences
+      column in plain text, so it never needs encryption keys. They stay
+      readable and are encrypted the next time their record is saved. This step
+      encrypts them all now.
+
+      Skips with a note when Active Record encryption keys are not configured;
+      see the encryption section of the upgrade guide to add them, then run
+      this step again.
+
+      Idempotent.

data/lib/tasks/categories_and_collections.rake

@@ -80,7 +80,7 @@ namespace :spree do
           # otherwise purge/destroy: ActionText description, images, custom fields, slugs.
           move_polymorphic.call(ActionText::RichText, :record_type, :record_id, category, collection)
           move_polymorphic.call(ActiveStorage::Attachment, :record_type, :record_id, category, collection, name: %w[image square_image])
-          move_polymorphic.call(Spree::Metafield, :resource_type, :resource_id, category, collection)
+          move_polymorphic.call(Spree::CustomField, :resource_type, :resource_id, category, collection)
           move_polymorphic.call(FriendlyId::Slug, :sluggable_type, :sluggable_id, category, collection)
 
           # Rules -> collection_rules (remap the STI type; insert_all bypasses the
@@ -169,8 +169,8 @@ namespace :spree do
     # category rows that still hold the pre-6.0 names.
     puts 'Backfilling renamed class-name strings...'
     [
-      [Spree::Metafield, :resource_type, 'Spree::Taxon', 'Spree::Category'],
-      [Spree::MetafieldDefinition, :resource_type, 'Spree::Taxon', 'Spree::Category'],
+      [Spree::CustomField, :resource_type, 'Spree::Taxon', 'Spree::Category'],
+      [Spree::CustomFieldDefinition, :resource_type, 'Spree::Taxon', 'Spree::Category'],
       [ActiveStorage::Attachment, :record_type, 'Spree::Taxon', 'Spree::Category'],
       # description is an ActionText field (translates :description, backend: :action_text);
       # surviving categories keep their rich-text description without this.

data/lib/tasks/core.rake

@@ -26,14 +26,16 @@ namespace :core do
 
   desc 'Migrate newsletter subscribers'
   task migrate_newsletter_subscribers: :environment do |_t, _args|
-    Spree.customer_class.where(accepts_email_marketing: true).in_batches(of: 500) do |user_batch|
-      subscriber_attributes = user_batch.pluck(:id, :email, :updated_at).map do |id, email, updated_at|
+    store_id = Spree::Store.default&.id
+
+    Spree.customer_class.where(accepts_email_marketing: true).in_batches(of: 500) do |customer_batch|
+      subscriber_attributes = customer_batch.pluck(:id, :email, :updated_at).map do |id, email, updated_at|
         {
           email: Spree::NewsletterSubscriber.new(email: email).email, # normalized email
-          user_id: id,
+          customer_id: id,
           verified_at: updated_at,
           verification_token: nil,
-          store_id: Spree::Store.default&.id,
+          store_id: store_id,
           updated_at: DateTime.current,
           created_at: DateTime.current
         }

data/lib/tasks/media.rake

@@ -31,9 +31,9 @@ namespace :spree do
       # Subquery (not pluck) so the product set doesn't materialize in Ruby —
       # important for catalogs with millions of products.
       variant_product_ids = Spree::Variant
-                              .joins("INNER JOIN #{Spree::Asset.table_name} ON " \
-                                     "#{Spree::Asset.table_name}.viewable_id = #{Spree::Variant.table_name}.id " \
-                                     "AND #{Spree::Asset.table_name}.viewable_type = 'Spree::Variant'")
+                              .joins("INNER JOIN #{Spree::Media.table_name} ON " \
+                                     "#{Spree::Media.table_name}.viewable_id = #{Spree::Variant.table_name}.id " \
+                                     "AND #{Spree::Media.table_name}.viewable_type = 'Spree::Variant'")
                               .select(:product_id)
 
       relation = Spree::Product.where(id: variant_product_ids)

data/lib/tasks/package_types.rake

@@ -43,7 +43,7 @@ namespace :spree do
         end
 
         store.package_types.create!(
-          name: Spree.t('package_types.default_name'),
+          name: I18n.t('spree.package_types.default_name'),
           kind: 'box',
           default: true,
           weight: weight.positive? ? weight : nil,

data/lib/tasks/preferences_json.rake

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# 5.6 → 6.0 follow-ups to the ConvertPreferencesToJson migration
+# (docs/plans/6.0-json-preferences.md). Both are idempotent.
+module Spree
+  module SecretPreferencesUpgrade
+    # The models keeping secrets in `secret_preferences`, one per table.
+    def self.models
+      Rails.application.eager_load!
+      Spree::Base.descendants.select do |model|
+        model.include?(Spree::SecretPreferences) && model.base_class == model && model.table_exists?
+      end
+    end
+
+    # Every row of the model, deleted ones included, except rows whose class
+    # is no longer installed — loading one of those raises, which would stop
+    # the task before it reached the rest. They are reported and left as
+    # they are; their secrets stay readable.
+    #
+    # @return [ActiveRecord::Relation]
+    def self.loadable_rows(model)
+      rows = model.unscoped
+      return rows unless model.column_names.include?(model.inheritance_column)
+
+      types = rows.distinct.pluck(model.inheritance_column)
+      missing = types.compact.reject(&:safe_constantize)
+      return rows if missing.empty?
+
+      missing.each { |type| puts "  #{model.table_name}: skipped rows of #{type}, which is not installed" }
+      rows.where.not(model.inheritance_column => missing).or(rows.where(model.inheritance_column => nil))
+    end
+  end
+end
+
+namespace :spree do
+  namespace :upgrade do
+    desc <<~DESC
+      Converts any preferences row still holding YAML to JSON, and moves secrets
+      left in `preferences` to the encrypted `secret_preferences` column.
+
+      The 6.0 migration does both itself, so a normal `db:migrate` leaves nothing
+      for this task. It exists for schemas changed out of band, and for secrets of
+      a class that was not loaded when the migration ran (an extension gem added
+      afterwards).
+    DESC
+    task preferences_json: :environment do
+      conversion = Spree::Preferences::JsonConversion.new(ActiveRecord::Base.connection, log: ->(message) { puts "  #{message}" })
+
+      conversion.preference_tables.each do |table|
+        converted = conversion.text_column?(table) ? conversion.convert_text_table(table) : conversion.convert_table(table)
+        puts "  #{table}: #{converted} rows converted from YAML" if converted.positive?
+      end
+
+      Spree::SecretPreferencesUpgrade.models.each do |model|
+        moved = 0
+
+        Spree::SecretPreferencesUpgrade.loadable_rows(model).find_each do |record|
+          separated = record.separated_secret_preferences
+          next unless separated
+
+          # Written without callbacks: moving a secret is not a change to it, and
+          # must not look like one to a gateway that re-registers on key changes.
+          record.update_columns(separated)
+          moved += 1
+        end
+
+        puts "  #{model.table_name}: moved secrets out of preferences for #{moved} rows" if moved.positive?
+      end
+
+      puts 'preferences_json done.'
+    end
+
+    desc <<~DESC
+      Encrypts every `secret_preferences` value still stored in plain text.
+
+      The 6.0 migration moves existing secrets into `secret_preferences` without
+      encrypting them, so it never depends on encryption keys. They stay readable
+      as they are and are encrypted on their next save; this task encrypts them
+      all at once. Skips with a note when Active Record encryption keys are not
+      configured.
+    DESC
+    task encrypt_secret_preferences: :environment do
+      unless ActiveRecord::Encryption.config.has_primary_key?
+        puts '  Active Record encryption keys are not configured, so secrets stay in plain text. ' \
+             'See https://spreecommerce.org/docs/developer/deployment/environment_variables'
+        next
+      end
+
+      Spree::SecretPreferencesUpgrade.models.each do |model|
+        count = 0
+        Spree::SecretPreferencesUpgrade.loadable_rows(model).where.not(secret_preferences: nil).find_each do |record|
+          record.encrypt
+          count += 1
+        end
+        puts "  #{model.table_name}: encrypted secrets for #{count} rows"
+      end
+
+      puts 'encrypt_secret_preferences done.'
+    end
+  end
+end

data/spec/fixtures/mailer_views/custom_views_probe_mailer/welcome_email.html.erb

@@ -0,0 +1,4 @@
+<%= render layout: 'spree/shared/mailer_hero' do %>
+  <h1>Welcome</h1>
+  <%= render 'spree/shared/mailer_button', url: 'https://example.com/start', label: 'Get started' %>
+<% end %>