Class: Inch::CLI::Command::Base Abstract

Inherits:
Object
  • Object
show all
Includes:
TraceHelper
Defined in:
lib/inch/cli/command/base.rb

Overview

This class is abstract.

Subclass and override #run to implement a new command

Note:

This was adapted from YARD github.com/lsegal/yard/blob/master/lib/yard/cli/command.rb

Abstract base class for CLI controller objects

Direct Known Subclasses

BaseList, Diff

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from TraceHelper

#ui

Constructor Details

#initialize ⇒ Base

Returns a new instance of Base.



62
63
64
65
66
67
 
# File 'lib/inch/cli/command/base.rb', line 62

def initialize
  name = self.class.to_s.split('::').last
  options_class = Command::Options.const_get(name)
  @options = options_class.new
  @options.usage = usage
end

Instance Attribute Details

#codebase ⇒ Codebase::Proxy (readonly)

Returns:



41
42
43
 
# File 'lib/inch/cli/command/base.rb', line 41

def codebase
  @codebase
end

Class Method Details

.register_command_as(name, default = false) ⇒ void

This method returns an undefined value.

Registers the current Command in the CommandParser

Parameters:

  • name (Symbol) —

    name of the Command



57
58
59
60
 
# File 'lib/inch/cli/command/base.rb', line 57

def self.register_command_as(name, default = false)
  CLI::CommandParser.default_command = name if default
  CLI::CommandParser.commands[name] = self
end

.run(*args) ⇒ Command::Base

Helper method to run an instance with the given args

Returns:

See Also:



47
48
49
50
51
 
# File 'lib/inch/cli/command/base.rb', line 47

def self.run(*args)
  command = new
  command.run(*args)
  command
end

Instance Method Details

#description ⇒ String

Returns a description of the command

Returns:

  • (String) 


72
73
74
 
# File 'lib/inch/cli/command/base.rb', line 72

def description
  ""
end

#name ⇒ String

Returns the name of the command by which it is referenced in the command list

Returns:

  • (String) 


80
81
82
83
84
 
# File 'lib/inch/cli/command/base.rb', line 80

def name
  CommandParser.commands.each do |name, klass|
    return name if klass == self.class
  end
end

#run(*args) ⇒ Object

This method is abstract.
Note:

Override with implementation

Runs the command with the given args

Parameters:

  • *args (Array<String>)

Raises:

  • (NotImplementedError) 


91
92
93
 
# File 'lib/inch/cli/command/base.rb', line 91

def run(*args)
  raise NotImplementedError
end

#usage ⇒ String

Returns a description of the command’s usage pattern

Returns:

  • (String) 


98
99
100
 
# File 'lib/inch/cli/command/base.rb', line 98

def usage
  "Usage: inch #{name} [options]"
end