solidus_core 3.2.5 → 3.3.0

data/lib/generators/solidus/install/app_templates/frontend/none.rb

@@ -0,0 +1,2 @@
+apply "#{__dir__}/break_down_solidus_gem.rb"
+run_bundle

data/lib/generators/solidus/install/app_templates/frontend/starter.rb

@@ -0,0 +1,3 @@
+apply "#{__dir__}/break_down_solidus_gem.rb"
+run_bundle
+apply 'https://github.com/solidusio/solidus_starter_frontend/raw/main/template.rb'

data/lib/generators/solidus/install/app_templates/payment_method/bolt.rb

@@ -1,11 +1,13 @@
-plugin_name = PAYMENT_METHODS.fetch(@selected_payment_method)
-plugin_generator_name = "#{plugin_name}:install"
+unless Bundler.locked_gems.dependencies['solidus_frontend']
+  say_status :warning, "Support for frontends other than `solidus_frontend` by `solidus_bolt` is still in progress.", :yellow
+end
+
+unless Bundler.locked_gems.dependencies['solidus_auth_devise']
+  say_status :warning, "Running solidus_bolt without solidus_auth_devise is not supported.", :yellow
+end
 
-if bundler_context.dependencies[plugin_name]
-  say_status :skipping, "#{plugin_name} is already in the gemfile"
-else
-  gem plugin_name
-  run_bundle
-  run "spring stop" if defined?(Spring)
-  generate "#{plugin_generator_name} --skip_migrations=true"
+unless Bundler.locked_gems.dependencies['solidus_bolt']
+  bundle_command 'add solidus_bolt'
 end
+
+generate 'solidus_bolt:install'

data/lib/generators/solidus/install/app_templates/payment_method/paypal.rb

@@ -1,11 +1,10 @@
-plugin_name = PAYMENT_METHODS.fetch(@selected_payment_method)
-plugin_generator_name = "#{plugin_name}:install"
+unless Bundler.locked_gems.dependencies['solidus_frontend']
+  say_status :warning, "Support for frontends other than `solidus_frontend` by `solidus_paypal_commerce_platform` is still in progress.", :yellow
+end
 
-if bundler_context.dependencies[plugin_name]
-  say_status :skipping, "#{plugin_name} is already in the gemfile"
-else
-  gem plugin_name, @selected_frontend == 'solidus_frontend' ? '< 1' : '>= 1.a'
-  run_bundle
-  run "spring stop" if defined?(Spring)
-  generate "#{plugin_generator_name} --skip_migrations=true"
+unless Bundler.locked_gems.dependencies['solidus_paypal_commerce_platform']
+  version = @selected_frontend == 'classic' ? '< 1' : '~> 1.0'
+  bundle_command "add solidus_paypal_commerce_platform --version='#{version}'"
 end
+
+generate 'solidus_paypal_commerce_platform:install'

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

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 
+require 'rails/version'
 require 'rails/generators'
 require 'rails/generators/app_base'
-require 'rails/version'
-require_relative 'install_generator/bundler_context'
-require_relative 'install_generator/support_solidus_frontend_extraction'
-require_relative 'install_generator/install_frontend'
 
 module Solidus
   # @private
@@ -14,58 +11,80 @@ module Solidus
 
     CORE_MOUNT_ROUTE = "mount Spree::Core::Engine"
 
-    LEGACY_FRONTEND = 'solidus_frontend'
-    DEFAULT_FRONTEND = 'solidus_starter_frontend'
-    FRONTENDS = [
-      DEFAULT_FRONTEND,
-      LEGACY_FRONTEND,
-      'none'
-    ].freeze
-
-    PAYMENT_METHODS = {
-      'paypal' => 'solidus_paypal_commerce_platform',
-      'bolt' => 'solidus_bolt',
-      'none' => nil,
-    }
+    FRONTENDS = %w[
+      none
+      classic
+      starter
+    ]
+
+    LEGACY_FRONTENDS = %w[
+      solidus_starter_frontend
+      solidus_frontend
+    ]
+
+    AUTHENTICATIONS = %w[
+      devise
+      existing
+      custom
+      none
+    ]
+
+    PAYMENT_METHODS = %w[
+      paypal
+      bolt
+      none
+    ]
 
     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 :active_storage, type: :boolean, default: Rails.gem_version >= Gem::Version.new("6.1.0"), banner: 'Install ActiveStorage as image attachments handler for products and taxons'
+    class_option :sample, type: :boolean, default: true, banner: 'Load sample data (migrations and seeds must be run)'
+    class_option :active_storage, type: :boolean, default: (
+      Rails.gem_version >= Gem::Version.new("6.1.0")
+    ), banner: 'Install ActiveStorage as image attachments handler for products and taxons'
     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 :with_authentication, type: :boolean, default: nil
-    class_option :enforce_available_locales, type: :boolean, default: nil
-    class_option :frontend,
-                 type: :string,
-                 enum: FRONTENDS,
-                 default: nil,
-                 desc: "Indicates which frontend to install."
-    class_option :payment_method,
-                 type: :string,
-                 enum: PAYMENT_METHODS.keys,
-                 default: nil,
-                 desc: "Indicates which payment method to install."
-
-    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
+
+    class_option :frontend, type: :string, enum: FRONTENDS + LEGACY_FRONTENDS, default: nil, desc: "Indicates which frontend to install."
+    class_option :authentication, type: :string, enum: AUTHENTICATIONS, default: nil, desc: "Indicates which authentication system to install."
+    class_option :payment_method, type: :string, enum: PAYMENT_METHODS, default: nil, desc: "Indicates which payment method to install."
+
+    # DEPRECATED
+    class_option :with_authentication, type: :boolean, hide: true, default: nil
+    class_option :enforce_available_locales, type: :boolean, hide: true, default: nil
+    class_option :lib_name, type: :string, hide: true, default: nil
+
+    source_root "#{__dir__}/templates"
+
+    def self.exit_on_failure?
+      true
     end
 
     def prepare_options
       @run_migrations = options[:migrate]
-      @load_seed_data = options[:seed]
-      @load_sample_data = options[:sample]
+      @load_seed_data = options[:seed] && @run_migrations
+      @load_sample_data = options[:sample] && @run_migrations && @load_seed_data
+      @selected_frontend = detect_frontend_to_install
+      @selected_authentication = detect_authentication_to_install
+      @selected_payment_method = detect_payment_method_to_install
+
+      # Silence verbose output (e.g. Rails migrations will rely on this environment variable)
+      ENV['VERBOSE'] = 'false'
+
+      # No reason to check for their presence if we're about to install them
+      ENV['SOLIDUS_SKIP_MIGRATIONS_CHECK'] = 'true'
 
-      unless @run_migrations
-         @load_seed_data = false
-         @load_sample_data = false
+      if options[:enforce_available_locales] != nil
+        warn \
+          "DEPRECATION WARNING: using `solidus:install --enforce-available-locales` is now deprecated and has no effect. " \
+          "Since Rails 4.1 the default is `true` so we no longer need to explicitly set a value."
+      end
+
+      if options[:lib_name] != nil
+        warn \
+          "DEPRECATION WARNING: using `solidus:install --lib-name` is now deprecated and has no effect. " \
+          "The option is legacy and should be removed from scripts still using it."
       end
     end
 
@@ -75,32 +94,15 @@ module Solidus
 
     def install_file_attachment
       if options[:active_storage]
-        say "Installing Active Storage", :green
+        say_status :assets, "Active Storage", :green
         rake 'active_storage:install'
       else
-        say "Installing Paperclip", :green
+        say_status :assets, "Paperclip", :green
         gsub_file 'config/initializers/spree.rb', "ActiveStorageAttachment", "PaperclipAttachment"
       end
     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|
@@ -117,51 +119,15 @@ module Solidus
       empty_directory "app/overrides"
     end
 
-    def configure_application
-      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 select_auth_plugin
-      @with_authentication = options[:with_authentication]
-      @with_authentication.nil? and @with_authentication = (options[:auto_accept] || !no?("
-        Solidus has a default authentication extension that uses Devise.
-        You can find more info at https://github.com/solidusio/solidus_auth_devise.
-
-        Regardless of what you answer here, it'll be installed if you choose
-        solidus_starter_frontend as your storefront in a later step.
-
-        Would you like to install it? (Y/n)"))
-    end
-
-    def select_payment_method
-      say_status :warning, set_color(
-        "Selecting a payment along with `solidus_starter_frontend` might require manual integration.",
-        :yellow
-      ), :yellow
-
-      @selected_payment_method = options[:payment_method]
-      @selected_payment_method ||= PAYMENT_METHODS.keys.first if options[:auto_accept]
-      @selected_payment_method ||= ask("
-  You can select a payment method to be included in the installation process.
-  Please select a payment method name:", limited_to: PAYMENT_METHODS.keys, default: PAYMENT_METHODS.keys.first)
-    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)
+      append_file "db/seeds.rb", <<~RUBY
+        Spree::Core::Engine.load_seed
       RUBY
     end
 
     def install_migrations
       say_status :copying, "migrations"
-      `rake railties:install:migrations`
+      rake 'railties:install:migrations'
     end
 
     def create_database
@@ -169,51 +135,46 @@ module Solidus
       rake 'db:create'
     end
 
-    def install_frontend
-      @selected_frontend = detect_frontend_to_install
-
-      if @selected_frontend == 'none'
-        support_solidus_frontend_extraction
+    def install_routes
+      if Pathname(app_path).join('config', 'routes.rb').read.include? CORE_MOUNT_ROUTE
+        say_status :route_exist, CORE_MOUNT_ROUTE, :blue
       else
-        support_solidus_frontend_extraction unless @selected_frontend == LEGACY_FRONTEND
-
-        say_status :installing, @selected_frontend
-
-        InstallFrontend
-          .new(bundler_context: bundler_context, generator_context: self)
-          .call(@selected_frontend)
-
-        # The DEFAULT_FRONTEND installation makes changes to the
-        # bundle without updating the bundler context. As such, we need to
-        # reset the bundler context to get the latest dependencies from the
-        # context.
-        reset_bundler_context if @selected_frontend == DEFAULT_FRONTEND
+        route <<~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
 
-    def install_authentication_plugin
-      return unless @with_authentication
-
-      install_plugin(plugin_name: 'solidus_auth_devise', plugin_generator_name: 'solidus:auth:install')
-    end
-
-    def install_payment_method
-      apply_template_for :payment_method, @selected_payment_method
-    end
-
     def run_migrations
       if @run_migrations
         say_status :running, "migrations"
 
-        rake 'db:migrate VERBOSE=false'
+        rake 'db:migrate'
       else
         say_status :skipping, "migrations (don't forget to run rake db:migrate)"
       end
     end
 
+    def install_authentication
+      apply_template_for :authentication, @selected_authentication
+    end
+
+    def install_frontend
+      apply_template_for :frontend, @selected_frontend
+    end
+
+    def install_payment_method
+      apply_template_for :payment_method, @selected_payment_method
+    end
+
     def populate_seed_data
       if @load_seed_data
-        say_status :loading,  "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]
@@ -234,40 +195,41 @@ module Solidus
       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
+    def complete
+      say_status :complete, "Solidus has been installed successfully. Enjoy!"
+    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
+    private
+
+    def generate(what, *args, abort_on_failure: true)
+      args << '--auto-accept' if options[:auto_accept]
+      args << '--auto-run-migrations' if options[:migrate]
+      super(what, *args, abort_on_failure: abort_on_failure)
     end
 
-    def complete
-      unless options[:quiet]
-        puts "*" * 50
-        puts "Solidus has been installed successfully. You're all ready to go!"
-        puts " "
-        puts "Enjoy!"
-      end
+    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'))
+    ensure
+      Bundler.reset_paths!
     end
 
-    private
+    def ask_with_description(desc:, limited_to:, default:)
+      loop do
+        say_status :question, desc, :yellow
+        answer = ask(set_color("answer:".rjust(13), :blue, :bold)).to_s.downcase.presence
+
+        case answer
+        when nil
+          say_status :using, "#{default} (default)"
+          break default
+        when *limited_to.map(&:to_s)
+          say_status :using, answer
+          break answer
+        else say_status :error, "Please select a valid answer:", :red
+        end
+      end
+    end
 
     def apply_template_for(topic, selected)
       template_path = Dir["#{__dir__}/app_templates/#{topic}/*.rb"].find do |path|
@@ -283,46 +245,107 @@ module Solidus
       apply template_path
     end
 
-    def detect_frontend_to_install
-      ENV['FRONTEND'] ||
-        options[:frontend] ||
-        (bundler_context.component_in_gemfile?(:frontend) && LEGACY_FRONTEND) ||
-        (options[:auto_accept] && DEFAULT_FRONTEND) ||
-        ask(<<~MSG.indent(8), limited_to: FRONTENDS, default: DEFAULT_FRONTEND)
+    def with_env(vars)
+      original = ENV.to_hash
+      vars.each { |k, v| ENV[k] = v }
 
-          Which frontend would you like to use? solidus_starter_frontend is
-          recommended. However, some extensions are still only compatible with
-          the now deprecated solidus_frontend.
-
-        MSG
+      begin
+        yield
+      ensure
+        ENV.replace(original)
+      end
     end
 
-    def support_solidus_frontend_extraction
-      say_status "break down", "solidus"
+    def detect_frontend_to_install
+      # We need to support names that were available in v3.2
+      selected_frontend = 'starter' if options[:frontend] == 'solidus_starter_frontend'
+      selected_frontend = 'classic' if options[:frontend] == 'solidus_frontend'
+      selected_frontend ||= options[:frontend]
 
-      SupportSolidusFrontendExtraction.
-        new(bundler_context: bundler_context).
-        call
+      ENV['FRONTEND'] ||
+        selected_frontend ||
+        (Bundler.locked_gems.dependencies['solidus_frontend'] && 'classic') ||
+        (options[:auto_accept] && 'starter') ||
+        ask_with_description(
+          default: 'starter',
+          limited_to: FRONTENDS,
+          desc: <<~TEXT
+            Which frontend would you like to use?
+
+            - [#{set_color 'starter', :bold}] Generate all necessary controllers and views directly in your Rails app (#{set_color :default, :bold}).
+            - [#{set_color 'classic', :bold}] Install `solidus_frontend`, was the default in previous solidus versions (#{set_color :deprecated, :bold}).
+            - [#{set_color 'none', :bold}] Skip installing a frontend.
+
+            Selecting `starter` is recommended, however, some extensions are still only compatible with `classic`.
+          TEXT
+        )
     end
 
-    def install_plugin(plugin_name:, plugin_generator_name:)
-      if bundler_context.dependencies[plugin_name]
-        say_status :skipping, "#{plugin_name} is already in the gemfile"
-        return
+    def detect_authentication_to_install
+      return 'devise' if @selected_frontend == 'starter'
+
+      if options[:with_authentication] != nil
+        say_status :warning, \
+          "Using `solidus:install --with-authentication` is now deprecated. " \
+          "Please use `--authentication` instead (see --help for the full list of options).",
+          :red
+
+        if options[:with_authentication] == 'false'
+          # Don't use the default authentication if the user explicitly
+          # requested no authentication system.
+          return 'none'
+        else
+          return 'devise'
+        end
       end
 
-      gem plugin_name
-      run_bundle
-      run "spring stop" if defined?(Spring)
-      generate "#{plugin_generator_name} --skip_migrations=true"
+      ENV['AUTHENTICATION'] ||
+        options[:authentication] ||
+        (Bundler.locked_gems.dependencies['solidus_auth_devise'] && 'devise') ||
+        (options[:auto_accept] && 'devise') ||
+        ask_with_description(
+          default: 'devise',
+          limited_to: AUTHENTICATIONS,
+          desc: <<~TEXT
+            Which authentication would you like to use?
+
+            - [#{set_color 'devise', :bold}] Install and configure the standard `devise` integration. (#{set_color :default, :bold}).
+            - [#{set_color 'existing', :bold}] Integrate and configure an existing `devise` setup.
+            - [#{set_color 'custom', :bold}] A starter configuration for rolling your own authentication system.
+            - [#{set_color 'none', :bold}] Don't add any configuration for authentication.
+
+            Selecting `devise` is recommended.
+          TEXT
+        )
     end
 
-    def bundler_context
-      @bundler_context ||= BundlerContext.new
-    end
+    def detect_payment_method_to_install
+      return 'paypal' if Bundler.locked_gems.dependencies['solidus_paypal_commerce_platform']
+      return 'bolt' if Bundler.locked_gems.dependencies['solidus_bolt']
+
+      descriptions = {
+        paypal: "- [#{set_color 'paypal', :bold}] Install `solidus_paypal_commerce_platform` (#{set_color :default, :bold}).",
+        bolt: "- [#{set_color 'bolt', :bold}] Install `solidus_bolt`.",
+        none: "- [#{set_color 'none', :bold}] Skip installing a payment method.",
+      }
+
+      payment_methods = PAYMENT_METHODS
+
+      if @selected_frontend != 'classic'
+        payment_methods -= ['bolt']
+        descriptions.delete(:bolt)
+      end
+
+      selected = options[:payment_method] || (options[:auto_accept] && 'paypal') ||
+        ask_with_description(
+          default: 'paypal',
+          limited_to: payment_methods,
+          desc: <<~TEXT
+            Which payment method would you like to use?
 
-    def reset_bundler_context
-      @bundler_context = nil
+            #{descriptions.values.join("\n")}
+          TEXT
+        )
     end
   end
 end

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

@@ -9,9 +9,6 @@ Spree.config do |config|
   # Default currency for new sites
   config.currency = "USD"
 
-  # from address for transactional emails
-  config.mails_from = "store@example.com"
-
   # Uncomment to stop tracking inventory levels in the application
   # config.track_inventory_levels = false
 
@@ -79,7 +76,9 @@ Spree::Api::Config.configure do |config|
 end
 <% end -%>
 
-Spree.user_class = <%= (options[:user_class].blank? ? "Spree::LegacyUser" : options[:user_class]).inspect %>
+<% if options[:user_class].present? -%>
+  Spree.user_class = <%= options[:user_class].inspect %>
+<% end -%>
 
 # 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

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

@@ -22,10 +22,12 @@ module Spree
       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"
 
-      file_action = File.exist?('config/initializers/spree.rb') ? :append_file : :create_file
-      send(file_action, 'config/initializers/spree.rb') do
-        "Rails.application.config.to_prepare do\n  require_dependency 'spree/authentication_helpers'\nend\n"
-      end
+      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}"}
     end

data/lib/generators/spree/custom_user/templates/authentication_helpers.rb.tt

@@ -9,7 +9,8 @@ module Spree
     end
 
     def spree_current_user
-      current_user
+      # TODO: Replace this with your implementation for retrieving the current user
+      Spree.user_class.new
     end
   end
 
@@ -33,8 +34,3 @@ module Spree
     end
   end
 end
-
-ApplicationController.send :include, Spree::AuthenticationHelpers
-ApplicationController.send :include, Spree::CurrentUserHelpers
-
-Spree::Api::BaseController.send :include, Spree::CurrentUserHelpers

data/lib/generators/spree/custom_user/templates/migration.rb.tt

@@ -1,7 +1,11 @@
 class AddSpreeFieldsToCustomUserTable < ActiveRecord::Migration[4.2]
   def up
-    add_column <%= table_name.inspect %>, :spree_api_key, :string, :limit => 48
-    add_column <%= table_name.inspect %>, :ship_address_id, :integer
-    add_column <%= table_name.inspect %>, :bill_address_id, :integer
+    if table_exists?(<%= table_name.inspect %>)
+      add_column <%= table_name.inspect %>, :spree_api_key, :string, :limit => 48 unless column_exists?(<%= table_name.inspect %>, :spree_api_key)
+      add_column <%= table_name.inspect %>, :ship_address_id, :integer unless column_exists?(<%= table_name.inspect %>, :ship_address_id)
+      add_column <%= table_name.inspect %>, :bill_address_id, :integer unless column_exists?(<%= table_name.inspect %>, :bill_address_id)
+      add_column <%= table_name.inspect %>, :deleted_at, :datetime unless column_exists?(<%= table_name.inspect %>, :deleted_at)
+      add_index  <%= table_name.inspect %>, :deleted_at unless column_exists?(<%= table_name.inspect %>, :deleted_at)
+    end
   end
 end