rex-text 0.2.48 → 0.2.50

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e3ab248f34fa3b7917bad07015868aebb7e91af8af1a210fa90cb89da7b8edc
-  data.tar.gz: 853d7652f999e24504754ad1416faed2a68377c0c29e4d74ff1189b2c7194f01
+  metadata.gz: 26e1e4f195a13ca2269745675f94c71bd02c1de0b4e3f39c4b92fb67495b0cf7
+  data.tar.gz: c1c23a29f68de3b6079ea88e0744bbaf5c9ca438b5f1e8154b72eadf330ccac7
 SHA512:
-  metadata.gz: 5d49ba31b089bc450704c14d0d93f5b2a5c40519c4d324474fa6f8c27faacb8808f71c9f36f9c8baa519084b9f20e39b9569868504d061c422fa65fc3ed1e94e
-  data.tar.gz: a11d6dbc2323b7e9e0aa92aa7bbdf8b67a2cbc1329ff637e4a4cfd047191ea347c58ae40bb6a5f0a4cfc614cf6e7c3561e9de629c1172e18c930534cdf5a7f25
+  metadata.gz: e3b09f9314ca321522b7a599231274e4685255f85457eb9b7466047941db5e22c8907d2d607c3b7d40e26b1d381423841291e269423545da2ea2345b734f0b82
+  data.tar.gz: ab1b340d0812134021d7776016e3cfb51358c2ecbe85b57e5f2943b07ec61608cae635ae6525390e16d6b7003d96638d859fc452572d7047700c0b3c1378afce

data/lib/rex/text/version.rb

@@ -1,5 +1,5 @@
 module Rex
   module Text
-    VERSION = "0.2.48"
+    VERSION = "0.2.50"
   end
 end

data/lib/rex/text/wrapped_table.rb

@@ -56,13 +56,13 @@ class WrappedTable
   #
   # 	The text to affix to the end of the table.
   #
-  # Sortindex
+  # SortIndex
   #
   #	The column to sort the table on, -1 disables sorting.
   #
   # ColProps
   #
-  # A hash specifying column MaxWidth, Stylers, and Formatters.
+  # A hash specifying column Width, Stylers, and Formatters.
   #
   def initialize(opts = {})
     self.header   = opts['Header']
@@ -85,10 +85,11 @@ class WrappedTable
     # Default column properties
     self.columns.length.times { |idx|
       self.colprops[idx] = {}
-      self.colprops[idx]['MaxWidth'] = self.columns[idx].length
+      self.colprops[idx]['Width'] = nil
       self.colprops[idx]['WordWrap'] = true
       self.colprops[idx]['Stylers'] = []
       self.colprops[idx]['Formatters'] = []
+      self.colprops[idx]['ColumnStylers'] = []
     }
 
     # ensure all our internal state gets updated with the given rows by
@@ -112,20 +113,28 @@ class WrappedTable
   # Converts table contents to a string.
   #
   def to_s
+    sort_rows
+
+    # Loop over and style columns
+    styled_columns = columns.map.with_index { |col, idx| style_table_column_headers(col, idx) }
+    # Loop over and style rows that are visible to the user
+    styled_rows = rows.select { |row| row_visible(row) }
+                      .map! { |row| row.map.with_index { |cell, index| style_table_field(cell, index) } }
+
+    optimal_widths = calculate_optimal_widths(styled_columns, styled_rows)
+
     str  = prefix.dup
     str << header_to_s || ''
-    str << columns_to_s || ''
+    str << columns_to_s(styled_columns, optimal_widths) || ''
     str << hr_to_s || ''
 
-    sort_rows
-    rows.each { |row|
-      if (is_hr(row))
+    styled_rows.each { |row|
+      if is_hr(row)
         str << hr_to_s
       else
-        str << row_to_s(row) if row_visible(row)
+        str << row_to_s(row, optimal_widths)
       end
     }
-
     str << postfix
 
     return str
@@ -135,6 +144,8 @@ class WrappedTable
   # Converts table contents to a csv
   #
   def to_csv
+    sort_rows
+
     str = ''
     str << ( columns.join(",") + "\n" )
     rows.each { |row|
@@ -185,11 +196,6 @@ class WrappedTable
     formatted_fields = fields.map.with_index { |field, idx|
       field = format_table_field(field, idx)
 
-      if (colprops[idx]['MaxWidth'] < display_width(field))
-        old = colprops[idx]['MaxWidth']
-        colprops[idx]['MaxWidth'] = display_width(field)
-      end
-
       field
     }
 
@@ -333,7 +339,7 @@ protected
   #
   def row_visible(row)
     return true if self.scterm.nil?
-    row_to_s(row).match(self.scterm)
+    row.join(' ').match(self.scterm)
   end
 
   #
@@ -354,8 +360,7 @@ protected
   #
   # Converts the columns to a string.
   #
-  def columns_to_s # :nodoc:
-    optimal_widths = calculate_optimal_widths
+  def columns_to_s(columns, optimal_widths) # :nodoc:
     values_as_chunks = chunk_values(columns, optimal_widths)
     result = chunks_to_s(values_as_chunks, optimal_widths)
 
@@ -389,9 +394,7 @@ protected
   #
   # Converts a row to a string.
   #
-  def row_to_s(row) # :nodoc:
-    row = row.each_with_index.map { |cell, index| style_table_field(cell, index) }
-    optimal_widths = calculate_optimal_widths
+  def row_to_s(row, optimal_widths) # :nodoc:
     values_as_chunks = chunk_values(row, optimal_widths)
     chunks_to_s(values_as_chunks, optimal_widths)
   end
@@ -567,12 +570,26 @@ protected
     without_extra_column
   end
 
-  def calculate_optimal_widths
-    # Calculate the minimum width each column can be. This is dictated by the user.
+  def calculate_optimal_widths(styled_columns, styled_rows)
+    total_columns = self.colprops.length
+    # Calculate the display width metadata, i.e. the size of the longest strings in the table
+    display_width_metadata = Array.new(total_columns) { {} }
+    [[styled_columns], styled_rows].each do |group|
+      group.each do |row|
+        row.each.with_index do |cell, column_index|
+          metadata = display_width_metadata[column_index]
+          cell_display_width = display_width(cell)
+          if cell_display_width > (metadata[:max_display_width] || 0)
+            metadata[:max_display_width] = cell_display_width
+          end
+        end
+      end
+    end
+
+    # Calculate the sizes set by the user
     user_influenced_column_widths = colprops.map do |colprop|
-      if colprop['WordWrap'] == false
-        colprop['MaxWidth']
-        raise 'Not implemented'
+      if colprop['Width']
+        colprop['Width']
       else
         nil
       end
@@ -583,15 +600,16 @@ protected
     remaining_column_calculations = user_influenced_column_widths.select(&:nil?).count
 
     # Calculate the initial widths, which will need an additional refinement to reallocate surplus space
-    naive_optimal_width_calculations = colprops.map.with_index do |colprop, index|
+    naive_optimal_width_calculations = display_width_metadata.map.with_index do |display_size, index|
       shared_column_width = available_space / [remaining_column_calculations, 1].max
       remaining_column_calculations -= 1
 
+      # Preference the user defined widths first
       if user_influenced_column_widths[index]
         { width: user_influenced_column_widths[index], wrapped: false }
-      elsif colprop['MaxWidth'] < shared_column_width
-        available_space -= colprop['MaxWidth']
-        { width: colprop['MaxWidth'], wrapped: false }
+      elsif display_size[:max_display_width] < shared_column_width
+        available_space -= display_size[:max_display_width]
+        { width: display_size[:max_display_width], wrapped: false }
       else
         available_space -= shared_column_width
         { width: shared_column_width, wrapped: true }
@@ -608,7 +626,7 @@ protected
       revisiting_column_counts -= 1
 
       if naive_width[:wrapped]
-        max_width = colprops[index]['MaxWidth']
+        max_width = display_width_metadata[index][:max_display_width]
         if max_width < (naive_width[:width] + additional_column_width)
           surplus_width -= max_width - naive_width[:width]
           max_width
@@ -638,6 +656,16 @@ protected
     str_cp
   end
 
+  def style_table_column_headers(str, idx)
+    str_cp = str.dup
+
+    colprops[idx]['ColumnStylers'].each do |s|
+      str_cp = s.style(str_cp)
+    end
+
+    str_cp
+  end
+
   def style_table_field(str, idx)
     str_cp = str.dup
 
@@ -652,4 +680,3 @@ end
 
 end
 end
-

data/lib/rex/text.rb

@@ -110,6 +110,8 @@ module Rex
     # @param [String] str
     # @return [Integer]
     def self.display_width(str)
+      return 0 if str.nil?
+
       str.gsub(COLOR_CODES_REGEX, '').length
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rex-text
 version: !ruby/object:Gem::Version
-  version: 0.2.48
+  version: 0.2.50
 platform: ruby
 authors:
 - Metasploit Hackers
@@ -93,7 +93,7 @@ cert_chain:
   EknWpNgVhohbot1lfVAMmIhdtOVaRVcQQixWPwprDj/ydB8ryDMDosIMcw+fkoXU
   9GJsSaSRRYQ9UUkVL27b64okU8D48m8=
   -----END CERTIFICATE-----
-date: 2023-01-31 00:00:00.000000000 Z
+date: 2023-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake