spree_core 4.4.0 → 4.5.0

data/config/routes.rb

@@ -1 +1,44 @@
+# direct method cannot be used inside engine routes
+# see: https://github.com/rails/rails/issues/34872
+Rails.application.routes.draw do
+  direct :cdn_image do |model, options|
+    if model.blob.service_name == 'cloudinary' && defined?(Cloudinary)
+      if model.class.method_defined?(:has_mvariation)
+        Cloudinary::Utils.cloudinary_url(model.blob.key,
+          width: model.variation.transformations[:resize_to_limit].first,
+          height: model.variation.transformations[:resize_to_limit].last,
+          crop: :fill
+        )
+      else
+        Cloudinary::Utils.cloudinary_url(model.blob.key)
+      end
+    elsif model.respond_to?(:signed_id)
+      route_for(
+        :rails_service_blob_proxy,
+        model.signed_id,
+        model.filename,
+        options.merge(
+          host: Spree.cdn_host || Rails.application.routes.default_url_options[:host],
+          port: Rails.application.routes.default_url_options[:port]
+        )
+      )
+    else
+      signed_blob_id = model.blob.signed_id
+      variation_key  = model.variation.key
+      filename       = model.blob.filename
+
+      route_for(
+        :rails_blob_representation_proxy,
+        signed_blob_id,
+        variation_key,
+        filename,
+        options.merge(
+          host: Spree.cdn_host || Rails.application.routes.default_url_options[:host],
+          port: Rails.application.routes.default_url_options[:port]
+        )
+      )
+    end
+  end
+end
+
 Spree::Core::Engine.draw_routes

data/db/migrate/20211201202851_update_linkable_resource_types.rb

@@ -0,0 +1,10 @@
+class UpdateLinkableResourceTypes < ActiveRecord::Migration[5.2]
+  def change
+    change_column_default :spree_menu_items, :linked_resource_type, 'Spree::Linkable::Uri'
+
+    Spree::MenuItem.where(linked_resource_type: 'URL').update_all(linked_resource_type: 'Spree::Linkable::Uri')
+    Spree::CmsSection.where(linked_resource_type: 'URL').update_all(linked_resource_type: 'Spree::Linkable::Uri')
+    Spree::MenuItem.where(linked_resource_type: 'Home Page').update_all(linked_resource_type: 'Spree::Linkable::Homepage')
+    Spree::CmsSection.where(linked_resource_type: 'Home Page').update_all(linked_resource_type: 'Spree::Linkable::Homepage')
+  end
+end

data/db/migrate/20211203082008_add_settings_to_payment_methods.rb

@@ -0,0 +1,11 @@
+class AddSettingsToPaymentMethods < ActiveRecord::Migration[5.2]
+  def change
+    change_table :spree_payment_methods do |t|
+      if t.respond_to? :jsonb
+        add_column :spree_payment_methods, :settings, :jsonb
+      else
+        add_column :spree_payment_methods, :settings, :json
+      end
+    end
+  end
+end

data/db/migrate/20211229162122_disable_propagate_all_variants_by_default.rb

@@ -0,0 +1,5 @@
+class DisablePropagateAllVariantsByDefault < ActiveRecord::Migration[5.2]
+  def change
+    change_column_default :spree_stock_locations, :propagate_all_variants, false
+  end
+end

data/db/migrate/20220103082046_add_status_and_make_active_at_to_spree_products.rb

@@ -0,0 +1,7 @@
+class AddStatusAndMakeActiveAtToSpreeProducts < ActiveRecord::Migration[5.2]
+  def change
+    add_column :spree_products, :status, :string, null: false, default: 'draft'
+    add_index :spree_products, :status
+    add_index :spree_products, %i[status deleted_at]
+  end
+end

data/db/migrate/20220106230929_add_internal_note_to_spree_orders.rb

@@ -0,0 +1,5 @@
+class AddInternalNoteToSpreeOrders < ActiveRecord::Migration[5.2]
+  def change
+    add_column :spree_orders, :internal_note, :text
+  end
+end

data/db/migrate/20220113052823_create_payment_sources.rb

@@ -0,0 +1,22 @@
+class CreatePaymentSources < ActiveRecord::Migration[5.2]
+  def change
+    create_table :spree_payment_sources do |t|
+      t.string :gateway_payment_profile_id
+      t.string :type, index: true
+
+      t.references :payment_method, index: true, foreign_key: { to_table: :spree_payment_methods }
+      t.references :user, index: true, foreign_key: { to_table: :spree_users }
+
+      if t.respond_to? :jsonb
+        t.jsonb :public_metadata
+        t.jsonb :private_metadata
+      else
+        t.json :public_metadata
+        t.json :private_metadata
+      end
+
+      t.index [:type, :gateway_payment_profile_id], unique: true, name: 'index_payment_sources_on_type_and_gateway_payment_profile_id'
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20220117100333_add_make_active_at_to_spree_products.rb

@@ -0,0 +1,17 @@
+class AddMakeActiveAtToSpreeProducts < ActiveRecord::Migration[5.2]
+  def change
+    add_column :spree_products, :make_active_at, :datetime
+    add_index :spree_products, :make_active_at
+
+    Spree::Product.
+      where('discontinue_on IS NULL or discontinue_on > ?', Time.current).
+      where('available_on <= ?', Time.current).
+      where(status: 'draft').
+      update_all(status: 'active', updated_at: Time.current)
+
+    Spree::Product.
+      where('discontinue_on <= ?', Time.current).
+      where.not(status: 'archived').
+      update_all(status: 'archived', updated_at: Time.current)
+  end
+end

data/db/migrate/20220120092821_add_metadata_to_spree_tax_rates.rb

@@ -0,0 +1,13 @@
+class AddMetadataToSpreeTaxRates < ActiveRecord::Migration[5.2]
+  def change
+    change_table :spree_tax_rates do |t|
+      if t.respond_to? :jsonb
+        add_column :spree_tax_rates, :public_metadata, :jsonb
+        add_column :spree_tax_rates, :private_metadata, :jsonb
+      else
+        add_column :spree_tax_rates, :public_metadata, :json
+        add_column :spree_tax_rates, :private_metadata, :json
+      end
+    end
+  end
+end

data/db/migrate/20220201103922_add_first_name_and_last_name_to_spree_users.rb

@@ -0,0 +1,9 @@
+class AddFirstNameAndLastNameToSpreeUsers < ActiveRecord::Migration[5.2]
+  def change
+    if Spree.user_class.present?
+      users_table_name = Spree.user_class.table_name
+      add_column users_table_name, :first_name, :string unless column_exists?(users_table_name, :first_name)
+      add_column users_table_name, :last_name, :string unless column_exists?(users_table_name, :last_name)
+    end
+  end
+end

data/db/migrate/20220222083546_add_barcode_to_spree_variants.rb

@@ -0,0 +1,6 @@
+class AddBarcodeToSpreeVariants < ActiveRecord::Migration[5.2]
+  def change
+    add_column :spree_variants, :barcode, :string
+    add_index :spree_variants, :barcode
+  end
+end

data/db/migrate/20220329113557_fix_cms_pages_unique_indexes.rb

@@ -0,0 +1,8 @@
+class FixCmsPagesUniqueIndexes < ActiveRecord::Migration[5.2]
+  def change
+    remove_index :spree_cms_pages, [:slug, :store_id, :deleted_at]
+    remove_index :spree_cms_pages, [:slug, :store_id], unique: true
+
+    add_index :spree_cms_pages, [:slug, :store_id, :deleted_at], unique: true
+  end
+end

data/db/migrate/20220613133029_add_metadata_to_spree_stock_items.rb

@@ -0,0 +1,13 @@
+class AddMetadataToSpreeStockItems < ActiveRecord::Migration[5.2]
+  def change
+    change_table :spree_stock_items do |t|
+      if t.respond_to? :jsonb
+        add_column :spree_stock_items, :public_metadata, :jsonb
+        add_column :spree_stock_items, :private_metadata, :jsonb
+      else
+        add_column :spree_stock_items, :public_metadata, :json
+        add_column :spree_stock_items, :private_metadata, :json
+      end
+    end
+  end
+end

data/lib/friendly_id/paranoia.rb

@@ -0,0 +1,4 @@
+require 'friendly_id'
+require 'paranoia'
+
+FriendlyId::Slug.acts_as_paranoid

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

@@ -38,13 +38,12 @@ module Spree
       opts[:skip_rc] = true
       opts[:skip_spring] = true
       opts[:skip_test] = true
-      opts[:skip_yarn] = true
-      opts[:skip_javascript] = true
       opts[:skip_bootsnap] = true
 
       puts 'Generating dummy Rails application...'
       invoke Rails::Generators::AppGenerator,
         [File.expand_path(dummy_path, destination_root)], opts
+      inject_yaml_permitted_classes
     end
 
     def test_dummy_config
@@ -58,6 +57,10 @@ 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
@@ -114,6 +117,14 @@ end
       ], before: /require '#{@lib_name}'/, verbose: true
     end
 
+    def inject_yaml_permitted_classes
+      inside dummy_path do
+        inject_into_file 'config/application.rb', %Q[
+    config.active_record.yaml_column_permitted_classes = [Symbol, BigDecimal, ActiveSupport::HashWithIndifferentAccess]
+        ], after: /config\.load_defaults.*$/, verbose: true
+      end
+    end
+
     def dummy_path
       ENV['DUMMY_PATH'] || 'spec/dummy'
     end

data/lib/generators/spree/dummy/templates/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "app",
+  "private": "true",
+  "dependencies": {
+    "@hotwired/turbo-rails": "^7.2.0",
+    "@spree/dashboard": "^0.2.1",
+    "esbuild": "^0.15.10"
+  },
+  "scripts": {
+    "build": "esbuild app/javascript/*.* --bundle --sourcemap --outdir=app/assets/builds"
+  }
+}

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

@@ -37,4 +37,6 @@ Dummy::Application.configure do
   config.active_job.queue_adapter = :test
 
   config.cache_store = :redis_cache_store
+
+  routes.default_url_options = { host: 'localhost', port: 3000 }
 end

data/lib/spree/core/configuration.rb

@@ -0,0 +1,90 @@
+# This is the primary location for defining spree preferences
+#
+# The expectation is that this is created once and stored in
+# the spree environment
+#
+# setters:
+# a.color = :blue
+# a[:color] = :blue
+# a.set :color = :blue
+# a.preferred_color = :blue
+#
+# getters:
+# a.color
+# a[:color]
+# a.get :color
+# a.preferred_color
+#
+require 'spree/core/search/base'
+require 'spree/core/preferences/configuration'
+
+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_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 :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 :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 :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.
+      preference :expedited_exchanges_days_window, :integer, default: 14 # the amount of days the customer has to return their item after the expedited exchange is shipped in order to avoid being charged
+      preference :layout, :string, deprecated: 'Please use Spree::Frontend::Config[:layout] instead'
+      preference :logo, :string, deprecated: true
+      preference :mailer_logo, :string, deprecated: true
+      preference :max_level_in_taxons_menu, :integer, deprecated: true
+      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
+      preference :return_eligibility_number_of_days, :integer, default: 365
+      preference :send_core_emails, :boolean, default: true # Default mail headers settings
+      preference :shipping_instructions, :boolean, deprecated: true
+      preference :show_only_complete_orders_by_default, :boolean, deprecated: true
+      preference :show_variant_full_price, :boolean, default: false # Displays variant full price or difference with product price. Default false to be compatible with older behavior
+      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 :track_inventory_levels, :boolean, default: true # Determines whether to track on_hand values for variants / products.
+
+      # 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
+
+      # searcher_class allows spree extension writers to provide their own Search class
+      def searcher_class
+        ActiveSupport::Deprecation.warn('`Spree::Config.searcher_class` is deprecated and will be removed in Spree v5, please use `Spree.searcher_class` instead.')
+        @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
+end

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

@@ -7,7 +7,9 @@ module Spree
 
         included do
           before_action :set_token
-          helper_method :try_spree_current_user
+          if defined?(helper_method)
+            helper_method :try_spree_current_user
+          end
 
           rescue_from CanCan::AccessDenied do |_exception|
             redirect_unauthorized_access

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

@@ -5,11 +5,13 @@ module Spree
         extend ActiveSupport::Concern
 
         included do
-          helper_method :supported_currencies
-          helper_method :supported_currencies_for_all_stores
-          helper_method :current_currency
-          helper_method :supported_currency?
-          helper_method :currency_param
+          if defined?(helper_method)
+            helper_method :supported_currencies
+            helper_method :supported_currencies_for_all_stores
+            helper_method :current_currency
+            helper_method :supported_currency?
+            helper_method :currency_param
+          end
         end
 
         def current_currency

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

@@ -7,12 +7,14 @@ module Spree
         included do
           before_action :set_locale
 
-          helper_method :supported_locales
-          helper_method :supported_locales_for_all_stores
-          helper_method :current_locale
-          helper_method :supported_locale?
-          helper_method :available_locales
-          helper_method :locale_param
+          if defined?(helper_method)
+            helper_method :supported_locales
+            helper_method :supported_locales_for_all_stores
+            helper_method :current_locale
+            helper_method :supported_locale?
+            helper_method :available_locales
+            helper_method :locale_param
+          end
         end
 
         def set_locale

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

@@ -5,8 +5,10 @@ module Spree
         extend ActiveSupport::Concern
 
         included do
-          helper_method :current_order
-          helper_method :simple_current_order
+          if defined?(helper_method)
+            helper_method :current_order
+            helper_method :simple_current_order
+          end
         end
 
         # Used in the link_to_cart helper.

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

@@ -3,7 +3,7 @@ module Spree
     module ControllerHelpers
       module Search
         def build_searcher(params)
-          Spree::Config.searcher_class.new(params).tap do |searcher|
+          Spree.searcher_class.new(params).tap do |searcher|
             searcher.current_user = try_spree_current_user
             searcher.current_currency = current_currency&.upcase
             searcher.current_store = current_store

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

@@ -5,9 +5,11 @@ module Spree
         extend ActiveSupport::Concern
 
         included do
-          helper_method :current_store
-          helper_method :current_price_options
-          helper_method :available_menus
+          if defined?(helper_method)
+            helper_method :current_store
+            helper_method :current_price_options
+            helper_method :available_menus
+          end
         end
 
         def current_store

data/lib/spree/core/dependencies.rb

@@ -0,0 +1,130 @@
+require_relative 'dependencies_helper'
+
+module Spree
+  module Core
+    class Dependencies
+      include Spree::DependenciesHelper
+
+      INJECTION_POINTS = [
+        :ability_class,
+        :cart_create_service, :cart_add_item_service, :cart_remove_item_service,
+        :cart_remove_line_item_service, :cart_set_item_quantity_service, :cart_recalculate_service,
+        :cms_page_finder, :cart_update_service, :checkout_next_service, :checkout_advance_service, :checkout_update_service,
+        :checkout_complete_service, :checkout_add_store_credit_service, :checkout_remove_store_credit_service, :checkout_get_shipping_rates_service,
+        :coupon_handler, :menu_finder, :country_finder, :current_order_finder, :credit_card_finder,
+        :completed_order_finder, :order_sorter, :cart_compare_line_items_service, :collection_paginator, :products_sorter,
+        :products_finder, :taxon_finder, :line_item_by_variant_finder, :cart_estimate_shipping_rates_service,
+        :account_create_address_service, :account_update_address_service, :account_create_service, :account_update_service,
+        :address_finder, :collection_sorter, :error_handler, :current_store_finder, :cart_empty_service, :cart_destroy_service,
+        :classification_reposition_service, :credit_cards_destroy_service, :cart_associate_service, :cart_change_currency_service,
+        :line_item_create_service, :line_item_update_service, :line_item_destroy_service,
+        :order_approve_service, :order_cancel_service, :shipment_change_state_service, :shipment_update_service,
+        :shipment_create_service, :shipment_add_item_service, :shipment_remove_item_service,
+        :payment_create_service, :address_create_service, :address_update_service,
+        :checkout_select_shipping_method_service
+      ].freeze
+
+      attr_accessor *INJECTION_POINTS
+
+      def initialize
+        set_default_ability
+        set_default_services
+        set_default_finders
+      end
+
+      private
+
+      def set_default_ability
+        @ability_class = 'Spree::Ability'
+      end
+
+      def set_default_services
+        # cart
+        @cart_compare_line_items_service = 'Spree::CompareLineItems'
+        @cart_create_service = 'Spree::Cart::Create'
+        @cart_add_item_service = 'Spree::Cart::AddItem'
+        @cart_update_service = 'Spree::Cart::Update'
+        @cart_recalculate_service = 'Spree::Cart::Recalculate'
+        @cart_remove_item_service = 'Spree::Cart::RemoveItem'
+        @cart_remove_line_item_service = 'Spree::Cart::RemoveLineItem'
+        @cart_set_item_quantity_service = 'Spree::Cart::SetQuantity'
+        @cart_estimate_shipping_rates_service = 'Spree::Cart::EstimateShippingRates'
+        @cart_empty_service = 'Spree::Cart::Empty'
+        @cart_destroy_service = 'Spree::Cart::Destroy'
+        @cart_associate_service = 'Spree::Cart::Associate'
+        @cart_change_currency_service = 'Spree::Cart::ChangeCurrency'
+
+        # checkout
+        @checkout_next_service = 'Spree::Checkout::Next'
+        @checkout_advance_service = 'Spree::Checkout::Advance'
+        @checkout_update_service = 'Spree::Checkout::Update'
+        @checkout_complete_service = 'Spree::Checkout::Complete'
+        @checkout_add_store_credit_service = 'Spree::Checkout::AddStoreCredit'
+        @checkout_remove_store_credit_service = 'Spree::Checkout::RemoveStoreCredit'
+        @checkout_get_shipping_rates_service = 'Spree::Checkout::GetShippingRates'
+        @checkout_select_shipping_method_service = 'Spree::Checkout::SelectShippingMethod'
+
+        # order
+        @order_approve_service = 'Spree::Orders::Approve'
+        @order_cancel_service = 'Spree::Orders::Cancel'
+
+        # shipment
+        @shipment_change_state_service = 'Spree::Shipments::ChangeState'
+        @shipment_create_service = 'Spree::Shipments::Create'
+        @shipment_update_service = 'Spree::Shipments::Update'
+        @shipment_add_item_service = 'Spree::Shipments::AddItem'
+        @shipment_remove_item_service = 'Spree::Shipments::RemoveItem'
+
+        # sorter
+        @collection_sorter = 'Spree::BaseSorter'
+        @order_sorter = 'Spree::BaseSorter'
+        @products_sorter = 'Spree::Products::Sort'
+
+        # paginator
+        @collection_paginator = 'Spree::Shared::Paginate'
+
+        # coupons
+        # TODO: we should split this service into 2 separate - Add and Remove
+        @coupon_handler = 'Spree::PromotionHandler::Coupon'
+
+        # account
+        @account_create_service = 'Spree::Account::Create'
+        @account_update_service = 'Spree::Account::Update'
+
+        # addresses
+        @address_create_service = 'Spree::Addresses::Create'
+        @address_update_service = 'Spree::Addresses::Update'
+
+        # credit cards
+        @credit_cards_destroy_service = 'Spree::CreditCards::Destroy'
+
+        # classifications
+        @classification_reposition_service = 'Spree::Classifications::Reposition'
+
+        # line items
+        @line_item_create_service = 'Spree::LineItems::Create'
+        @line_item_update_service = 'Spree::LineItems::Update'
+        @line_item_destroy_service = 'Spree::LineItems::Destroy'
+
+        @payment_create_service = 'Spree::Payments::Create'
+
+        # errors
+        @error_handler = 'Spree::ErrorReporter'
+      end
+
+      def set_default_finders
+        @address_finder = 'Spree::Addresses::Find'
+        @country_finder = 'Spree::Countries::Find'
+        @cms_page_finder = 'Spree::CmsPages::Find'
+        @menu_finder = 'Spree::Menus::Find'
+        @current_order_finder = 'Spree::Orders::FindCurrent'
+        @current_store_finder = 'Spree::Stores::FindCurrent'
+        @completed_order_finder = 'Spree::Orders::FindComplete'
+        @credit_card_finder = 'Spree::CreditCards::Find'
+        @products_finder = 'Spree::Products::Find'
+        @taxon_finder = 'Spree::Taxons::Find'
+        @line_item_by_variant_finder = 'Spree::LineItems::FindByVariant'
+      end
+    end
+  end
+end