spree_core 4.5.3 → 4.6.0

data/db/migrate/20230109084253_create_product_property_translations.rb

@@ -0,0 +1,25 @@
+class CreateProductPropertyTranslations < ActiveRecord::Migration[6.1]
+  def change
+    if ActiveRecord::Base.connection.table_exists? 'spree_product_property_translations'
+      # manually check for index since Rails if_exists does not always work correctly
+      if ActiveRecord::Migration.connection.index_exists?(:spree_product_property_translations, :spree_product_property_id)
+        remove_index :spree_product_property_translations, column: :spree_product_property_id, if_exists: true
+      end
+    else
+      create_table :spree_product_property_translations do |t|
+        # Translated attribute(s)
+        t.string :value
+        t.string :filter_param
+
+        t.string  :locale, null: false
+        t.references :spree_product_property, null: false, foreign_key: true, index: false
+
+        t.timestamps
+      end
+
+      add_index :spree_product_property_translations, :locale, name: :index_spree_product_property_translations_on_locale
+    end
+
+    add_index :spree_product_property_translations, [:spree_product_property_id, :locale], name: :unique_product_property_id_per_locale, unique: true
+  end
+end

data/db/migrate/20230109094907_transfer_options_data_to_translatable_tables.rb

@@ -0,0 +1,58 @@
+class TransferOptionsDataToTranslatableTables < ActiveRecord::Migration[6.1]
+  DEFAULT_LOCALE = 'en'
+
+  def up
+    # Only transfer data if translation tables are being newly created / no translations exist
+    # Otherwise, assume translation data is already in place from spree_globalize
+
+    # Option Types
+    if not Spree::OptionType::Translation.exists?
+      ActiveRecord::Base.connection.execute("
+        INSERT INTO spree_option_type_translations (name, presentation, locale, spree_option_type_id, created_at, updated_at)
+        SELECT name, presentation, '#{DEFAULT_LOCALE}', id, created_at, updated_at
+        FROM spree_option_types;
+      ")
+      ActiveRecord::Base.connection.execute("
+        UPDATE spree_option_types
+        SET name=null, presentation=null;
+      ")
+    end
+
+    # Option Values
+    if not Spree::OptionValue::Translation.exists?
+      ActiveRecord::Base.connection.execute("
+        INSERT INTO spree_option_value_translations (name, presentation, locale, spree_option_value_id, created_at, updated_at)
+        SELECT name, presentation, '#{DEFAULT_LOCALE}', id, created_at, updated_at
+        FROM spree_option_values;
+      ")
+      ActiveRecord::Base.connection.execute("
+        UPDATE spree_option_values
+        SET name=null, presentation=null;
+      ")
+    end
+  end
+
+  def down
+    # Option Types
+    ActiveRecord::Base.connection.execute("
+      UPDATE spree_option_types as option_types
+      SET (name, presentation) = (t_option_types.name, t_option_types.presentation)
+      FROM spree_option_type_translations AS t_option_types
+      WHERE t_option_types.spree_option_type_id = option_types.id;
+    ")
+    ActiveRecord::Base.connection.execute("
+      TRUNCATE TABLE spree_option_type_translations;
+    ")
+
+    # Option Values
+    ActiveRecord::Base.connection.execute("
+      UPDATE spree_option_values as option_values
+      SET (name, presentation) = (t_option_values.name, t_option_values.presentation)
+      FROM spree_option_value_translations AS t_option_values
+      WHERE t_option_values.spree_option_value_id = option_values.id;
+    ")
+    ActiveRecord::Base.connection.execute("
+      TRUNCATE TABLE spree_option_value_translations;
+    ")
+  end
+end

data/db/migrate/20230109105943_create_property_translations.rb

@@ -0,0 +1,26 @@
+class CreatePropertyTranslations < ActiveRecord::Migration[6.1]
+  def change
+    if ActiveRecord::Base.connection.table_exists?('spree_property_translations')
+      # manually check for index since Rails if_exists does not always work correctly
+      if ActiveRecord::Migration.connection.index_exists?(:spree_property_translations, :spree_property_id)
+        remove_index :spree_property_translations, column: :spree_property_id, if_exists: true
+      end
+    else
+      create_table :spree_property_translations do |t|
+        # Translated attribute(s)
+        t.string :name
+        t.string :presentation
+        t.string :filter_param
+
+        t.string  :locale, null: false
+        t.references :spree_property, null: false, foreign_key: true, index: false
+
+        t.timestamps
+      end
+
+      add_index :spree_property_translations, :locale, name: :index_spree_property_translations_on_locale
+    end
+
+    add_index :spree_property_translations, [:spree_property_id, :locale], name: :unique_property_id_per_locale, unique: true
+  end
+end

data/db/migrate/20230109110840_transfer_property_data_to_translatable_tables.rb

@@ -0,0 +1,59 @@
+class TransferPropertyDataToTranslatableTables < ActiveRecord::Migration[6.1]
+  DEFAULT_LOCALE = 'en'
+
+  def up
+    # Properties
+    change_column_null :spree_properties, :presentation, true
+
+    if not Spree::Property::Translation.exists?
+      ActiveRecord::Base.connection.execute("
+        INSERT INTO spree_property_translations (name, presentation, filter_param, locale, spree_property_id, created_at, updated_at)
+        SELECT name, presentation, filter_param, '#{DEFAULT_LOCALE}', id, created_at, updated_at
+        FROM spree_properties;
+      ")
+      ActiveRecord::Base.connection.execute("
+        UPDATE spree_properties
+        SET name=null, presentation=null, filter_param=null;
+      ")
+    end
+
+    # Product Properties
+    if not Spree::ProductProperty::Translation.exists?
+      ActiveRecord::Base.connection.execute("
+        INSERT INTO spree_product_property_translations (value, filter_param, locale, spree_product_property_id, created_at, updated_at)
+        SELECT value, filter_param, '#{DEFAULT_LOCALE}', id, created_at, updated_at
+        FROM spree_product_properties;
+      ")
+      ActiveRecord::Base.connection.execute("
+        UPDATE spree_product_properties
+        SET value=null, filter_param=null;
+      ")
+    end
+  end
+
+  def down
+    # Properties
+    change_column_null :spree_properties, :presentation, false
+
+    ActiveRecord::Base.connection.execute("
+      UPDATE spree_properties AS properties
+      SET (name, presentation, filter_param) = (t_properties.name, t_properties.presentation, t_properties.filter_param)
+      FROM spree_property_translations AS t_properties
+      WHERE t_properties.spree_property_id = properties.id;
+    ")
+    ActiveRecord::Base.connection.execute("
+      TRUNCATE TABLE spree_property_translations;
+    ")
+
+    # Product Properties
+    ActiveRecord::Base.connection.execute("
+      UPDATE spree_product_properties AS product_properties
+      SET (value, filter_param) = (t_product_properties.value, t_product_properties.filter_param)
+      FROM spree_product_property_translations AS t_product_properties
+      WHERE t_product_properties.spree_product_property_id = product_properties.id;
+    ")
+    ActiveRecord::Base.connection.execute("
+      TRUNCATE TABLE spree_product_property_translations;
+    ")
+  end
+end

data/db/migrate/20230110142344_backfill_friendly_id_slug_locale.rb

@@ -0,0 +1,15 @@
+class BackfillFriendlyIdSlugLocale < ActiveRecord::Migration[6.1]
+  DEFAULT_LOCALE = 'en'
+
+  def up
+    ActiveRecord::Base.connection.execute("
+    UPDATE friendly_id_slugs SET locale = '#{DEFAULT_LOCALE}'
+                                          ")
+  end
+
+  def down
+    ActiveRecord::Base.connection.execute("
+    UPDATE friendly_id_slugs SET locale = NULL
+                                          ")
+  end
+end

data/db/migrate/20230111121534_add_additional_taxon_translation_fields.rb

@@ -0,0 +1,8 @@
+class AddAdditionalTaxonTranslationFields < ActiveRecord::Migration[6.1]
+  def change
+    add_column :spree_taxon_translations, :meta_title, :string, if_not_exists: true
+    add_column :spree_taxon_translations, :meta_description, :string, if_not_exists: true
+    add_column :spree_taxon_translations, :meta_keywords, :string, if_not_exists: true
+    add_column :spree_taxon_translations, :permalink, :string, if_not_exists: true
+  end
+end

data/db/migrate/20230111122511_transfer_product_and_taxon_data_to_translatable_tables.rb

@@ -0,0 +1,82 @@
+class TransferProductAndTaxonDataToTranslatableTables < ActiveRecord::Migration[6.1]
+  DEFAULT_LOCALE = 'en'
+  PRODUCTS_TABLE = 'spree_products'
+  PRODUCT_TRANSLATIONS_TABLE = 'spree_product_translations'
+  TAXONS_TABLE = 'spree_taxons'
+  TAXON_TRANSLATIONS_TABLE = 'spree_taxon_translations'
+
+  def up
+    # Only transfer data if translation tables are being newly created / no translations exist
+    # Otherwise, assume translation data is already in place from spree_globalize
+
+    # Products
+    if not Spree::Product::Translation.exists?
+      ActiveRecord::Base.connection.execute("
+      INSERT INTO #{PRODUCT_TRANSLATIONS_TABLE} (name, description, locale, spree_product_id, created_at, updated_at, meta_description, meta_keywords, meta_title, slug)
+      SELECT name, description, '#{DEFAULT_LOCALE}' as locale, id, created_at, updated_at, meta_description, meta_keywords, meta_title, slug FROM #{PRODUCTS_TABLE};
+                                            ")
+      ActiveRecord::Base.connection.execute("
+      UPDATE #{PRODUCTS_TABLE}
+      SET name=null, description=null, meta_description=null, meta_keywords=null, meta_title=null, slug=null;
+                                            ")
+    end
+
+    # Taxons
+    if not Spree::Taxon::Translation.exists?
+      ActiveRecord::Base.connection.execute("
+      INSERT INTO #{TAXON_TRANSLATIONS_TABLE} (name, description, meta_title, meta_description, meta_keywords, permalink, locale, spree_taxon_id, created_at, updated_at)
+      SELECT name, description, meta_title, meta_description, meta_keywords, permalink, '#{DEFAULT_LOCALE}' as locale, id, created_at, updated_at FROM #{TAXONS_TABLE};
+                                            ")
+      ActiveRecord::Base.connection.execute("
+      UPDATE #{TAXONS_TABLE}
+      SET name=null, description=null, meta_title=null, meta_description=null, meta_keywords=null, permalink=null;
+                                            ")
+    end
+  end
+
+  def down
+    ActiveRecord::Base.connection.execute("
+      UPDATE #{PRODUCTS_TABLE} as products
+      SET (name,
+           description,
+           meta_description,
+           meta_keywords,
+           meta_title,
+           slug) =
+          (t_products.name,
+           t_products.description,
+           t_products.meta_description,
+           t_products.meta_keywords,
+           t_products.meta_title,
+           t_products.slug)
+      FROM #{PRODUCT_TRANSLATIONS_TABLE} AS t_products
+      WHERE t_products.spree_product_id = products.id
+    ")
+
+    ActiveRecord::Base.connection.execute("
+      TRUNCATE TABLE #{PRODUCT_TRANSLATIONS_TABLE}
+                                          ")
+
+    ActiveRecord::Base.connection.execute("
+      UPDATE #{TAXONS_TABLE} as taxons
+      SET (name,
+           description,
+           meta_title,
+           meta_description,
+           meta_keywords,
+           permalink) =
+          (t_taxons.name,
+           t_taxons.description,
+           t_taxons.meta_title,
+           t_taxons.meta_description,
+           t_taxons.meta_keywords,
+           t_taxons.permalink)
+      FROM #{TAXON_TRANSLATIONS_TABLE} AS t_taxons
+      WHERE t_taxons.spree_taxon_id = taxons.id
+    ")
+
+    ActiveRecord::Base.connection.execute("
+      TRUNCATE TABLE #{TAXON_TRANSLATIONS_TABLE}
+                                          ")
+  end
+end

data/db/migrate/20230117115531_create_taxonomy_translations.rb

@@ -0,0 +1,24 @@
+class CreateTaxonomyTranslations < ActiveRecord::Migration[6.1]
+  def change
+      if ActiveRecord::Base.connection.table_exists?('spree_taxonomy_translations')
+        # manually check for index since Rails if_exists does not always work correctly
+        if ActiveRecord::Migration.connection.index_exists?(:spree_taxonomy_translations, :spree_taxonomy_id)
+          remove_index :spree_taxonomy_translations, column: :spree_taxonomy_id, if_exists: true
+        end
+      else
+        create_table :spree_taxonomy_translations do |t|
+          # Translated attribute(s)
+          t.string :name
+
+          t.string  :locale, null: false
+          t.references :spree_taxonomy, null: false, foreign_key: true, index: false
+
+          t.timestamps null: false
+        end
+
+        add_index :spree_taxonomy_translations, :locale, name: :index_spree_taxonomy_translations_on_locale
+      end
+
+      add_index :spree_taxonomy_translations, [:spree_taxonomy_id, :locale], name: :index_spree_taxonomy_translations_on_spree_taxonomy_id_locale, unique: true
+  end
+end

data/db/migrate/20230117120430_allow_null_taxonomy_name.rb

@@ -0,0 +1,5 @@
+class AllowNullTaxonomyName < ActiveRecord::Migration[6.1]
+  def change
+    change_column_null :spree_taxonomies, :name, true
+  end
+end

data/db/migrate/20230117121303_transfer_taxonomy_data_to_translatable_tables.rb

@@ -0,0 +1,11 @@
+class TransferTaxonomyDataToTranslatableTables < ActiveRecord::Migration[6.1]
+  TRANSLATION_MIGRATION = Spree::TranslationMigrations.new(Spree::Taxonomy, 'en')
+
+  def up
+    TRANSLATION_MIGRATION.transfer_translation_data
+  end
+
+  def down
+    TRANSLATION_MIGRATION.revert_translation_data_transfer
+  end
+end

data/db/migrate/20230210142732_create_store_translations.rb

@@ -0,0 +1,50 @@
+class CreateStoreTranslations < ActiveRecord::Migration[6.1]
+  def change
+    if ActiveRecord::Base.connection.table_exists?('spree_store_translations')
+      add_new_translation_columns_to_globalize_table
+    else
+      create_table :spree_store_translations do |t|
+        # Translated attribute(s)
+        t.string :name
+        t.text :meta_description
+        t.text :meta_keywords
+        t.string :seo_title
+        t.string :facebook
+        t.string :twitter
+        t.string :instagram
+        t.string :customer_support_email
+        t.text :description
+        t.text :address
+        t.string :contact_phone
+        t.string :new_order_notifications_email
+
+        t.string  :locale, null: false
+        t.references :spree_store, null: false, foreign_key: true, index: false
+
+        t.timestamps null: false
+      end
+
+      add_index :spree_store_translations, :locale, name: :index_spree_store_translations_on_locale
+    end
+
+    add_index :spree_store_translations, [:spree_store_id, :locale], name: :index_spree_store_translations_on_spree_store_id_locale, unique: true
+  end
+
+  private
+
+  def add_new_translation_columns_to_globalize_table
+    # manually check for index since Rails if_exists does not always work correctly
+    if ActiveRecord::Migration.connection.index_exists?(:spree_store_translations, :spree_store_id)
+      remove_index :spree_store_translations, column: :spree_store_id, if_exists: true
+    end
+
+    add_column :spree_store_translations, :facebook, :string
+    add_column :spree_store_translations, :twitter, :string
+    add_column :spree_store_translations, :instagram, :string
+    add_column :spree_store_translations, :customer_support_email, :string
+    add_column :spree_store_translations, :description, :text
+    add_column :spree_store_translations, :address, :text
+    add_column :spree_store_translations, :contact_phone, :string
+    add_column :spree_store_translations, :new_order_notifications_email, :string
+  end
+end

data/db/migrate/20230210142849_transfer_store_data_to_translatable_tables.rb

@@ -0,0 +1,11 @@
+class TransferStoreDataToTranslatableTables < ActiveRecord::Migration[6.1]
+  TRANSLATION_MIGRATION = Spree::TranslationMigrations.new(Spree::Store, 'en')
+
+  def up
+    TRANSLATION_MIGRATION.transfer_translation_data
+  end
+
+  def down
+    TRANSLATION_MIGRATION.revert_translation_data_transfer
+  end
+end

data/db/migrate/20230210230434_add_deleted_at_to_store_translations.rb

@@ -0,0 +1,6 @@
+class AddDeletedAtToStoreTranslations < ActiveRecord::Migration[6.1]
+  def change
+    add_column :spree_store_translations, :deleted_at, :datetime
+    add_index :spree_store_translations, :deleted_at
+  end
+end

data/db/migrate/20230415155958_rename_data_feed_settings_table.rb

@@ -0,0 +1,5 @@
+class RenameDataFeedSettingsTable < ActiveRecord::Migration[6.1]
+  def change
+    rename_table :spree_data_feed_settings, :spree_data_feeds
+  end
+end

data/db/migrate/20230415160828_rename_data_feed_table_columns.rb

@@ -0,0 +1,7 @@
+class RenameDataFeedTableColumns < ActiveRecord::Migration[6.1]
+  def change
+    rename_column :spree_data_feeds, :spree_store_id, :store_id
+    rename_column :spree_data_feeds, :enabled, :active
+    rename_column :spree_data_feeds, :uuid, :slug
+  end
+end

data/db/migrate/20230415161226_add_indexes_to_data_feeds_table.rb

@@ -0,0 +1,5 @@
+class AddIndexesToDataFeedsTable < ActiveRecord::Migration[6.1]
+  def change
+    add_index :spree_data_feeds, [:store_id, :slug, :provider]
+  end
+end

data/db/migrate/20230512094803_rename_data_feeds_column_provider_to_type.rb

@@ -0,0 +1,5 @@
+class RenameDataFeedsColumnProviderToType < ActiveRecord::Migration[6.1]
+  def change
+    rename_column :spree_data_feeds, :provider, :type
+  end
+end

data/db/migrate/20230514162157_add_index_on_locale_and_permalink_to_spree_taxons.rb

@@ -0,0 +1,5 @@
+class AddIndexOnLocaleAndPermalinkToSpreeTaxons < ActiveRecord::Migration[6.1]
+  def change
+    add_index :spree_taxon_translations, [:locale, :permalink], unique: true, name: 'unique_permalink_per_locale', if_not_exists: true
+  end
+end

data/lib/spree/core/configuration.rb

@@ -65,6 +65,7 @@ module Spree
       preference :show_raw_product_description, :boolean, deprecated: true
       preference :tax_using_ship_address, :boolean, default: true
       preference :track_inventory_levels, :boolean, default: true # Determines whether to track on_hand values for variants / products.
+      preference :use_user_locale, :boolean, default: true
 
       # Store credits configurations
       preference :non_expiring_credit_types, :array, default: []

data/lib/spree/core/controller_helpers/locale.rb

@@ -22,15 +22,29 @@ module Spree
         end
 
         def current_locale
-          @current_locale ||= if params[:locale].present? && supported_locale?(params[:locale])
+          @current_locale ||= if user_locale?
+                                try_spree_current_user.selected_locale
+                              elsif params_locale?
                                 params[:locale]
-                              elsif respond_to?(:config_locale, true) && config_locale.present?
+                              elsif config_locale?
                                 config_locale
                               else
                                 current_store&.default_locale || Rails.application.config.i18n.default_locale || I18n.default_locale
                               end
         end
 
+        def config_locale?
+          respond_to?(:config_locale, true) && config_locale.present?
+        end
+
+        def params_locale?
+          params[:locale].present? && supported_locale?(params[:locale])
+        end
+
+        def user_locale?
+          Spree::Config.use_user_locale && try_spree_current_user && supported_locale?(try_spree_current_user.selected_locale)
+        end
+
         def supported_locales
           @supported_locales ||= current_store&.supported_locales_list
         end
@@ -54,6 +68,16 @@ module Spree
 
           I18n.locale.to_s
         end
+
+        def find_with_fallback_default_locale(&block)
+          result = begin
+            block.call
+          rescue ActiveRecord::RecordNotFound => _e
+            nil
+          end
+
+          result || Mobility.with_locale(current_store.default_locale) { block.call }
+        end
       end
     end
   end