railties 5.2.8.1 → 6.0.0.beta1

data/lib/rails/command.rb

@@ -4,7 +4,6 @@ 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 +11,7 @@ module Rails
   module Command
     extend ActiveSupport::Autoload
 
+    autoload :Spellchecker
     autoload :Behavior
     autoload :Base
 
@@ -83,20 +83,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/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 `bin/rails credentials:edit`.
+credentials file in `config/credentials.yml.enc` the first time you run `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.
@@ -38,3 +38,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 takes precedence over the
+global `config/credentials.yml.enc` file when running in that environment. So:
+
+   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 overriden through
+`config.credentials.content_path` and `config.credentials.key_path`.

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

@@ -8,6 +8,9 @@ module Rails
     class CredentialsCommand < Rails::Command::Base # :nodoc:
       include Helpers::Editor
 
+      class_option :environment, aliases: "-e", type: :string,
+        desc: "Uses credentials from config/credentials/:environment.yml.enc encrypted by config/credentials/:environment.key key"
+
       no_commands do
         def help
           say "Usage:\n  #{self.class.banner}"
@@ -17,62 +20,78 @@ module Rails
       end
 
       def edit
-        require_application!
+        require_application_and_environment!
 
         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
 
         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!
+        require_application_and_environment!
 
-        say Rails.application.credentials.read.presence || missing_credentials_message
+        say credentials.read.presence || missing_credentials_message
       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
+          encrypted_file_generator.add_encrypted_file_silently(content_path, key_path)
         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 `rails credentials:help`"
+          else
+            "File '#{content_path}' does not exist. Use `rails credentials:edit` to change that."
+          end
+        end
 
-        def master_key_generator
-          require "rails/generators"
-          require "rails/generators/rails/master_key/master_key_generator"
 
-          Rails::Generators::MasterKeyGenerator.new
+        def content_path
+          options[:environment] ? "config/credentials/#{options[:environment]}.yml.enc" : "config/credentials.yml.enc"
         end
 
-        def credentials_generator
+        def key_path
+          options[:environment] ? "config/credentials/#{options[:environment]}.key" : "config/master.key"
+        end
+
+
+        def encryption_key_file_generator
           require "rails/generators"
-          require "rails/generators/rails/credentials/credentials_generator"
+          require "rails/generators/rails/encryption_key_file/encryption_key_file_generator"
 
-          Rails::Generators::CredentialsGenerator.new
+          Rails::Generators::EncryptionKeyFileGenerator.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
+        def encrypted_file_generator
+          require "rails/generators"
+          require "rails/generators/rails/encrypted_file/encrypted_file_generator"
+
+          Rails::Generators::EncryptedFileGenerator.new
         end
     end
   end

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

@@ -0,0 +1,20 @@
+# 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 perform
+            Rails::Generators::Db::System::ChangeGenerator.start
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -75,7 +75,7 @@ module Rails
         args += ["-P", "#{config['password']}"] if config["password"]
 
         if config["host"]
-          host_arg = "#{config['host']}".dup
+          host_arg = +"#{config['host']}"
           host_arg << ":#{config['port']}" if config["port"]
           args += ["-S", host_arg]
         end
@@ -97,7 +97,7 @@ module Rails
         elsif configurations[environment].blank? && configurations[connection].blank?
           raise ActiveRecord::AdapterNotSpecified, "'#{environment}' database is not configured. Available configuration: #{configurations.inspect}"
         else
-          configurations[environment].presence || configurations[connection]
+          configurations[connection] || configurations[environment].presence
         end
       end
     end

data/lib/rails/commands/dev/dev_command.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rails/dev_caching"
+
+module Rails
+  module Command
+    class DevCommand < Base # :nodoc:
+      def help
+        say "rails dev:cache # Toggle development mode caching on/off."
+      end
+
+      def cache
+        Rails::DevCaching.enable_by_file
+      end
+    end
+  end
+end

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

@@ -16,7 +16,6 @@ module Rails
         def help
           say "Usage:\n  #{self.class.banner}"
           say ""
-          say self.class.desc
         end
       end
 
@@ -77,9 +76,9 @@ module Rails
 
         def missing_encrypted_message(key:, key_path:, file_path:)
           if key.nil?
-            "Missing '#{key_path}' to decrypt data. See bin/rails encrypted:help"
+            "Missing '#{key_path}' to decrypt data. See `rails encrypted:help`"
           else
-            "File '#{file_path}' does not exist. Use bin/rails encrypted:edit #{file_path} to change that."
+            "File '#{file_path}' does not exist. Use `rails encrypted:edit #{file_path}` to change that."
           end
         end
     end

data/lib/rails/commands/help/help_command.rb

@@ -6,7 +6,7 @@ module Rails
       hide_command!
 
       def help(*)
-        puts self.class.desc
+        say self.class.desc
 
         Rails::Command.print_commands
       end

data/lib/rails/commands/initializers/initializers_command.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Rails
+  module Command
+    class InitializersCommand < Base # :nodoc:
+      desc "initializers", "Print out all defined initializers in the order they are invoked by Rails."
+      def perform
+        require_application_and_environment!
+
+        Rails.application.initializers.tsort_each do |initializer|
+          say "#{initializer.context_class}.#{initializer.name}"
+        end
+      end
+    end
+  end
+end

data/lib/rails/commands/new/new_command.rb

@@ -10,8 +10,8 @@ module Rails
       end
 
       def perform(*)
-        puts "Can't initialize a new Rails application within the directory of another, please change to a non-Rails directory first.\n"
-        puts "Type 'rails' for help."
+        say "Can't initialize a new Rails application within the directory of another, please change to a non-Rails directory first.\n"
+        say "Type 'rails' for help."
         exit 1
       end
     end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+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, default: %w(OPTIMIZE FIXME TODO)
+
+      def perform(*)
+        require_application_and_environment!
+
+        deprecation_warning
+        display_annotations
+      end
+
+      private
+        def display_annotations
+          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(",")
+        end
+    end
+  end
+end

data/lib/rails/commands/plugin/plugin_command.rb

@@ -26,7 +26,7 @@ module Rails
 
           if File.exist?(railsrc)
             extra_args = File.read(railsrc).split(/\n+/).flat_map(&:split)
-            puts "Using #{extra_args.join(" ")} from #{railsrc}"
+            say "Using #{extra_args.join(" ")} from #{railsrc}"
             plugin_args.insert(1, *extra_args)
           end
         end

data/lib/rails/commands/routes/routes_command.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "rails/command"
+
+module Rails
+  module Command
+    class RoutesCommand < Base # :nodoc:
+      class_option :controller, aliases: "-c", desc: "Filter by a specific controller, e.g. PostsController or Admin::PostsController."
+      class_option :grep, aliases: "-g", desc: "Grep routes by a specific pattern."
+      class_option :expanded, type: :boolean, aliases: "-E", desc: "Print routes expanded vertically with parts explained."
+
+      def perform(*)
+        require_application_and_environment!
+        require "action_dispatch/routing/inspector"
+
+        say inspector.format(formatter, routes_filter)
+      end
+
+      private
+        def inspector
+          ActionDispatch::Routing::RoutesInspector.new(Rails.application.routes.routes)
+        end
+
+        def formatter
+          if options.key?("expanded")
+            ActionDispatch::Routing::ConsoleFormatter::Expanded.new
+          else
+            ActionDispatch::Routing::ConsoleFormatter::Sheet.new
+          end
+        end
+
+        def routes_filter
+          options.symbolize_keys.slice(:controller, :grep)
+        end
+    end
+  end
+end

data/lib/rails/commands/runner/runner_command.rb

@@ -10,7 +10,7 @@ module Rails
       no_commands do
         def help
           super
-          puts self.class.desc
+          say self.class.desc
         end
       end
 
@@ -39,11 +39,11 @@ module Rails
         else
           begin
             eval(code_or_file, TOPLEVEL_BINDING, __FILE__, __LINE__)
-          rescue SyntaxError, NameError => error
-            $stderr.puts "Please specify a valid ruby command or the path of a script to run."
-            $stderr.puts "Run '#{self.class.executable} -h' for help."
-            $stderr.puts
-            $stderr.puts error
+          rescue SyntaxError, NameError => e
+            error "Please specify a valid ruby command or the path of a script to run."
+            error "Run '#{self.class.executable} -h' for help."
+            error ""
+            error e
             exit 1
           end
         end

data/lib/rails/commands/secrets/USAGE

@@ -7,7 +7,7 @@ with the code.
 
 === Setup
 
-Run `bin/rails secrets:setup` to opt in and generate the `config/secrets.yml.key`
+Run `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 +45,12 @@ the key. Add this:
 
    config.read_encrypted_secrets = true
 
-to the environment you'd like to read encrypted secrets. `bin/rails secrets:setup`
+to the environment you'd like to read encrypted secrets. `rails secrets:setup`
 inserts this into the production environment by default.
 
 === Editing Secrets
 
-After `bin/rails secrets:setup`, run `bin/rails secrets:edit`.
+After `rails secrets:setup`, run `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.

data/lib/rails/commands/secrets/secrets_command.rb

@@ -22,7 +22,7 @@ module Rails
         if ENV["EDITOR"].to_s.empty?
           say "No $EDITOR to open decrypted secrets in. Assign one like this:"
           say ""
-          say %(EDITOR="mate --wait" bin/rails secrets:edit)
+          say %(EDITOR="mate --wait" rails secrets:edit)
           say ""
           say "For editors that fork and exit immediately, it's important to pass a wait flag,"
           say "otherwise the secrets will be saved immediately with no chance to edit."
@@ -42,7 +42,7 @@ module Rails
       rescue Rails::Secrets::MissingKeyError => error
         say error.message
       rescue Errno::ENOENT => error
-        if error.message =~ /secrets\.yml\.enc/
+        if /secrets\.yml\.enc/.match?(error.message)
           deprecate_in_favor_of_credentials_and_exit
         else
           raise
@@ -56,7 +56,7 @@ module Rails
       private
         def deprecate_in_favor_of_credentials_and_exit
           say "Encrypted secrets is deprecated in favor of credentials. Run:"
-          say "bin/rails credentials:help"
+          say "rails credentials:help"
 
           exit 1
         end