Class: WavefrontCommandBase

Inherits:
Object
  • Object
show all
Defined in:
lib/wavefront-cli/commands/base.rb

Overview

A base class which all command classes extend.

Instance Method Summary collapse

Instance Method Details

#_commands ⇒ Array

Inheriting classes must override this method

Returns:



67
68
69
 
# File 'lib/wavefront-cli/commands/base.rb', line 67

def _commands
  []
end

#_options ⇒ Array

Inheriting classes must override this method

Returns:



38
39
40
 
# File 'lib/wavefront-cli/commands/base.rb', line 38

def _options
  []
end

#acl_commands ⇒ Array

Anything which takes ACLs provides the same interface

Returns:



57
58
59
60
61
62
 
# File 'lib/wavefront-cli/commands/base.rb', line 57

def acl_commands
  ["acls #{CMN} <id>",
   "acl #{CMN} clear <id>",
   "acl #{CMN} grant (view | modify) on <id> to <name>...",
   "acl #{CMN} revoke (view | modify) on <id> from <name>..."]
end

#commands(term_width = TW) ⇒ String

Returns the subcommands the command offers.

Parameters:

  • term_width (Integer) (defaults to: TW) —

    force a terminal width. Makes testing far simpler.

Returns:

  • (String) —

    the subcommands the command offers.



104
105
106
107
108
 
# File 'lib/wavefront-cli/commands/base.rb', line 104

def commands(term_width = TW)
  _commands.flatten.each_with_object("Usage:\n") do |cmd, ret|
    ret.<< '  ' + "#{CMD} #{word} #{cmd}\n".cmd_fold(term_width) + "\n"
  end + "  #{CMD} #{word} --help"
end

#common_options ⇒ Array

Many commands have these options

Returns:



30
31
32
33
 
# File 'lib/wavefront-cli/commands/base.rb', line 30

def common_options
  ['-E, --endpoint=URI       cluster endpoint',
   '-t, --token=TOKEN        Wavefront authentication token']
end

#description ⇒ Object 



9
10
11
 
# File 'lib/wavefront-cli/commands/base.rb', line 9

def description
  "view and manage #{things}"
end

#docopt ⇒ String

Returns a full options string which docopt understands.

Returns:

  • (String) —

    a full options string which docopt understands



160
161
162
 
# File 'lib/wavefront-cli/commands/base.rb', line 160

def docopt
  commands + "\n\n" + options + "\n" + postscript
end

#global_options ⇒ Array

All commands have these options

Returns:



16
17
18
19
20
21
22
23
24
25
 
# File 'lib/wavefront-cli/commands/base.rb', line 16

def global_options
  ['-c, --config=FILE    path to configuration file',
   '-P, --profile=NAME   profile in configuration file',
   '-D, --debug          enable debug mode',
   '-n, --noop           do not perform API calls',
   '-V, --verbose        be verbose',
   '-f, --format=STRING  output format',
   '-M, --items-only     only show items in machine-parseable formats',
   '-h, --help           show this message']
end

#opt_row(opt, width, term_width = TW) ⇒ Object

Formats an option string.

Parameters:

  • opt (String) —

    the option string

  • width (Integer) —

    the width of the short + long options columns. This is used to indent following lines

  • term_width (Integer) (defaults to: TW) —

    the width of the user’s terminal



138
139
140
141
 
# File 'lib/wavefront-cli/commands/base.rb', line 138

def opt_row(opt, width, term_width = TW)
  format("  %s %-#{width}s %s\n", *opt.split(/\s+/, 3))
    .opt_fold(term_width, width + 5)
end

#option_column_width ⇒ Integer

Returns the width of the column containing short and long options.

Returns:

  • (Integer) —

    the width of the column containing short and long options



146
147
148
149
150
 
# File 'lib/wavefront-cli/commands/base.rb', line 146

def option_column_width
  (global_options + _options).flatten.map do |o|
    o.split(/\s+/, 3)[0..1].join(' ').size
  end.max
end

#options(term_width = TW) ⇒ String

rubocop:disable Metrics/AbcSize

Parameters:

  • term_width (Integer) (defaults to: TW) —

    force a terminal width. Makes testing far simpler.

Returns:

  • (String) —

    the options the command understands.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/wavefront-cli/commands/base.rb', line 115

def options(term_width = TW)
  width = option_column_width
  ret = ''

  unless global_options.empty?
    ret.<< "Global options:\n"
    global_options.each { |o| ret.<< opt_row(o, width, term_width) }
    ret.<< "\n"
  end

  ret.<< "Options:\n"
  _options.flatten.each { |o| ret.<< opt_row(o, width, term_width) }
  ret
end

#postscript ⇒ String

Returns which will be printed underneath the options.

Returns:

  • (String) —

    which will be printed underneath the options.



154
155
156
 
# File 'lib/wavefront-cli/commands/base.rb', line 154

def postscript
  ''
end

#sdk_class ⇒ String

Returns the name of the SDK class which does the work for this command.

Returns:

  • (String) —

    the name of the SDK class which does the work for this command.



88
89
90
 
# File 'lib/wavefront-cli/commands/base.rb', line 88

def sdk_class
  word.capitalize
end

#sdk_file ⇒ String

Returns the name of the SDK file which does the work for this command.

Returns:

  • (String) —

    the name of the SDK file which does the work for this command.



95
96
97
 
# File 'lib/wavefront-cli/commands/base.rb', line 95

def sdk_file
  word
end

#tag_commands ⇒ Array

Anything which takes tags provides the same interface

Returns:



45
46
47
48
49
50
51
52
 
# File 'lib/wavefront-cli/commands/base.rb', line 45

def tag_commands
  ["tags #{CMN} <id>",
   "tag set #{CMN} <id> <tag>...",
   "tag clear #{CMN} <id>",
   "tag add #{CMN} <id> <tag>",
   "tag delete #{CMN} <id> <tag>",
   "tag pathsearch #{CMN} [-al] [-o offset] [-L limit] <word>"]
end

#thing ⇒ Object 



77
78
79
 
# File 'lib/wavefront-cli/commands/base.rb', line 77

def thing
  word
end

#things ⇒ Object 



81
82
83
 
# File 'lib/wavefront-cli/commands/base.rb', line 81

def things
  thing + 's'
end

#word ⇒ String

Returns the command keyword.

Returns:

  • (String) —

    the command keyword



73
74
75
 
# File 'lib/wavefront-cli/commands/base.rb', line 73

def word
  self.class.name.sub(/WavefrontCommand/, '').downcase
end