123456789_123456789_123456789_123456789_123456789_

Class: Rails::Command::HelpCommand

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, Base, Actions, Thor
Inherits: Rails::Command::Base
Defined in: railties/lib/rails/commands/help/help_command.rb

Constant Summary

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

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

#help

[ GitHub ]

  
# File 'railties/lib/rails/commands/help/help_command.rb', line 8

def help(*)
  say self.class.class_usage
end

#help_extended

[ GitHub ]

  
# File 'railties/lib/rails/commands/help/help_command.rb', line 12

def help_extended(*)
  help

  say ""
  say "In addition to those commands, there are:"
  say ""

  extended_commands = printing_commands_not_in_usage.sort_by(&:first)
  print_table(extended_commands, truncate: true)
end

#printing_commands_not_in_usage (private)

[ GitHub ]

  
# File 'railties/lib/rails/commands/help/help_command.rb', line 27

def printing_commands_not_in_usage # :nodoc:
  Rails::Command.printing_commands.reject do |command, _|
    command.in?(COMMANDS_IN_USAGE)
  end
end