spree_core 4.0.0 → 4.6.0

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

@@ -8,18 +8,7 @@ end %>
 <% db_username = ENV['DB_USERNAME'] %>
 <% db_host = ENV['DB_HOST'] %>
 <% case ENV['DB']
-  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' %>
+  when 'mysql' %>
 mysql: &mysql
   adapter: mysql2
   encoding: utf8
@@ -68,13 +57,26 @@ 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:
-  adapter: sqlite3
-  database: db/spree_development.sqlite3
+  <<: *postgres
+  database: <%= database_prefix %><%= lib_name %>_spree_development
 test:
-  adapter: sqlite3
-  database: db/spree_test.sqlite3
+  <<: *postgres
+  database: <%= database_prefix %><%= lib_name %>_spree_test
 production:
-  adapter: sqlite3
-  database: db/spree_production.sqlite3
+  <<: *postgres
+  database: <%= database_prefix %><%= lib_name %>_spree_production
 <% end %>

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

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

data/lib/generators/spree/dummy_model/templates/model.rb.tt

@@ -1,5 +1,5 @@
 module Spree
-  class Spree::DummyModel < ApplicationRecord
+  class DummyModel < Spree::Base
     acts_as_list
     validates :name, presence: true
   end

data/lib/generators/spree/install/install_generator.rb

@@ -9,8 +9,10 @@ module Spree
   class InstallGenerator < Rails::Generators::Base
     class_option :migrate, type: :boolean, default: true, banner: 'Run Spree migrations'
     class_option :seed, type: :boolean, default: true, banner: 'load seed data (migrations must be run)'
-    class_option :sample, type: :boolean, default: true, banner: 'load sample data (migrations must be run)'
-    class_option :copy_views, type: :boolean, default: true, banner: 'copy frontend views from spree to your application for easy customization'
+    class_option :sample, type: :boolean, default: false, banner: 'load sample data (migrations must be run)'
+    class_option :install_storefront, type: :boolean, default: false, banner: 'installs default rails storefront'
+    class_option :install_admin, type: :boolean, default: false, banner: 'installs default rails admin'
+    class_option :copy_storefront, type: :boolean, default: false, banner: 'copy all storefront views and stylesheets'
     class_option :auto_accept, type: :boolean
     class_option :user_class, type: :string
     class_option :admin_email, type: :string
@@ -30,7 +32,9 @@ module Spree
       @run_migrations = options[:migrate]
       @load_seed_data = options[:seed]
       @load_sample_data = options[:sample]
-      @copy_views = options[:copy_views]
+      @install_storefront = options[:install_storefront]
+      @install_admin = options[:install_admin]
+      @copy_storefront = options[:copy_storefront]
 
       unless @run_migrations
         @load_seed_data = false
@@ -54,38 +58,31 @@ module Spree
         Disallow: /account
         Disallow: /api
         Disallow: /password
+        Disallow: /api_tokens
+        Disallow: /cart_link
+        Disallow: /account_link
       ROBOTS
     end
 
-    def setup_assets
-      @lib_name = 'spree'
-      %w{javascripts stylesheets images}.each do |path|
-        if Spree::Core::Engine.frontend_available? || Rails.env.test?
-          empty_directory "vendor/assets/#{path}/spree/frontend"
-        end
-        if Spree::Core::Engine.backend_available? || Rails.env.test?
-          empty_directory "vendor/assets/#{path}/spree/backend"
-        end
-      end
-
-      if Spree::Core::Engine.frontend_available? || Rails.env.test?
-        template 'vendor/assets/javascripts/spree/frontend/all.js'
-        template 'vendor/assets/stylesheets/spree/frontend/all.css'
-      end
+    def create_overrides_directory
+      empty_directory 'app/overrides'
+    end
 
-      if Spree::Core::Engine.backend_available? || Rails.env.test?
-        template 'vendor/assets/javascripts/spree/backend/all.js'
-        template 'vendor/assets/stylesheets/spree/backend/all.css'
+    def install_storefront
+      if @install_storefront && Spree::Core::Engine.frontend_available?
+        generate 'spree:frontend:install'
       end
     end
 
-    def create_overrides_directory
-      empty_directory 'app/overrides'
+    def install_admin
+      if @install_admin && Spree::Core::Engine.backend_available?
+        generate 'spree:backend:install'
+      end
     end
 
-    def copy_views
-      if @copy_views && Spree::Core::Engine.frontend_available?
-        generate 'spree:frontend:copy_views'
+    def copy_storefront
+      if @copy_storefront && Spree::Core::Engine.frontend_available?
+        generate 'spree:frontend:copy_storefront'
       end
     end
 
@@ -174,6 +171,8 @@ module Spree
     end
 
     def load_sample_data
+      return unless Spree::Core::Engine.sample_available?
+
       if @load_sample_data
         say_status :loading, 'sample data'
         silence_stream(STDOUT) do

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

@@ -26,5 +26,6 @@ Spree.dependencies do |dependencies|
   # dependencies.cart_add_item_service = 'MyNewAwesomeService'
 end
 
+# Spree::Api::Dependencies.storefront_cart_serializer = 'MyRailsApp::CartSerializer'
 
 Spree.user_class = <%= (options[:user_class].blank? ? 'Spree::LegacyUser' : options[:user_class]).inspect %>

data/lib/spree/core/components.rb

@@ -12,6 +12,14 @@ module Spree
       def self.frontend_available?
         @@frontend_available ||= ::Rails::Engine.subclasses.map(&:instance).map { |e| e.class.to_s }.include?('Spree::Frontend::Engine')
       end
+
+      def self.emails_available?
+        @@emails_available ||= ::Rails::Engine.subclasses.map(&:instance).map { |e| e.class.to_s }.include?('Spree::Emails::Engine')
+      end
+
+      def self.sample_available?
+        @@sample_available ||= ::Rails::Engine.subclasses.map(&:instance).map { |e| e.class.to_s }.include?('SpreeSample::Engine')
+      end
     end
   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,10 +36,12 @@ module Spree
         end
 
         def current_oauth_token
+          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
 
-          @current_oauth_token ||= Doorkeeper::AccessToken.active_for(user).last || Doorkeeper::AccessToken.create!(resource_owner_id: user.id)
+          @current_oauth_token ||= get_last_access_token.call(user) || create_access_token.call(user)
         end
 
         def store_location
@@ -71,12 +75,18 @@ module Spree
         # Override this method in your controllers if you want to have special behavior in case the user is not authorized
         # to access the requested action.  For example, a popup window might simply close itself.
         def redirect_unauthorized_access
+          ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+            Core::ControllerHelpers#redirect_unauthorized_access is deprecated and will be removed in Spree 5.0.
+            This method is implemented differently for Storefront and Admin
+          DEPRECATION
           if try_spree_current_user
             flash[:error] = Spree.t(:authorization_failure)
             redirect_to spree.forbidden_path
           else
             store_location
-            if respond_to?(:spree_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
             elsif spree.respond_to?(:root_path)
               redirect_to spree.root_path

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

@@ -10,8 +10,6 @@ module Spree
 
           layout :get_layout
 
-          before_action :set_user_language
-
           protected
 
           # can be used in views as well as controllers.
@@ -19,9 +17,12 @@ 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]
+              if Spree::Config[:always_put_site_name_in_title] && !title_string.include?(default_title)
                 [title_string, default_title].join(" #{Spree::Config[:title_site_name_separator]} ")
               else
                 title_string
@@ -32,22 +33,29 @@ 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
 
           private
 
           def set_user_language
-            locale = session[:locale]
-            locale = config_locale if respond_to?(:config_locale, true) && locale.blank?
-            locale = Rails.application.config.i18n.default_locale if locale.blank?
-            locale = I18n.default_locale unless I18n.available_locales.map(&:to_s).include?(locale.to_s)
-            I18n.locale = locale
+            ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+              ControllerHelpers::Common#set_user_language is deprecated and will be removed in Spree 5.0.
+              Please use `before_action :set_locale` instead
+            DEPRECATION
+
+            set_locale
           end
 
           # Returns which layout to render.
@@ -57,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

@@ -0,0 +1,56 @@
+module Spree
+  module Core
+    module ControllerHelpers
+      module Currency
+        extend ActiveSupport::Concern
+
+        included do
+          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
+          @current_currency ||= if defined?(session) && session.key?(:currency) && supported_currency?(session[:currency])
+                                  session[:currency]
+                                elsif params[:currency].present? && supported_currency?(params[:currency])
+                                  params[:currency]
+                                elsif current_store.present?
+                                  current_store.default_currency
+                                else
+                                  Spree::Store.default.default_currency
+                                end&.upcase
+        end
+
+        def supported_currencies
+          @supported_currencies ||= current_store&.supported_currencies_list
+        end
+
+        def supported_currencies_for_all_stores
+          @supported_currencies_for_all_stores ||= begin
+            (
+              Spree::Store.pluck(:supported_currencies).map { |c| c&.split(',') }.flatten + Spree::Store.pluck(:default_currency)
+            ).
+              compact.uniq.map { |code| ::Money::Currency.find(code.strip) }
+          end
+        end
+
+        def supported_currency?(currency_iso_code)
+          return false if supported_currencies.nil?
+
+          supported_currencies.map(&:iso_code).include?(currency_iso_code.upcase)
+        end
+
+        def currency_param
+          return if current_currency == current_store.default_currency
+
+          current_currency
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+module Spree
+  module Core
+    module ControllerHelpers
+      module Locale
+        extend ActiveSupport::Concern
+
+        included do
+          before_action :set_locale
+
+          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 current_locale
+          @current_locale ||= if user_locale?
+                                try_spree_current_user.selected_locale
+                              elsif params_locale?
+                                params[:locale]
+                              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
+
+        def supported_locale?(locale_code)
+          return false if supported_locales.nil?
+
+          supported_locales.include?(locale_code&.to_s)
+        end
+
+        def supported_locales_for_all_stores
+          @supported_locales_for_all_stores ||= Spree.available_locales
+        end
+
+        def available_locales
+          Spree::Store.available_locales
+        end
+
+        def locale_param
+          return if I18n.locale.to_s == current_store.default_locale || current_store.default_locale.nil?
+
+          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
+end

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

@@ -5,10 +5,10 @@ module Spree
         extend ActiveSupport::Concern
 
         included do
-          before_action :set_current_order
-
-          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.
@@ -21,13 +21,14 @@ module Spree
             @simple_current_order.last_ip_address = ip_address
             return @simple_current_order
           else
-            @simple_current_order = Spree::Order.new
+            @simple_current_order = current_store.orders.new
           end
         end
 
         # The current incomplete order from the token for use in cart and during checkout
         def current_order(options = {})
           options[:create_order_if_necessary] ||= false
+          options[:includes] ||= true
 
           if @current_order
             @current_order.last_ip_address = ip_address
@@ -37,7 +38,7 @@ module Spree
           @current_order = find_order_by_token_or_user(options, true)
 
           if options[:create_order_if_necessary] && (@current_order.nil? || @current_order.completed?)
-            @current_order = Spree::Order.create!(current_order_params)
+            @current_order = current_store.orders.create!(current_order_params)
             @current_order.associate_user! try_spree_current_user if try_spree_current_user
             @current_order.last_ip_address = ip_address
           end
@@ -53,10 +54,15 @@ module Spree
         end
 
         def set_current_order
-          if try_spree_current_user && current_order
-            try_spree_current_user.orders.incomplete.where('id != ?', current_order.id).each do |order|
-              current_order.merge!(order, try_spree_current_user)
-            end
+          return unless try_spree_current_user && current_order
+
+          orders_scope = try_spree_current_user.orders.
+                         incomplete.
+                         where.not(id: current_order.id).
+                         where(store_id: current_store.id)
+
+          orders_scope.each do |order|
+            current_order.merge!(order, try_spree_current_user)
           end
         end
 
@@ -66,19 +72,26 @@ module Spree
 
         private
 
-        def last_incomplete_order
-          @last_incomplete_order ||= try_spree_current_user.last_incomplete_spree_order(current_store)
+        def last_incomplete_order(includes = {})
+          @last_incomplete_order ||= try_spree_current_user.last_incomplete_spree_order(current_store, includes: includes)
         end
 
         def current_order_params
-          { currency: current_currency, token: cookies.signed[:token], store_id: current_store.id, user_id: try_spree_current_user.try(:id) }
+          { currency: current_currency, token: cookies.signed[:token], user_id: try_spree_current_user.try(:id) }
         end
 
         def find_order_by_token_or_user(options = {}, with_adjustments = false)
           options[:lock] ||= false
 
+          includes = if options[:includes]
+                       { line_items: [variant: [:images, :option_values, :product]] }
+                     else
+                       {}
+                     end
+
           # Find any incomplete orders for the token
-          incomplete_orders = Spree::Order.incomplete.includes(line_items: [variant: [:images, :option_values, :product]])
+          incomplete_orders = current_store.orders.incomplete.includes(includes)
+
           token_order_params = current_order_params.except(:user_id)
           order = if with_adjustments
                     incomplete_orders.includes(:adjustments).lock(options[:lock]).find_by(token_order_params)
@@ -87,7 +100,7 @@ module Spree
                   end
 
           # Find any incomplete orders for the current user
-          order = last_incomplete_order if order.nil? && try_spree_current_user
+          order = last_incomplete_order(includes) if order.nil? && try_spree_current_user
 
           order
         end

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

@@ -3,9 +3,10 @@ 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
+            searcher.current_currency = current_currency&.upcase
+            searcher.current_store = current_store
           end
         end
       end