Module: Gitlab::CLI::Helpers

Included in:
Gitlab::CLI, Help, Shell
Defined in:
lib/gitlab/cli_helpers.rb

Overview

Defines methods related to CLI output and formatting.

Class Method Summary collapse

Class Method Details

.actionsArray

Returns actions available to CLI & Shell

Returns:

  • (Array)

15
16
17
# File 'lib/gitlab/cli_helpers.rb', line 15

def actions
  @actions ||= Gitlab.actions
end

.clientGitlab::Client

Returns Gitlab::Client instance

Returns:


22
23
24
# File 'lib/gitlab/cli_helpers.rb', line 22

def client
  @client ||= Gitlab::Client.new(endpoint: (Gitlab.endpoint || ''))
end

.confirm_command(cmd) ⇒ String

Confirms command with a desctructive action.

Returns:

  • (String)

72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/gitlab/cli_helpers.rb', line 72

def confirm_command(cmd)
  return unless cmd.start_with?('remove_', 'delete_')

  puts 'Are you sure? (y/n)'

  if %w[y yes].include?($stdin.gets.to_s.strip.downcase)
    puts 'Proceeding..'
  else
    puts 'Command aborted.'
    exit(1)
  end
end

.excluded_fields(args) ⇒ Array

Returns filtered excluded fields.

Returns:

  • (Array)

48
49
50
# File 'lib/gitlab/cli_helpers.rb', line 48

def excluded_fields(args)
  filtered_fields(args, '--except=')
end

.filtered_fields(args, key) ⇒ Array

Returns fields filtered by a keyword.

Returns:

  • (Array)

55
56
57
58
59
# File 'lib/gitlab/cli_helpers.rb', line 55

def filtered_fields(args, key)
  return [] unless args.any? && args.last.is_a?(String) && args.last.start_with?(key)

  args.last.gsub(key, '').split(',')
end

.get_keys(args, data) ⇒ Object

Helper function to get rows and keys from data returned from API call


199
200
201
202
203
204
205
# File 'lib/gitlab/cli_helpers.rb', line 199

def get_keys(args, data)
  arr = data.map(&:to_h)
  keys = arr.first.keys.sort_by(&:to_s)
  keys &= required_fields(args) if required_fields(args).any?
  keys -= excluded_fields(args)
  [arr, keys]
end

.gitlab_helper(cmd, args = []) ⇒ Object

Helper function to call Gitlab commands with args.


208
209
210
211
212
213
214
215
216
217
# File 'lib/gitlab/cli_helpers.rb', line 208

def gitlab_helper(cmd, args = [])
  begin
    data = args.any? ? Gitlab.send(cmd, *args) : Gitlab.send(cmd)
  rescue StandardError => e
    puts e.message
    yield if block_given?
  end

  data
end

.help(cmd = nil, &block) ⇒ String

Gets defined help for a specific command/action.

Returns:

  • (String)

88
89
90
91
92
93
94
# File 'lib/gitlab/cli_helpers.rb', line 88

def help(cmd = nil, &block)
  if cmd.nil? || Gitlab::Help.help_map.key?(cmd)
    Gitlab::Help.actions_table(cmd)
  else
    Gitlab::Help.get_help(cmd, &block)
  end
end

.hex_color?(arg) ⇒ Boolean

Check if arg is a color in 6-digit hex notation with leading '#' sign

Returns:

  • (Boolean)

236
237
238
239
240
# File 'lib/gitlab/cli_helpers.rb', line 236

def hex_color?(arg)
  pattern = /\A#\h{6}\Z/

  pattern.match(arg)
end

.method_ownersArray<Hash>

Returns method names and their owners

Returns:

  • (Array<Hash>)

29
30
31
32
33
34
35
36
# File 'lib/gitlab/cli_helpers.rb', line 29

def method_owners
  @method_owners ||= actions.map do |action|
    {
      name: action.to_s,
      owner: client.method(action).owner.to_s
    }
  end
end

.output_json(cmd, args, data) ⇒ Object


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/gitlab/cli_helpers.rb', line 108

def output_json(cmd, args, data)
  if data.respond_to?(:empty?) && data.empty?
    puts '{}'
  else
    hash_result = case data
                  when Gitlab::ObjectifiedHash, Gitlab::FileResponse
                    record_hash([data], cmd, args, true)
                  when Gitlab::PaginatedResponse
                    record_hash(data, cmd, args)
                  else
                    { cmd: cmd, data: data, args: args }
                  end
    puts JSON.pretty_generate(hash_result)
  end
end

.output_table(cmd, args, data) ⇒ Object

Outputs a nicely formatted table or error message.


97
98
99
100
101
102
103
104
105
106
# File 'lib/gitlab/cli_helpers.rb', line 97

def output_table(cmd, args, data)
  case data
  when Gitlab::ObjectifiedHash, Gitlab::FileResponse
    puts record_table([data], cmd, args)
  when Gitlab::PaginatedResponse
    puts record_table(data, cmd, args)
  else # probably just an error message
    puts data
  end
end

.record_hash(data, cmd, args, single_value = false) ⇒ Hash

Renders the result of given commands and arguments into a Hash

Parameters:

  • data (Array)

    Resultset from the API call

  • cmd (String)

    The command passed to the API

  • args (Array)

    Options passed to the API call

  • single_value (bool) (defaults to: false)

    If set to true, a single result should be returned

Returns:

  • (Hash)

    Result hash


165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'lib/gitlab/cli_helpers.rb', line 165

def record_hash(data, cmd, args, single_value = false)
  if data.empty?
    result = nil
  else
    arr, keys = get_keys(args, data)
    result = []
    arr.each do |hash|
      row = {}

      keys.each do |key|
        row[key] = case hash[key]
                   when Hash
                     'Hash'
                   when StringIO
                     Base64.encode64(hash[key].read)
                   when nil
                     nil
                   else
                     hash[key]
                   end
      end

      result.push row
    end
    result = result[0] if single_value && result.count.positive?
  end

  {
    cmd: "Gitlab.#{cmd} #{args.join(', ')}".strip,
    result: result
  }
end

.record_table(data, cmd, args) ⇒ Terminal::Table

Table to display records.

Returns:

  • (Terminal::Table)

127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'lib/gitlab/cli_helpers.rb', line 127

def record_table(data, cmd, args)
  return 'No data' if data.empty?

  arr, keys = get_keys(args, data)

  table do |t|
    t.title = "Gitlab.#{cmd} #{args.join(', ')}"
    t.headings = keys

    arr.each_with_index do |hash, index|
      values = []

      keys.each do |key|
        case value = hash[key]
        when Hash
          value = value.key?('id') ? value['id'] : 'Hash'
        when StringIO
          value = 'File'
        when nil
          value = 'null'
        end

        values << value
      end

      t.add_row values
      t.add_separator unless arr.size - 1 == index
    end
  end
end

.required_fields(args) ⇒ Array

Returns filtered required fields.

Returns:

  • (Array)

41
42
43
# File 'lib/gitlab/cli_helpers.rb', line 41

def required_fields(args)
  filtered_fields(args, '--only=')
end

.symbolize_keys(hash) ⇒ Hash

Convert a hash (recursively) to use symbol hash keys

Returns:

  • (Hash)

221
222
223
224
225
226
227
228
229
230
231
232
233
# File 'lib/gitlab/cli_helpers.rb', line 221

def symbolize_keys(hash)
  if hash.is_a?(Hash)
    hash = hash.each_with_object({}) do |(key, value), new_hash|
      begin
        new_hash[key.to_sym] = symbolize_keys(value)
      rescue NoMethodError
        raise "Error: cannot convert hash key to symbol: #{key}"
      end
    end
  end

  hash
end

.valid_command?(cmd) ⇒ Boolean

Confirms command is valid.

Returns:

  • (Boolean)

64
65
66
67
# File 'lib/gitlab/cli_helpers.rb', line 64

def valid_command?(cmd)
  command = cmd.is_a?(Symbol) ? cmd : cmd.to_sym
  Gitlab.actions.include?(command)
end

.yaml_load(arg) ⇒ Object

YAML::load on a single argument


243
244
245
246
247
# File 'lib/gitlab/cli_helpers.rb', line 243

def yaml_load(arg)
  hex_color?(arg) ? arg : YAML.safe_load(arg)
rescue Psych::SyntaxError
  raise "Error: Argument is not valid YAML syntax: #{arg}"
end