-
Notifications
You must be signed in to change notification settings - Fork 554
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extract print methods to seperate classes
The printing methods are already pretty large, making it difficult to add extra functionality. Extracting them to seperate classes allows refactoring them for easier maintainability. A lot of the functionality of calculating the terminal width can be extracted to a separate object as well.
- Loading branch information
Showing
8 changed files
with
223 additions
and
144 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
require_relative "printer" | ||
require_relative "terminal" | ||
|
||
class Thor | ||
module Shell | ||
class ColumnPrinter < Printer | ||
def print(array) | ||
return if array.empty? | ||
colwidth = (array.map { |el| el.to_s.size }.max || 0) + 2 | ||
array.each_with_index do |value, index| | ||
# Don't output trailing spaces when printing the last column | ||
if ((((index + 1) % (Terminal.terminal_width / colwidth))).zero? && !index.zero?) || index + 1 == array.length | ||
stdout.puts value | ||
else | ||
stdout.printf("%-#{colwidth}s", value) | ||
end | ||
end | ||
end | ||
end | ||
end | ||
end | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
class Thor | ||
module Shell | ||
class Printer | ||
attr_reader :stdout, :options | ||
|
||
def initialize(stdout, options = {}) | ||
@stdout = stdout | ||
@options = options | ||
@indent = options[:indent].to_i | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
require_relative "printer" | ||
require_relative "terminal" | ||
|
||
class Thor | ||
module Shell | ||
class TablePrinter < Printer | ||
def initialize(stdout, options = {}) | ||
super | ||
@formats = [] | ||
@maximas = [] | ||
@colwidth = options[:colwidth] | ||
@truncate = options[:truncate] == true ? Terminal.terminal_width : options[:truncate] | ||
end | ||
|
||
def print(array) | ||
return if array.empty? | ||
|
||
prepare(array) | ||
|
||
array.each do |row| | ||
sentence = "".dup | ||
|
||
row.each_with_index do |column, index| | ||
maxima = @maximas[index] | ||
|
||
f = if column.is_a?(Numeric) | ||
if index == row.size - 1 | ||
# Don't output 2 trailing spaces when printing the last column | ||
"%#{maxima}s" | ||
else | ||
"%#{maxima}s " | ||
end | ||
else | ||
@formats[index] | ||
end | ||
sentence << f % column.to_s | ||
end | ||
|
||
sentence = truncate(sentence) | ||
stdout.puts sentence | ||
end | ||
end | ||
|
||
private | ||
|
||
def prepare(array) | ||
@formats << "%-#{@colwidth + 2}s".dup if @colwidth | ||
start = @colwidth ? 1 : 0 | ||
|
||
colcount = array.max { |a, b| a.size <=> b.size }.size | ||
|
||
start.upto(colcount - 1) do |index| | ||
maxima = array.map { |row| row[index] ? row[index].to_s.size : 0 }.max | ||
@maximas << maxima | ||
@formats << if index == colcount - 1 | ||
# Don't output 2 trailing spaces when printing the last column | ||
"%-s".dup | ||
else | ||
"%-#{maxima + 2}s".dup | ||
end | ||
end | ||
|
||
@formats[0] = @formats[0].insert(0, " " * @indent) | ||
@formats << "%s" | ||
end | ||
|
||
def truncate(string) | ||
return string unless @truncate | ||
as_unicode do | ||
chars = string.chars.to_a | ||
if chars.length <= @truncate | ||
chars.join | ||
else | ||
chars[0, @truncate - 3].join + "..." | ||
end | ||
end | ||
end | ||
|
||
if "".respond_to?(:encode) | ||
def as_unicode | ||
yield | ||
end | ||
else | ||
def as_unicode | ||
old = $KCODE # rubocop:disable Style/GlobalVars | ||
$KCODE = "U" # rubocop:disable Style/GlobalVars | ||
yield | ||
ensure | ||
$KCODE = old # rubocop:disable Style/GlobalVars | ||
end | ||
end | ||
end | ||
end | ||
end | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
class Thor | ||
module Shell | ||
module Terminal | ||
DEFAULT_TERMINAL_WIDTH = 80 | ||
|
||
class << self | ||
# This code was copied from Rake, available under MIT-LICENSE | ||
# Copyright (c) 2003, 2004 Jim Weirich | ||
def terminal_width | ||
result = if ENV["THOR_COLUMNS"] | ||
ENV["THOR_COLUMNS"].to_i | ||
else | ||
unix? ? dynamic_width : DEFAULT_TERMINAL_WIDTH | ||
end | ||
result < 10 ? DEFAULT_TERMINAL_WIDTH : result | ||
rescue | ||
DEFAULT_TERMINAL_WIDTH | ||
end | ||
|
||
def unix? | ||
RUBY_PLATFORM =~ /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris)/i | ||
end | ||
|
||
private | ||
|
||
# Calculate the dynamic width of the terminal | ||
def dynamic_width | ||
@dynamic_width ||= (dynamic_width_stty.nonzero? || dynamic_width_tput) | ||
end | ||
|
||
def dynamic_width_stty | ||
`stty size 2>/dev/null`.split[1].to_i | ||
end | ||
|
||
def dynamic_width_tput | ||
`tput cols 2>/dev/null`.to_i | ||
end | ||
|
||
end | ||
end | ||
end | ||
end |
Oops, something went wrong.