solidus_core 4.6.2 → 4.7.0

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'rails/version'
-require 'rails/generators'
-require 'rails/generators/app_base'
+require "rails/version"
+require "rails/generators"
+require "rails/generators/app_base"
 
 module Solidus
   # @private
@@ -12,30 +12,30 @@ module Solidus
     CORE_MOUNT_ROUTE = "mount Spree::Core::Engine"
 
     FRONTENDS = [
-      { name: 'starter', description: 'Generate all necessary controllers and views directly in your Rails app', default: true },
-      { name: 'none', description: 'Skip installing a frontend' }
+      {name: "starter", description: "Generate all necessary controllers and views directly in your Rails app", default: true},
+      {name: "none", description: "Skip installing a frontend"}
     ]
 
     AUTHENTICATIONS = [
-      { name: 'devise', description: 'Install and configure the standard `devise` integration', default: true },
-      { name: 'existing', description: 'Integrate and configure an existing `devise` setup' },
-      { name: 'custom', description: 'A starter configuration for rolling your own authentication system' },
-      { name: 'none', description: 'Don\'t add any configuration for authentication' }
+      {name: "devise", description: "Install and configure the standard `devise` integration", default: true},
+      {name: "existing", description: "Integrate and configure an existing `devise` setup"},
+      {name: "custom", description: "A starter configuration for rolling your own authentication system"},
+      {name: "none", description: "Don't add any configuration for authentication"}
     ]
 
     PAYMENT_METHODS = [
-      { name: 'paypal', description: 'Install `solidus_paypal_commerce_platform`', default: true },
-      { name: 'stripe', description: 'Install `solidus_stripe`', default: false },
-      { name: 'braintree', description: 'Install `solidus_braintree`', default: false },
-      { name: 'none', description: 'Skip installing a payment method', default: false }
+      {name: "paypal", description: "Install `solidus_paypal_commerce_platform`", default: true},
+      {name: "stripe", description: "Install `solidus_stripe`", default: false},
+      {name: "braintree", description: "Install `solidus_braintree`", default: false},
+      {name: "none", description: "Skip installing a payment method", default: false}
     ]
 
-    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 and seeds must be run)'
-    class_option :active_storage, type: :boolean, default: true, banner: 'Install ActiveStorage as image attachments handler for products and taxons'
-    class_option :admin_preview, type: :boolean, default: true, desc: 'Install the admin preview'
-    class_option :build_admin_tailwind, type: :boolean, default: true, desc: 'Build and install Solidus Admin Tailwind CSS file and rake tasks'
+    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 and seeds must be run)"
+    class_option :active_storage, type: :boolean, default: true, banner: "Install ActiveStorage as image attachments handler for products and taxons"
+    class_option :admin_preview, type: :boolean, default: true, desc: "Install the admin preview"
+    class_option :build_admin_tailwind, type: :boolean, default: true, desc: "Build and install Solidus Admin Tailwind CSS file and rake tasks"
     class_option :auto_accept, type: :boolean
     class_option :user_class, type: :string
     class_option :admin_email, type: :string
@@ -58,45 +58,45 @@ module Solidus
       @load_sample_data = options[:sample] && @run_migrations && @load_seed_data
 
       @selected_frontend = selected_option_for(
-        'frontend',
-        selected: ENV['FRONTEND'] || options[:frontend],
-        available_options: FRONTENDS,
+        "frontend",
+        selected: ENV["FRONTEND"] || options[:frontend],
+        available_options: FRONTENDS
       )
 
       @selected_authentication = selected_option_for(
-        'authentication',
+        "authentication",
         selected:
-          ('devise' if @selected_frontend == 'starter') ||
-          ('devise' if has_gem?('solidus_auth_devise')) ||
-          ENV['AUTHENTICATION'] || options[:authentication],
-        available_options: AUTHENTICATIONS,
+          ("devise" if @selected_frontend == "starter") ||
+          ("devise" if has_gem?("solidus_auth_devise")) ||
+          ENV["AUTHENTICATION"] || options[:authentication],
+        available_options: AUTHENTICATIONS
       )
 
       @selected_payment_method = selected_option_for(
-        'payment method',
+        "payment method",
         selected:
-          ('paypal' if has_gem?('solidus_paypal_commerce_platform')) ||
-          ('stripe' if has_gem?('solidus_stripe')) ||
-          ('bolt' if has_gem?('solidus_bolt')) ||
-          ENV['PAYMENT_METHOD'] || options[:payment_method],
-        available_options: PAYMENT_METHODS,
+          ("paypal" if has_gem?("solidus_paypal_commerce_platform")) ||
+          ("stripe" if has_gem?("solidus_stripe")) ||
+          ("bolt" if has_gem?("solidus_bolt")) ||
+          ENV["PAYMENT_METHOD"] || options[:payment_method],
+        available_options: PAYMENT_METHODS
       )
 
       # Silence verbose output (e.g. Rails migrations will rely on this environment variable)
-      ENV['VERBOSE'] = 'false'
+      ENV["VERBOSE"] = "false"
 
       # No reason to check for their presence if we're about to install them
-      ENV['SOLIDUS_SKIP_MIGRATIONS_CHECK'] = 'true'
+      ENV["SOLIDUS_SKIP_MIGRATIONS_CHECK"] = "true"
     end
 
     def install_routes
-      if Pathname(app_path).join('config', 'routes.rb').read.include? CORE_MOUNT_ROUTE
+      if Pathname(app_path).join("config", "routes.rb").read.include? CORE_MOUNT_ROUTE
         say_status :route_exist, CORE_MOUNT_ROUTE, :blue
       else
         say_status :installing, "solidus routes"
         mount_point = options[:mount_point] || ask_with_default(
           desc: 'Where would you like to mount Solidus? (E.g. "/store" or "/shop")',
-          default: '/',
+          default: "/"
         )
 
         shell.mute do
@@ -120,23 +120,23 @@ module Solidus
     end
 
     def add_files
-      template 'config/initializers/spree.rb.tt', 'config/initializers/spree.rb'
+      template "config/initializers/spree.rb.tt", "config/initializers/spree.rb"
     end
 
     def install_file_attachment
       if options[:active_storage]
         say_status :assets, "Active Storage", :green
-        rake 'active_storage:install'
+        rake "active_storage:install"
       else
         say_status :assets, "Paperclip", :green
-        gsub_file 'config/initializers/spree.rb', "::ActiveStorageAttachment", "::PaperclipAttachment"
+        gsub_file "config/initializers/spree.rb", "::ActiveStorageAttachment", "::PaperclipAttachment"
       end
     end
 
     def setup_assets
-      empty_directory 'app/assets/images'
+      empty_directory "app/assets/images"
 
-      %w{javascripts stylesheets images}.each do |path|
+      %w[javascripts stylesheets images].each do |path|
         empty_directory "vendor/assets/#{path}/spree/backend" if defined?(Spree::Backend) || Rails.env.test?
       end
 
@@ -158,19 +158,19 @@ module Solidus
 
     def install_migrations
       say_status :copying, "migrations"
-      rake 'railties:install:migrations'
+      rake "railties:install:migrations"
     end
 
     def create_database
       say_status :creating, "database"
-      rake 'db:create'
+      rake "db:create"
     end
 
     def run_migrations
       if @run_migrations
         say_status :running, "migrations"
 
-        rake 'db:migrate'
+        rake "db:migrate"
       else
         say_status :skipping, "migrations (don't forget to run rake db:migrate)"
       end
@@ -186,10 +186,10 @@ module Solidus
       return unless options[:admin_preview]
 
       say_status :installing, "SolidusAdmin", :blue
-      unless File.read(app_path.join('Gemfile')).include?('solidus_admin')
+      unless File.read(app_path.join("Gemfile")).include?("solidus_admin")
         bundle_command 'add solidus_admin -v ">= 0.2"'
       end
-      generate "solidus_admin:install #{'--tailwind' if options[:build_admin_tailwind]}"
+      generate "solidus_admin:install #{"--tailwind" if options[:build_admin_tailwind]}"
     end
 
     def populate_seed_data
@@ -200,7 +200,7 @@ module Solidus
         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(' ')}")
+        rake("db:seed #{rake_options.join(" ")}")
       else
         say_status :skipping, "seed data (you can always run rake db:seed)"
       end
@@ -209,7 +209,7 @@ module Solidus
     def load_sample_data
       if @load_sample_data
         say_status :loading, "sample data"
-        rake 'spree_sample:load'
+        rake "spree_sample:load"
       else
         say_status :skipping, "sample data (you can always run rake spree_sample:load)"
       end
@@ -223,7 +223,7 @@ module Solidus
 
     def bundle_command(command, env = {})
       # Make `bundle install` less verbose by skipping the "Using ..." messages
-      super(command, env.reverse_merge('BUNDLE_SUPPRESS_INSTALL_USING_MESSAGES' => 'true'))
+      super(command, env.reverse_merge("BUNDLE_SUPPRESS_INSTALL_USING_MESSAGES" => "true"))
     ensure
       Bundler.reset_paths!
     end
@@ -268,7 +268,7 @@ module Solidus
 
     def apply_template_for(topic, selected)
       template_path = Dir["#{__dir__}/app_templates/#{topic}/*.rb"].find do |path|
-        File.basename(path, '.rb') == selected
+        File.basename(path, ".rb") == selected
       end
 
       unless template_path

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

@@ -21,6 +21,9 @@ Spree.config do |config|
   config.image_attachment_module = 'Spree::Image::ActiveStorageAttachment'
   config.taxon_attachment_module = 'Spree::Taxon::ActiveStorageAttachment'
 
+  # Uncomment to recalculate cart prices when the cart changes
+  # config.recalculate_cart_prices = true
+
   # Defaults
   # Permission Sets:
 

data/lib/generators/solidus/update/update_generator.rb

@@ -1,46 +1,46 @@
 # frozen_string_literal: true
 
-require 'spree/preferences/preference_differentiator'
-require 'rails/generators'
+require "spree/preferences/preference_differentiator"
+require "rails/generators"
 
 module Solidus
   # @private
   class UpdateGenerator < ::Rails::Generators::Base
     FROM = Spree.previous_solidus_minor_version
 
-    desc 'Generates a new initializer to preview the new defaults for current Solidus version and copy new migrations'
+    desc "Generates a new initializer to preview the new defaults for current Solidus version and copy new migrations"
 
-    source_root File.expand_path('templates', __dir__)
+    source_root File.expand_path("templates", __dir__)
 
     class_option :initializer_basename,
-                 type: :string,
-                 default: 'new_solidus_defaults',
-                 banner: 'The name for the new initializer'
+      type: :string,
+      default: "new_solidus_defaults",
+      banner: "The name for the new initializer"
 
     class_option :previous_version_prompt,
-                 type: :boolean,
-                 default: true,
-                 banner: 'Prompt to warn about only previous version support'
+      type: :boolean,
+      default: true,
+      banner: "Prompt to warn about only previous version support"
 
     class_option :from,
-                 type: :string,
-                 default: FROM,
-                 banner: 'Solidus version from which you are upgrading'
+      type: :string,
+      default: FROM,
+      banner: "Solidus version from which you are upgrading"
 
     class_option :to,
-                 type: :string,
-                 default: Spree.solidus_version,
-                 hide: true
+      type: :string,
+      default: Spree.solidus_version,
+      hide: true
 
     class_option :initializer_directory,
-                 type: :string,
-                 default: 'config/initializers/',
-                 hide: true
+      type: :string,
+      default: "config/initializers/",
+      hide: true
 
     class_option :install_migrations,
-                 type: :boolean,
-                 default: true,
-                 hide: true
+      type: :boolean,
+      default: true,
+      hide: true
 
     def create_new_defaults_initializer
       previous_version_prompt = options[:previous_version_prompt]
@@ -58,15 +58,15 @@ module Solidus
       @backend_changes = backend_changes_template(from, to)
       @api_changes = api_changes_template(from, to)
 
-      template 'config/initializers/new_solidus_defaults.rb.tt',
-               File.join(options[:initializer_directory], "#{options[:initializer_basename]}.rb")
+      template "config/initializers/new_solidus_defaults.rb.tt",
+        File.join(options[:initializer_directory], "#{options[:initializer_basename]}.rb")
     end
 
     def install_migrations
       return unless options[:install_migrations]
 
       say_status :copying, "migrations"
-      rake 'spree:install:migrations'
+      rake "spree:install:migrations"
     end
 
     def print_message
@@ -92,26 +92,26 @@ module Solidus
     end
 
     def frontend_changes_template(from, to)
-      return '' unless defined?(Spree::Frontend::Engine)
+      return "" unless defined?(Spree::Frontend::Engine)
 
       changes_template_for(Spree::FrontendConfiguration, from, to)
     end
 
     def backend_changes_template(from, to)
-      return '' unless defined?(Spree::Backend::Engine)
+      return "" unless defined?(Spree::Backend::Engine)
 
       changes_template_for(Spree::BackendConfiguration, from, to)
     end
 
     def api_changes_template(from, to)
-      return '' unless defined?(Spree::Api::Engine)
+      return "" unless defined?(Spree::Api::Engine)
 
       changes_template_for(Spree::ApiConfiguration, from, to)
     end
 
     def changes_template_for(klass, from, to)
       changes = Spree::Preferences::PreferenceDifferentiator.new(klass).call(from:, to:)
-      return '# No changes' if changes.empty?
+      return "# No changes" if changes.empty?
 
       [
         ["config.load_defaults('#{from}')"] +

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rails/generators/active_record/migration'
+require "rails/generators/active_record/migration"
 
 module Spree
   # @private
@@ -9,7 +9,7 @@ module Spree
 
     desc "Set up a Solidus installation with a custom User class"
 
-    source_root File.expand_path('templates', File.dirname(__FILE__))
+    source_root File.expand_path("templates", File.dirname(__FILE__))
 
     def check_for_constant
       klass
@@ -19,17 +19,17 @@ module Spree
     end
 
     def generate
-      migration_template 'migration.rb.tt', "db/migrate/add_spree_fields_to_custom_user_table.rb"
-      template 'authentication_helpers.rb.tt', "lib/spree/authentication_helpers.rb"
+      migration_template "migration.rb.tt", "db/migrate/add_spree_fields_to_custom_user_table.rb"
+      template "authentication_helpers.rb.tt", "lib/spree/authentication_helpers.rb"
 
-      initializer 'solidus_authentication', <<~RUBY
+      initializer "solidus_authentication", <<~RUBY
         Rails.application.config.to_prepare do
           ApplicationController.include Spree::AuthenticationHelpers, Spree::CurrentUserHelpers
           Spree::Api::BaseController.include Spree::CurrentUserHelpers if defined? Spree::Api
         end
       RUBY
 
-      gsub_file 'config/initializers/spree.rb', /Spree\.user_class.?=.?.+$/, %{Spree.user_class = "#{class_name}"}
+      gsub_file "config/initializers/spree.rb", /Spree\.user_class.?=.?.+$/, %(Spree.user_class = "#{class_name}")
     end
 
     private

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

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
 require "rails/generators/rails/app/app_generator"
-require 'active_support/core_ext/hash'
-require 'spree/core/version'
+require "active_support/core_ext/hash"
+require "spree/core/version"
 
 module Spree
   # @private
   class DummyGenerator < Rails::Generators::Base
     desc "Creates blank Rails application, installs Solidus and all sample data"
 
-    class_option :lib_name, default: ''
-    class_option :database, default: ''
+    class_option :lib_name, default: ""
+    class_option :database, default: ""
 
     def self.source_paths
       paths = superclass.source_paths
-      paths << File.expand_path('templates', __dir__)
+      paths << File.expand_path("templates", __dir__)
       paths.flatten
     end
 
@@ -30,7 +30,7 @@ module Spree
       # calling slice on a Thor::CoreExtensions::HashWithIndifferentAccess
       # object has been known to return nil
       opts = {}.merge(options).slice(*PASSTHROUGH_OPTIONS)
-      opts[:database] = 'sqlite3' if opts[:database].blank?
+      opts[:database] = "sqlite3" if opts[:database].blank?
       opts[:force] = true
       opts[:skip_bundle] = true
       opts[:skip_gemfile] = true
@@ -68,9 +68,9 @@ module Spree
     def test_dummy_inject_extension_requirements
       if DummyGeneratorHelper.inject_extension_requirements
         inside dummy_path do
-          inject_require_for('spree_frontend')
-          inject_require_for('spree_backend')
-          inject_require_for('spree_api')
+          inject_require_for("spree_frontend")
+          inject_require_for("spree_backend")
+          inject_require_for("spree_api")
         end
       end
     end
@@ -98,23 +98,21 @@ module Spree
     protected
 
     def inject_require_for(requirement)
-      inject_into_file 'config/application.rb', (
-        <<~RUBY
-          begin
-            require '#{requirement}'
-          rescue LoadError
-            # #{requirement} is not available.
-          end
-        RUBY
-      ), before: /require '#{@lib_name}'/, verbose: true
+      inject_into_file "config/application.rb", <<~RUBY, before: /require '#{@lib_name}'/, verbose: true
+        begin
+          require '#{requirement}'
+        rescue LoadError
+          # #{requirement} is not available.
+        end
+      RUBY
     end
 
     def dummy_path
-      ENV['DUMMY_PATH'] || 'spec/dummy'
+      ENV["DUMMY_PATH"] || "spec/dummy"
     end
 
     def module_name
-      'Dummy'
+      "Dummy"
     end
 
     def application_definition
@@ -126,10 +124,10 @@ module Spree
         end
       end
     end
-    alias :store_application_definition! :application_definition
+    alias_method :store_application_definition!, :application_definition
 
     def camelized
-      @camelized ||= name.gsub(/\W/, '_').squeeze('_').camelize
+      @camelized ||= name.gsub(/\W/, "_").squeeze("_").camelize
     end
 
     def remove_directory_if_exists(path)
@@ -140,9 +138,9 @@ module Spree
       core_gems = ["spree/core", "spree/api", "spree/backend", "spree/frontend"]
 
       if core_gems.include?(lib_name)
-        '../../../../../Gemfile'
+        "../../../../../Gemfile"
       else
-        '../../../../Gemfile'
+        "../../../../Gemfile"
       end
     end
   end

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

@@ -1,6 +1,6 @@
-require 'rubygems'
+require "rubygems"
 gemfile = File.expand_path("<%= gemfile_path %>", __FILE__)
 
-ENV['BUNDLE_GEMFILE'] = gemfile
-require 'bundler'
+ENV["BUNDLE_GEMFILE"] = gemfile
+require "bundler"
 Bundler.setup

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

@@ -9,16 +9,16 @@ Dummy::Application.configure do
 
   # Configure static asset server for tests with Cache-Control for performance
   config.public_file_server.enabled = true
-  config.public_file_server.headers = { 'Cache-Control' => "public, max-age=3600" }
+  config.public_file_server.headers = {"Cache-Control" => "public, max-age=3600"}
 
   # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
+  config.consider_all_requests_local = true
   config.action_controller.perform_caching = false
 
   config.eager_load = false
 
   # Raise exceptions instead of rendering exception templates
-  if Rails.gem_version >= Gem::Version.new('7.1')
+  if Rails.gem_version >= Gem::Version.new("7.1")
     config.action_controller.raise_on_missing_callback_actions = true
     config.action_dispatch.show_exceptions = :none
   else
@@ -37,7 +37,7 @@ Dummy::Application.configure do
   config.active_storage.service = :test
 
   # Raise on deprecation warnings
-  if ENV['SOLIDUS_RAISE_DEPRECATIONS'].present?
+  if ENV["SOLIDUS_RAISE_DEPRECATIONS"].present?
     Spree.deprecator.behavior = :raise
   end
 end

data/lib/solidus_core.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'spree_core'
+require "spree_core"