solidus_core 2.10.5 → 2.11.0

data/lib/generators/{spree → solidus}/install/templates/config/initializers/spree.rb.tt

@@ -10,6 +10,15 @@ Spree.config do |config|
   # from address for transactional emails
   config.mails_from = "store@example.com"
 
+  # Use combined first and last name attribute in HTML views and API responses
+  config.use_combined_first_and_last_name_in_address = true
+
+  # Use legacy Spree::Order state machine
+  config.use_legacy_order_state_machine = false
+
+  # Use the legacy address' state validation logic
+  config.use_legacy_address_state_validator = false
+
   # Uncomment to stop tracking inventory levels in the application
   # config.track_inventory_levels = false
 
@@ -22,6 +31,33 @@ Spree.config do |config|
   config.image_attachment_module = 'Spree::Image::PaperclipAttachment'
   config.taxon_attachment_module = 'Spree::Taxon::PaperclipAttachment'
 
+  # Disable legacy Solidus custom CanCanCan actions aliases
+  config.use_custom_cancancan_actions = false
+
+  # Defaults
+
+  # Set this configuration to `true` to raise an exception when
+  # an order is populated with a line item with a mismatching
+  # currency. The `false` value will just add a validation error
+  # and will be the only behavior accepted in future versions.
+  # See https://github.com/solidusio/solidus/pull/3456 for more info.
+  config.raise_with_invalid_currency = false
+
+  # Set this configuration to false to always redirect the user to
+  # /unauthorized when needed, without trying to redirect them to
+  # their previous location first.
+  config.redirect_back_on_unauthorized = true
+
+  # Set this configuration to `true` to allow promotions
+  # with no associated actions to be considered active for use by customers.
+  # See https://github.com/solidusio/solidus/pull/3749 for more info.
+  config.consider_actionless_promotion_active = false
+
+  # Set this configuration to `false` to avoid running validations when
+  # updating an order. Be careful since you can end up having inconsistent
+  # data in your database turning it on.
+  # See https://github.com/solidusio/solidus/pull/3645 for more info.
+  config.run_order_validations_on_order_updater = true
 
   # Permission Sets:
 
@@ -89,11 +125,6 @@ end
 
 Spree.user_class = <%= (options[:user_class].blank? ? "Spree::LegacyUser" : options[:user_class]).inspect %>
 
-# If you want to add a field to the whitelisted ransackable attributes,
-# just uncomment the following code and change it as you need.
-#
-# Spree::Model.whitelisted_ransackable_attributes << 'field'
-
 # Rules for avoiding to store the current path into session for redirects
 # When at least one rule is matched, the request path will not be stored
 # in session.

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

@@ -1,197 +1,15 @@
 # frozen_string_literal: true
 
-require 'rails/generators'
-require 'bundler'
-require 'bundler/cli'
+require 'generators/solidus/install/install_generator'
 
 module Spree
   # @private
-  class InstallGenerator < Rails::Generators::Base
-    CORE_MOUNT_ROUTE = "mount Spree::Core::Engine"
-
-    class_option :migrate, type: :boolean, default: true, banner: 'Run Solidus 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 :auto_accept, type: :boolean
-    class_option :user_class, type: :string
-    class_option :admin_email, type: :string
-    class_option :admin_password, type: :string
-    class_option :lib_name, type: :string, default: 'spree'
-    class_option :enforce_available_locales, type: :boolean, default: nil
-
-    def self.source_paths
-      paths = superclass.source_paths
-      paths << File.expand_path('../templates', "../../#{__FILE__}")
-      paths << File.expand_path('../templates', "../#{__FILE__}")
-      paths << File.expand_path('templates', __dir__)
-      paths.flatten
-    end
-
-    def prepare_options
-      @run_migrations = options[:migrate]
-      @load_seed_data = options[:seed]
-      @load_sample_data = options[:sample]
-
-      unless @run_migrations
-         @load_seed_data = false
-         @load_sample_data = false
-      end
-    end
-
-    def add_files
-      template 'config/initializers/spree.rb.tt', 'config/initializers/spree.rb'
-    end
-
-    def additional_tweaks
-      return unless File.exist? 'public/robots.txt'
-      append_file "public/robots.txt", <<-ROBOTS.strip_heredoc
-        User-agent: *
-        Disallow: /checkout
-        Disallow: /cart
-        Disallow: /orders
-        Disallow: /user
-        Disallow: /account
-        Disallow: /api
-        Disallow: /password
-      ROBOTS
-    end
-
-    def setup_assets
-      @lib_name = 'spree'
-
-      empty_directory 'app/assets/images'
-
-      %w{javascripts stylesheets images}.each do |path|
-        empty_directory "vendor/assets/#{path}/spree/frontend" if defined? Spree::Frontend || Rails.env.test?
-        empty_directory "vendor/assets/#{path}/spree/backend" if defined? Spree::Backend || Rails.env.test?
-      end
-
-      if defined? Spree::Frontend || Rails.env.test?
-        template "vendor/assets/javascripts/spree/frontend/all.js"
-        template "vendor/assets/stylesheets/spree/frontend/all.css"
-      end
-
-      if defined? Spree::Backend || Rails.env.test?
-        template "vendor/assets/javascripts/spree/backend/all.js"
-        template "vendor/assets/stylesheets/spree/backend/all.css"
-      end
-    end
-
-    def create_overrides_directory
-      empty_directory "app/overrides"
-    end
-
-    def configure_application
-      application <<-RUBY
-    # Load application's model / class decorators
-    initializer 'spree.decorators' do |app|
-      config.to_prepare do
-        Dir.glob(Rails.root.join('app/**/*_decorator*.rb')) do |path|
-          require_dependency(path)
-        end
-      end
-    end
-
-    # Load application's view overrides
-    initializer 'spree.overrides' do |app|
-      config.to_prepare do
-        Dir.glob(Rails.root.join('app/overrides/*.rb')) do |path|
-          require_dependency(path)
-        end
-      end
-    end
-      RUBY
-
-      if !options[:enforce_available_locales].nil?
-        application <<-RUBY
-    # Prevent this deprecation message: https://github.com/svenfuchs/i18n/commit/3b6e56e
-    I18n.enforce_available_locales = #{options[:enforce_available_locales]}
-        RUBY
-      end
-    end
-
-    def include_seed_data
-      append_file "db/seeds.rb", <<-RUBY.strip_heredoc
-
-        Spree::Core::Engine.load_seed if defined?(Spree::Core)
-        Spree::Auth::Engine.load_seed if defined?(Spree::Auth)
-      RUBY
-    end
-
-    def install_migrations
-      say_status :copying, "migrations"
-      `rake railties:install:migrations`
-    end
-
-    def create_database
-      say_status :creating, "database"
-      rake 'db:create'
-    end
-
-    def run_migrations
-      if @run_migrations
-        say_status :running, "migrations"
-
-        rake 'db:migrate VERBOSE=false'
-      else
-        say_status :skipping, "migrations (don't forget to run rake db:migrate)"
-      end
-    end
-
-    def populate_seed_data
-      if @load_seed_data
-        say_status :loading,  "seed data"
-        rake_options = []
-        rake_options << "AUTO_ACCEPT=1" if options[:auto_accept]
-        rake_options << "ADMIN_EMAIL=#{options[:admin_email]}" if options[:admin_email]
-        rake_options << "ADMIN_PASSWORD=#{options[:admin_password]}" if options[:admin_password]
-
-        rake("db:seed #{rake_options.join(' ')}")
-      else
-        say_status :skipping, "seed data (you can always run rake db:seed)"
-      end
-    end
-
-    def load_sample_data
-      if @load_sample_data
-        say_status :loading, "sample data"
-        rake 'spree_sample:load'
-      else
-        say_status :skipping, "sample data (you can always run rake spree_sample:load)"
-      end
-    end
-
-    def install_routes
-      routes_file_path = File.join('config', 'routes.rb')
-      unless File.read(routes_file_path).include? CORE_MOUNT_ROUTE
-        insert_into_file routes_file_path, after: "Rails.application.routes.draw do\n" do
-          <<-RUBY
-  # This line mounts Solidus's routes at the root of your application.
-  # This means, any requests to URLs such as /products, will go to Spree::ProductsController.
-  # If you would like to change where this engine is mounted, simply change the :at option to something different.
-  #
-  # We ask that you don't use the :as option here, as Solidus relies on it being the default of "spree"
-  #{CORE_MOUNT_ROUTE}, at: '/'
-
-          RUBY
-        end
-      end
-
-      unless options[:quiet]
-        puts "*" * 50
-        puts "We added the following line to your application's config/routes.rb file:"
-        puts " "
-        puts "    #{CORE_MOUNT_ROUTE}, at: '/'"
-      end
-    end
-
-    def complete
-      unless options[:quiet]
-        puts "*" * 50
-        puts "Solidus has been installed successfully. You're all ready to go!"
-        puts " "
-        puts "Enjoy!"
-      end
+  class InstallGenerator < Solidus::InstallGenerator
+    def print_deprecation_warning
+      puts " "
+      puts "*" * 50
+      puts "spree:install generator is deprecated, please use solidus:install."
+      puts " "
     end
   end
 end

data/lib/solidus/migrations/promotions_with_code_handlers.rb

@@ -3,7 +3,7 @@
 module Solidus
   module Migrations
     module PromotionWithCodeHandlers
-      class PromotionCode < ActiveRecord::Base
+      class PromotionCode < Spree::Base
         self.table_name = "spree_promotion_codes"
       end
 

data/lib/spree/app_configuration.rb

@@ -24,12 +24,20 @@ require 'spree/core/environment'
 
 module Spree
   class AppConfiguration < Preferences::Configuration
-    # Alphabetized to more easily lookup particular preferences
+    # Preferences (alphabetized to more easily lookup particular preferences)
+
+    # @!attribute [rw] address_requires_phone
+    #   @return [Boolean] should phone number be required (default: +true+)
+    preference :address_requires_phone, :boolean, default: true
 
     # @!attribute [rw] address_requires_state
     #   @return [Boolean] should state/state_name be required (default: +true+)
     preference :address_requires_state, :boolean, default: true
 
+    # @!attribute [rw] legacy
+    #   @return [Boolean] use the legacy address' state validation logic (default: +true+)
+    preference :use_legacy_address_state_validator, :boolean, default: true
+
     # @!attribute [rw] admin_interface_logo
     #   @return [String] URL of logo used in admin (default: +'logo/solidus.svg'+)
     preference :admin_interface_logo, :string, default: 'logo/solidus.svg'
@@ -42,6 +50,12 @@ module Spree
     #   @return [Integer] Number of variants to display in admin (default: +20+)
     preference :admin_variants_per_page, :integer, default: 20
 
+    # @!attribute [rw] admin_vat_country_iso
+    #   Set this if you want to enter prices in the backend including value added tax.
+    #   @return [String, nil] Two-letter ISO code of that {Spree::Country} for which
+    #      prices are entered in the backend (default: nil)
+    preference :admin_vat_country_iso, :string, default: nil
+
     # @!attribute [rw] allow_checkout_on_gateway_error
     #   @return [Boolean] Allow checkout to complete after a failed payment (default: +false+)
     preference :allow_checkout_on_gateway_error, :boolean, default: false
@@ -50,6 +64,10 @@ module Spree
     #   @return [Boolean] When false, customers must create an account to complete an order (default: +true+)
     preference :allow_guest_checkout, :boolean, default: true
 
+    # @!attribute [rw] guest_token_cookie_options
+    #   @return [Hash] Add additional guest_token cookie options here (ie. domain or path)
+    preference :guest_token_cookie_options, :hash, default: {}
+
     # @!attribute [rw] allow_return_item_amount_editing
     #   @return [Boolean] Determines whether an admin is allowed to change a return item's pre-calculated amount (default: +false+)
     preference :allow_return_item_amount_editing, :boolean, default: false
@@ -78,6 +96,21 @@ module Spree
     #   @return [Boolean] Automatically capture the credit card (as opposed to just authorize and capture later) (default: +false+)
     preference :auto_capture_exchanges, :boolean, default: false
 
+    # @!attribute [rw] automatic_default_address
+    #   The default value of true preserves existing backwards compatible feature of
+    #   treating the most recently used address in checkout as the user's default address.
+    #   Setting to false means that the user should manage their own default via some
+    #   custom UI that uses AddressBookController.
+    #   @return [Boolean] Whether use of an address in checkout marks it as user's default
+    preference :automatic_default_address, :boolean, default: true
+
+    # @!attribute [rw] billing_address_required
+    #   Controls whether billing address is required or not in the checkout process
+    #   by default, can be overridden at order level.
+    #   (default: +false+)
+    #   @return [Boolean]
+    preference :billing_address_required, :boolean, default: false
+
     # @!attribute [rw] binary_inventory_cache
     #   Only invalidate product caches when they change from in stock to out of
     #   stock. By default, caches are invalidated on any change of inventory
@@ -88,20 +121,9 @@ module Spree
     #   @return [Boolean]
     preference :binary_inventory_cache, :boolean, default: false
 
-    # @!attribute [rw] completable_order_created_cutoff
-    #   @return [Integer] the number of days to look back for created orders which get returned to the user as last completed
-    preference :completable_order_created_cutoff_days, :integer, default: nil
-
-    # @!attribute [rw] completable_order_created_cutoff
-    #   @return [Integer] the number of days to look back for updated orders which get returned to the user as last completed
-    preference :completable_order_updated_cutoff_days, :integer, default: nil
-
-    # @!attribute [rw] inventory_cache_threshold
-    #   Only invalidate product caches when the count on hand for a stock item
-    #   falls below or rises about the inventory_cache_threshold.  When undefined, the
-    #   product caches will be invalidated anytime the count on hand is changed.
-    #   @return [Integer]
-    preference :inventory_cache_threshold, :integer
+    # @!attribute [rw] can_restrict_stock_management
+    #   @return [Boolean] Indicates if stock management can be restricted by location
+    preference :can_restrict_stock_management, :boolean, default: false
 
     # @!attribute [rw] checkout_zone
     #   @return [String] Name of a {Spree::Zone}, which limits available countries to those included in that zone. (default: +nil+)
@@ -111,11 +133,27 @@ module Spree
     #   @return [Boolean] Request company field for billing and shipping addresses. (default: +false+)
     preference :company, :boolean, default: false
 
+    # @!attribute [rw] completable_order_created_cutoff
+    #   @return [Integer] the number of days to look back for created orders which get returned to the user as last completed
+    preference :completable_order_created_cutoff_days, :integer, default: nil
+
+    # @!attribute [rw] completable_order_created_cutoff
+    #   @return [Integer] the number of days to look back for updated orders which get returned to the user as last completed
+    preference :completable_order_updated_cutoff_days, :integer, default: nil
+
+    # @!attribute [rw] credit_to_new_allocation
+    #   @return [Boolean] Creates a new allocation anytime {Spree::StoreCredit#credit} is called
+    preference :credit_to_new_allocation, :boolean, default: false
+
     # @!attribute [rw] currency
     #   Currency to use by default when not defined on the site (default: +"USD"+)
     #   @return [String] ISO 4217 Three letter currency code
     preference :currency, :string, default: "USD"
 
+    # @!attribute [rw] customer_returns_per_page
+    #   @return [Integer] Customer returns to show per-page in the admin (default: +15+)
+    preference :customer_returns_per_page, :integer, default: 15
+
     # @!attribute [rw] default_country_id
     #   @deprecated Use the default country ISO preference instead
     #   @return [Integer,nil] id of {Spree::Country} to be selected by default in dropdowns (default: nil)
@@ -126,17 +164,22 @@ module Spree
     #   @return [String] Two-letter ISO code of a {Spree::Country} to assumed as the country of an unidentified customer (default: "US")
     preference :default_country_iso, :string, default: 'US'
 
-    # @!attribute [rw] admin_vat_country_iso
-    #   Set this if you want to enter prices in the backend including value added tax.
-    #   @return [String, nil] Two-letter ISO code of that {Spree::Country} for which
-    #      prices are entered in the backend (default: nil)
-    preference :admin_vat_country_iso, :string, default: nil
+    # @!attribute [rw] use_custom_cancancan_actions
+    #   @return [Boolean] Allow to use legacy Solidus custom CanCanCan action aliases (default: +true+)
+    preference :use_custom_cancancan_actions, :boolean, default: true
 
     # @!attribute [rw] generate_api_key_for_all_roles
     #   @return [Boolean] Allow generating api key automatically for user
     #   at role_user creation for all roles. (default: +false+)
     preference :generate_api_key_for_all_roles, :boolean, default: false
 
+    # @!attribute [rw] inventory_cache_threshold
+    #   Only invalidate product caches when the count on hand for a stock item
+    #   falls below or rises about the inventory_cache_threshold.  When undefined, the
+    #   product caches will be invalidated anytime the count on hand is changed.
+    #   @return [Integer]
+    preference :inventory_cache_threshold, :integer
+
     # @!attribute [rw] layout
     #   @return [String] template to use for layout on the frontend (default: +"spree/layouts/spree_application"+)
     preference :layout, :string, default: 'spree/layouts/spree_application'
@@ -145,6 +188,14 @@ module Spree
     #   @return [String] URL of logo used on frontend (default: +'logo/solidus.svg'+)
     preference :logo, :string, default: 'logo/solidus.svg'
 
+    # @!attribute [rw] mails_from
+    #   @return [String] Email address used as +From:+ field in transactional emails.
+    preference :mails_from, :string, default: 'spree@example.com'
+
+    # @!attribute [rw] max_level_in_taxons_menu
+    #   @return [Integer] maximum nesting level in taxons menu (default: +1+)
+    preference :max_level_in_taxons_menu, :integer, default: 1
+
     # @!attribute [rw] order_bill_address_used
     #   @return [Boolean] Use the order's bill address, as opposed to storing
     #   bill addresses on payment sources. (default: +true+)
@@ -154,10 +205,6 @@ module Spree
     #   @return [Integer] the number of days to look back for fully-shipped/cancelled orders in order to charge for them
     preference :order_capturing_time_window, :integer, default: 14
 
-    # @!attribute [rw] max_level_in_taxons_menu
-    #   @return [Integer] maximum nesting level in taxons menu (default: +1+)
-    preference :max_level_in_taxons_menu, :integer, default: 1
-
     # @!attribute [rw] order_mutex_max_age
     #   @return [Integer] Max age of {Spree::OrderMutex} in seconds (default: 2 minutes)
     preference :order_mutex_max_age, :integer, default: 120
@@ -178,9 +225,22 @@ module Spree
     #   @return [Integer] Promotions to show per-page in the admin (default: +15+)
     preference :promotions_per_page, :integer, default: 15
 
-    # @!attribute [rw] customer_returns_per_page
-    #   @return [Integer] Customer returns to show per-page in the admin (default: +15+)
-    preference :customer_returns_per_page, :integer, default: 15
+    # @!attribute [rw] disable_actionless_promotion_validation
+    #   @return [Boolean] Promotions should have actions associated before being considered active (default: +true+)
+    preference :consider_actionless_promotion_active, :boolean, default: true
+
+    # @!attribute [rw] raise_with_invalid_currency
+    #   Whether to raise an exception if trying to set a line item currency
+    #   different from the order currency. When false a validation error
+    #   is added to the instance instead.
+    #   @return [Boolean] (default: +true+)
+    preference :raise_with_invalid_currency, :boolean, default: true
+
+    # @!attribute [rw] redirect_back_on_unauthorized
+    #   Whether to try to redirect users back when they try to access
+    #   unauthorized routes, before redirect them to /unauthorized.
+    #   @return [Boolean] (default: +false+)
+    preference :redirect_back_on_unauthorized, :boolean, default: false
 
     # @!attribute [rw] require_master_price
     #   @return [Boolean] Require a price on the master variant of a product (default: +true+)
@@ -200,6 +260,22 @@ module Spree
     #   (default: +['admin']+)
     preference :roles_for_auto_api_key, :array, default: ['admin']
 
+    # @!attribute [rw] countries_that_use_nested_subregions
+    #   @return [Array] An array of countries that use nested subregions, instead
+    #   of the default subregions that come with Carmen. Will be used on store creation
+    #   to ensure the correct states are generated, and when running the states
+    #   regenerate rake task.
+    #   (default: +['IT']+)
+    preference :countries_that_use_nested_subregions, :array, default: ['IT']
+
+    # @!attribute [rw] run_order_validations_on_order_updater
+    #   @return [Boolean] Whether to run validation when updating an order with the OrderUpdater
+    preference :run_order_validations_on_order_updater, :boolean, default: false
+
+    # @!attribute [rw] send_core_emails
+    #   @return [Boolean] Whether to send transactional emails (default: true)
+    preference :send_core_emails, :boolean, default: true
+
     # @!attribute [rw] shipping_instructions
     #   @return [Boolean] Request instructions/info for shipping (default: +false+)
     preference :shipping_instructions, :boolean, default: false
@@ -231,33 +307,23 @@ module Spree
     #   @return [] Track on_hand values for variants / products. (default: true)
     preference :track_inventory_levels, :boolean, default: true
 
-    # Default mail headers settings
-
-    # @!attribute [rw] send_core_emails
-    #   @return [Boolean] Whether to send transactional emails (default: true)
-    preference :send_core_emails, :boolean, default: true
-
-    # @!attribute [rw] mails_from
-    #   @return [String] Email address used as +From:+ field in transactional emails.
-    preference :mails_from, :string, default: 'spree@example.com'
-
-    # Store credits configurations
+    # @!attribute [rw] use_combined_first_and_last_name_in_address
+    #   @return [Boolean] Use Spree::Address combined first and last name in HTML views and
+    #   API responses. (default: +false+)
+    preference :use_combined_first_and_last_name_in_address, :boolean, default: false
 
-    # @!attribute [rw] credit_to_new_allocation
-    #   @return [Boolean] Creates a new allocation anytime {Spree::StoreCredit#credit} is called
-    preference :credit_to_new_allocation, :boolean, default: false
+    # @!attribute [rw] use_legacy_order_state_machine
+    #   @return [Boolean] Uses the legacy order state machine from Spree::Order::Checkout
+    #   (default: +false+)
+    preference :use_legacy_order_state_machine, :boolean, default: true
 
-    # @!attribute [rw] automatic_default_address
-    #   The default value of true preserves existing backwards compatible feature of
-    #   treating the most recently used address in checkout as the user's default address.
-    #   Setting to false means that the user should manage their own default via some
-    #   custom UI that uses AddressBookController.
-    #   @return [Boolean] Whether use of an address in checkout marks it as user's default
-    preference :automatic_default_address, :boolean, default: true
+    # The legacy_store_credit_category_name allows to control whether the legacy
+    # way of fetching the category should be used.
+    #
+    # @param [Boolean] enable/disable the legacy way of fetching the store category name
+    preference :use_legacy_store_credit_reimbursement_category_name, :boolean, default: true
 
-    # @!attribute [rw] can_restrict_stock_management
-    #   @return [Boolean] Indicates if stock management can be restricted by location
-    preference :can_restrict_stock_management, :boolean, default: false
+    # Other configurations
 
     # Allows restricting what currencies will be available.
     #