123456789_123456789_123456789_123456789_123456789_

Class: Rails::Command::SecretsCommand

Do not use. This class is for internal use only.
Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Base, Thor
Instance Chain:
self, Helpers::Editor, Base, Actions, Thor
Inherits: Rails::Command::Base
Defined in: railties/lib/rails/commands/secrets/secrets_command.rb

Class Attribute Summary

Base - Inherited

.bin, .bin?,
.engine?

Returns true when the app is a Rails engine.

.exit_on_failure?

Class Method Summary

Base - Inherited

.banner,
.base_name

Sets the base_name taking into account the current class namespace.

.command_name

Return command name without namespaces.

.default_command_root

Default file root to place extra files a command might need, placed one folder above the command file.

.desc

Tries to get the description from a USAGE file one folder above the command root.

.executable,
.hide_command!

Convenience method to hide this command from the available ones when running rails command.

.namespace

Convenience method to get the namespace from the class name.

.printing_commands,
.usage_path

Path to lookup a USAGE description in a file.

.create_command

Allow the command method to be called perform.

.namespaced_name, .resolve_path, .class_usage,
.help

Override Thor’s class-level help to also show the USAGE.

.inherited, .perform

Instance Method Summary

Helpers::Editor - Included

Actions - Included

#boot_application!, #load_environment_config!,
#load_generators

See additional method definition at line 36.

#load_tasks

See additional method definition at line 31.

#require_application!,
#set_application_directory!

Change to the application’s path if there is no config.ru file in current directory.

Instance Method Details

#edit

[ GitHub ]

  
# File 'railties/lib/rails/commands/secrets/secrets_command.rb', line 14

def 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

  boot_application!

  using_system_editor do
    Rails::Secrets.read_for_editing { |tmp_path| system_editor(tmp_path) }
    say "File encrypted and saved."
  end
rescue Rails::Secrets::MissingKeyError => error
  say error.message
rescue Errno::ENOENT => error
  if error.message.include?("secrets.yml.enc")
    exit 1
  else
    raise
  end
end

#show

[ GitHub ]

  
# File 'railties/lib/rails/commands/secrets/secrets_command.rb', line 37

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