aspera-cli 4.21.1 → 4.22.0

data/lib/aspera/cli/formatter.rb

@@ -11,6 +11,7 @@ require 'terminal-table'
 require 'tty-spinner'
 require 'yaml'
 require 'pp'
+require 'word_wrap'
 
 module Aspera
   module Cli
@@ -58,12 +59,12 @@ module Aspera
           @result[name] = @formatter.special_format('empty list')
         elsif array.all?(String)
           @result[name] = array.join("\n")
-        elsif array.all?{|i| i.is_a?(Hash) && i.keys.eql?(%w[name])}
+        elsif array.all?{ |i| i.is_a?(Hash) && i.keys.eql?(%w[name])}
           @result[name] = array.map(&:values).join(', ')
-        elsif array.all?{|i| i.is_a?(Hash) && i.keys.sort.eql?(%w[name value])}
-          flattened_hash(array.each_with_object({}){|i, h|h[i['name']] = i['value']}, name)
+        elsif array.all?{ |i| i.is_a?(Hash) && i.keys.sort.eql?(%w[name value])}
+          flattened_hash(array.each_with_object({}){ |i, h| h[i['name']] = i['value']}, name)
         else
-          array.each_with_index { |item, index| flatten_any(item, "#{name}.#{index}")}
+          array.each_with_index{ |item, index| flatten_any(item, "#{name}.#{index}")}
         end
         nil
       end
@@ -101,7 +102,7 @@ module Aspera
       class << self
         def all_but(list)
           list = [list] unless list.is_a?(Array)
-          return list.map{|i|"#{FIELDS_LESS}#{i}"}.unshift(SpecialValues::ALL)
+          return list.map{ |i| "#{FIELDS_LESS}#{i}"}.unshift(SpecialValues::ALL)
         end
 
         def tick(yes)
@@ -120,17 +121,6 @@ module Aspera
           return result.green if yes
           return result.red
         end
-
-        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
       end
 
       # initialize the formatter
@@ -139,10 +129,17 @@ module Aspera
         @spinner = nil
       end
 
-      # Highlight special values
+      # Highlight special values on terminal
       def special_format(what)
         result = "<#{what}>"
-        return %w[null empty].any?{|s|what.include?(s)} ? result.dim : result.reverse_color
+        return %w[null empty].any?{ |s| what.include?(s)} ? result.dim : result.reverse_color
+      end
+
+      # for transfer spec table, build line for display
+      def check_row(row)
+        row.each_key do |k|
+          row[k] = row[k].map{ |i| WordWrap.ww(i.to_s, 120).chomp}.join("\n") if row[k].is_a?(Array)
+        end
       end
 
       # call this after REST calls if several api calls are expected
@@ -201,7 +198,7 @@ module Aspera
             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]}
+            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?
@@ -216,7 +213,8 @@ module Aspera
       # data: for requested data, not displayed if level==error
       # info: additional info, displayed if level==info
       # error: always displayed on stderr
-      def display_message(message_level, message)
+      def display_message(message_level, message, hide_secrets: true)
+        message = SecretHider.hide_secrets_in_string(message) if hide_secrets && 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)
@@ -225,8 +223,8 @@ module Aspera
         end
       end
 
-      def display_status(status)
-        display_message(:info, status)
+      def display_status(status, **kwopt)
+        display_message(:info, status, **kwopt)
       end
 
       def display_item_count(number, total)
@@ -238,8 +236,13 @@ module Aspera
         display_status(count_msg)
       end
 
+      def hide_secrets?
+        !@options[:show_secrets] && !@options[:display].eql?(:data)
+      end
+
+      # hides secrets in Hash or Array
       def hide_secrets(data)
-        SecretHider.deep_remove_secret(data) unless @options[:show_secrets] || @options[:display].eql?(:data)
+        SecretHider.deep_remove_secret(data) if hide_secrets?
       end
 
       # this method displays the results, especially the table format
@@ -255,6 +258,7 @@ module Aspera
         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)
@@ -289,16 +293,15 @@ module Aspera
             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))
+            obj_list = obj_list.map{ |obj| Flattener.new(self).flatten(obj)} if @options[:flat_hash]
+            display_table(obj_list, compute_fields(obj_list, fields), single: type.eql?(:single_object))
           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])
+            display_table(data.map{ |i| {name => i}}, [name])
           when :empty # no table
             display_message(:info, special_format('empty'))
             return
@@ -310,9 +313,6 @@ module Aspera
           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
@@ -349,7 +349,7 @@ module Aspera
       private
 
       def all_fields(data)
-        data.each_with_object({}){|v, m|v.each_key{|c|m[c] = true}}.keys
+        data.each_with_object({}){ |v, m| v.each_key{ |c| m[c] = true}}.keys
       end
 
       # @return the list of fields to display
@@ -363,8 +363,8 @@ module Aspera
           # 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)}
+          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 = []
@@ -380,12 +380,12 @@ module Aspera
             # 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).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)}
+              result = result.reject{ |i| i.eql?(item)}
             else
               result.push(item)
             end
@@ -403,8 +403,8 @@ module Aspera
         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.slice(*selected_fields)}
+        return data.map{ |i| i[selected_fields.first]} if selected_fields.length == 1
+        return data.map{ |i| i.slice(*selected_fields)}
       end
 
       # filter the list of items on the select option
@@ -412,16 +412,16 @@ module Aspera
       def filter_columns_on_select(data)
         case @options[:select]
         when Proc
-          data.select!{|i|@options[:select].call(i)}
+          data.select!{ |i| @options[:select].call(i)}
         when Hash
-          @options[:select].each{|k, v|data.select!{|i|i[k].eql?(v)}}
+          @options[:select].each{ |k, v| data.select!{ |i| i[k].eql?(v)}}
         end
       end
 
       # displays a list of objects
       # @param object_array  [Array] array of hash
       # @param fields        [Array] list of column names
-      def display_table(object_array, fields)
+      def display_table(object_array, fields, single: false)
         Aspera.assert(!fields.nil?){'missing fields parameter'}
         filter_columns_on_select(object_array)
         if object_array.empty?
@@ -431,35 +431,42 @@ module Aspera
         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
+          Log.log.debug("display_table: single element, field: #{fields.first}")
+          data = object_array.first[fields.first]
+          unless data.is_a?(Array) && data.all?(Hash)
+            display_message(:data, data)
+            return
+          end
+          object_array = data
+          fields = all_fields(object_array)
+          single = false
         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 } }
+        final_table_rows = object_array.map{ |r| fields.map{ |c| r[c].to_s}}
         # remove empty rows
-        final_table_rows.select!{|i| !(i.is_a?(Hash) && i.empty?)}
+        final_table_rows.select!{ |i| !(i.is_a?(Hash) && i.empty?)}
         # here : fields : list of column names
         case @options[:format]
         when :table
-          if @options[:multi_single].eql?(:yes) ||
+          if single || @options[:multi_single].eql?(:yes) ||
               (@options[:multi_single].eql?(:single) && final_table_rows.length.eql?(1))
+            # display multiple objects as multiple transposed tables
             final_table_rows.each do |row|
-              Log.log.debug{Log.dump(:row, row)}
               display_message(:data, Terminal::Table.new(
                 headings:  SINGLE_OBJECT_COLUMN_NAMES,
                 rows:      fields.zip(row),
                 style:     @options[:table_style]&.symbolize_keys))
             end
           else
-            # display the table !
+            # display the table ! as single table
             display_message(:data, Terminal::Table.new(
               headings:  fields,
               rows:      final_table_rows,
               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))
+          display_message(:data, final_table_rows.map{ |t| t.join(CSV_FIELD_SEPARATOR)}.join(CSV_RECORD_SEPARATOR))
         else
           raise "not expected: #{@options[:format]}"
         end

data/lib/aspera/cli/hints.rb

@@ -89,7 +89,7 @@ module Aspera
               end
               remediation = hint[:remediation]
               remediation = [remediation] unless remediation.is_a?(Array)
-              remediation.each{|r|formatter.display_message(:error, "#{Formatter::HINT_FLASH} #{r}")}
+              remediation.each{ |r| formatter.display_message(:error, "#{Formatter::HINT_FLASH} #{r}")}
               break
             end
           end

data/lib/aspera/cli/info.rb

@@ -10,6 +10,7 @@ module Aspera
       DOC_URL  = "https://www.rubydoc.info/gems/#{GEM_NAME}"
       GEM_URL  = "https://rubygems.org/gems/#{GEM_NAME}"
       SRC_URL  = 'https://github.com/IBM/aspera-cli'
+      CONTAINER = 'docker.io/martinlaurent/ascli'
       # set this to warn in advance when minimum required ruby version will increase
       # see also required_ruby_version in gemspec file
       RUBY_FUTURE_MINIMUM_VERSION = '3.2'