flexible_table 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b743ebb494954434ce4835b57d8692c1dcf54f5
-  data.tar.gz: 020c4ec648d16a4241becb7d0db83e75f4ea7468
+  metadata.gz: 7820ebcd7f52ec82dc683231eb1a0d9bdd01a198
+  data.tar.gz: 03a373e6e7e954b5c68633800c1d2fffb6710c0d
 SHA512:
-  metadata.gz: 426906c3b1c2189a16d420e73d0015f5a46cf486f9dd654e48ee8b0f8d010e4d369412baa9d77fa9da6c46dc32fb3411d0936eb12278952b0edc9a239c8dd227
-  data.tar.gz: 27a2a8088925e0f9d1da035171c8ff1c2a6647558d405698773813e34e3b04fa3c02a76cefa233dff989af81d71572e12218a77d296c46c7ae05a37fae4f67f9
+  metadata.gz: da3febe12f4c2820748e6ef503cbd1c4a6459d8890ed4ddaf0ba4ad92c2187df0cca5688d74292481be93d4460bd71f158ef1573ddf1b271db178b9fedf7d5d2
+  data.tar.gz: d238dafe7c473efea8d96e7a70fd8e26cb8bdaa122fe80143926d15a6c5dd6b3bcb6d34072746bd768290e094aa7a2fb41ce605d916d68318f6a6451a9f832e8

data/lib/flexible_column.rb

@@ -1,9 +1,20 @@
+##
+# This class represents a column in the table. Instances of this class will get created by FlexibleTable#add_column and used inside an instance of a FlexibleTable.
+#
+# It's important to note that the width_percentages of all FlexibleColmn's inside an instance of FlexibleTable must add up to less than or equal to 100.
 class FlexibleColumn
-    def initialize(header, width_percentage, justify_row: :left, justify_header: :left)
-        @header           = header
-        @width_percentage = width_percentage
-        @justify_row      = justify_row
-        @justify_header   = justify_header
-    end
-    attr_reader :width_percentage, :header, :justify_row, :justify_header
+
+	# === Attributes
+	#
+	# * +header+ - A String that will be displayed as the name of the column
+	# * +width_percentage+ - An Integer that will be the percentage of the terminal that the column should take up. The total columns width_percentages must add up to less than 100
+	# * +justify_header+ - Optional param that takes a symbol (:left or :right) that determines the justification of the column header
+	# * +justify_row+ - Optional param that takes a symbol (:left or :right) that determines the justification of the column cells
+	def initialize(header, width_percentage, justify_header: :left, justify_row: :left)
+		@header            = header
+		@width_percentage  = width_percentage
+		@justify_header    = justify_header
+		@justify_row       = justify_row
+	end
+	attr_reader :width_percentage, :header, :justify_row, :justify_header
 end

data/lib/flexible_table.rb

@@ -1,57 +1,75 @@
 require_relative './flexible_column'
 require_relative './print_helper'
 require 'io/console'
+require_relative './terminal_utils'
 
+##
+# This is the main class for creating Tables. The user can create a series of columns, and the print those columns out.
+# See the README for more example usages.
+#
+# === Examples
+#
+#  table = FlexibleTable.new
+#  table.add_column("I'm the first column", 10)
+#  table.add_column("I'm the second column", 10)
+#  table.print_header
+#  table.print_row("I'll be in column 1", "I'll be in column 2")
+#  table.print_row("I'll be in column 1", "I'll be in column 2")
+#  table.print_row("I'll be in column 1", "I'll be in column 2")
 class FlexibleTable
-    include PrintHelper
-
-    def initialize
-        @screen_width = IO.console.winsize[1]
-        @columns      = []
-    end
-
-    def add_column(title, width_percentage, **args)
-        @columns << FlexibleColumn.new(title, width_percentage, args)
-    end
-
-    def print_header()
-        validate_column_width_percentages
-
-        @columns.each_with_index do |col, index|
-            abs_width = get_abs_width(col.width_percentage, 3)
-            output    = get_printable_output(col.header, abs_width)
-
-            if(@columns[index].justify_header == :left)
-                printf("%-#{abs_width}s", output)
-            elsif(@columns[index].justify_header == :right)
-                printf("%#{abs_width}s", output)
-            else
-                printf("%-#{abs_width}s", output) # default to left justify
-            end
-            printf(' | ') unless index == (@columns.length - 1)
-        end
-
-        puts "\n"
-        print_header_line
-    end
-
-    def print_row(*args)
-        validate_column_width_percentages
-
-        args.each_with_index do |element, index|
-            abs_width = get_abs_width(@columns[index].width_percentage, 3)
-            output    = get_printable_output(element, abs_width)
-
-            if(@columns[index].justify_row == :left)
-                printf("%-#{abs_width}s", output)
-            elsif(@columns[index].justify_row == :right)
-                printf("%#{abs_width}s", output)
-            else
-                printf("%-#{abs_width}s", output) # default to left justify
-            end
-
-            printf(' | ') unless index == (@columns.length - 1)
-        end
-        puts "\n"
-    end
+	include PrintHelper
+
+	def initialize
+		@total_screen_columns = IO.console.winsize[1]
+		@columns              = []
+	end
+
+	def add_column(title, width_percentage, **args)
+		@columns << FlexibleColumn.new(title, width_percentage, args)
+	end
+
+	def print_header()
+		exit unless columns_fit_screen?(@columns)
+
+		@columns.each_with_index do |col, index|
+			abs_width    = get_abs_column_width(@total_screen_columns, col.width_percentage)
+			color_prefix = col.header.instance_eval { @tu_color_prefix } || ''
+			color_suffix = col.header.instance_eval { @tu_color_suffix } || ''
+			output       = get_printable_output(col.header, abs_width)
+
+			if(@columns[index].justify_header == :left)
+				printf("%s%-#{abs_width}s%s", color_prefix, output, color_suffix)
+			elsif(@columns[index].justify_header == :right)
+				printf("%s%#{abs_width}s%s", color_prefix, output, color_suffix)
+			else
+				printf("%s%-#{abs_width}s%s", color_prefix, output, color_suffix) # default to left justify
+			end
+			print_column_separator unless index == (@columns.length - 1)
+		end
+
+		puts "\n"
+		print_header_line(@total_screen_columns)
+	end
+
+	def print_row(*args)
+		exit unless columns_fit_screen?(@columns)
+
+		args.each_with_index do |element, index|
+			abs_width    = get_abs_column_width(@total_screen_columns, @columns[index].width_percentage)
+			color_prefix = element.instance_eval { @tu_color_prefix } || ''
+			color_suffix = element.instance_eval { @tu_color_suffix } || ''
+			output       = get_printable_output(element, abs_width)
+
+			if(@columns[index].justify_row == :left)
+				printf("%s%-#{abs_width}s%s", color_prefix, output, color_suffix)
+			elsif(@columns[index].justify_row == :right)
+				printf("%s%#{abs_width}s%s", color_prefix, output, color_suffix)
+			else
+				printf("%s%-#{abs_width}s%s", color_prefix, output, color_suffix) # default to left justify
+			end
+
+			print_column_separator unless index == (@columns.length - 1)
+		end
+		puts "\n"
+	end
 end

data/lib/print_helper.rb

@@ -1,33 +1,70 @@
 module PrintHelper
-    private
-    def get_abs_width(width_percentage, offset=0)
-        abs_width = (Integer(((width_percentage.to_f / 100.to_f) * @screen_width.to_f).floor)) - offset
-
-        return abs_width <= 0 ? 1 : abs_width
-    end
-
-    def get_printable_output(str, abs_width)
-        return str.to_s[0..(abs_width - 1)]
-    end
-
-    def print_header_line
-        line_header = ''
-        
-        @columns.each do |col|
-            get_abs_width(col.width_percentage).times do |t|
-                line_header << '-'
-            end
-        end
-        puts "#{line_header}\n"
-    end
-
-    def validate_column_width_percentages
-        total_percentage = (@columns.map { |x| x.width_percentage }).reduce(:+)
-        if(total_percentage > 100)
-            puts "Your column percentages can't add up to more than 100%\n"
-            @columns.each { |col| puts "\t#{col.header}: \t#{col.width_percentage}" }
-            puts "\tTotal percetage: #{total_percentage}" 
-            exit
-        end
-    end
+	##
+	# Returns the width that a column should occupy based on screen size
+	#
+	# === Attributes
+	#
+	# +total_screen_columns+ - An Integer representing columns on the terminal window
+	# +width_percentage+ - An Integer representing the percentage of the total_screen_columns that the column should occupy
+	def get_column_width(total_screen_columns, width_percentage)
+		column_width = (Integer(((width_percentage.to_f / 100.to_f) * total_screen_columns.to_f).floor))
+
+		return column_width
+	end
+
+	##
+	# Returns a slightly truncated version of #get_column_width in order to compensate for different font sizes.
+	# This is the method that should be used when calculating what gets printed into a column
+	#
+	# === Attributes
+	#
+	# +total_screen_columns+ - An Integer representing columns on the terminal window
+	# +width_percentage+ - An Integer representing the percentage of the total_screen_columns that the column should occupy
+	def get_abs_column_width(total_screen_columns, width_percentage)
+		column_width = get_column_width(total_screen_columns, width_percentage) - 3
+
+		return column_width <= 0 ? 1 : column_width
+	end
+
+	def get_printable_output(str, abs_width)
+		return str.to_s[0..(abs_width - 1)]
+	end
+
+	def print_header_line(total_screen_columns)
+		line_header = ''
+		separator   = tty_supports_unicode? ? "\u2500" : '-'
+
+		@columns.each do |col|
+			get_column_width(total_screen_columns, col.width_percentage).times do |t|
+				line_header << separator
+			end
+		end
+		puts "#{line_header}\n"
+	end
+
+	def columns_fit_screen?(columns)
+		total_percentage = (columns.map { |x| x.width_percentage }).reduce(:+)
+		if(total_percentage > 100)
+			puts "Your column percentages can't add up to more than 100\n"
+			columns.each { |col| puts "\t#{col.header}: \t#{col.width_percentage}" }
+			puts "\tTotal percetage: #{total_percentage}"
+
+			return false
+		else
+			return true
+		end
+	end
+
+	def print_column_separator
+		separator = tty_supports_unicode? ? "\u2502" : '|'
+
+		printf(" #{separator} ")
+	end
+
+	private
+	def tty_supports_unicode?
+		@tty_is_unicode_enabled ||= ENV.values_at("LC_ALL","LC_CTYPE","LANG").compact.any? { |x| x.downcase.include?('utf-8') }
+
+		return @tty_is_unicode_enabled
+	end
 end

data/lib/terminal_utils.rb

@@ -0,0 +1,89 @@
+module TerminalUtils
+	##
+	#
+	# This is a refinement on String that adds some properties to the String that represent ANSI Escape Sequences
+	#
+	# === Examples
+	#
+	# # Set the String foreground color property to red
+	# 'hello'.fg_red.tu_color_prefix
+	# => "\e[31m"
+	#
+	# 'hello'.fg_red.tu_color_suffix
+	# => "\e[0m"
+	#
+	#
+	# # Set the background color property to red
+	# 'hello'.bg_red.tu_color_prefix
+	# => "\e[41m"
+	#
+	# 'hello'.bg_red.tu_color_suffix
+	# => "\e[0m"
+	#
+	#
+	# # Set the foreground to red and the background to black
+	# 'hello'.fg_red.bg_black.tu_color_prefix
+	# => "\e[31m\e[40m"
+	#
+	# 'hello'.fg_red.bg_black.tu_color_suffix
+	# => "\e[0m"
+	module Color
+		refine String do
+			def fg_default;        return fg_color("\e[39m");  end
+			def fg_black;          return fg_color("\e[30m");  end
+			def fg_red;            return fg_color("\e[31m");  end
+			def fg_green;          return fg_color("\e[32m");  end
+			def fg_yellow;         return fg_color("\e[33m");  end
+			def fg_blue;           return fg_color("\e[34m");  end
+			def fg_magenta;        return fg_color("\e[35m");  end
+			def fg_cyan;           return fg_color("\e[36m");  end
+			def fg_grey;           return fg_color("\e[37m");  end
+			def fg_bright_black;   return fg_color("\e[90m");  end
+			def fg_bright_red;     return fg_color("\e[91m");  end
+			def fg_bright_green;   return fg_color("\e[92m");  end
+			def fg_bright_yellow;  return fg_color("\e[93m");  end
+			def fg_bright_blue;    return fg_color("\e[94m");  end
+			def fg_bright_magenta; return fg_color("\e[95m");  end
+			def fg_bright_cyan;    return fg_color("\e[96m");  end
+			def fg_bright_grey;    return fg_color("\e[97m");  end
+
+			def bg_default;        return fg_color("\e[49m");  end
+			def bg_black;          return bg_color("\e[40m");  end
+			def bg_red;            return bg_color("\e[41m");  end
+			def bg_green;          return bg_color("\e[42m");  end
+			def bg_yellow;         return bg_color("\e[43m");  end
+			def bg_blue;           return bg_color("\e[44m");  end
+			def bg_magenta;        return bg_color("\e[45m");  end
+			def bg_cyan;           return bg_color("\e[46m");  end
+			def bg_grey;           return bg_color("\e[47m");  end
+			def bg_bright_black;   return bg_color("\e[100m"); end
+			def bg_bright_red;     return bg_color("\e[101m"); end
+			def bg_bright_green;   return bg_color("\e[102m"); end
+			def bg_bright_yellow;  return bg_color("\e[103m"); end
+			def bg_bright_blue;    return bg_color("\e[104m"); end
+			def bg_bright_magenta; return bg_color("\e[105m"); end
+			def bg_bright_cyan;    return bg_color("\e[106m"); end
+			def bg_bright_grey;    return bg_color("\e[107m"); end
+
+			private
+			def fg_color(ansi_code)
+				@tu_fg_color = ansi_code
+
+				return color_string
+			end
+
+			def bg_color(ansi_code)
+				@tu_bg_color = ansi_code
+
+				return color_string
+			end
+
+			def color_string
+				@tu_color_prefix = [@tu_fg_color, @tu_bg_color].compact.join('')
+				@tu_color_suffix = "\e[0m"
+
+				return self
+			end
+		end
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexible_table
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Brett Sykes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-02 00:00:00.000000000 Z
+date: 2016-10-13 00:00:00.000000000 Z
 dependencies: []
 description: Prints a table that can have different column widths that also respond
   in size relative to the size of the terminal window
@@ -20,6 +20,7 @@ files:
 - lib/flexible_column.rb
 - lib/flexible_table.rb
 - lib/print_helper.rb
+- lib/terminal_utils.rb
 homepage: https://github.com/bretts/flexible_table
 licenses:
 - MIT
@@ -40,7 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: Prints a table that can have different column widths that also respond in