railties 6.1.6 → 7.1.2

data/lib/rails/commands/help/USAGE

@@ -1,16 +1,17 @@
-The most common rails commands are:
- generate     Generate new code (short-cut alias: "g")
- console      Start the Rails console (short-cut alias: "c")
- server       Start the Rails server (short-cut alias: "s")
- test         Run tests except system tests (short-cut alias: "t")
- test:system  Run system tests
- dbconsole    Start a console for the database specified in config/database.yml
-              (short-cut alias: "db")
-<% unless engine? %>
- new          Create a new Rails application. "rails new my_app" creates a
-              new application called MyApp in "./my_app"
-<% end %>
+Usage:
+  bin/rails COMMAND [options]
 
-All commands can be run with -h (or --help) for more information.
-In addition to those commands, there are:
+You must specify a command. The most common commands are:
+
+  generate     Generate new code (short-cut alias: "g")
+  console      Start the Rails console (short-cut alias: "c")
+  server       Start the Rails server (short-cut alias: "s")
+  test         Run tests except system tests (short-cut alias: "t")
+  test:system  Run system tests
+  dbconsole    Start a console for the database specified in config/database.yml
+               (short-cut alias: "db")
+<% unless engine? -%>
+  plugin new   Create a new Rails railtie or engine
+<% end -%>
 
+All commands can be run with -h (or --help) for more information.

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

@@ -6,10 +6,29 @@ module Rails
       hide_command!
 
       def help(*)
-        say self.class.desc
+        say self.class.class_usage
+      end
+
+      def help_extended(*)
+        help
+
+        say ""
+        say "In addition to those commands, there are:"
+        say ""
 
-        Rails::Command.print_commands
+        extended_commands = printing_commands_not_in_usage.sort_by(&:first)
+        print_table(extended_commands, truncate: true)
       end
+
+      private
+        COMMANDS_IN_USAGE = %w(generate console server test test:system dbconsole new)
+        private_constant :COMMANDS_IN_USAGE
+
+        def printing_commands_not_in_usage # :nodoc:
+          Rails::Command.printing_commands.reject do |command, _|
+            command.in?(COMMANDS_IN_USAGE)
+          end
+        end
     end
   end
 end

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

@@ -9,10 +9,7 @@ module Rails
 
       desc "initializers", "Print out all defined initializers in the order they are invoked by Rails."
       def perform
-        extract_environment_option_from_argument
-        ENV["RAILS_ENV"] = options[:environment]
-
-        require_application_and_environment!
+        boot_application!
 
         Rails.application.initializers.tsort_each do |initializer|
           say "#{initializer.context_class}.#{initializer.name}"

data/lib/rails/commands/middleware/middleware_command.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Rails
+  module Command
+    class MiddlewareCommand < Base # :nodoc:
+      desc "middleware", "Print out your Rack middleware stack"
+      def perform
+        boot_application!
+
+        Rails.configuration.middleware.each do |middleware|
+          say "use #{middleware.inspect}"
+        end
+        say "run #{Rails.application.class.name}.routes"
+      end
+    end
+  end
+end

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

@@ -3,6 +3,8 @@
 module Rails
   module Command
     class NewCommand < Base # :nodoc:
+      self.bin = "rails"
+
       no_commands do
         def help
           Rails::Command.invoke :application, [ "--help" ]

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

@@ -7,8 +7,9 @@ module Rails
     class NotesCommand < Base # :nodoc:
       class_option :annotations, aliases: "-a", desc: "Filter by specific annotations, e.g. Foobar TODO", type: :array
 
+      desc "notes", "Show comments in your code annotated with FIXME, OPTIMIZE, and TODO"
       def perform(*)
-        require_application_and_environment!
+        boot_application!
 
         display_annotations
       end

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

@@ -5,6 +5,8 @@ module Rails
     class PluginCommand < Base # :nodoc:
       hide_command!
 
+      self.bin = "rails"
+
       def help
         run_plugin_generator %w( --help )
       end

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

@@ -9,42 +9,45 @@ module Rails
 
       class << self
         def printing_commands
-          formatted_rake_tasks.map(&:first)
+          rake_tasks.filter_map do |task|
+            if task.comment && task.locations.any?(non_app_file_pattern)
+              [task.name_with_args, task.comment]
+            end
+          end
         end
 
         def perform(task, args, config)
-          require_rake
-
-          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)})/
+          with_rake(task, *args) do |rake|
+            if unrecognized_task = rake.top_level_tasks.find { |task| !rake.lookup(task[/[^\[]+/]) }
+              @rake_tasks = rake.tasks
+              raise UnrecognizedCommandError.new(unrecognized_task)
             end
+
+            rake.options.suppress_backtrace_pattern = non_app_file_pattern
             rake.standard_exception_handling { rake.top_level }
           end
         end
 
         private
-          def rake_tasks
-            require_rake
-
-            return @rake_tasks if defined?(@rake_tasks)
-
-            require_application!
+          def non_app_file_pattern
+            /\A(?!#{Regexp.quote Rails::Command.root.to_s})/
+          end
 
+          def with_rake(*args, &block)
+            require "rake"
             Rake::TaskManager.record_task_metadata = true
-            Rake.application.instance_variable_set(:@name, "rails")
-            load_tasks
-            @rake_tasks = Rake.application.tasks.select(&:comment)
-          end
 
-          def formatted_rake_tasks
-            rake_tasks.map { |t| [ t.name_with_args, t.comment ] }
+            result = nil
+            Rake.with_application do |rake|
+              rake.init(bin, args) unless args.empty?
+              rake.load_rakefile
+              result = block.call(rake)
+            end
+            result
           end
 
-          def require_rake
-            require "rake" # Defer booting Rake until we know it's needed.
+          def rake_tasks
+            @rake_tasks ||= with_rake(&:tasks)
           end
       end
     end

data/lib/rails/commands/restart/restart_command.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Rails
+  module Command
+    class RestartCommand < Base # :nodoc:
+      desc "restart", "Restart app by touching tmp/restart.txt"
+      def perform
+        require "fileutils"
+        FileUtils.mkdir_p Rails::Command.application_root.join("tmp")
+        FileUtils.touch   Rails::Command.application_root.join("tmp/restart.txt")
+      end
+    end
+  end
+end

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

@@ -8,9 +8,21 @@ module Rails
       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."
+      class_option :unused, type: :boolean, aliases: "-u", desc: "Print unused routes."
 
+      no_commands do
+        def invoke_command(*)
+          if options.key?("unused")
+            Rails::Command.invoke "unused_routes", ARGV
+          else
+            super
+          end
+        end
+      end
+
+      desc "routes", "List all the defined routes"
       def perform(*)
-        require_application_and_environment!
+        boot_application!
         require "action_dispatch/routing/inspector"
 
         say inspector.format(formatter, routes_filter)

data/lib/rails/commands/runner/USAGE

@@ -1,20 +1,22 @@
-Examples:
+Description:
+    The Rails `runner` allows running Ruby code in the context of your application.
 
-Run `puts Rails.env` after loading the app:
+Examples:
+    Run `puts Rails.env` after loading the app:
 
-  <%= executable %> 'puts Rails.env'
+        <%= executable %> 'puts Rails.env'
 
-Run the Ruby file located at `path/to/filename.rb` after loading the app:
+    Run the Ruby file located at `path/to/filename.rb` after loading the app:
 
-  <%= executable %> path/to/filename.rb
+        <%= executable %> path/to/filename.rb
 
-Run the Ruby script read from stdin after loading the app:
-  <%= executable %> -
+    Run the Ruby script read from stdin after loading the app:
 
-<% unless Gem.win_platform? %>
-You can also use the runner command as a shebang line for your executables:
+        <%= executable %> -
+<% unless Gem.win_platform? -%>
 
-  #!/usr/bin/env <%= File.expand_path(executable) %>
+    You can also use the runner command as a shebang line for your executables:
 
-  Product.all.each { |p| p.price *= 2 ; p.save! }
-<% end %>
+        #!/usr/bin/env <%= File.expand_path(executable) %>
+        Product.all.each { |p| p.price *= 2 ; p.save! }
+<% end -%>

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

@@ -7,51 +7,64 @@ module Rails
     class RunnerCommand < Base # :nodoc:
       include EnvironmentArgument
 
-      self.environment_desc = "The environment for the runner to operate under (test/development/production)"
-
       no_commands do
-        def help
+        def help(command_name = nil, *)
           super
-          say self.class.desc
+          if command_name == "runner"
+            say ""
+            say self.class.class_usage
+          end
         end
       end
 
-      def self.banner(*)
-        "#{super} [<'Some.ruby(code)'> | <filename.rb> | -]"
-      end
-
+      desc "runner [<'Some.ruby(code)'> | <filename.rb> | -]",
+        "Run Ruby code in the context of your application"
       def perform(code_or_file = nil, *command_argv)
-        extract_environment_option_from_argument
-
         unless code_or_file
           help
           exit 1
         end
 
-        ENV["RAILS_ENV"] = options[:environment]
-
-        require_application_and_environment!
+        boot_application!
         Rails.application.load_runner
 
         ARGV.replace(command_argv)
 
         if code_or_file == "-"
-          eval($stdin.read, TOPLEVEL_BINDING, "stdin")
+          Rails.application.executor.wrap(source: "application.runner.railties") do
+            eval($stdin.read, TOPLEVEL_BINDING, "stdin")
+          end
         elsif File.exist?(code_or_file)
-          $0 = code_or_file
-          Kernel.load code_or_file
+          expanded_file_path = File.expand_path code_or_file
+          $0 = expanded_file_path
+          Rails.application.executor.wrap(source: "application.runner.railties") do
+            Kernel.load expanded_file_path
+          end
         else
           begin
-            eval(code_or_file, TOPLEVEL_BINDING, __FILE__, __LINE__)
+            Rails.application.executor.wrap(source: "application.runner.railties") do
+              eval(code_or_file, TOPLEVEL_BINDING, __FILE__, __LINE__)
+            end
           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
+            if looks_like_a_file_path?(code_or_file)
+              error "The file #{code_or_file} could not be found, please check and try again."
+              error "Run '#{self.class.executable} -h' for help."
+            else
+              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
+            end
+
             exit 1
           end
         end
       end
+
+      private
+        def looks_like_a_file_path?(code_or_file)
+          code_or_file.ends_with?(".rb")
+        end
     end
   end
 end

data/lib/rails/commands/secret/secret_command.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rails
+  module Command
+    class SecretCommand < Base # :nodoc:
+      desc "secret", "Generate a cryptographically secure secret key (this is typically used to generate a secret for cookie sessions)."
+      def perform
+        require "securerandom"
+        puts SecureRandom.hex(64)
+      end
+    end
+  end
+end

data/lib/rails/commands/secrets/USAGE

@@ -1,66 +1,61 @@
-=== ** DEPRECATED **
+Description:
+    ** DEPRECATED **
+    Rails 5.2 has introduced a new `credentials` API that replaces Rails secrets.
+    Please use the Rails `credentials` commands instead.
+    Run `bin/rails credentials:help` for more information.
 
-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.
+    The Rails `secrets` commands helps encrypting secrets to slim a production
+    environment's `ENV` hash. It's also useful for atomic deploys: no need to
+    coordinate key changes to get everything working as the keys are shipped
+    with the code.
 
-=== Storing Encrypted Secrets in Source Control
+Setup:
+    Run `<%= executable(:setup) %>` to opt in and generate the `config/secrets.yml.key`
+    and `config/secrets.yml.enc` files.
 
-The Rails `secrets` commands helps encrypting secrets to slim a production
-environment's `ENV` hash. It's also useful for atomic deploys: no need to
-coordinate key changes to get everything working as the keys are shipped
-with the code.
+    The latter contains all the keys to be encrypted while the former holds the
+    encryption key.
 
-=== Setup
+    Don't lose the key! Put it in a password manager your team can access.
+    Should you lose it no one, including you, will be able to access any encrypted
+    secrets.
+    Don't commit the key! Add `config/secrets.yml.key` to your source control's
+    ignore file. If you use Git, Rails handles this for you.
 
-Run `bin/rails secrets:setup` to opt in and generate the `config/secrets.yml.key`
-and `config/secrets.yml.enc` files.
+    Rails also looks for the key in `ENV["RAILS_MASTER_KEY"]` if that's easier to
+    manage.
 
-The latter contains all the keys to be encrypted while the former holds the
-encryption key.
+    You could prepend that to your server's start command like this:
 
-Don't lose the key! Put it in a password manager your team can access.
-Should you lose it no one, including you, will be able to access any encrypted
-secrets.
-Don't commit the key! Add `config/secrets.yml.key` to your source control's
-ignore file. If you use Git, Rails handles this for you.
+        RAILS_MASTER_KEY="im-the-master-now-hahaha" bin/rails server
 
-Rails also looks for the key in `ENV["RAILS_MASTER_KEY"]` if that's easier to
-manage.
+    The `config/secrets.yml.enc` has much the same format as `config/secrets.yml`:
 
-You could prepend that to your server's start command like this:
+        production:
+          secret_key_base: so-secret-very-hidden-wow
+          payment_processing_gateway_key: much-safe-very-gaedwey-wow
 
-   RAILS_MASTER_KEY="im-the-master-now-hahaha" server.start
+    But that's where the similarities between `secrets.yml` and `secrets.yml.enc`
+    end, e.g. no keys from `secrets.yml` will be moved to `secrets.yml.enc` and
+    be encrypted.
 
+    A `shared:` top level key is also supported such that any keys there is merged
+    into the other environments.
 
-The `config/secrets.yml.enc` has much the same format as `config/secrets.yml`:
+    Additionally, Rails won't read encrypted secrets out of the box even if you have
+    the key. Add this:
 
-   production:
-     secret_key_base: so-secret-very-hidden-wow
-     payment_processing_gateway_key: much-safe-very-gaedwey-wow
+        config.read_encrypted_secrets = true
 
-But that's where the similarities between `secrets.yml` and `secrets.yml.enc`
-end, e.g. no keys from `secrets.yml` will be moved to `secrets.yml.enc` and
-be encrypted.
+    to the environment you'd like to read encrypted secrets. `<%= executable(:setup) %>`
+    inserts this into the production environment by default.
 
-A `shared:` top level key is also supported such that any keys there is merged
-into the other environments.
+Editing Secrets:
+    After `<%= executable(:setup) %>`, run `<%= executable(:edit) %>`.
 
-Additionally, Rails won't read encrypted secrets out of the box even if you have
-the key. Add this:
+    That command opens a temporary file in `$VISUAL` or `$EDITOR` with the decrypted
+    contents of `config/secrets.yml.enc` to edit the encrypted secrets.
 
-   config.read_encrypted_secrets = true
-
-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 `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.
-
-When the temporary file is next saved the contents are encrypted and written to
-`config/secrets.yml.enc` while the file itself is destroyed to prevent secrets
-from leaking.
+    When the temporary file is next saved the contents are encrypted and written to
+    `config/secrets.yml.enc` while the file itself is destroyed to prevent secrets
+    from leaking.

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

@@ -1,65 +1,47 @@
 # frozen_string_literal: true
 
 require "active_support"
+require "active_support/core_ext/string/filters"
 require "rails/secrets"
+require "rails/command/helpers/editor"
 
 module Rails
   module Command
     class SecretsCommand < Rails::Command::Base # :nodoc:
-      no_commands do
-        def help
-          say "Usage:\n  #{self.class.banner}"
-          say ""
-          say self.class.desc
-        end
-      end
-
-      def setup
-        deprecate_in_favor_of_credentials_and_exit
-      end
+      include Helpers::Editor
 
+      desc "edit", "**deprecated** Open the secrets in `$VISUAL` or `$EDITOR` for editing"
       def edit
-        if ENV["EDITOR"].to_s.empty?
-          say "No $EDITOR to open decrypted secrets in. Assign one like this:"
-          say ""
-          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."
+        Rails.deprecator.warn(<<~MSG.squish)
+          `bin/rails secrets:edit` is deprecated in favor of credentials and will be removed in Rails 7.2.
+          Run `bin/rails credentials:help` for more information.
+        MSG
 
-          return
-        end
-
-        require_application_and_environment!
+        boot_application!
 
-        Rails::Secrets.read_for_editing do |tmp_path|
-          system("#{ENV["EDITOR"]} #{tmp_path}")
+        using_system_editor do
+          Rails::Secrets.read_for_editing { |tmp_path| system_editor(tmp_path) }
+          say "File encrypted and saved."
         end
-
-        say "New secrets encrypted and saved."
-      rescue Interrupt
-        say "Aborted changing encrypted secrets: nothing saved."
       rescue Rails::Secrets::MissingKeyError => error
         say error.message
       rescue Errno::ENOENT => error
-        if /secrets\.yml\.enc/.match?(error.message)
-          deprecate_in_favor_of_credentials_and_exit
+        if error.message.include?("secrets.yml.enc")
+          exit 1
         else
           raise
         end
       end
 
+      desc "show", "**deprecated** Show the decrypted secrets"
       def show
+        Rails.deprecator.warn(<<~MSG.squish)
+          `bin/rails secrets:show` is deprecated in favor of credentials and will be removed in Rails 7.2.
+          Run `bin/rails credentials:help` for more information.
+        MSG
+
         say Rails::Secrets.read
       end
-
-      private
-        def deprecate_in_favor_of_credentials_and_exit
-          say "Encrypted secrets is deprecated in favor of credentials. Run:"
-          say "rails credentials:help"
-
-          exit 1
-        end
     end
   end
 end