summaryrefslogtreecommitdiff
path: root/lib/chef
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2020-08-25 10:07:21 -0700
committerGitHub <noreply@github.com>2020-08-25 10:07:21 -0700
commit6681194a118bbf6a11ee4bd4cde3339b57fa365c (patch)
tree2b4d4caa40575c7a4066dc5fb528f0f18d44738f /lib/chef
parent196902f1db7ad8682c344ebda12b9ebe548f115c (diff)
parentde848c5ff06d1c7829af5635a90817ec31a99116 (diff)
downloadchef-6681194a118bbf6a11ee4bd4cde3339b57fa365c.tar.gz
Merge pull request #10341 from chef/VSingh/add-tty-table
knife config list-profiles UI with tty-table
Diffstat (limited to 'lib/chef')
-rw-r--r--lib/chef/knife/config_list_profiles.rb65
1 files changed, 39 insertions, 26 deletions
diff --git a/lib/chef/knife/config_list_profiles.rb b/lib/chef/knife/config_list_profiles.rb
index df5a08c86f..64768c8415 100644
--- a/lib/chef/knife/config_list_profiles.rb
+++ b/lib/chef/knife/config_list_profiles.rb
@@ -23,8 +23,12 @@ class Chef
banner "knife config list-profiles (options)"
category "deprecated"
+ TABLE_HEADER = [" Profile", "Client", "Key", "Server"].freeze
+
deps do
require_relative "../workstation_config_loader"
+ require "tty-screen" unless defined?(TTY::Screen)
+ require "tty-table" unless defined?(TTY::Table)
end
option :ignore_knife_rb,
@@ -93,36 +97,45 @@ class Chef
private
- def render_table(profiles, padding: 2)
- # Replace the home dir in the client key path with ~.
+ def render_table(profiles, padding: 1)
+ rows = []
+ # Render the data to a 2D array that will be used for the table.
profiles.each do |profile|
+ # Replace the home dir in the client key path with ~.
profile[:client_key] = profile[:client_key].to_s.gsub(/^#{Regexp.escape(Dir.home)}/, "~") if profile[:client_key]
+ profile[:profile] = "#{profile[:active] ? "*" : " "}#{profile[:profile]}"
+ rows << profile.values_at(:profile, :client_name, :client_key, :server_url)
end
- # Render the data to a 2D array that will be used for the table.
- table_data = [["", "Profile", "Client", "Key", "Server"]] + profiles.map do |profile|
- [profile[:active] ? "*" : ""] + profile.values_at(:profile, :client_name, :client_key, :server_url).map(&:to_s)
- end
- # Compute column widths.
- column_widths = Array.new(table_data.first.length) do |i|
- table_data.map { |row| row[i].length + padding }.max
- end
- # Special case, the first col gets no padding (because indicator) and last
- # get no padding because last.
- column_widths[0] -= padding
- column_widths[-1] -= padding
- # Build the format string for each row.
- format_string = column_widths.map { |w| "%-#{w}.#{w}s" }.join("")
- format_string << "\n"
- # Print the header row and a separator.
- table = ui.color(format_string % table_data.first, :green)
- table << "-" * column_widths.sum
- table << "\n"
- # Print the rest of the table.
- table_data.drop(1).each do |row|
- table << format_string % row
+
+ table = TTY::Table.new(header: TABLE_HEADER, rows: rows)
+
+ # Rotate the table to vertical if the screen width is less than table width.
+ if table.width > TTY::Screen.width
+ table.orientation = :vertical
+ table.rotate
+ # Add a new line after each profile record.
+ table.render do |renderer|
+ renderer.border do
+ separator ->(row) { (row + 1) % TABLE_HEADER.size == 0 }
+ end
+ # Remove the leading space added of the first column.
+ renderer.filter = Proc.new do |val, row_index, col_index|
+ if col_index == 1 || (row_index) % TABLE_HEADER.size == 0
+ val.strip
+ else
+ val
+ end
+ end
+ end
+ else
+ table.render do |renderer|
+ renderer.border do
+ mid "-"
+ style :green
+ end
+ renderer.padding = [0, padding, 0, 0] # pad right with 2 characters
+ end
end
- # Trim the last newline because ui.output adds one.
- table.chomp!
end
end