railties 5.2.0 → 6.1.0

data/lib/rails/command/actions.rb

@@ -11,10 +11,20 @@ module Rails
       end
 
       def require_application_and_environment!
+        require_application!
+        require_environment!
+      end
+
+      def require_application!
         require ENGINE_PATH if defined?(ENGINE_PATH)
 
         if defined?(APP_PATH)
           require APP_PATH
+        end
+      end
+
+      def require_environment!
+        if defined?(APP_PATH)
           Rails.application.require_environment!
         end
       end

data/lib/rails/command/base.rb

@@ -17,6 +17,10 @@ module Rails
       include Actions
 
       class << self
+        def exit_on_failure? # :nodoc:
+          false
+        end
+
         # Returns true when the app is a Rails engine.
         def engine?
           defined?(ENGINE_ROOT)
@@ -52,7 +56,7 @@ module Rails
         def inherited(base) #:nodoc:
           super
 
-          if base.name && base.name !~ /Base$/
+          if base.name && !base.name.end_with?("Base")
             Rails::Command.subclasses << base
           end
         end
@@ -70,7 +74,7 @@ module Rails
         end
 
         def executable
-          "bin/rails #{command_name}"
+          "rails #{command_name}"
         end
 
         # Use Rails' default banner.
@@ -115,7 +119,7 @@ module Rails
         # For a Rails::Command::TestCommand placed in <tt>rails/command/test_command.rb</tt>
         # would return <tt>rails/test</tt>.
         def default_command_root
-          path = File.expand_path(File.join("../commands", command_root_namespace), __dir__)
+          path = File.expand_path(relative_command_path, __dir__)
           path if File.exist?(path)
         end
 
@@ -135,12 +139,20 @@ module Rails
           end
 
           def command_root_namespace
-            (namespace.split(":") - %w( rails )).first
+            (namespace.split(":") - %w(rails)).join(":")
+          end
+
+          def relative_command_path
+            File.join("../commands", *command_root_namespace.split(":"))
           end
 
           def namespaced_commands
             commands.keys.map do |key|
-              key == command_root_namespace ? key : "#{command_root_namespace}:#{key}"
+              if command_root_namespace.match?(/(\A|\:)#{key}\z/)
+                command_root_namespace
+              else
+                "#{command_root_namespace}:#{key}"
+              end
             end
           end
       end

data/lib/rails/command/behavior.rb

@@ -19,46 +19,6 @@ module Rails
         end
 
         private
-
-          # This code is based directly on the Text gem implementation.
-          # Copyright (c) 2006-2013 Paul Battley, Michael Neumann, Tim Fletcher.
-          #
-          # Returns a value representing the "cost" of transforming str1 into str2.
-          def levenshtein_distance(str1, str2) # :doc:
-            s = str1
-            t = str2
-            n = s.length
-            m = t.length
-
-            return m if (0 == n)
-            return n if (0 == m)
-
-            d = (0..m).to_a
-            x = nil
-
-            # avoid duplicating an enumerable object in the loop
-            str2_codepoint_enumerable = str2.each_codepoint
-
-            str1.each_codepoint.with_index do |char1, i|
-              e = i + 1
-
-              str2_codepoint_enumerable.with_index do |char2, j|
-                cost = (char1 == char2) ? 0 : 1
-                x = [
-                     d[j + 1] + 1, # insertion
-                     e + 1,      # deletion
-                     d[j] + cost # substitution
-                    ].min
-                d[j] = e
-                e = x
-              end
-
-              d[m] = x
-            end
-
-            x
-          end
-
           # Prints a list of generators.
           def print_list(base, namespaces)
             return if namespaces.empty?
@@ -84,7 +44,7 @@ module Rails
                   require path
                   return
                 rescue LoadError => e
-                  raise unless e.message =~ /#{Regexp.escape(path)}$/
+                  raise unless /#{Regexp.escape(path)}$/.match?(e.message)
                 rescue Exception => e
                   warn "[WARNING] Could not load #{command_type} #{path.inspect}. Error: #{e.message}.\n#{e.backtrace.join("\n")}"
                 end
@@ -96,12 +56,10 @@ module Rails
           def lookup!
             $LOAD_PATH.each do |base|
               Dir[File.join(base, *file_lookup_paths)].each do |path|
-                begin
-                  path = path.sub("#{base}/", "")
-                  require path
-                rescue Exception
-                  # No problem
-                end
+                path = path.delete_prefix("#{base}/")
+                require path
+              rescue Exception
+                # No problem
               end
             end
           end
@@ -113,8 +71,9 @@ module Rails
             paths = []
             namespaces.each do |namespace|
               pieces = namespace.split(":")
-              paths << pieces.dup.push(pieces.last).join("/")
-              paths << pieces.join("/")
+              path = pieces.join("/")
+              paths << "#{path}/#{pieces.last}"
+              paths << path
             end
             paths.uniq!
             paths

data/lib/rails/command/environment_argument.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_support"
+require "active_support/core_ext/class/attribute"
 
 module Rails
   module Command
@@ -8,26 +9,18 @@ module Rails
       extend ActiveSupport::Concern
 
       included do
-        argument :environment, optional: true, banner: "environment"
-
-        class_option :environment, aliases: "-e", type: :string,
-          desc: "Specifies the environment to run this console under (test/development/production)."
+        no_commands do
+          class_attribute :environment_desc, default: "Specifies the environment to run this #{self.command_name} under (test/development/production)."
+        end
+        class_option :environment, aliases: "-e", type: :string, desc: environment_desc
       end
 
       private
-        def extract_environment_option_from_argument
-          if environment
-            self.options = options.merge(environment: acceptable_environment(environment))
-
-            ActiveSupport::Deprecation.warn "Passing the environment's name as a " \
-                                            "regular argument is deprecated and "  \
-                                            "will be removed in the next Rails "   \
-                                            "version. Please, use the -e option "  \
-                                            "instead."
-          elsif options[:environment]
+        def extract_environment_option_from_argument(default_environment: Rails::Command.environment)
+          if options[:environment]
             self.options = options.merge(environment: acceptable_environment(options[:environment]))
           else
-            self.options = options.merge(environment: Rails::Command.environment)
+            self.options = options.merge(environment: default_environment)
           end
         end
 
@@ -35,7 +28,7 @@ module Rails
           if available_environments.include? env
             env
           else
-            %w( production development test ).detect { |e| e =~ /^#{env}/ } || env
+            %w( production development test ).detect { |e| /^#{env}/.match?(e) } || env
           end
         end
 

data/lib/rails/command/spellchecker.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Rails
+  module Command
+    module Spellchecker # :nodoc:
+      class << self
+        def suggest(word, from:)
+          if defined?(DidYouMean::SpellChecker)
+            DidYouMean::SpellChecker.new(dictionary: from.map(&:to_s)).correct(word).first
+          else
+            from.sort_by { |w| levenshtein_distance(word, w) }.first
+          end
+        end
+
+        private
+          # This code is based directly on the Text gem implementation.
+          # Copyright (c) 2006-2013 Paul Battley, Michael Neumann, Tim Fletcher.
+          #
+          # Returns a value representing the "cost" of transforming str1 into str2.
+          def levenshtein_distance(str1, str2) # :doc:
+            s = str1
+            t = str2
+            n = s.length
+            m = t.length
+
+            return m if 0 == n
+            return n if 0 == m
+
+            d = (0..m).to_a
+            x = nil
+
+            # avoid duplicating an enumerable object in the loop
+            str2_codepoint_enumerable = str2.each_codepoint
+
+            str1.each_codepoint.with_index do |char1, i|
+              e = i + 1
+
+              str2_codepoint_enumerable.with_index do |char2, j|
+                cost = (char1 == char2) ? 0 : 1
+                x = [
+                  d[j + 1] + 1, # insertion
+                  e + 1,        # deletion
+                  d[j] + cost   # substitution
+                ].min
+                d[j] = e
+                e = x
+              end
+
+              d[m] = x
+            end
+
+            x
+          end
+      end
+    end
+  end
+end

data/lib/rails/command.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
 require "active_support"
-require "active_support/dependencies/autoload"
 require "active_support/core_ext/enumerable"
 require "active_support/core_ext/object/blank"
-require "active_support/core_ext/hash/transform_values"
 
 require "thor"
 
@@ -12,6 +10,7 @@ module Rails
   module Command
     extend ActiveSupport::Autoload
 
+    autoload :Spellchecker
     autoload :Behavior
     autoload :Base
 
@@ -41,12 +40,19 @@ module Rails
         command_name, namespace = "help", "help" if command_name.blank? || HELP_MAPPINGS.include?(command_name)
         command_name, namespace = "version", "version" if %w( -v --version ).include?(command_name)
 
+        # isolate ARGV to ensure that commands depend only on the args they are given
+        args = args.dup # args might *be* ARGV so dup before clearing
+        old_argv = ARGV.dup
+        ARGV.clear
+
         command = find_by_namespace(namespace, command_name)
         if command && command.all_commands[command_name]
           command.perform(command_name, args, config)
         else
           find_by_namespace("rake").perform(full_namespace, args, config)
         end
+      ensure
+        ARGV.replace(old_argv)
       end
 
       # Rails finds namespaces similar to Thor, it only adds one rule:
@@ -83,20 +89,21 @@ module Rails
       end
 
       def print_commands # :nodoc:
-        sorted_groups.each { |b, n| print_list(b, n) }
+        commands.each { |command| puts("  #{command}") }
       end
 
-      def sorted_groups # :nodoc:
-        lookup!
+      private
+        COMMANDS_IN_USAGE = %w(generate console server test test:system dbconsole new)
+        private_constant :COMMANDS_IN_USAGE
 
-        groups = (subclasses - hidden_commands).group_by { |c| c.namespace.split(":").first }
-        groups.transform_values! { |commands| commands.flat_map(&:printing_commands).sort }
+        def commands
+          lookup!
 
-        rails = groups.delete("rails")
-        [[ "rails", rails ]] + groups.sort.to_a
-      end
+          visible_commands = (subclasses - hidden_commands).flat_map(&:printing_commands)
+
+          (visible_commands - COMMANDS_IN_USAGE).sort
+        end
 
-      private
         def command_type # :doc:
           @command_type ||= "command"
         end

data/lib/rails/commands/console/console_command.rb

@@ -26,6 +26,12 @@ module Rails
       @options = options
 
       app.sandbox = sandbox?
+
+      if sandbox? && app.config.disable_sandbox
+        puts "Error: Unable to start console in sandbox mode as sandbox mode is disabled (config.disable_sandbox is true)."
+        exit 1
+      end
+
       app.load_console
 
       @console = app.config.console || IRB

data/lib/rails/commands/credentials/USAGE

@@ -30,6 +30,21 @@ You could prepend that to your server's start command like this:
 
    RAILS_MASTER_KEY="very-secret-and-secure" server.start
 
+=== Set up Git to Diff Credentials
+
+Rails provides `rails credentials:diff --enroll` to instruct Git to call `rails credentials:diff`
+when `git diff` is run on a credentials file.
+
+Running the command enrolls the project such that all credentials files use the
+"rails_credentials" diff driver in .gitattributes.
+
+Additionally since Git requires the driver itself to be set up in a config file
+that isn't tracked Rails automatically ensures it's configured when running
+`credentials:edit`.
+
+Otherwise each co-worker would have to run enable manually, including on each new
+repo clone.
+
 === Editing Credentials
 
 This will open a temporary file in `$EDITOR` with the decrypted contents to edit
@@ -38,3 +53,21 @@ the encrypted credentials.
 When the temporary file is next saved the contents are encrypted and written to
 `config/credentials.yml.enc` while the file itself is destroyed to prevent credentials
 from leaking.
+
+=== Environment Specific Credentials
+
+The `credentials` command supports passing an `--environment` option to create an
+environment specific override. That override will take precedence over the
+global `config/credentials.yml.enc` file when running in that environment. So:
+
+   bin/rails credentials:edit --environment development
+
+will create `config/credentials/development.yml.enc` with the corresponding
+encryption key in `config/credentials/development.key` if the credentials file
+doesn't exist.
+
+The encryption key can also be put in `ENV["RAILS_MASTER_KEY"]`, which takes
+precedence over the file encryption key.
+
+In addition to that, the default credentials lookup paths can be overridden through
+`config.credentials.content_path` and `config.credentials.key_path`.

data/lib/rails/commands/credentials/credentials_command/diffing.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Rails::Command::CredentialsCommand::Diffing # :nodoc:
+  def enroll_project_in_credentials_diffing
+    if enrolled?
+      true
+    else
+      gitattributes.write(<<~end_of_template, mode: "a")
+        config/credentials/*.yml.enc diff=rails_credentials
+        config/credentials.yml.enc diff=rails_credentials
+      end_of_template
+
+      say "Project successfully enrolled!"
+      say "Rails ensures the rails_credentials diff driver is set when running `credentials:edit`. See `credentials:help` for more."
+    end
+  end
+
+  def ensure_rails_credentials_driver_is_set
+    set_driver if enrolled? && !driver_configured?
+  end
+
+  private
+    def enrolled?
+      gitattributes.read.match?(/config\/credentials(\/\*)?\.yml\.enc diff=rails_credentials/)
+    rescue Errno::ENOENT
+      false
+    end
+
+    def driver_configured?
+      system "git config --get diff.rails_credentials.textconv", out: File::NULL
+    end
+
+    def set_driver
+      puts "running"
+      system "git config diff.rails_credentials.textconv 'bin/rails credentials:diff'"
+    end
+
+    def gitattributes
+      Rails.root.join(".gitattributes")
+    end
+end

data/lib/rails/commands/credentials/credentials_command.rb

@@ -1,12 +1,20 @@
 # frozen_string_literal: true
 
+require "pathname"
 require "active_support"
 require "rails/command/helpers/editor"
+require "rails/command/environment_argument"
 
 module Rails
   module Command
     class CredentialsCommand < Rails::Command::Base # :nodoc:
       include Helpers::Editor
+      include EnvironmentArgument
+
+      require_relative "credentials_command/diffing"
+      include Diffing
+
+      self.environment_desc = "Uses credentials from config/credentials/:environment.yml.enc encrypted by config/credentials/:environment.key key"
 
       no_commands do
         def help
@@ -17,47 +25,104 @@ module Rails
       end
 
       def edit
-        require_application_and_environment!
+        extract_environment_option_from_argument(default_environment: nil)
+        require_application!
 
         ensure_editor_available(command: "bin/rails credentials:edit") || (return)
-        ensure_master_key_has_been_added if Rails.application.credentials.key.nil?
+
+        ensure_encryption_key_has_been_added if credentials.key.nil?
         ensure_credentials_have_been_added
+        ensure_rails_credentials_driver_is_set
 
         catch_editing_exceptions do
           change_credentials_in_system_editor
         end
 
-        say "New credentials encrypted and saved."
+        say "File encrypted and saved."
+      rescue ActiveSupport::MessageEncryptor::InvalidMessage
+        say "Couldn't decrypt #{content_path}. Perhaps you passed the wrong key?"
       end
 
       def show
-        require_application_and_environment!
+        extract_environment_option_from_argument(default_environment: nil)
+        require_application!
+
+        say credentials.read.presence || missing_credentials_message
+      end
+
+      option :enroll, type: :boolean, default: false,
+        desc: "Enrolls project in credential file diffing with `git diff`"
 
-        say Rails.application.credentials.read.presence || missing_credentials_message
+      def diff(content_path = nil)
+        if @content_path = content_path
+          extract_environment_option_from_argument(default_environment: extract_environment_from_path(content_path))
+          require_application!
+
+          say credentials.read.presence || credentials.content_path.read
+        else
+          require_application!
+          enroll_project_in_credentials_diffing if options[:enroll]
+        end
+      rescue ActiveSupport::MessageEncryptor::InvalidMessage
+        say credentials.content_path.read
       end
 
       private
-        def ensure_master_key_has_been_added
-          master_key_generator.add_master_key_file
-          master_key_generator.ignore_master_key_file
+        def credentials
+          Rails.application.encrypted(content_path, key_path: key_path)
+        end
+
+        def ensure_encryption_key_has_been_added
+          encryption_key_file_generator.add_key_file(key_path)
+          encryption_key_file_generator.ignore_key_file(key_path)
         end
 
         def ensure_credentials_have_been_added
-          credentials_generator.add_credentials_file_silently
+          if options[:environment]
+            encrypted_file_generator.add_encrypted_file_silently(content_path, key_path)
+          else
+            credentials_generator.add_credentials_file_silently
+          end
         end
 
         def change_credentials_in_system_editor
-          Rails.application.credentials.change do |tmp_path|
+          credentials.change do |tmp_path|
             system("#{ENV["EDITOR"]} #{tmp_path}")
           end
         end
 
+        def missing_credentials_message
+          if credentials.key.nil?
+            "Missing '#{key_path}' to decrypt credentials. See `bin/rails credentials:help`"
+          else
+            "File '#{content_path}' does not exist. Use `bin/rails credentials:edit` to change that."
+          end
+        end
 
-        def master_key_generator
+        def content_path
+          @content_path ||= options[:environment] ? "config/credentials/#{options[:environment]}.yml.enc" : "config/credentials.yml.enc"
+        end
+
+        def key_path
+          options[:environment] ? "config/credentials/#{options[:environment]}.key" : "config/master.key"
+        end
+
+        def extract_environment_from_path(path)
+          available_environments.find { |env| path.include? env } if path.end_with?(".yml.enc")
+        end
+
+        def encryption_key_file_generator
           require "rails/generators"
-          require "rails/generators/rails/master_key/master_key_generator"
+          require "rails/generators/rails/encryption_key_file/encryption_key_file_generator"
 
-          Rails::Generators::MasterKeyGenerator.new
+          Rails::Generators::EncryptionKeyFileGenerator.new
+        end
+
+        def encrypted_file_generator
+          require "rails/generators"
+          require "rails/generators/rails/encrypted_file/encrypted_file_generator"
+
+          Rails::Generators::EncryptedFileGenerator.new
         end
 
         def credentials_generator
@@ -66,14 +131,6 @@ module Rails
 
           Rails::Generators::CredentialsGenerator.new
         end
-
-        def missing_credentials_message
-          if Rails.application.credentials.key.nil?
-            "Missing master key to decrypt credentials. See bin/rails credentials:help"
-          else
-            "No credentials have been added yet. Use bin/rails credentials:edit to change that."
-          end
-        end
     end
   end
 end

data/lib/rails/commands/db/system/change/change_command.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/rails/db/system/change/change_generator"
+
+module Rails
+  module Command
+    module Db
+      module System
+        class ChangeCommand < Base # :nodoc:
+          class_option :to, desc: "The database system to switch to."
+
+          def initialize(positional_args, option_args, *)
+            @argv = positional_args + option_args
+            super
+          end
+
+          def perform
+            Rails::Generators::Db::System::ChangeGenerator.start(@argv)
+          end
+        end
+      end
+    end
+  end
+end