railties 6.0.4.3 → 6.1.1

data/lib/rails/code_statistics_calculator.rb

@@ -58,20 +58,20 @@ class CodeStatisticsCalculator #:nodoc:
       @lines += 1
 
       if comment_started
-        if patterns[:end_block_comment] && line =~ patterns[:end_block_comment]
+        if patterns[:end_block_comment] && patterns[:end_block_comment].match?(line)
           comment_started = false
         end
         next
       else
-        if patterns[:begin_block_comment] && line =~ patterns[:begin_block_comment]
+        if patterns[:begin_block_comment] && patterns[:begin_block_comment].match?(line)
           comment_started = true
           next
         end
       end
 
-      @classes   += 1 if patterns[:class] && line =~ patterns[:class]
-      @methods   += 1 if patterns[:method] && line =~ patterns[:method]
-      if line !~ /^\s*$/ && (patterns[:line_comment].nil? || line !~ patterns[:line_comment])
+      @classes   += 1 if patterns[:class] && patterns[:class].match?(line)
+      @methods   += 1 if patterns[:method] && patterns[:method].match?(line)
+      if !line.match?(/^\s*$/) && (patterns[:line_comment].nil? || !line.match?(patterns[:line_comment]))
         @code_lines += 1
       end
     end
@@ -82,7 +82,7 @@ class CodeStatisticsCalculator #:nodoc:
       if file_path.end_with? "_test.rb"
         :minitest
       else
-        File.extname(file_path).sub(/\A\./, "").downcase.to_sym
+        File.extname(file_path).delete_prefix(".").downcase.to_sym
       end
     end
 end

data/lib/rails/command/base.rb

@@ -56,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

data/lib/rails/command/behavior.rb

@@ -56,7 +56,7 @@ module Rails
           def lookup!
             $LOAD_PATH.each do |base|
               Dir[File.join(base, *file_lookup_paths)].each do |path|
-                path = path.sub("#{base}/", "")
+                path = path.delete_prefix("#{base}/")
                 require path
               rescue Exception
                 # No problem

data/lib/rails/command/environment_argument.rb

@@ -28,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.rb

@@ -1,7 +1,6 @@
 # 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"
 
@@ -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:

data/lib/rails/commands/credentials/USAGE

@@ -14,7 +14,7 @@ that just contains the secret_key_base used by MessageVerifiers/MessageEncryptor
 signing and encrypting cookies.
 
 For applications created prior to Rails 5.2, we'll automatically generate a new
-credentials file in `config/credentials.yml.enc` the first time you run `rails credentials:edit`.
+credentials file in `config/credentials.yml.enc` the first time you run `bin/rails credentials:edit`.
 If you didn't have a master key saved in `config/master.key`, that'll be created too.
 
 Don't lose this master key! Put it in a password manager your team can access.
@@ -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
@@ -45,7 +60,7 @@ The `credentials` command supports passing an `--environment` option to create a
 environment specific override. That override will take precedence over the
 global `config/credentials.yml.enc` file when running in that environment. So:
 
-   rails credentials:edit --environment development
+   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

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,5 +1,6 @@
 # frozen_string_literal: true
 
+require "pathname"
 require "active_support"
 require "rails/command/helpers/editor"
 require "rails/command/environment_argument"
@@ -10,6 +11,9 @@ module Rails
       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
@@ -28,6 +32,7 @@ module Rails
 
         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
@@ -45,6 +50,23 @@ module Rails
         say credentials.read.presence || missing_credentials_message
       end
 
+      option :enroll, type: :boolean, default: false,
+        desc: "Enrolls project in credential file diffing with `git diff`"
+
+      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 credentials
           Rails.application.encrypted(content_path, key_path: key_path)
@@ -71,21 +93,23 @@ module Rails
 
         def missing_credentials_message
           if credentials.key.nil?
-            "Missing '#{key_path}' to decrypt credentials. See `rails credentials:help`"
+            "Missing '#{key_path}' to decrypt credentials. See `bin/rails credentials:help`"
           else
-            "File '#{content_path}' does not exist. Use `rails credentials:edit` to change that."
+            "File '#{content_path}' does not exist. Use `bin/rails credentials:edit` to change that."
           end
         end
 
-
         def content_path
-          options[:environment] ? "config/credentials/#{options[:environment]}.yml.enc" : "config/credentials.yml.enc"
+          @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"

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

@@ -10,8 +10,13 @@ module Rails
         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
+            Rails::Generators::Db::System::ChangeGenerator.start(@argv)
           end
         end
       end

data/lib/rails/commands/dbconsole/dbconsole_command.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "active_support/deprecation"
 require "active_support/core_ext/string/filters"
+require "active_support/deprecation"
 require "rails/command/environment_argument"
 
 module Rails
@@ -16,55 +16,56 @@ module Rails
 
     def start
       ENV["RAILS_ENV"] ||= @options[:environment] || environment
+      config = db_config.configuration_hash
 
-      case config["adapter"]
+      case db_config.adapter
       when /^(jdbc)?mysql/
         args = {
-          "host"      => "--host",
-          "port"      => "--port",
-          "socket"    => "--socket",
-          "username"  => "--user",
-          "encoding"  => "--default-character-set",
-          "sslca"     => "--ssl-ca",
-          "sslcert"   => "--ssl-cert",
-          "sslcapath" => "--ssl-capath",
-          "sslcipher" => "--ssl-cipher",
-          "sslkey"    => "--ssl-key"
+          host: "--host",
+          port: "--port",
+          socket: "--socket",
+          username: "--user",
+          encoding: "--default-character-set",
+          sslca: "--ssl-ca",
+          sslcert: "--ssl-cert",
+          sslcapath: "--ssl-capath",
+          sslcipher: "--ssl-cipher",
+          sslkey: "--ssl-key"
         }.map { |opt, arg| "#{arg}=#{config[opt]}" if config[opt] }.compact
 
-        if config["password"] && @options["include_password"]
-          args << "--password=#{config['password']}"
-        elsif config["password"] && !config["password"].to_s.empty?
+        if config[:password] && @options[:include_password]
+          args << "--password=#{config[:password]}"
+        elsif config[:password] && !config[:password].to_s.empty?
           args << "-p"
         end
 
-        args << config["database"]
+        args << db_config.database
 
         find_cmd_and_exec(["mysql", "mysql5"], *args)
 
       when /^postgres|^postgis/
-        ENV["PGUSER"]     = config["username"] if config["username"]
-        ENV["PGHOST"]     = config["host"] if config["host"]
-        ENV["PGPORT"]     = config["port"].to_s if config["port"]
-        ENV["PGPASSWORD"] = config["password"].to_s if config["password"] && @options["include_password"]
-        find_cmd_and_exec("psql", config["database"])
+        ENV["PGUSER"]     = config[:username] if config[:username]
+        ENV["PGHOST"]     = config[:host] if config[:host]
+        ENV["PGPORT"]     = config[:port].to_s if config[:port]
+        ENV["PGPASSWORD"] = config[:password].to_s if config[:password] && @options[:include_password]
+        find_cmd_and_exec("psql", db_config.database)
 
       when "sqlite3"
         args = []
 
-        args << "-#{@options['mode']}" if @options["mode"]
-        args << "-header" if @options["header"]
-        args << File.expand_path(config["database"], Rails.respond_to?(:root) ? Rails.root : nil)
+        args << "-#{@options[:mode]}" if @options[:mode]
+        args << "-header" if @options[:header]
+        args << File.expand_path(db_config.database, Rails.respond_to?(:root) ? Rails.root : nil)
 
         find_cmd_and_exec("sqlite3", *args)
 
       when "oracle", "oracle_enhanced"
         logon = ""
 
-        if config["username"]
-          logon = config["username"].dup
-          logon << "/#{config['password']}" if config["password"] && @options["include_password"]
-          logon << "@#{config['database']}" if config["database"]
+        if config[:username]
+          logon = config[:username].dup
+          logon << "/#{config[:password]}" if config[:password] && @options[:include_password]
+          logon << "@#{db_config.database}" if db_config.database
         end
 
         find_cmd_and_exec("sqlplus", logon)
@@ -72,36 +73,43 @@ module Rails
       when "sqlserver"
         args = []
 
-        args += ["-D", "#{config['database']}"] if config["database"]
-        args += ["-U", "#{config['username']}"] if config["username"]
-        args += ["-P", "#{config['password']}"] if config["password"]
+        args += ["-d", "#{db_config.database}"] if db_config.database
+        args += ["-U", "#{config[:username]}"] if config[:username]
+        args += ["-P", "#{config[:password]}"] if config[:password]
 
-        if config["host"]
-          host_arg = +"#{config['host']}"
-          host_arg << ":#{config['port']}" if config["port"]
+        if config[:host]
+          host_arg = +"tcp:#{config[:host]}"
+          host_arg << ",#{config[:port]}" if config[:port]
           args += ["-S", host_arg]
         end
 
-        find_cmd_and_exec("sqsh", *args)
+        find_cmd_and_exec("sqlcmd", *args)
 
       else
-        abort "Unknown command-line client for #{config['database']}."
+        abort "Unknown command-line client for #{db_config.database}."
       end
     end
 
     def config
-      @config ||= begin
-        # We need to check whether the user passed the database the
-        # first time around to show a consistent error message to people
-        # relying on 2-level database configuration.
-        if @options["database"] && configurations[database].blank?
-          raise ActiveRecord::AdapterNotSpecified, "'#{database}' database is not configured. Available configuration: #{configurations.inspect}"
-        elsif configurations[environment].blank? && configurations[database].blank?
-          raise ActiveRecord::AdapterNotSpecified, "'#{environment}' database is not configured. Available configuration: #{configurations.inspect}"
-        else
-          configurations[database] || configurations[environment].presence
-        end
+      db_config.configuration_hash
+    end
+    deprecate config: "please use db_config.configuration_hash"
+
+    def db_config
+      return @db_config if defined?(@db_config)
+
+      # We need to check whether the user passed the database the
+      # first time around to show a consistent error message to people
+      # relying on 2-level database configuration.
+
+      @db_config = configurations.configs_for(env_name: environment, name: database)
+
+      unless @db_config
+        raise ActiveRecord::AdapterNotSpecified,
+          "'#{database}' database is not configured for '#{environment}'. Available configuration: #{configurations.inspect}"
       end
+
+      @db_config
     end
 
     def environment
@@ -131,7 +139,12 @@ module Rails
         found = commands.detect do |cmd|
           dirs_on_path.detect do |path|
             full_path_command = File.join(path, cmd)
-            File.file?(full_path_command) && File.executable?(full_path_command)
+            begin
+              stat = File.stat(full_path_command)
+            rescue SystemCallError
+            else
+              stat.file? && stat.executable?
+            end
           end
         end
 
@@ -155,9 +168,6 @@ module Rails
 
       class_option :header, type: :boolean
 
-      class_option :connection, aliases: "-c", type: :string,
-        desc: "Specifies the connection to use."
-
       class_option :database, aliases: "--db", type: :string,
         desc: "Specifies the database to use."
 
@@ -167,13 +177,6 @@ module Rails
         # RAILS_ENV needs to be set before config/application is required.
         ENV["RAILS_ENV"] = options[:environment]
 
-        if options["connection"]
-          ActiveSupport::Deprecation.warn(<<-MSG.squish)
-            `connection` option is deprecated and will be removed in Rails 6.1. Please use `database` option instead.
-          MSG
-          options["database"] = options["connection"]
-        end
-
         require_application_and_environment!
         Rails::DBConsole.start(options)
       end

data/lib/rails/commands/encrypted/encrypted_command.rb

@@ -21,7 +21,7 @@ module Rails
       end
 
       def edit(file_path)
-        require_application_and_environment!
+        require_application!
         encrypted = Rails.application.encrypted(file_path, key_path: options[:key])
 
         ensure_editor_available(command: "bin/rails encrypted:edit") || (return)
@@ -38,7 +38,7 @@ module Rails
       end
 
       def show(file_path)
-        require_application_and_environment!
+        require_application!
         encrypted = Rails.application.encrypted(file_path, key_path: options[:key])
 
         say encrypted.read.presence || missing_encrypted_message(key: encrypted.key, key_path: options[:key], file_path: file_path)
@@ -77,9 +77,9 @@ module Rails
 
         def missing_encrypted_message(key:, key_path:, file_path:)
           if key.nil?
-            "Missing '#{key_path}' to decrypt data. See `rails encrypted:help`"
+            "Missing '#{key_path}' to decrypt data. See `bin/rails encrypted:help`"
           else
-            "File '#{file_path}' does not exist. Use `rails encrypted:edit #{file_path}` to change that."
+            "File '#{file_path}' does not exist. Use `bin/rails encrypted:edit #{file_path}` to change that."
           end
         end
     end

data/lib/rails/commands/generate/generate_command.rb

@@ -21,7 +21,7 @@ module Rails
         require_application_and_environment!
         load_generators
 
-        ARGV.shift
+        ARGV.replace(args) # set up ARGV for third-party libraries
 
         Rails::Generators.invoke generator, args, behavior: :invoke, destination_root: Rails::Command.root
       end

data/lib/rails/commands/notes/notes_command.rb

@@ -5,34 +5,24 @@ require "rails/source_annotation_extractor"
 module Rails
   module Command
     class NotesCommand < Base # :nodoc:
-      class_option :annotations, aliases: "-a", desc: "Filter by specific annotations, e.g. Foobar TODO", type: :array
+      class_option :annotations, aliases: "-a", desc: "Filter by specific annotations, e.g. Foobar TODO", type: :array, default: Rails::SourceAnnotationExtractor::Annotation.tags
 
       def perform(*)
         require_application_and_environment!
 
-        deprecation_warning
         display_annotations
       end
 
       private
         def display_annotations
-          annotations = options[:annotations] || Rails::SourceAnnotationExtractor::Annotation.tags
+          annotations = options[:annotations]
           tag = (annotations.length > 1)
 
           Rails::SourceAnnotationExtractor.enumerate annotations.join("|"), tag: tag, dirs: directories
         end
 
         def directories
-          Rails::SourceAnnotationExtractor::Annotation.directories + source_annotation_directories
-        end
-
-        def deprecation_warning
-          return if source_annotation_directories.empty?
-          ActiveSupport::Deprecation.warn("`SOURCE_ANNOTATION_DIRECTORIES` is deprecated and will be removed in Rails 6.1. You can add default directories by using config.annotations.register_directories instead.")
-        end
-
-        def source_annotation_directories
-          ENV["SOURCE_ANNOTATION_DIRECTORIES"].to_s.split(",")
+          Rails::SourceAnnotationExtractor::Annotation.directories
         end
     end
   end

data/lib/rails/commands/rake/rake_command.rb

@@ -12,15 +12,16 @@ module Rails
           formatted_rake_tasks.map(&:first)
         end
 
-        def perform(task, *)
+        def perform(task, args, config)
           require_rake
 
-          ARGV.unshift(task) # Prepend the task, so Rake knows how to run it.
-
-          Rake.application.standard_exception_handling do
-            Rake.application.init("rails")
-            Rake.application.load_rakefile
-            Rake.application.top_level
+          Rake.with_application do |rake|
+            rake.init("rails", [task, *args])
+            rake.load_rakefile
+            if Rails.respond_to?(:root)
+              rake.options.suppress_backtrace_pattern = /\A(?!#{Regexp.quote(Rails.root.to_s)})/
+            end
+            rake.standard_exception_handling { rake.top_level }
           end
         end
 
@@ -30,7 +31,7 @@ module Rails
 
             return @rake_tasks if defined?(@rake_tasks)
 
-            require_application_and_environment!
+            require_application!
 
             Rake::TaskManager.record_task_metadata = true
             Rake.application.instance_variable_set(:@name, "rails")

data/lib/rails/commands/secrets/USAGE

@@ -1,3 +1,9 @@
+=== ** DEPRECATED **
+
+Rails 5.2 has introduced a new `credentials` API that replaces Rails secrets.
+Please use the Rails `credentials` commands instead.
+Run `rails credentials:help` for more information.
+
 === Storing Encrypted Secrets in Source Control
 
 The Rails `secrets` commands helps encrypting secrets to slim a production
@@ -7,7 +13,7 @@ with the code.
 
 === Setup
 
-Run `rails secrets:setup` to opt in and generate the `config/secrets.yml.key`
+Run `bin/rails secrets:setup` to opt in and generate the `config/secrets.yml.key`
 and `config/secrets.yml.enc` files.
 
 The latter contains all the keys to be encrypted while the former holds the
@@ -45,12 +51,12 @@ the key. Add this:
 
    config.read_encrypted_secrets = true
 
-to the environment you'd like to read encrypted secrets. `rails secrets:setup`
+to the environment you'd like to read encrypted secrets. `bin/rails secrets:setup`
 inserts this into the production environment by default.
 
 === Editing Secrets
 
-After `rails secrets:setup`, run `rails secrets:edit`.
+After `bin/rails secrets:setup`, run `bin/rails secrets:edit`.
 
 That command opens a temporary file in `$EDITOR` with the decrypted contents of
 `config/secrets.yml.enc` to edit the encrypted secrets.