From 6e10f913714f195c2bbc77786f86342378243c1f Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Sun, 2 Oct 2016 04:11:43 +0200 Subject: Refactor `puts_columns`. --- Library/Homebrew/utils.rb | 50 +++++----------------------------- Library/Homebrew/utils/puts_columns.rb | 49 +++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+), 43 deletions(-) create mode 100644 Library/Homebrew/utils/puts_columns.rb (limited to 'Library') diff --git a/Library/Homebrew/utils.rb b/Library/Homebrew/utils.rb index 79e5287e8..e31339e16 100644 --- a/Library/Homebrew/utils.rb +++ b/Library/Homebrew/utils.rb @@ -1,16 +1,17 @@ require "pathname" require "emoji" require "exceptions" +require "utils/analytics" +require "utils/curl" +require "utils/fork" require "utils/formatter" +require "utils/git" +require "utils/github" require "utils/hash" -require "utils/json" require "utils/inreplace" +require "utils/json" require "utils/popen" -require "utils/fork" -require "utils/git" -require "utils/analytics" -require "utils/github" -require "utils/curl" +require "utils/puts_columns" require "utils/tty" def ohai(title, *sput) @@ -286,43 +287,6 @@ def quiet_system(cmd, *args) end end -def puts_columns(items) - return if items.empty? - - unless $stdout.tty? - puts items - return - end - - # TTY case: If possible, output using multiple columns. - console_width = Tty.width - console_width = 80 if console_width <= 0 - plain_item_lengths = items.map { |s| Tty.strip_ansi(s).length } - max_len = plain_item_lengths.max - col_gap = 2 # number of spaces between columns - gap_str = " " * col_gap - cols = (console_width + col_gap) / (max_len + col_gap) - cols = 1 if cols < 1 - rows = (items.size + cols - 1) / cols - cols = (items.size + rows - 1) / rows # avoid empty trailing columns - - if cols >= 2 - col_width = (console_width + col_gap) / cols - col_gap - items = items.each_with_index.map do |item, index| - item + "".ljust(col_width - plain_item_lengths[index]) - end - end - - if cols == 1 - puts items - else - rows.times do |row_index| - item_indices_for_row = row_index.step(items.size - 1, rows).to_a - puts items.values_at(*item_indices_for_row).join(gap_str) - end - end -end - def which(cmd, path = ENV["PATH"]) path.split(File::PATH_SEPARATOR).each do |p| begin diff --git a/Library/Homebrew/utils/puts_columns.rb b/Library/Homebrew/utils/puts_columns.rb new file mode 100644 index 000000000..94a5354ad --- /dev/null +++ b/Library/Homebrew/utils/puts_columns.rb @@ -0,0 +1,49 @@ +require "utils/tty" + +class IO + def puts_columns(*objects, gap_size: 2) + objects.flatten! + + if objects.empty? || !tty? + puts(*objects) + return + end + + console_width = Tty.width + + object_lengths = objects.map { |obj| Tty.strip_ansi(obj.to_s).length } + + cols = (console_width + gap_size) / (object_lengths.max + gap_size) + + if cols < 2 + puts(*objects) + return + end + + rows = (objects.count + cols - 1) / cols + cols = (objects.count + rows - 1) / rows # avoid empty trailing columns + + col_width = (console_width + gap_size) / cols - gap_size + + gap_string = "".rjust(gap_size) + + rows.times do |row_index| + item_indices_for_row = row_index.step(objects.size - 1, rows).to_a + + first_n = item_indices_for_row[0...-1].map { |index| + objects[index] + "".rjust(col_width - object_lengths[index]) + } + + # don't add trailing whitespace to last column + last = objects.values_at(item_indices_for_row.last) + + puts (first_n + last).join(gap_string) + end + end +end + +module Kernel + def puts_columns(*objects) + $stdout.puts_columns(*objects) + end +end -- cgit v1.2.3 From 4bfeaaf21259637c1ad1a98b479fc0e4fdaea56e Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Sun, 2 Oct 2016 07:34:53 +0200 Subject: `puts_columns` only has to be defined inside `module Kernel`. --- Library/Homebrew/utils/puts_columns.rb | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) (limited to 'Library') diff --git a/Library/Homebrew/utils/puts_columns.rb b/Library/Homebrew/utils/puts_columns.rb index 94a5354ad..7f8e2d319 100644 --- a/Library/Homebrew/utils/puts_columns.rb +++ b/Library/Homebrew/utils/puts_columns.rb @@ -1,10 +1,10 @@ require "utils/tty" -class IO +module Kernel def puts_columns(*objects, gap_size: 2) objects.flatten! - if objects.empty? || !tty? + if objects.empty? || (respond_to?(:tty?) && !tty?) puts(*objects) return end @@ -41,9 +41,3 @@ class IO end end end - -module Kernel - def puts_columns(*objects) - $stdout.puts_columns(*objects) - end -end -- cgit v1.2.3 From 01d87f810721d8e8faf4b73ff5120923fa7c88ca Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Sun, 2 Oct 2016 07:57:21 +0200 Subject: Don’t use `puts_columns` if `empty?` or single item. --- Library/Homebrew/cask/lib/hbc/cli/install.rb | 7 +++---- Library/Homebrew/cmd/install.rb | 4 ++-- Library/Homebrew/cmd/list.rb | 1 + Library/Homebrew/cmd/search.rb | 4 ++-- Library/Homebrew/cmd/uses.rb | 1 + 5 files changed, 9 insertions(+), 8 deletions(-) (limited to 'Library') diff --git a/Library/Homebrew/cask/lib/hbc/cli/install.rb b/Library/Homebrew/cask/lib/hbc/cli/install.rb index 996de8d1b..1292ad076 100644 --- a/Library/Homebrew/cask/lib/hbc/cli/install.rb +++ b/Library/Homebrew/cask/lib/hbc/cli/install.rb @@ -42,13 +42,12 @@ module Hbc def self.warn_unavailable_with_suggestion(cask_token, e) exact_match, partial_matches = Search.search(cask_token) - errmsg = e.message if exact_match - errmsg.concat(". Did you mean:\n#{exact_match}") + onoe e.message.concat(". Did you mean:\n#{exact_match}") elsif !partial_matches.empty? - errmsg.concat(". Did you mean one of:\n#{puts_columns(partial_matches.take(20))}\n") + onoe e.message.concat(". Did you mean one of:") + $stderr.puts_columns(partial_matches.take(20)) end - onoe errmsg end def self.help diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb index ffb7eeab3..209fe8bad 100644 --- a/Library/Homebrew/cmd/install.rb +++ b/Library/Homebrew/cmd/install.rb @@ -179,7 +179,7 @@ module Homebrew ofail "No similarly named formulae found." when 1 puts "This similarly named formula was found:" - puts_columns(formulae_search_results) + puts formulae_search_results puts "To install it, run:\n brew install #{formulae_search_results.first}" else puts "These similarly named formulae were found:" @@ -194,7 +194,7 @@ module Homebrew ofail "No formulae found in taps." when 1 puts "This formula was found in a tap:" - puts_columns(taps_search_results) + puts taps_search_results puts "To install it, run:\n brew install #{taps_search_results.first}" else puts "These formulae were found in taps:" diff --git a/Library/Homebrew/cmd/list.rb b/Library/Homebrew/cmd/list.rb index 01af678a7..93c2545ad 100644 --- a/Library/Homebrew/cmd/list.rb +++ b/Library/Homebrew/cmd/list.rb @@ -48,6 +48,7 @@ module Homebrew a <=> b end end + return if full_names.empty? puts_columns full_names else ENV["CLICOLOR"] = nil diff --git a/Library/Homebrew/cmd/search.rb b/Library/Homebrew/cmd/search.rb index 8d6e5ad7c..f0a276929 100644 --- a/Library/Homebrew/cmd/search.rb +++ b/Library/Homebrew/cmd/search.rb @@ -59,9 +59,9 @@ module Homebrew query = ARGV.first regex = query_regexp(query) local_results = search_formulae(regex) - puts_columns(local_results) + puts_columns(local_results) unless local_results.empty? tap_results = search_taps(regex) - puts_columns(tap_results) + puts_columns(tap_results) unless tap_results.empty? if $stdout.tty? count = local_results.length + tap_results.length diff --git a/Library/Homebrew/cmd/uses.rb b/Library/Homebrew/cmd/uses.rb index 4acf1b9f1..66088e217 100644 --- a/Library/Homebrew/cmd/uses.rb +++ b/Library/Homebrew/cmd/uses.rb @@ -93,6 +93,7 @@ module Homebrew end end + return if uses.empty? puts_columns uses.map(&:full_name) end end -- cgit v1.2.3 From a89dc33834e31fd8a3314647c747c4ddd1fbc029 Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Sun, 2 Oct 2016 07:58:04 +0200 Subject: Change test for `puts_columns` with empty input. --- Library/Homebrew/test/test_utils.rb | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'Library') diff --git a/Library/Homebrew/test/test_utils.rb b/Library/Homebrew/test/test_utils.rb index 3eeb7ce9d..c97d70285 100644 --- a/Library/Homebrew/test/test_utils.rb +++ b/Library/Homebrew/test/test_utils.rb @@ -110,8 +110,12 @@ class UtilTests < Homebrew::TestCase end def test_put_columns_empty - # Issue #217 put columns with no results fails. - assert_silent { puts_columns [] } + out, err = capture_io do + puts_columns [] + end + + assert_equal out, "\n" + assert_equal err, "" end def test_which -- cgit v1.2.3 From 5ee6df6d822ee1217d2240b85ea1597efc4a3696 Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Sun, 2 Oct 2016 08:19:06 +0200 Subject: Fallback to `$stdout.tty?` unless `respond_to?(:tty?)`. --- Library/Homebrew/utils/puts_columns.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Library') diff --git a/Library/Homebrew/utils/puts_columns.rb b/Library/Homebrew/utils/puts_columns.rb index 7f8e2d319..7ff275143 100644 --- a/Library/Homebrew/utils/puts_columns.rb +++ b/Library/Homebrew/utils/puts_columns.rb @@ -4,7 +4,7 @@ module Kernel def puts_columns(*objects, gap_size: 2) objects.flatten! - if objects.empty? || (respond_to?(:tty?) && !tty?) + if objects.empty? || (respond_to?(:tty?) ? !tty? : !$stdout.tty?) puts(*objects) return end -- cgit v1.2.3 From 429327cac8b75118087400fc9b5ffed4c4ce83ec Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Sun, 2 Oct 2016 08:32:25 +0200 Subject: Use `proc` to fallback to `puts`. --- Library/Homebrew/utils/puts_columns.rb | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) (limited to 'Library') diff --git a/Library/Homebrew/utils/puts_columns.rb b/Library/Homebrew/utils/puts_columns.rb index 7ff275143..2810918c6 100644 --- a/Library/Homebrew/utils/puts_columns.rb +++ b/Library/Homebrew/utils/puts_columns.rb @@ -4,21 +4,19 @@ module Kernel def puts_columns(*objects, gap_size: 2) objects.flatten! - if objects.empty? || (respond_to?(:tty?) ? !tty? : !$stdout.tty?) + fallback = proc do puts(*objects) return end - console_width = Tty.width + fallback.call if objects.empty? + fallback.call if respond_to?(:tty?) ? !tty? : !$stdout.tty? + console_width = Tty.width object_lengths = objects.map { |obj| Tty.strip_ansi(obj.to_s).length } - cols = (console_width + gap_size) / (object_lengths.max + gap_size) - if cols < 2 - puts(*objects) - return - end + fallback.call if cols < 2 rows = (objects.count + cols - 1) / cols cols = (objects.count + rows - 1) / rows # avoid empty trailing columns -- cgit v1.2.3 From 198bf4d3bdeaf3047f9af80788ea18cd192541af Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Sun, 2 Oct 2016 20:39:43 +0200 Subject: Convert `puts_columns` to `puts Formatter.columns`. --- Library/Homebrew/cask/lib/hbc/cli/install.rb | 8 +++-- Library/Homebrew/cask/lib/hbc/cli/list.rb | 2 +- Library/Homebrew/cask/lib/hbc/cli/search.rb | 2 +- Library/Homebrew/cmd/commands.rb | 8 ++--- Library/Homebrew/cmd/install.rb | 4 +-- Library/Homebrew/cmd/list.rb | 2 +- Library/Homebrew/cmd/search.rb | 9 +++--- Library/Homebrew/cmd/update-report.rb | 2 +- Library/Homebrew/cmd/uses.rb | 2 +- Library/Homebrew/compat/utils.rb | 5 +++ Library/Homebrew/test/test_utils.rb | 2 +- Library/Homebrew/utils.rb | 1 - Library/Homebrew/utils/formatter.rb | 1 + Library/Homebrew/utils/formatter/columns.rb | 46 ++++++++++++++++++++++++++++ Library/Homebrew/utils/puts_columns.rb | 41 ------------------------- 15 files changed, 74 insertions(+), 61 deletions(-) create mode 100644 Library/Homebrew/utils/formatter/columns.rb delete mode 100644 Library/Homebrew/utils/puts_columns.rb (limited to 'Library') diff --git a/Library/Homebrew/cask/lib/hbc/cli/install.rb b/Library/Homebrew/cask/lib/hbc/cli/install.rb index 1292ad076..3e9ce4e4f 100644 --- a/Library/Homebrew/cask/lib/hbc/cli/install.rb +++ b/Library/Homebrew/cask/lib/hbc/cli/install.rb @@ -42,12 +42,14 @@ module Hbc def self.warn_unavailable_with_suggestion(cask_token, e) exact_match, partial_matches = Search.search(cask_token) + error_message = e.message if exact_match - onoe e.message.concat(". Did you mean:\n#{exact_match}") + error_message.concat(". Did you mean:\n#{exact_match}") elsif !partial_matches.empty? - onoe e.message.concat(". Did you mean one of:") - $stderr.puts_columns(partial_matches.take(20)) + error_message.concat(". Did you mean one of:\n") + .concat(Formatter.columns(partial_matches.take(20))) end + onoe error_message end def self.help diff --git a/Library/Homebrew/cask/lib/hbc/cli/list.rb b/Library/Homebrew/cask/lib/hbc/cli/list.rb index 3a993f8e6..330c81b90 100644 --- a/Library/Homebrew/cask/lib/hbc/cli/list.rb +++ b/Library/Homebrew/cask/lib/hbc/cli/list.rb @@ -68,7 +68,7 @@ module Hbc elsif @options[:versions] puts installed_casks.map(&method(:format_versioned)) else - puts_columns installed_casks.map(&:to_s) + puts Formatter.columns(installed_casks.map(&:to_s)) end installed_casks.empty? ? nil : true diff --git a/Library/Homebrew/cask/lib/hbc/cli/search.rb b/Library/Homebrew/cask/lib/hbc/cli/search.rb index b671ea862..147e6d194 100644 --- a/Library/Homebrew/cask/lib/hbc/cli/search.rb +++ b/Library/Homebrew/cask/lib/hbc/cli/search.rb @@ -47,7 +47,7 @@ module Hbc else ohai "Partial matches" end - puts_columns partial_matches + puts Formatter.columns(partial_matches) end end diff --git a/Library/Homebrew/cmd/commands.rb b/Library/Homebrew/cmd/commands.rb index f6445d560..addccd609 100644 --- a/Library/Homebrew/cmd/commands.rb +++ b/Library/Homebrew/cmd/commands.rb @@ -12,22 +12,22 @@ module Homebrew cmds = internal_commands + external_commands cmds += internal_developer_commands cmds += HOMEBREW_INTERNAL_COMMAND_ALIASES.keys if ARGV.include? "--include-aliases" - puts_columns cmds.sort + puts Formatter.columns(cmds.sort) else # Find commands in Homebrew/cmd puts "Built-in commands" - puts_columns internal_commands + puts Formatter.columns(internal_commands) # Find commands in Homebrew/dev-cmd puts puts "Built-in developer commands" - puts_columns internal_developer_commands + puts Formatter.columns(internal_developer_commands) # Find commands in the path unless (exts = external_commands).empty? puts puts "External commands" - puts_columns exts + puts Formatter.columns(exts) end end end diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb index 209fe8bad..2c027a52e 100644 --- a/Library/Homebrew/cmd/install.rb +++ b/Library/Homebrew/cmd/install.rb @@ -183,7 +183,7 @@ module Homebrew puts "To install it, run:\n brew install #{formulae_search_results.first}" else puts "These similarly named formulae were found:" - puts_columns(formulae_search_results) + puts Formatter.columns(formulae_search_results) puts "To install one of them, run (for example):\n brew install #{formulae_search_results.first}" end @@ -198,7 +198,7 @@ module Homebrew puts "To install it, run:\n brew install #{taps_search_results.first}" else puts "These formulae were found in taps:" - puts_columns(taps_search_results) + puts Formatter.columns(taps_search_results) puts "To install one of them, run (for example):\n brew install #{taps_search_results.first}" end end diff --git a/Library/Homebrew/cmd/list.rb b/Library/Homebrew/cmd/list.rb index 93c2545ad..3496580f4 100644 --- a/Library/Homebrew/cmd/list.rb +++ b/Library/Homebrew/cmd/list.rb @@ -49,7 +49,7 @@ module Homebrew end end return if full_names.empty? - puts_columns full_names + puts Formatter.columns(full_names) else ENV["CLICOLOR"] = nil exec "ls", *ARGV.options_only << HOMEBREW_CELLAR diff --git a/Library/Homebrew/cmd/search.rb b/Library/Homebrew/cmd/search.rb index f0a276929..d69164eb9 100644 --- a/Library/Homebrew/cmd/search.rb +++ b/Library/Homebrew/cmd/search.rb @@ -27,7 +27,7 @@ module Homebrew def search if ARGV.empty? - puts_columns Formula.full_names + puts Formatter.columns(Formula.full_names) elsif ARGV.include? "--macports" exec_browser "https://www.macports.org/ports.php?by=name&substr=#{ARGV.next}" elsif ARGV.include? "--fink" @@ -54,14 +54,15 @@ module Homebrew result = search_tap(user, repo, name) end - puts_columns Array(result) + results = Array(result) + puts Formatter.columns(results) unless results.empty? else query = ARGV.first regex = query_regexp(query) local_results = search_formulae(regex) - puts_columns(local_results) unless local_results.empty? + puts Formatter.columns(local_results) unless local_results.empty? tap_results = search_taps(regex) - puts_columns(tap_results) unless tap_results.empty? + puts Formatter.columns(tap_results) unless tap_results.empty? if $stdout.tty? count = local_results.length + tap_results.length diff --git a/Library/Homebrew/cmd/update-report.rb b/Library/Homebrew/cmd/update-report.rb index 629ce1f3f..72dcc293d 100644 --- a/Library/Homebrew/cmd/update-report.rb +++ b/Library/Homebrew/cmd/update-report.rb @@ -553,7 +553,7 @@ class ReporterHub return if formulae.empty? # Dump formula list. ohai title - puts_columns(formulae) + puts Formatter.columns(formulae) end def installed?(formula) diff --git a/Library/Homebrew/cmd/uses.rb b/Library/Homebrew/cmd/uses.rb index 66088e217..fb11a31a7 100644 --- a/Library/Homebrew/cmd/uses.rb +++ b/Library/Homebrew/cmd/uses.rb @@ -94,6 +94,6 @@ module Homebrew end return if uses.empty? - puts_columns uses.map(&:full_name) + puts Formatter.columns(uses.map(&:full_name)) end end diff --git a/Library/Homebrew/compat/utils.rb b/Library/Homebrew/compat/utils.rb index 7b529f04e..ed6063472 100644 --- a/Library/Homebrew/compat/utils.rb +++ b/Library/Homebrew/compat/utils.rb @@ -16,3 +16,8 @@ module Tty reset.bold end end + +def puts_columns(items) + odeprecated "puts_columns", "puts Formatter.columns" + puts Formatter.columns(items) +end diff --git a/Library/Homebrew/test/test_utils.rb b/Library/Homebrew/test/test_utils.rb index c97d70285..11332e450 100644 --- a/Library/Homebrew/test/test_utils.rb +++ b/Library/Homebrew/test/test_utils.rb @@ -111,7 +111,7 @@ class UtilTests < Homebrew::TestCase def test_put_columns_empty out, err = capture_io do - puts_columns [] + puts Formatter.columns([]) end assert_equal out, "\n" diff --git a/Library/Homebrew/utils.rb b/Library/Homebrew/utils.rb index e31339e16..fce03f888 100644 --- a/Library/Homebrew/utils.rb +++ b/Library/Homebrew/utils.rb @@ -11,7 +11,6 @@ require "utils/hash" require "utils/inreplace" require "utils/json" require "utils/popen" -require "utils/puts_columns" require "utils/tty" def ohai(title, *sput) diff --git a/Library/Homebrew/utils/formatter.rb b/Library/Homebrew/utils/formatter.rb index cb4f041f4..3759e2b4f 100644 --- a/Library/Homebrew/utils/formatter.rb +++ b/Library/Homebrew/utils/formatter.rb @@ -1,3 +1,4 @@ +require "utils/formatter/columns" require "utils/tty" module Formatter diff --git a/Library/Homebrew/utils/formatter/columns.rb b/Library/Homebrew/utils/formatter/columns.rb new file mode 100644 index 000000000..6488ef35f --- /dev/null +++ b/Library/Homebrew/utils/formatter/columns.rb @@ -0,0 +1,46 @@ +require "utils/tty" + +module Formatter + module_function + + def columns(*objects, gap_size: 2) + objects = objects.flatten.map(&:to_s) + + fallback = proc do + return objects.join("\n").concat("\n") + end + + fallback.call if objects.empty? + fallback.call if respond_to?(:tty?) ? !tty? : !$stdout.tty? + + console_width = Tty.width + object_lengths = objects.map { |obj| Tty.strip_ansi(obj).length } + cols = (console_width + gap_size) / (object_lengths.max + gap_size) + + fallback.call if cols < 2 + + rows = (objects.count + cols - 1) / cols + cols = (objects.count + rows - 1) / rows # avoid empty trailing columns + + col_width = (console_width + gap_size) / cols - gap_size + + gap_string = "".rjust(gap_size) + + output = "" + + rows.times do |row_index| + item_indices_for_row = row_index.step(objects.size - 1, rows).to_a + + first_n = item_indices_for_row[0...-1].map { |index| + objects[index] + "".rjust(col_width - object_lengths[index]) + } + + # don't add trailing whitespace to last column + last = objects.values_at(item_indices_for_row.last) + + output.concat((first_n + last).join(gap_string)).concat("\n") + end + + output + end +end diff --git a/Library/Homebrew/utils/puts_columns.rb b/Library/Homebrew/utils/puts_columns.rb deleted file mode 100644 index 2810918c6..000000000 --- a/Library/Homebrew/utils/puts_columns.rb +++ /dev/null @@ -1,41 +0,0 @@ -require "utils/tty" - -module Kernel - def puts_columns(*objects, gap_size: 2) - objects.flatten! - - fallback = proc do - puts(*objects) - return - end - - fallback.call if objects.empty? - fallback.call if respond_to?(:tty?) ? !tty? : !$stdout.tty? - - console_width = Tty.width - object_lengths = objects.map { |obj| Tty.strip_ansi(obj.to_s).length } - cols = (console_width + gap_size) / (object_lengths.max + gap_size) - - fallback.call if cols < 2 - - rows = (objects.count + cols - 1) / cols - cols = (objects.count + rows - 1) / rows # avoid empty trailing columns - - col_width = (console_width + gap_size) / cols - gap_size - - gap_string = "".rjust(gap_size) - - rows.times do |row_index| - item_indices_for_row = row_index.step(objects.size - 1, rows).to_a - - first_n = item_indices_for_row[0...-1].map { |index| - objects[index] + "".rjust(col_width - object_lengths[index]) - } - - # don't add trailing whitespace to last column - last = objects.values_at(item_indices_for_row.last) - - puts (first_n + last).join(gap_string) - end - end -end -- cgit v1.2.3 From ef70677e881855f1e7b51f158752e1ee78b27a96 Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Sun, 9 Oct 2016 18:03:15 +0200 Subject: Add test for `Formatter.columns`. --- Library/Homebrew/cask/spec/formatter_spec.rb | 56 ++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 Library/Homebrew/cask/spec/formatter_spec.rb (limited to 'Library') diff --git a/Library/Homebrew/cask/spec/formatter_spec.rb b/Library/Homebrew/cask/spec/formatter_spec.rb new file mode 100644 index 000000000..7e143d933 --- /dev/null +++ b/Library/Homebrew/cask/spec/formatter_spec.rb @@ -0,0 +1,56 @@ +require "spec_helper" +require "utils/formatter" +require "utils/tty" + +describe Formatter do + describe "::columns" do + let(:input) { + [ + 'aa', + 'bbb', + 'ccc', + 'dd' + ] + } + subject { described_class.columns(input) } + + it "doesn't output columns if $stdout is not a TTY." do + allow_any_instance_of(IO).to receive(:tty?).and_return(false) + allow(Tty).to receive(:width).and_return(10) + + expect(subject).to eq( + "aa\n" \ + "bbb\n" \ + "ccc\n" \ + "dd\n" + ) + end + + describe "$stdout is a TTY" do + it "outputs columns" do + allow_any_instance_of(IO).to receive(:tty?).and_return(true) + allow(Tty).to receive(:width).and_return(10) + + expect(subject).to eq( + "aa ccc\n" \ + "bbb dd\n" + ) + end + + it "outputs only one line if everything fits" do + allow_any_instance_of(IO).to receive(:tty?).and_return(true) + allow(Tty).to receive(:width).and_return(20) + + expect(subject).to eq( + "aa bbb ccc dd\n" + ) + end + end + + describe "with empty input" do + let(:input) { [] } + + it { is_expected.to eq("\n") } + end + end +end -- cgit v1.2.3 From 581a1245bf2c038a2f35fb10445592c7655108e3 Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Sat, 15 Oct 2016 17:15:20 +0200 Subject: Move `Formatter.columns` into `utils/formatter`. --- Library/Homebrew/utils/formatter.rb | 42 +++++++++++++++++++++++++- Library/Homebrew/utils/formatter/columns.rb | 46 ----------------------------- 2 files changed, 41 insertions(+), 47 deletions(-) delete mode 100644 Library/Homebrew/utils/formatter/columns.rb (limited to 'Library') diff --git a/Library/Homebrew/utils/formatter.rb b/Library/Homebrew/utils/formatter.rb index 3759e2b4f..a29a0d491 100644 --- a/Library/Homebrew/utils/formatter.rb +++ b/Library/Homebrew/utils/formatter.rb @@ -1,4 +1,3 @@ -require "utils/formatter/columns" require "utils/tty" module Formatter @@ -50,4 +49,45 @@ module Formatter end end private_class_method :prefix + + def columns(*objects, gap_size: 2) + objects = objects.flatten.map(&:to_s) + + fallback = proc do + return objects.join("\n").concat("\n") + end + + fallback.call if objects.empty? + fallback.call if respond_to?(:tty?) ? !tty? : !$stdout.tty? + + console_width = Tty.width + object_lengths = objects.map { |obj| Tty.strip_ansi(obj).length } + cols = (console_width + gap_size) / (object_lengths.max + gap_size) + + fallback.call if cols < 2 + + rows = (objects.count + cols - 1) / cols + cols = (objects.count + rows - 1) / rows # avoid empty trailing columns + + col_width = (console_width + gap_size) / cols - gap_size + + gap_string = "".rjust(gap_size) + + output = "" + + rows.times do |row_index| + item_indices_for_row = row_index.step(objects.size - 1, rows).to_a + + first_n = item_indices_for_row[0...-1].map { |index| + objects[index] + "".rjust(col_width - object_lengths[index]) + } + + # don't add trailing whitespace to last column + last = objects.values_at(item_indices_for_row.last) + + output.concat((first_n + last).join(gap_string)).concat("\n") + end + + output + end end diff --git a/Library/Homebrew/utils/formatter/columns.rb b/Library/Homebrew/utils/formatter/columns.rb deleted file mode 100644 index 6488ef35f..000000000 --- a/Library/Homebrew/utils/formatter/columns.rb +++ /dev/null @@ -1,46 +0,0 @@ -require "utils/tty" - -module Formatter - module_function - - def columns(*objects, gap_size: 2) - objects = objects.flatten.map(&:to_s) - - fallback = proc do - return objects.join("\n").concat("\n") - end - - fallback.call if objects.empty? - fallback.call if respond_to?(:tty?) ? !tty? : !$stdout.tty? - - console_width = Tty.width - object_lengths = objects.map { |obj| Tty.strip_ansi(obj).length } - cols = (console_width + gap_size) / (object_lengths.max + gap_size) - - fallback.call if cols < 2 - - rows = (objects.count + cols - 1) / cols - cols = (objects.count + rows - 1) / rows # avoid empty trailing columns - - col_width = (console_width + gap_size) / cols - gap_size - - gap_string = "".rjust(gap_size) - - output = "" - - rows.times do |row_index| - item_indices_for_row = row_index.step(objects.size - 1, rows).to_a - - first_n = item_indices_for_row[0...-1].map { |index| - objects[index] + "".rjust(col_width - object_lengths[index]) - } - - # don't add trailing whitespace to last column - last = objects.values_at(item_indices_for_row.last) - - output.concat((first_n + last).join(gap_string)).concat("\n") - end - - output - end -end -- cgit v1.2.3