Class: Aspera::Cli::Formatter

Inherits:
Object
  • Object
show all
Defined in:
lib/aspera/cli/formatter.rb

Overview

Take care of output

Constant Summary collapse

FIELDS_LESS =

remove a fields from the list

'-'
ERROR_FLASH =

prefix to display error messages in user messages (terminal)

'ERROR:'.bg_red.gray.blink.freeze
WARNING_FLASH = 
'WARNING:'.bg_brown.black.blink.freeze
HINT_FLASH = 
'HINT:'.bg_green.gray.blink.freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Formatter

initialize the formatter



148
149
150
151
 
# File 'lib/aspera/cli/formatter.rb', line 148

def initialize
  @options = {}
  @spinner = nil
end

Class Method Details

.all_but(list) ⇒ Object 



113
114
115
116
 
# File 'lib/aspera/cli/formatter.rb', line 113

def all_but(list)
  list = [list] unless list.is_a?(Array)
  return list.map{|i|"#{FIELDS_LESS}#{i}"}.unshift(SpecialValues::ALL)
end

.auto_type(data) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
 
# File 'lib/aspera/cli/formatter.rb', line 135

def auto_type(data)
  result = {type: :other_struct, data: data}
  result[:type] = :single_object if result[:data].is_a?(Hash)
  if result[:data].is_a?(Array)
    if result[:data].all?(Hash)
      result[:type] = :object_list
    end
  end
  return result
end

.tick(yes) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/aspera/cli/formatter.rb', line 118

def tick(yes)
  result =
    if Environment.instance.terminal_supports_unicode?
      if yes
        "\u2713"
      else
        "\u2717"
      end
    elsif yes
      'Y'
    else
      ' '
    end
  return result.green if yes
  return result.red
end

Instance Method Details

#all_fields(data) ⇒ Object 



242
243
244
 
# File 'lib/aspera/cli/formatter.rb', line 242

def all_fields(data)
  data.each_with_object({}){|v, m|v.each_key{|c|m[c] = true}}.keys
end

#compute_fields(data, default) ⇒ Object

Returns the list of fields to display.

Parameters:

  • data (Array<Hash>) —

    data to display

  • default (Array<String>, Proc) —

    list of fields to display by default (may contain special values)

Returns:

  • the list of fields to display



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/aspera/cli/formatter.rb', line 249

def compute_fields(data, default)
  Log.log.debug{"compute_fields: data:#{data.class} default:#{default.class} #{default}"}
  # the requested list of fields, but if can contain special values
  request =
    case @options[:fields]
    # when NilClass then [SpecialValues::DEF]
    when String then @options[:fields].split(',')
    when Array then @options[:fields]
    when Regexp then return all_fields(data).select{|i|i.match(@options[:fields])}
    when Proc then return all_fields(data).select{|i|@options[:fields].call(i)}
    else Aspera.error_unexpected_value(@options[:fields])
    end
  result = []
  until request.empty?
    item = request.shift
    removal = false
    if item[0].eql?(FIELDS_LESS)
      removal = true
      item = item[1..-1]
    end
    case item
    when SpecialValues::ALL
      # get the list of all column names used in all lines, not just first one, as all lines may have different columns
      request.unshift(*all_fields(data))
    when SpecialValues::DEF
      default = all_fields(data).select{|i|default.call(i)} if default.is_a?(Proc)
      default = all_fields(data) if default.nil?
      request.unshift(*default)
    else
      if removal
        result = result.reject{|i|i.eql?(item)}
      else
        result.push(item)
      end
    end
  end
  return result
end

#declare_options(options) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/aspera/cli/formatter.rb', line 194

def declare_options(options)
  default_table_style = if Environment.instance.terminal_supports_unicode?
    {border: :unicode_round}
  else
    {}
  end

  options.declare(:format, 'Output format', values: DISPLAY_FORMATS, handler: {o: self, m: :option_handler}, default: :table)
  options.declare(:output, 'Destination for results', types: String, handler: {o: self, m: :option_handler})
  options.declare(:display, 'Output only some information', values: DISPLAY_LEVELS, handler: {o: self, m: :option_handler}, default: :info)
  options.declare(
    :fields, "Comma separated list of: fields, or #{SpecialValues::ALL}, or #{SpecialValues::DEF}", handler: {o: self, m: :option_handler},
    types: [String, Array, Regexp, Proc],
    default: SpecialValues::DEF)
  options.declare(:select, 'Select only some items in lists: column, value', types: [Hash, Proc], handler: {o: self, m: :option_handler})
  options.declare(:table_style, 'Table display style', types: [Hash], handler: {o: self, m: :option_handler}, default: default_table_style)
  options.declare(:flat_hash, 'Display deep values as additional keys', values: :bool, handler: {o: self, m: :option_handler}, default: true)
  options.declare(:transpose_single, 'Single object fields output vertically', values: :bool, handler: {o: self, m: :option_handler}, default: true)
  options.declare(:show_secrets, 'Show secrets on command output', values: :bool, handler: {o: self, m: :option_handler}, default: false)
  options.declare(:image, 'Options for image display', types: Hash, handler: {o: self, m: :option_handler}, default: {})
end

#display_item_count(number, total) ⇒ Object 



233
234
235
236
237
238
239
240
 
# File 'lib/aspera/cli/formatter.rb', line 233

def display_item_count(number, total)
  number = number.to_i
  total = total.to_i
  return if total.eql?(0) && number.eql?(0)
  count_msg = "Items: #{number}/#{total}"
  count_msg = count_msg.bg_red unless number.eql?(total)
  display_status(count_msg)
end

#display_message(message_level, message) ⇒ Object

main output method data: for requested data, not displayed if level==error info: additional info, displayed if level==info error: always displayed on stderr



220
221
222
223
224
225
226
227
 
# File 'lib/aspera/cli/formatter.rb', line 220

def display_message(message_level, message)
  case message_level
  when :data then $stdout.puts(message) unless @options[:display].eql?(:error)
  when :info then $stdout.puts(message) if @options[:display].eql?(:info)
  when :error then $stderr.puts(message)
  else Aspera.error_unexpected_value(message_level)
  end
end

#display_results(type:, data: nil, total: nil, fields: nil, name: nil) ⇒ Object

this method displays the results, especially the table format

Parameters:

  • type (Symbol) —

    type of data

  • data (Object) (defaults to: nil) —

    data to display

  • total (Integer) (defaults to: nil) —

    total number of items

  • fields (Array<String>) (defaults to: nil) —

    list of fields to display

  • name (String) (defaults to: nil) —

    name of the column to display



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/aspera/cli/formatter.rb', line 393

def display_results(type:, data: nil, total: nil, fields: nil, name: nil)
  Log.log.debug{"display_results: #{type} class=#{data.class} data=#{data}"}
  Aspera.assert_type(type, Symbol){'result must have type'}
  Aspera.assert(!data.nil? || %i[empty nothing].include?(type)){'result must have data'}
  display_item_count(data.length, total) unless total.nil?
  SecretHider.deep_remove_secret(data) unless @options[:show_secrets] || @options[:display].eql?(:data)
  case @options[:format]
  when :text
    display_message(:data, data.to_s)
  when :nagios
    Nagios.process(data)
  when :ruby
    display_message(:data, PP.pp(filter_list_on_fields(data), +''))
  when :json
    display_message(:data, JSON.generate(filter_list_on_fields(data)))
  when :jsonpp
    display_message(:data, JSON.pretty_generate(filter_list_on_fields(data)))
  when :yaml
    display_message(:data, YAML.dump(filter_list_on_fields(data)))
  when :image
    # assume it is an url
    url = data
    case type
    when :single_object, :object_list
      url = [url] if type.eql?(:single_object)
      raise 'image display requires a single result' unless url.length == 1
      fields = compute_fields(url, fields)
      raise 'select a field to display' unless fields.length == 1
      url = url.first
      raise 'no such field' unless url.key?(fields.first)
      url = url[fields.first]
    end
    raise "not url: #{url.class} #{url}" unless url.is_a?(String)
    display_message(:data, status_image(url))
  when :table, :csv, :multi
    case type
    when :config_over
      display_table(Flattener.new(self).config_over(data), CONF_OVERVIEW_KEYS)
    when :object_list, :single_object
      obj_list = data
      obj_list = [obj_list] if type.eql?(:single_object)
      Aspera.assert_type(obj_list, Array)
      Aspera.assert(obj_list.all?(Hash)){"expecting Array of Hash: #{obj_list.inspect}"}
      # :object_list is an array of hash tables, where key=colum name
      obj_list = obj_list.map{|obj|Flattener.new(self).flatten(obj)} if @options[:flat_hash]
      display_table(obj_list, compute_fields(obj_list, fields))
    when :value_list
      # :value_list is a simple array of values, name of column provided in the :name
      display_table(data.map { |i| { name => i } }, [name])
    when :empty # no table
      display_message(:info, special_format('empty'))
      return
    when :nothing # no result expected
      Log.log.debug('no result expected')
    when :status # no table
      # :status displays a simple message
      display_message(:info, data)
    when :text # no table
      # :status displays a simple message
      display_message(:data, data)
    when :other_struct # no table
      # :other_struct is any other type of structure
      display_message(:data, PP.pp(data, +''))
    else
      raise "unknown data type: #{type}"
    end
  else
    raise "not expected: #{@options[:format]}"
  end
end

#display_status(status) ⇒ Object 



229
230
231
 
# File 'lib/aspera/cli/formatter.rb', line 229

def display_status(status)
  display_message(:info, status)
end

#display_table(object_array, fields) ⇒ Object

this method displays a table object_array: array of hash fields: list of column names



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/aspera/cli/formatter.rb', line 315

def display_table(object_array, fields)
  Aspera.assert(!fields.nil?){'missing fields parameter'}
  filter_columns_on_select(object_array)
  if object_array.empty?
    # no  display for csv
    display_message(:info, special_format('empty')) if @options[:format].eql?(:table)
    return
  end
  # if table has only one element, and only one field, display the value
  if object_array.length == 1 && fields.length == 1
    display_message(:data, object_array.first[fields.first])
    return
  end
  # Special case if only one row (it could be object_list or single_object)
  if @options[:transpose_single] && object_array.length == 1
    single = object_array.first
    object_array = fields.map { |i| FIELD_VALUE_HEADINGS.zip([i, single[i]]).to_h }
    fields = FIELD_VALUE_HEADINGS
  end
  Log.log.debug{Log.dump(:object_array, object_array)}
  # convert data to string, and keep only display fields
  final_table_rows = object_array.map { |r| fields.map { |c| r[c].to_s } }
  # here : fields : list of column names
  case @options[:format]
  when :table
    # display the table !
    display_message(:data, Terminal::Table.new(
      headings:  fields,
      rows:      final_table_rows,
      style:     @options[:table_style]&.symbolize_keys))
  when :multi
    final_table_rows.each do |row|
      Log.log.debug{Log.dump(:row, row)}
      display_message(:data, Terminal::Table.new(
        headings:  FIELD_VALUE_HEADINGS,
        rows:      fields.zip(row),
        style:     @options[:table_style]&.symbolize_keys))
    end
  when :csv
    display_message(:data, final_table_rows.map{|t| t.join(CSV_FIELD_SEPARATOR)}.join(CSV_RECORD_SEPARATOR))
  else
    raise "not expected: #{@options[:format]}"
  end
end

#filter_columns_on_select(data) ⇒ Object

filter the list of items on the select option

Parameters:

  • data (Array<Hash>) —

    list of items



303
304
305
306
307
308
309
310
 
# File 'lib/aspera/cli/formatter.rb', line 303

def filter_columns_on_select(data)
  case @options[:select]
  when Proc
    data.select!{|i|@options[:select].call(i)}
  when Hash
    @options[:select].each{|k, v|data.select!{|i|i[k].eql?(v)}}
  end
end

#filter_list_on_fields(data) ⇒ Object

filter the list of items on the fields option



289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/aspera/cli/formatter.rb', line 289

def filter_list_on_fields(data)
  # by default, keep all data intact
  return data if @options[:fields].eql?(SpecialValues::DEF) && @options[:select].nil?
  Aspera.assert_type(data, Array){'Filtering fields or select requires result is an Array of Hash'}
  Aspera.assert(data.all?(Hash)){'Filtering fields or select requires result is an Array of Hash'}
  filter_columns_on_select(data)
  return data if @options[:fields].eql?(SpecialValues::DEF)
  selected_fields = compute_fields(data, @options[:fields])
  return data.map{|i|i[selected_fields.first]} if selected_fields.length == 1
  return data.map{|i|i.select{|k, _|selected_fields.include?(k)}}
end

#long_operation_running(title = '') ⇒ Object

call this after REST calls if several api calls are expected



160
161
162
163
164
165
166
167
168
 
# File 'lib/aspera/cli/formatter.rb', line 160

def long_operation_running(title = '')
  return unless Environment.terminal?
  if @spinner.nil?
    @spinner = TTY::Spinner.new('[:spinner] :title', format: :classic)
    @spinner.start
  end
  @spinner.update(title: title)
  @spinner.spin
end

#option_handler(option_symbol, operation, value = nil) ⇒ Object

options are: format, output, display, fields, select, table_style, flat_hash, transpose_single



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/aspera/cli/formatter.rb', line 171

def option_handler(option_symbol, operation, value=nil)
  Aspera.assert_values(operation, %i[set get])
  case operation
  when :set
    @options[option_symbol] = value
    case option_symbol
    when :output
      $stdout = if value.eql?('-')
        STDOUT # rubocop:disable Style/GlobalStdStream
      else
        File.open(value, 'w')
      end
    when :image
      allowed_options = Preview::Terminal.method(:build).parameters.select{|i|i[0].eql?(:key)}.map{|i|i[1]}
      unknown_options = value.keys.map(&:to_sym) - allowed_options
      raise "Invalid parameter(s) for option image: #{unknown_options.join(', ')}, use #{allowed_options.join(', ')}" unless unknown_options.empty?
    end
  when :get then return @options[option_symbol]
  else Aspera.error_unreachable_line
  end
  nil
end

#special_format(what) ⇒ Object

Highlight special values



154
155
156
157
 
# File 'lib/aspera/cli/formatter.rb', line 154

def special_format(what)
  result = "<#{what}>"
  return %w[null empty].any?{|s|what.include?(s)} ? result.dim : result.reverse_color
end

#status_image(blob) ⇒ Object

Returns text suitable to display an image from url.

Returns:

  • text suitable to display an image from url



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/aspera/cli/formatter.rb', line 361

def status_image(blob)
  begin
    raise URI::InvalidURIError, 'not uri' if !(blob =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/)
    # it's a url
    url = blob
    unless Environment.instance.url_method.eql?(:text)
      Environment.instance.open_uri(url)
      return ''
    end
    # remote_image = Rest.new(base_url: url).read('')
    # mime = remote_image[:http]['content-type']
    # blob = remote_image[:http].body
    # Log.log.warn("Image ? #{remote_image[:http]['content-type']}") unless mime.include?('image/')
    blob = UriReader.read(url)
  rescue URI::InvalidURIError
    nil
  end
  # try base64
  begin
    blob = Base64.strict_decode64(blob)
  rescue
    nil
  end
  return Preview::Terminal.build(blob, **@options[:image].symbolize_keys)
end