spree_core 4.3.0 → 4.6.1

data/lib/mobility/plugins/store_based_fallbacks.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'concurrent'
+require 'mobility'
+
+# The default implementation in the Mobility gem requires fallbacks to be defined when booting the application.
+# This patch allows to dynamically reconfigure translations fallbacks, by setting Mobility.store_based_fallbacks attribute.
+# The implementation is based on the default fallbacks plugin, with some changes around fetching the list of fallbacks to be used.
+# https://github.com/shioyama/mobility/blob/master/lib/mobility/plugins/fallbacks.rb
+module Mobility
+  @store_based_fallbacks = Concurrent::ThreadLocalVar.new(I18n::Locale::Fallbacks.new)
+
+  class << self
+    def store_based_fallbacks
+      @store_based_fallbacks.value
+    end
+
+    def store_based_fallbacks=(value)
+      @store_based_fallbacks.value = value
+    end
+  end
+
+  module Plugins
+    module StoreBasedFallbacks
+      extend ::Mobility::Plugin
+
+      default true
+      requires :backend, include: :before
+
+      # Applies fallbacks plugin to attributes. Completely disables fallbacks
+      # on model if option is +false+.
+      included_hook do |_, backend_class|
+        unless options[:fallbacks] == false
+          backend_class.include(BackendInstanceMethods)
+        end
+      end
+
+      module BackendInstanceMethods
+        def read(locale, fallback: true, **kwargs)
+          return super(locale, **kwargs) if !fallback || kwargs[:locale]
+
+          locales = Mobility.store_based_fallbacks[locale]
+          locales.each do |fallback_locale|
+            value = super(fallback_locale, **kwargs)
+            return value if Util.present?(value)
+          end
+
+          super(locale, **kwargs)
+        end
+      end
+    end
+
+    register_plugin(:store_based_fallbacks, StoreBasedFallbacks)
+  end
+end

data/lib/spree/core/configuration.rb

@@ -0,0 +1,91 @@
+# 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.
+      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
+
+      # 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,14 +7,16 @@ 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
           end
         end
 
-        # Needs to be overriden so that we use Spree's Ability rather than anyone else's.
+        # Needs to be overridden so that we use Spree's Ability rather than anyone else's.
         def current_ability
           @current_ability ||= Spree::Dependencies.ability_class.constantize.new(try_spree_current_user)
         end
@@ -34,8 +36,8 @@ module Spree
         end
 
         def current_oauth_token
-          get_last_access_token = ->(user) { Doorkeeper::AccessToken.active_for(user).where(expires_in: nil).last }
-          create_access_token = ->(user) { Doorkeeper::AccessToken.create!(resource_owner_id: user.id) }
+          get_last_access_token = ->(user) { Spree::OauthAccessToken.active_for(user).where(expires_in: nil).last }
+          create_access_token = ->(user) { Spree::OauthAccessToken.create!(resource_owner: user) }
           user = try_spree_current_user
           return unless user
 
@@ -82,7 +84,7 @@ module Spree
             redirect_to spree.forbidden_path
           else
             store_location
-            if request.fullpath.match(Spree.admin_path) && defined?(spree.admin_login_path)
+            if Spree.respond_to?(:admin_path) && request.fullpath.match(Spree.admin_path) && defined?(spree.admin_login_path)
               redirect_to spree.admin_login_path
             elsif respond_to?(:spree_login_path)
               redirect_to spree_login_path

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

@@ -17,6 +17,9 @@ module Spree
           attr_writer :title
 
           def title
+            ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+              ControllerHelpers::Common is deprecated and will be removed in Spree 5.0.
+            DEPRECATION
             title_string = @title.present? ? @title : accurate_title
             if title_string.present?
               if Spree::Config[:always_put_site_name_in_title] && !title_string.include?(default_title)
@@ -30,11 +33,17 @@ module Spree
           end
 
           def default_title
+            ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+              ControllerHelpers::Common is deprecated and will be removed in Spree 5.0.
+            DEPRECATION
             current_store.name
           end
 
           # this is a hook for subclasses to provide title
           def accurate_title
+            ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+              ControllerHelpers::Common is deprecated and will be removed in Spree 5.0.
+            DEPRECATION
             current_store.seo_title
           end
 
@@ -56,7 +65,12 @@ module Spree
           # Default layout is: +app/views/spree/layouts/spree_application+
           #
           def get_layout
-            layout ||= Spree::Config[:layout]
+            ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+              ControllerHelpers::Common is deprecated and will be removed in Spree 5.0.
+            DEPRECATION
+            return unless defined?(Spree::Frontend)
+
+            layout ||= Spree::Frontend::Config[:layout]
           end
         end
       end

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
@@ -20,7 +22,7 @@ module Spree
                                 elsif current_store.present?
                                   current_store.default_currency
                                 else
-                                  Spree::Config[:currency]
+                                  Spree::Store.default.default_currency
                                 end&.upcase
         end
 

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

@@ -6,29 +6,52 @@ module Spree
 
         included do
           before_action :set_locale
+          before_action :set_fallback_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
           I18n.locale = current_locale
         end
 
+        def set_fallback_locale
+          return unless respond_to?(:current_store) && current_store.present?
+
+          Spree::Locales::SetFallbackLocaleForStore.new.call(store: current_store)
+        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
@@ -52,6 +75,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

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,106 @@
+require_relative 'dependencies_helper'
+
+module Spree
+  module Core
+    class Dependencies
+      INJECTION_POINTS_WITH_DEFAULTS = {
+        # ability
+        ability_class: 'Spree::Ability',
+
+        # 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',
+
+        # data feeds
+        data_feeds_google_rss_service: 'Spree::DataFeeds::Google::Rss',
+        data_feeds_google_optional_attributes_service: 'Spree::DataFeeds::Google::OptionalAttributes',
+        data_feeds_google_required_attributes_service: 'Spree::DataFeeds::Google::RequiredAttributes',
+        data_feeds_google_optional_sub_attributes_service: 'Spree::DataFeeds::Google::OptionalSubAttributes',
+        data_feeds_google_products_list: 'Spree::DataFeeds::Google::ProductsList',
+
+        # 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'
+      }.freeze
+
+      include Spree::DependenciesHelper
+    end
+  end
+end

data/lib/spree/core/dependencies_helper.rb

@@ -0,0 +1,30 @@
+module Spree
+  module DependenciesHelper
+    def self.included(base)
+      injection_points = base::INJECTION_POINTS_WITH_DEFAULTS.keys.freeze
+      base.const_set(:INJECTION_POINTS, injection_points)
+      base.attr_accessor(*injection_points)
+    end
+
+    def initialize
+      set_default_values
+    end
+
+    def current_values
+      values = []
+      self.class::INJECTION_POINTS.each do |injection_point|
+        values << { injection_point.to_s => instance_variable_get("@#{injection_point}") }
+      end
+      values
+    end
+
+    private
+
+    def set_default_values
+      self.class::INJECTION_POINTS_WITH_DEFAULTS.each do |injection_point, default_value|
+        value = default_value.respond_to?(:call) ? default_value.call : default_value
+        instance_variable_set("@#{injection_point}", value)
+      end
+    end
+  end
+end