Class: Aspera::Cli::Formatter

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

Overview

Take care of output

Constant Summary collapse

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



137
138
139
140
 
# File 'lib/aspera/cli/formatter.rb', line 137

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

Class Method Details

.all_but(list) ⇒ Object 



102
103
104
105
 
# File 'lib/aspera/cli/formatter.rb', line 102

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 



124
125
126
127
128
129
130
131
132
133
 
# File 'lib/aspera/cli/formatter.rb', line 124

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 



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

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

#declare_options(options) ⇒ Object 



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/aspera/cli/formatter.rb', line 164

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, '(Table) Display deep values as additional keys', values: :bool, handler: {o: self, m: :option_handler}, default: true)
  options.declare(
    :multi_single, '(Table) Control how object list is displayed as single table, or multiple objects', values: %i[no yes single],
    handler: {o: self, m: :option_handler}, default: :no)
  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



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

def display_message(message_level, message)
  message = SecretHider.hide_secrets_in_string(message) if message.is_a?(String) && hide_secrets?
  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



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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/aspera/cli/formatter.rb', line 257

def display_results(type:, data: nil, total: nil, fields: nil, name: nil)
  Log.log.debug{"display_results: #{type} class=#{data.class}"}
  Log.log.trace1{"display_results: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?
  hide_secrets(data)
  data = SecretHider.hide_secrets_in_string(data) if data.is_a?(String) && hide_secrets?
  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
    case type
    when :object_list, :single_object
      obj_list = data
      if type.eql?(:single_object)
        obj_list = [obj_list]
        @options[:multi_single] = :yes
      end
      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

#hide_secrets(data) ⇒ Object

hides secrets in Hash or Array



247
248
249
 
# File 'lib/aspera/cli/formatter.rb', line 247

def hide_secrets(data)
  SecretHider.deep_remove_secret(data) if hide_secrets?
end

#hide_secrets? ⇒ Boolean

Returns:

  • (Boolean) 


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

def hide_secrets?
  !@options[:show_secrets] && !@options[:display].eql?(:data)
end

#long_operation_running(title = '') ⇒ Object

call this after REST calls if several api calls are expected



149
150
151
152
153
154
155
156
157
 
# File 'lib/aspera/cli/formatter.rb', line 149

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

#long_operation_terminated ⇒ Object 



159
160
161
162
 
# File 'lib/aspera/cli/formatter.rb', line 159

def long_operation_terminated
  @spinner&.stop
  @spinner = nil
end

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

method accessed by option manager options are: format, output, display, fields, select, table_style, flat_hash, multi_single



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

def option_handler(option_symbol, operation, value=nil)
  Aspera.assert_values(operation, %i[set get])
  case operation
  when :set
    @options[option_symbol] = value
    # special handling of some options
    case option_symbol
    when :output
      $stdout = if value.eql?('-')
        STDOUT # rubocop:disable Style/GlobalStdStream
      else
        File.open(value, 'w')
      end
    when :image
      # get list if key arguments of method
      allowed_options = Preview::Terminal.method(:build).parameters.select{|i|i[0].eql?(:key)}.map{|i|i[1]}
      # check that only supported options are given
      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



143
144
145
146
 
# File 'lib/aspera/cli/formatter.rb', line 143

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.

Parameters:

  • blob (String) —

    either a URL or image data

Returns:

  • text suitable to display an image from url



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/aspera/cli/formatter.rb', line 333

def status_image(blob)
  # check if URL
  begin
    URI.parse(blob)
    url = blob
    unless Environment.instance.url_method.eql?(:text)
      Environment.instance.open_uri(url)
      return ''
    end
    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