class Rails::Command::Base

Parent:: Thor
Included modules:: Rails::Command::Actions

Публичные Классовые Методы

# File railties/lib/rails/command/base.rb, line 81
def banner(*)
  "#{executable} #{arguments.map(&:usage).join(' ')} [options]".squish
end

Использование стандартного баннера Rails.

base_name() Показать исходный код

# File railties/lib/rails/command/base.rb, line 88
def base_name
  @base_name ||= begin
    if base = name.to_s.split("::").first
      base.underscore
    end
  end
end

Устанавливает имя base_name, учитывая текущее пространство имен класса.

Rails::Command::TestCommand.base_name # => 'rails'

command_name() Показать исходный код

# File railties/lib/rails/command/base.rb, line 99
def command_name
  @command_name ||= begin
    if command = name.to_s.split("::").last
      command.chomp!("Command")
      command.underscore
    end
  end
end

Возвращает имя команды без пространств имён.

Rails::Command::TestCommand.command_name # => 'test'

default_command_root() Показать исходный код

# File railties/lib/rails/command/base.rb, line 121
def default_command_root
  path = File.expand_path(relative_command_path, __dir__)
  path if File.exist?(path)
end

Базовой корневой каталог для размещения дополнительных файлов, необходимых команде, расположенный на одну папку выше файла команды.

Для Rails::Command::TestCommand, размещенного в rails/command/test_command.rb, будет возвращено rails/test.

desc(usage = nil, description = nil, options = {}) Показать исходный код

# File railties/lib/rails/command/base.rb, line 31
def desc(usage = nil, description = nil, options = {})
  if usage
    super
  else
    @desc ||= ERB.new(File.read(usage_path)).result(binding) if usage_path
  end
end

Попытка получить описание из файла USAGE в папке над корнем команды.

Вызов метода суперкласса

engine?() Показать исходный код

# File railties/lib/rails/command/base.rb, line 25
def engine?
  defined?(ENGINE_ROOT)
end

Возвращает true, если приложение является Rails модулем.

executable() Показать исходный код

# File railties/lib/rails/command/base.rb, line 76
def executable
  "rails #{command_name}"
end

hide_command!() Показать исходный код

# File railties/lib/rails/command/base.rb, line 52
def hide_command!
  Rails::Command.hidden_commands << self
end

Удобный метод для скрытия этой команды из доступных при запуске rails command.

namespace(name = nil) Показать исходный код

# File railties/lib/rails/command/base.rb, line 42
def namespace(name = nil)
  if name
    super
  else
    @namespace ||= super.chomp("_command").sub(/:command:/, ":")
  end
end

Удобный метод для получения пространства имен из имени класса. Он аналогичен стандартному Thor, за исключением того, что Command в конце класса удаляется.

Вызов метода суперкласса

printing_commands() Показать исходный код

# File railties/lib/rails/command/base.rb, line 72
def printing_commands
  namespaced_commands
end

usage_path() Показать исходный код

# File railties/lib/rails/command/base.rb, line 109
def usage_path
  if default_command_root
    path = File.join(default_command_root, "USAGE")
    path if File.exist?(path)
  end
end

Путь для поиска описания USAGE в файле.

Публичные Методы Экземпляров

help() Показать исходный код

# File railties/lib/rails/command/base.rb, line 160
def help
  if command_name = self.class.command_name
    self.class.command_help(shell, command_name)
  else
    super
  end
end

Вызов метода суперкласса