spree_core 4.7.2 → 4.8.0

data/db/migrate/20230103151034_create_option_value_translations.rb

@@ -9,7 +9,6 @@ class CreateOptionValueTranslations < ActiveRecord::Migration[6.1]
       create_table :spree_option_value_translations do |t|
 
         # Translated attribute(s)
-        t.string :name
         t.string :presentation
 
         t.string  :locale, null: false

data/db/migrate/20230109084253_create_product_property_translations.rb

@@ -9,7 +9,6 @@ class CreateProductPropertyTranslations < ActiveRecord::Migration[6.1]
       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

data/db/migrate/20230109105943_create_property_translations.rb

@@ -8,9 +8,7 @@ class CreatePropertyTranslations < ActiveRecord::Migration[6.1]
     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

data/db/migrate/20230110142344_backfill_friendly_id_slug_locale.rb

@@ -1,15 +1,9 @@
 class BackfillFriendlyIdSlugLocale < ActiveRecord::Migration[6.1]
-  DEFAULT_LOCALE = 'en'
-
   def up
-    ActiveRecord::Base.connection.execute("
-    UPDATE friendly_id_slugs SET locale = '#{DEFAULT_LOCALE}'
-                                          ")
+    FriendlyId::Slug.unscoped.update_all(locale: Spree::Store.default.default_locale)
   end
 
   def down
-    ActiveRecord::Base.connection.execute("
-    UPDATE friendly_id_slugs SET locale = NULL
-                                          ")
+    FriendlyId::Slug.unscoped.update_all(locale: nil)
   end
 end

data/db/migrate/20240303174340_fix_spree_stock_item_unique_index.rb

@@ -0,0 +1,35 @@
+class FixSpreeStockItemUniqueIndex < ActiveRecord::Migration[6.1]
+  def change
+    remove_index :spree_stock_items, name: 'stock_item_by_loc_var_id_deleted_at' if index_exists?(:spree_stock_items, [:stock_location_id, :variant_id], name: 'stock_item_by_loc_var_id_deleted_at')
+
+    unless index_exists?(:spree_stock_items, ['variant_id', 'stock_location_id'], name: 'index_spree_stock_items_unique_without_deleted_at')
+      # MySQL doesn't support partial indexes
+      if ActiveRecord::Base.connection.adapter_name == 'Mysql2'
+        reversible do |dir|
+          dir.up do
+            execute <<-SQL
+              CREATE UNIQUE INDEX index_spree_stock_items_unique_without_deleted_at
+              ON spree_stock_items(
+                stock_location_id,
+                variant_id,
+                (COALESCE(deleted_at, CAST('1970-01-01' AS DATETIME)))
+              );
+            SQL
+          end
+
+          dir.down do
+            remove_index :spree_stock_items, name: :index_spree_stock_items_unique_without_deleted_at
+          end
+        end
+      else
+        add_index(
+          :spree_stock_items,
+          ['variant_id', 'stock_location_id'],
+          name: 'index_spree_stock_items_unique_without_deleted_at',
+          unique: true,
+          where: 'deleted_at IS NULL',
+        )
+      end
+    end
+  end
+end

data/db/migrate/20240514105216_add_weight_and_dimension_units_to_spree_variants.rb

@@ -0,0 +1,6 @@
+class AddWeightAndDimensionUnitsToSpreeVariants < ActiveRecord::Migration[6.1]
+  def change
+    add_column :spree_variants, :weight_unit, :string, if_not_exists: true
+    add_column :spree_variants, :dimensions_unit, :string, if_not_exists: true
+  end
+end

data/lib/generators/spree/custom_authentication/custom_authentication_generator.rb

@@ -0,0 +1,23 @@
+module Spree
+  class CustomAuthenticationGenerator < Rails::Generators::Base
+    desc 'Set up a Spree installation with a custom authentication helpers'
+
+    def self.source_paths
+      paths = superclass.source_paths
+      paths << File.expand_path('templates', __dir__)
+      paths.flatten
+    end
+
+    def generate
+      template 'authentication_helpers.rb.tt', 'lib/spree/authentication_helpers.rb'
+
+      file_action = File.exist?('config/initializers/spree.rb') ? :append_file : :create_file
+      send(file_action, 'config/initializers/spree.rb') do
+        %Q{
+          Rails.application.config.to_prepare do
+            require_dependency 'spree/authentication_helpers'
+          end\n}
+      end
+    end
+  end
+end

data/lib/generators/spree/{custom_user → custom_authentication}/templates/authentication_helpers.rb.tt

@@ -1,14 +1,4 @@
 module Spree
-  module CurrentUserHelpers
-    def self.included(receiver)
-      receiver.send :helper_method, :spree_current_user
-    end
-
-    def spree_current_user
-      current_user
-    end
-  end
-
   module AuthenticationHelpers
     def self.included(receiver)
       receiver.send :helper_method, :spree_login_path
@@ -30,7 +20,4 @@ module Spree
   end
 end
 
-ApplicationController.include Spree::AuthenticationHelpers
-ApplicationController.include Spree::CurrentUserHelpers
-
-Spree::Api::BaseController.include Spree::CurrentUserHelpers
+ApplicationController.include Spree::AuthenticationHelpers if defined?(ApplicationController)

data/lib/generators/spree/custom_user/custom_user_generator.rb

@@ -20,24 +20,19 @@ module Spree
 
     def generate
       migration_template 'migration.rb.tt', 'db/migrate/add_spree_fields_to_custom_user_table.rb'
-      template 'authentication_helpers.rb.tt', 'lib/spree/authentication_helpers.rb'
+      template 'current_user_helpers.rb.tt', 'lib/spree/current_user_helpers.rb'
 
       file_action = File.exist?('config/initializers/spree.rb') ? :append_file : :create_file
       send(file_action, 'config/initializers/spree.rb') do
         %Q{
           Rails.application.config.to_prepare do
-            require_dependency 'spree/authentication_helpers'
+            require_dependency 'spree/current_user_helpers'
           end\n}
       end
     end
 
     def self.next_migration_number(dirname)
-      if ApplicationRecord.timestamped_migrations
-        sleep 1 # make sure to get a different migration every time
-        Time.new.utc.strftime('%Y%m%d%H%M%S')
-      else
-        format('%.3d', (current_migration_number(dirname) + 1))
-      end
+      format('%.3d', (current_migration_number(dirname) + 1))
     end
 
     def klass

data/lib/generators/spree/custom_user/templates/current_user_helpers.rb.tt

@@ -0,0 +1,15 @@
+module Spree
+  module CurrentUserHelpers
+    def self.included(receiver)
+      receiver.send :helper_method, :spree_current_user
+    end
+
+    def spree_current_user
+      current_user
+    end
+  end
+end
+
+
+ApplicationController.include Spree::CurrentUserHelpers if defined?(ApplicationController)
+Spree::Api::BaseController.include Spree::CurrentUserHelpers if defined?(Spree::Api::BaseController)

data/lib/generators/spree/custom_user/templates/migration.rb.tt

@@ -1,7 +1,7 @@
 class AddSpreeFieldsToCustomUserTable < ActiveRecord::Migration[4.2]
   def up
     add_column <%= table_name.inspect %>, :spree_api_key, :string, limit: 48
-    add_column <%= table_name.inspect %>, :ship_address_id, :integer
-    add_column <%= table_name.inspect %>, :bill_address_id, :integer
+    add_column <%= table_name.inspect %>, :ship_address_id, :bigint
+    add_column <%= table_name.inspect %>, :bill_address_id, :bigint
   end
 end

data/lib/generators/spree/dummy/dummy_generator.rb

@@ -29,10 +29,9 @@ module Spree
       # calling slice on a Thor::CoreExtensions::HashWithIndifferentAccess
       # object has been known to return nil
       opts = {}.merge(options).slice(*PASSTHROUGH_OPTIONS)
-      opts[:database] = 'postgresql' if opts[:database].blank?
+      opts[:database] = 'sqlite3' if opts[:database].blank?
       opts[:force] = true
       opts[:skip_bundle] = true
-      opts[:skip_gemfile] = true
       opts[:skip_git] = true
       opts[:skip_listen] = true
       opts[:skip_rc] = true
@@ -57,10 +56,6 @@ module Spree
       template 'rails/test.rb', "#{dummy_path}/config/environments/test.rb", force: true
       template 'rails/script/rails', "#{dummy_path}/spec/dummy/script/rails", force: true
       template 'initializers/devise.rb', "#{dummy_path}/config/initializers/devise.rb", force: true
-
-      if lib_name == 'spree/backend'
-        template 'package.json', "#{dummy_path}/package.json", force: true
-      end
     end
 
     def test_dummy_inject_extension_requirements

data/lib/generators/spree/dummy/templates/rails/database.yml

@@ -8,7 +8,18 @@ end %>
 <% db_username = ENV['DB_USERNAME'] %>
 <% db_host = ENV['DB_HOST'] %>
 <% case ENV['DB']
-  when 'mysql' %>
+  when 'sqlite' %>
+development:
+  adapter: sqlite3
+  database: db/spree_development.sqlite3
+test:
+  adapter: sqlite3
+  database: db/spree_test.sqlite3
+  timeout: 10000
+production:
+  adapter: sqlite3
+  database: db/spree_production.sqlite3
+<% when 'mysql' %>
 mysql: &mysql
   adapter: mysql2
   encoding: utf8
@@ -57,26 +68,13 @@ production:
   <<: *postgres
   database: <%= database_prefix %><%= lib_name %>_spree_production
 <% else %>
-postgres: &postgres
-  adapter: postgresql
-  <% unless db_username.blank? %>
-  username: <%= db_username || 'postgres' %>
-  <% end %>
-  <% unless db_password.blank? %>
-  password: <%= db_password %>
-  <% end %>
-  <% unless db_host.blank? %>
-  host: <%= db_host %>
-  <% end %>
-  min_messages: warning
-
 development:
-  <<: *postgres
-  database: <%= database_prefix %><%= lib_name %>_spree_development
+  adapter: sqlite3
+  database: db/spree_development.sqlite3
 test:
-  <<: *postgres
-  database: <%= database_prefix %><%= lib_name %>_spree_test
+  adapter: sqlite3
+  database: db/spree_test.sqlite3
 production:
-  <<: *postgres
-  database: <%= database_prefix %><%= lib_name %>_spree_production
-<% end %>
+  adapter: sqlite3
+  database: db/spree_production.sqlite3
+<% end %>

data/lib/generators/spree/dummy/templates/rails/test.rb

@@ -36,7 +36,7 @@ Dummy::Application.configure do
 
   config.active_job.queue_adapter = :test
 
-  config.cache_store = :redis_cache_store
+  config.cache_store = :memory_store # we need to use memory store for Spree preferences
 
   routes.default_url_options = { host: 'localhost', port: 3000 }
 end

data/lib/generators/spree/install/templates/config/initializers/spree.rb

@@ -9,17 +9,40 @@
 #
 # In order to initialize a setting do:
 # config.setting_name = 'new value'
+#
+# More on configuring Spree preferences can be found at:
+# https://docs.spreecommerce.org/developer/customization
 Spree.config do |config|
   # Example:
   # Uncomment to stop tracking inventory levels in the application
   # config.track_inventory_levels = false
 end
 
+# Use a CDN host for images, eg. Cloudfront
+# This is used in the frontend to generate absolute URLs to images
+# Default is nil and your application host will be used
+# Spree.cdn_host = 'cdn.example.com'
+
+# Use a different service for storage (S3, google, etc)
+# unless Rails.env.test?
+#   Spree.private_storage_service_name = :amazon_public # public assets, such as product images
+#   Spree.public_storage_service_name = :amazon_private # private assets, such as invoices, etc
+# end
+
+# Use a different search engine for products
+# You can check the default search class at:
+# https://github.com/spree/spree/blob/main/core/lib/spree/core/search/base.rb
+# and use it as base class for your custom searcher
+# eg. MySearcher < Spree::Core::Search::Base
+# Spree.searcher_class = 'MySearcher'
+
 # Configure Spree Dependencies
 #
 # Note: If a dependency is set here it will NOT be stored within the cache & database upon initialization.
 #       Just removing an entry from this initializer will make the dependency value go away.
 #
+# More on how to use Spree dependencies can be found at:
+# https://docs.spreecommerce.org/customization/dependencies
 Spree.dependencies do |dependencies|
   # Example:
   # Uncomment to change the default Service handling adding Items to Cart
@@ -29,3 +52,5 @@ end
 # Spree::Api::Dependencies.storefront_cart_serializer = 'MyRailsApp::CartSerializer'
 
 Spree.user_class = <%= (options[:user_class].blank? ? 'Spree::LegacyUser' : options[:user_class]).inspect %>
+# Use a different class for admin users
+# Spree.admin_user_class = 'AdminUser'

data/lib/spree/core/configuration.rb

@@ -1,4 +1,4 @@
-# This is the primary location for defining spree preferences
+# This is the primary location for defining Spree Core preferences
 #
 # The expectation is that this is created once and stored in
 # the spree environment
@@ -22,29 +22,20 @@ module Spree
   module Core
     class Configuration < Preferences::Configuration
       # Alphabetized to more easily lookup particular preferences
-      preference :address_requires_state, :boolean, default: true # should state/state_name be required
+      preference :address_requires_state, :boolean, default: true, deprecated: true # should state/state_name be required
       preference :address_requires_phone, :boolean, default: true # Determines whether we require phone in address
-      preference :admin_path, :string, deprecated: true
-      preference :admin_products_per_page, :integer, deprecated: true
-      preference :admin_orders_per_page, :integer, deprecated: true
-      preference :admin_properties_per_page, :integer, deprecated: true
-      preference :admin_promotions_per_page, :integer, deprecated: true
-      preference :admin_customer_returns_per_page, :integer, deprecated: true
-      preference :admin_users_per_page, :integer, deprecated: true
-      preference :admin_show_version, :boolean, deprecated: true
       preference :allow_checkout_on_gateway_error, :boolean, default: false
-      preference :allow_guest_checkout, :boolean, default: true
+      preference :allow_guest_checkout, :boolean, default: true # this is only used in the rails frontend, and is not implemented in API
       preference :alternative_shipping_phone, :boolean, default: false # Request extra phone for ship addr
       preference :always_include_confirm_step, :boolean, default: false # Ensures confirmation step is always in checkout_progress bar, but does not force a confirm step if your payment methods do not support it.
       preference :always_put_site_name_in_title, :boolean, deprecated: true
-      preference :title_site_name_separator, :string, deprecated: true
       preference :auto_capture, :boolean, default: false # automatically capture the credit card (as opposed to just authorize and capture later)
       preference :auto_capture_on_dispatch, :boolean, default: false # Captures payment for each shipment in Shipment#after_ship callback, and makes Shipment.ready when payment authorized.
-      preference :binary_inventory_cache, :boolean, default: false # only invalidate product cache when a stock item changes whether it is in_stock
+      preference :binary_inventory_cache, :boolean, default: false, deprecated: true # only invalidate product cache when a stock item changes whether it is in_stock
       preference :checkout_zone, :string, default: nil, deprecated: true # replace with the name of a zone if you would like to limit the countries
       preference :company, :boolean, default: false # Request company field for billing and shipping addr
       preference :currency, :string, default: 'USD', deprecated: true
-      preference :default_country_id, :integer, deprecated: true
+      preference :credit_to_new_allocation, :boolean, default: false
       preference :disable_sku_validation, :boolean, default: false # when turned off disables the built-in SKU uniqueness validation
       preference :disable_store_presence_validation, :boolean, default: false # when turned off disables Store presence validation for Products and Payment Methods
       preference :expedited_exchanges, :boolean, default: false # NOTE this requires payment profiles to be supported on your gateway of choice as well as a delayed job handler to be configured with activejob. kicks off an exchange shipment upon return authorization save. charge customer if they do not return items within timely manner.
@@ -53,6 +44,7 @@ module Spree
       preference :logo, :string, deprecated: true
       preference :mailer_logo, :string, deprecated: true
       preference :max_level_in_taxons_menu, :integer, deprecated: true
+      preference :non_expiring_credit_types, :array, default: []
       preference :products_per_page, :integer, default: 12
       preference :require_master_price, :boolean, default: true
       preference :restock_inventory, :boolean, default: true # Determines if a return item is restocked automatically once it has been received
@@ -64,15 +56,14 @@ module Spree
       preference :show_products_without_price, :boolean, default: false
       preference :show_raw_product_description, :boolean, deprecated: true
       preference :tax_using_ship_address, :boolean, default: true
+      preference :title_site_name_separator, :string, deprecated: 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: []
-      preference :credit_to_new_allocation, :boolean, default: false
-
-      # Multi store configurations
-      preference :show_store_selector, :boolean, deprecated: true
+      # Sets the path used for products, taxons and pages.
+      preference :storefront_products_path, :string, default: 'products'
+      preference :storefront_taxons_path, :string, default: 't'
+      preference :storefront_pages_path, :string, default: 'pages'
 
       # searcher_class allows spree extension writers to provide their own Search class
       def searcher_class
@@ -80,11 +71,6 @@ module Spree
         @searcher_class ||= Spree.searcher_class
       end
 
-      # Sets the path used for products, taxons and pages.
-      preference :storefront_products_path, :string, default: 'products'
-      preference :storefront_taxons_path, :string, default: 't'
-      preference :storefront_pages_path, :string, default: 'pages'
-
       attr_writer :searcher_class
     end
   end

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

@@ -28,6 +28,10 @@ module Spree
           Spree::Locales::SetFallbackLocaleForStore.new.call(store: current_store)
         end
 
+        def default_locale
+          @default_locale ||= current_store&.default_locale || Rails.application.config.i18n.default_locale || I18n.default_locale
+        end
+
         def current_locale
           @current_locale ||= if user_locale?
                                 try_spree_current_user.selected_locale
@@ -36,7 +40,7 @@ module Spree
                               elsif config_locale?
                                 config_locale
                               else
-                                current_store&.default_locale || Rails.application.config.i18n.default_locale || I18n.default_locale
+                                default_locale
                               end
         end
 

data/lib/spree/core/engine.rb

@@ -1,11 +1,13 @@
 require_relative 'dependencies'
 require_relative 'configuration'
+require_relative 'runtime_configuration'
 
 module Spree
   module Core
     class Engine < ::Rails::Engine
       Environment = Struct.new(:calculators,
                                :preferences,
+                               :runtime_preferences,
                                :dependencies,
                                :payment_methods,
                                :adjusters,
@@ -23,9 +25,10 @@ module Spree
       end
 
       initializer 'spree.environment', before: :load_config_initializers do |app|
-        app.config.spree = Environment.new(SpreeCalculators.new, Spree::Core::Configuration.new, Spree::Core::Dependencies.new)
+        app.config.spree = Environment.new(SpreeCalculators.new, Spree::Core::Configuration.new, Spree::Core::RuntimeConfiguration.new, Spree::Core::Dependencies.new)
         app.config.active_record.yaml_column_permitted_classes = [Symbol, BigDecimal]
         Spree::Config = app.config.spree.preferences
+        Spree::RuntimeConfig = app.config.spree.runtime_preferences
         Spree::Dependencies = app.config.spree.dependencies
         Spree::Deprecation = ActiveSupport::Deprecation.new
       end

data/lib/spree/core/preferences/runtime_configuration.rb

@@ -0,0 +1,43 @@
+module Spree
+  module Preferences
+    class RuntimeConfiguration
+      def initialize
+        self.class.defaults.each do |key, value|
+          self[key] = value
+        end
+      end
+
+      def configure
+        yield(self) if block_given?
+      end
+
+      def get(preference)
+        send(preference)
+      end
+
+      alias [] get
+
+      def set(preference, value)
+        send("#{preference}=", value)
+      end
+
+      alias []= set
+
+      class << self
+        def preference(name, _type, default: nil, deprecated: false)
+          defaults[name] = default
+          deprecations[name] = deprecated
+          attr_accessor name
+        end
+
+        def defaults
+          @defaults ||= {}
+        end
+
+        def deprecations
+          @deprecations ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/spree/core/product_duplicator.rb

@@ -30,6 +30,8 @@ module Spree
           t.name = "COPY OF #{t.name}"
           t.slug = nil
         end
+
+        new_product.name = "COPY OF #{product.name}"
         new_product.taxons = product.taxons
         new_product.stores = product.stores
         new_product.created_at = nil

data/lib/spree/core/product_filters.rb

@@ -98,7 +98,12 @@ module Spree
         conds.each do |new_scope|
           scope = scope.or(new_scope)
         end
-        Product.with_property('brand').join_translation_table(ProductProperty).where(scope)
+
+        if Spree.use_translations?
+          Product.with_property('brand').join_translation_table(ProductProperty).where(scope)
+        else
+          Product.with_property('brand').where(scope)
+        end
       end
 
       def self.brand_filter
@@ -106,7 +111,9 @@ module Spree
         brands = brand_property ? Spree::ProductProperty.where(property_id: brand_property.id).pluck(:value).uniq.map(&:to_s) : []
 
         conditions = brands.map do |brand|
-          [brand, { ProductProperty.translation_table_alias => { value: brand } }]
+          table_name = Spree.use_translations? ? ProductProperty.translation_table_alias : ProductProperty.table_name
+
+          [brand, { table_name.to_s => { value: brand } }]
         end.to_h
 
         {

data/lib/spree/core/runtime_configuration.rb

@@ -0,0 +1,9 @@
+require 'spree/core/preferences/runtime_configuration'
+
+module Spree
+  module Core
+    class RuntimeConfiguration < Preferences::RuntimeConfiguration
+      preference :always_use_translations, :boolean, default: false
+    end
+  end
+end

data/lib/spree/core/version.rb

@@ -1,5 +1,5 @@
 module Spree
-  VERSION = '4.7.2'.freeze
+  VERSION = '4.8.0'.freeze
 
   def self.version
     VERSION

data/lib/spree/core/webhooks.rb

@@ -0,0 +1,13 @@
+module Spree
+  module Webhooks
+    def self.disable_webhooks
+      webhooks_disabled_previously = ENV['DISABLE_SPREE_WEBHOOKS']
+      begin
+        ENV['DISABLE_SPREE_WEBHOOKS'] = 'true'
+        yield
+      ensure
+        ENV['DISABLE_SPREE_WEBHOOKS'] = webhooks_disabled_previously
+      end
+    end
+  end
+end

data/lib/spree/core.rb

@@ -76,6 +76,10 @@ module Spree
     end
   end
 
+  def self.use_translations?
+    Spree::RuntimeConfig.always_use_translations || I18n.default_locale != I18n.locale
+  end
+
   # Used to configure Spree.
   #
   # Example:
@@ -141,3 +145,6 @@ require 'spree/core/controller_helpers/currency'
 
 require 'spree/core/preferences/store'
 require 'spree/core/preferences/scoped_store'
+require 'spree/core/preferences/runtime_configuration'
+
+require "spree/core/webhooks"