fat_table 0.2.2

data/lib/fat_table/formatters/latex_formatter.rb

@@ -0,0 +1,208 @@
+module FatTable
+  # A subclass of Formatter for rendering the table as a LaTeX table. It allows
+  # foreground colors through LaTeX's xcolor package but ignores background
+  # colors.  You can see the valid color names with LaTeXFormatter.valid_colors.
+  class LaTeXFormatter < Formatter
+    # Return a new LaTeXFormatter for +table+.  You can set the following
+    # +options+ with hash-like parameters:
+    #
+    # document::
+    #   if set to true, include a document preamble and wrap the output in a
+    #   LaTeX document environment so that the output can be compiled by a LaTeX
+    #   processor such as +pdflatex+.  By default, only the table environment is
+    #   output.
+    #
+    # environment::
+    #   set to a string, by default 'longtable' that indicates what kind of
+    #   LaTeX tabular-like environment to use for the table. The default is good
+    #   for tables that might continue over multiple pages since it repeats the
+    #   header at the top of each continuation page.
+
+    def initialize(table = Table.new, **options)
+      super
+      @options[:document] = options.fetch(:document, false)
+      @options[:environment] = options.fetch(:environment, 'longtable')
+    end
+
+    # Taken from the Rainbow gem's list of valid colors.
+    self.valid_colors = %w(
+      none black blue brown cyan darkgray gray green lightgray lime magenta
+      olive orange pink purple red teal violet white yellow AntiqueWhite1
+      AntiqueWhite2 AntiqueWhite3 AntiqueWhite4 Aquamarine1 Aquamarine2
+      Aquamarine3 Aquamarine4 Azure1 Azure2 Azure3 Azure4 Bisque1 Bisque2
+      Bisque3 Bisque4 Blue1 Blue2 Blue3 Blue4 Brown1 Brown2 Brown3 Brown4
+      Burlywood1 Burlywood2 Burlywood3 Burlywood4 CadetBlue1 CadetBlue2
+      CadetBlue3 CadetBlue4 Chartreuse1 Chartreuse2 Chartreuse3 Chartreuse4
+      Chocolate1 Chocolate2 Chocolate3 Chocolate4 Coral1 Coral2 Coral3 Coral4
+      Cornsilk1 Cornsilk2 Cornsilk3 Cornsilk4 Cyan1 Cyan2 Cyan3 Cyan4
+      DarkGoldenrod1 DarkGoldenrod2 DarkGoldenrod3 DarkGoldenrod4
+      DarkOliveGreen1 DarkOliveGreen2 DarkOliveGreen3 DarkOliveGreen4
+      DarkOrange1 DarkOrange2 DarkOrange3 DarkOrange4 DarkOrchid1 DarkOrchid2
+      DarkOrchid3 DarkOrchid4 DarkSeaGreen1 DarkSeaGreen2 DarkSeaGreen3
+      DarkSeaGreen4 DarkSlateGray1 DarkSlateGray2 DarkSlateGray3 DarkSlateGray4
+      DeepPink1 DeepPink2 DeepPink3 DeepPink4 DeepSkyBlue1 DeepSkyBlue2
+      DeepSkyBlue3 DeepSkyBlue4 DodgerBlue1 DodgerBlue2 DodgerBlue3 DodgerBlue4
+      Firebrick1 Firebrick2 Firebrick3 Firebrick4 Gold1 Gold2 Gold3 Gold4
+      Goldenrod1 Goldenrod2 Goldenrod3 Goldenrod4 Gray0 Green0 Green1 Green2
+      Green3 Green4 Grey0 Honeydew1 Honeydew2 Honeydew3 Honeydew4 HotPink1
+      HotPink2 HotPink3 HotPink4 IndianRed1 IndianRed2 IndianRed3 IndianRed4
+      Ivory1 Ivory2 Ivory3 Ivory4 Khaki1 Khaki2 Khaki3 Khaki4 LavenderBlush1
+      LavenderBlush2 LavenderBlush3 LavenderBlush4 LemonChiffon1 LemonChiffon2
+      LemonChiffon3 LemonChiffon4 LightBlue1 LightBlue2 LightBlue3 LightBlue4
+      LightCyan1 LightCyan2 LightCyan3 LightCyan4 LightGoldenrod1
+      LightGoldenrod2 LightGoldenrod3 LightGoldenrod4 LightPink1 LightPink2
+      LightPink3 LightPink4 LightSalmon1 LightSalmon2 LightSalmon3 LightSalmon4
+      LightSkyBlue1 LightSkyBlue2 LightSkyBlue3 LightSkyBlue4 LightSteelBlue1
+      LightSteelBlue2 LightSteelBlue3 LightSteelBlue4 LightYellow1 LightYellow2
+      LightYellow3 LightYellow4 Magenta1 Magenta2 Magenta3 Magenta4 Maroon0
+      Maroon1 Maroon2 Maroon3 Maroon4 MediumOrchid1 MediumOrchid2 MediumOrchid3
+      MediumOrchid4 MediumPurple1 MediumPurple2 MediumPurple3 MediumPurple4
+      MistyRose1 MistyRose2 MistyRose3 MistyRose4 NavajoWhite1 NavajoWhite2
+      NavajoWhite3 NavajoWhite4 OliveDrab1 OliveDrab2 OliveDrab3 OliveDrab4
+      Orange1 Orange2 Orange3 Orange4 OrangeRed1 OrangeRed2 OrangeRed3
+      OrangeRed4 Orchid1 Orchid2 Orchid3 Orchid4 PaleGreen1 PaleGreen2
+      PaleGreen3 PaleGreen4 PaleTurquoise1 PaleTurquoise2 PaleTurquoise3
+      PaleTurquoise4 PaleVioletRed1 PaleVioletRed2 PaleVioletRed3 PaleVioletRed4
+      PeachPuff1 PeachPuff2 PeachPuff3 PeachPuff4 Pink1 Pink2 Pink3 Pink4 Plum1
+      Plum2 Plum3 Plum4 Purple0 Purple1 Purple2 Purple3 Purple4 Red1 Red2 Red3
+      Red4 RosyBrown1 RosyBrown2 RosyBrown3 RosyBrown4 RoyalBlue1 RoyalBlue2
+      RoyalBlue3 RoyalBlue4 Salmon1 Salmon2 Salmon3 Salmon4 SeaGreen1 SeaGreen2
+      SeaGreen3 SeaGreen4 Seashell1 Seashell2 Seashell3 Seashell4 Sienna1
+      Sienna2 Sienna3 Sienna4 SkyBlue1 SkyBlue2 SkyBlue3 SkyBlue4 SlateBlue1
+      SlateBlue2 SlateBlue3 SlateBlue4 SlateGray1 SlateGray2 SlateGray3
+      SlateGray4 Snow1 Snow2 Snow3 Snow4 SpringGreen1 SpringGreen2 SpringGreen3
+      SpringGreen4 SteelBlue1 SteelBlue2 SteelBlue3 SteelBlue4 Tan1 Tan2 Tan3
+      Tan4 Thistle1 Thistle2 Thistle3 Thistle4 Tomato1 Tomato2 Tomato3 Tomato4
+      Turquoise1 Turquoise2 Turquoise3 Turquoise4 VioletRed1 VioletRed2
+      VioletRed3 VioletRed4 Wheat1 Wheat2 Wheat3 Wheat4 Yellow1 Yellow2 Yellow3
+      Yellow4
+    )
+
+    # LaTeX commands to load the needed packages based on the :environement
+    # option.  For now, just handles the default 'longtable' :environment.  The
+    # preamble always includes a command to load the xcolor package.
+    def preamble
+      result = ''
+      result +=
+        case @options[:environment]
+        when 'longtable'
+          "\\usepackage{longtable}\n"
+        else
+          ''
+        end
+      result += "\\usepackage[pdftex,x11names]{xcolor}\n"
+      result
+    end
+
+    private
+
+    def color_valid?(clr)
+      valid_colors.include?(clr)
+    end
+
+    def invalid_color_msg(clr)
+      valid_colors_list = valid_colors.join(' ').wrap
+      "LaTeXFormatter invalid color '#{clr}'. Valid colors are:\n" +
+        valid_colors_list
+    end
+
+    # Add LaTeX control sequences. Ignore background color, underline, and
+    # blink. Alignment needs to be done by LaTeX, so we have to take it into
+    # account unless it's the same as the body alignment, since that is the
+    # default.
+    def decorate_string(str, istruct)
+      str = quote(str)
+      result = ''
+      result += '\\bfseries{}' if istruct.bold
+      result += '\\itshape{}' if istruct.italic
+      result += "\\color{#{istruct.color}}" if istruct.color && istruct.color != 'none'
+      result = "#{result}#{str}"
+      unless istruct.alignment == format_at[:body][istruct._h].alignment
+        ac = alignment_code(istruct.alignment)
+        result = "\\multicolumn{1}{#{ac}}{#{result}}"
+      end
+      result
+    end
+
+    # Return +str+ with quote marks oriented and special TeX characters quoted.
+    def quote(str)
+      # Replace single and double quotes with TeX oriented quotes.
+      result = str.gsub(/'([^']*)'/, "`\\1'")
+      result = result.gsub(/"([^"]*)"/, "``\\1''")
+      # Escape special TeX characters, such as $ and %
+      result.tex_quote
+    end
+
+    def pre_table
+      result = ''
+      if @options[:document]
+        result += "\\documentclass{article}\n"
+        result += preamble
+        result += "\\begin{document}\n"
+      end
+      result += "\\begin{#{@options[:environment]}}{"
+      table.headers.each do |h|
+        result += alignment_code(format_at[:body][h].alignment)
+      end
+      result += "}\n"
+      result
+    end
+
+    def post_table
+      result = "\\end{#{@options[:environment]}}\n"
+      result += "\\end{document}\n" if @options[:document]
+      result
+    end
+
+    def alignment_code(al_sym)
+      case al_sym
+      when :center
+        'c'
+      when :right
+        'r'
+      else
+        'l'
+      end
+    end
+
+    def post_header(_widths)
+      "\\endhead\n"
+    end
+
+    def pre_row
+      ''
+    end
+
+    def pre_cell(_h)
+      ''
+    end
+
+    # We do quoting before applying decoration, so do not re-quote here.  We
+    # will have LaTeX commands in v.
+    def quote_cell(v)
+      v
+    end
+
+    def post_cell
+      ''
+    end
+
+    def inter_cell
+      "&\n"
+    end
+
+    def post_row
+      "\\\\\n"
+    end
+
+    # Hlines look to busy in a printed table
+    def hline(_widths)
+      ''
+    end
+
+    # Hlines look too busy in a printed table
+    def post_footers(_widths)
+      ''
+    end
+  end
+end

data/lib/fat_table/formatters/org_formatter.rb

@@ -0,0 +1,72 @@
+module FatTable
+  # Output the table in the same way as org-mode for emacs does. This is almost
+  # identical to TextFormatter except that dates do get formatted as inactive
+  # timestamps and the connector at the beginning of hlines is a '|' rather than
+  # a '+' as for text tables.
+  class OrgFormatter < Formatter
+
+    self.default_format = default_format.dup
+    self.default_format[:date_fmt] = '[%F]'
+    self.default_format[:datetime_fmt] = '[%F %a %H:%M:%S]'
+
+    private
+
+    # Does this Formatter require a second pass over the cells to align the
+    # columns according to the alignment formatting instruction to the width of
+    # the widest cell in each column?
+    def aligned?
+      true
+    end
+
+    def pre_header(widths)
+      result = '|'
+      widths.values.each do |w|
+        result += '-' * (w + 2) + '+'
+      end
+      result[-1] = '|'
+      result + "\n"
+    end
+
+    def pre_row
+      '|'
+    end
+
+    def pre_cell(_h)
+      ''
+    end
+
+    def quote_cell(v)
+      v
+    end
+
+    def post_cell
+      ''
+    end
+
+    def inter_cell
+      '|'
+    end
+
+    def post_row
+      "|\n"
+    end
+
+    def hline(widths)
+      result = '|'
+      widths.values.each do |w|
+        result += '-' * (w + 2) + '+'
+      end
+      result[-1] = '|'
+      result + "\n"
+    end
+
+    def post_footers(widths)
+      result = '|'
+      widths.values.each do |w|
+        result += '-' * (w + 2) + '+'
+      end
+      result[-1] = '|'
+      result + "\n"
+    end
+  end
+end

data/lib/fat_table/formatters/term_formatter.rb

@@ -0,0 +1,297 @@
+# -*- coding: utf-8 -*-
+
+require 'rainbow'
+
+module FatTable
+  # Output the table as for a unicode-enabled ANSI terminal. This makes table
+  # gridlines drawable with unicode characters, as well as supporting colored
+  # text and backgrounds, and blink, and underline attributes. See
+  # TermFormatter.valid_colors for an Array of valid colors that you can use.
+  # The extent to which all of these are actually supported depends on your
+  # terminal. TermFormatter uses the +rainbow+ gem for forming colored strings.
+  # Use a
+  class TermFormatter < Formatter
+    # Return a new TermFormatter for +table+.  You can set a few +options+ with
+    # the following hash-like parameters:
+    #
+    # unicode::
+    #     if set true, use unicode characters to form the frame of the table on
+    #     output; if set false, use ASCII characters for the frame.  By default,
+    #     this is true.
+    #
+    # framecolor::
+    #     set to a string of the form '<color>' or '<color.color>' to set the
+    #     color of the frame or the color and background color.  By default, the
+    #     framecolor is set to 'none.none', meaning that the normal terminal
+    #     foreground and background colors will be used for the frame.
+    def initialize(table = Table.new, **options)
+      super
+      @options[:unicode] = options.fetch(:unicode, true)
+      @options[:framecolor] = options.fetch(:framecolor, 'none.none')
+      return unless @options[:framecolor] =~ /([-_a-zA-Z]*)(\.([-_a-zA-Z]*))/
+      @options[:frame_fg] = $1.downcase unless $1.blank?
+      @options[:frame_bg] = $3.downcase unless $3.blank?
+    end
+
+    # Valid colors for ANSI terminal using the rainbow gem's X11ColorNames.
+    self.valid_colors = ['none'] +
+                        ::Rainbow::X11ColorNames::NAMES.keys.map(&:to_s).sort
+
+    private
+
+    def color_valid?(clr)
+      valid_colors.include?(clr)
+    end
+
+    def invalid_color_msg(clr)
+      valid_colors_list = valid_colors.join(' ').wrap
+      "TermFormatter invalid color '#{clr}'. Valid colors are:\n" +
+        valid_colors_list
+    end
+
+    # Compute the width of the string as displayed, taking into account the
+    # characteristics of the target device.  For example, a colored string
+    # should not include in the width terminal control characters that simply
+    # change the color without occupying any space.  Thus, this method must be
+    # overridden in a subclass if a simple character count does not reflect the
+    # width as displayed.
+    def width(str)
+      strip_ansi(str).length
+    end
+
+    def strip_ansi(str)
+      str&.gsub(/\e\[[0-9;]+m/, '')
+    end
+
+    # Add ANSI codes to string to implement the given decorations
+    def decorate_string(str, istruct)
+      result = Rainbow(str)
+      result = colorize(result, istruct.color, istruct.bgcolor)
+      result = result.bold if istruct.bold
+      result = result.italic if istruct.italic
+      result = result.underline if istruct.underline
+      result = result.blink if istruct.blink
+      result
+    end
+
+    def colorize(str, fg, bg)
+      fg = nil if fg == 'none'
+      bg = nil if bg == 'none'
+      return str unless fg || bg
+      result = Rainbow(str)
+      if fg
+        fg = fg.tr(' ', '').downcase.as_sym
+        result = result.color(fg) if fg
+      end
+      if bg
+        bg = bg.tr(' ', '').downcase.as_sym
+        result = result.bg(bg) if bg
+      end
+      result
+    end
+
+    # Colorize frame components
+    def frame_colorize(str)
+      colorize(str, @options[:frame_fg], @options[:frame_bg])
+    end
+
+    # :stopdoc:
+    # Unicode line-drawing characters. We use double lines before and after the
+    # table and single lines for the sides and hlines between groups and
+    # footers.
+    UPPER_LEFT = "\u2552".freeze
+    UPPER_RIGHT = "\u2555".freeze
+    DOUBLE_RULE = "\u2550".freeze
+    UPPER_TEE = "\u2564".freeze
+    VERTICAL_RULE = "\u2502".freeze
+    LEFT_TEE = "\u251C".freeze
+    HORIZONTAL_RULE = "\u2500".freeze
+    SINGLE_CROSS = "\u253C".freeze
+    RIGHT_TEE = "\u2524".freeze
+    LOWER_LEFT = "\u2558".freeze
+    LOWER_RIGHT = "\u255B".freeze
+    LOWER_TEE = "\u2567".freeze
+    # :startdoc:
+
+    def upper_left
+      if options[:unicode]
+        UPPER_LEFT
+      else
+        '+'
+      end
+    end
+
+    def upper_right
+      if options[:unicode]
+        UPPER_RIGHT
+      else
+        '+'
+      end
+    end
+
+    def double_rule
+      if options[:unicode]
+        DOUBLE_RULE
+      else
+        '='
+      end
+    end
+
+    def upper_tee
+      if options[:unicode]
+        UPPER_TEE
+      else
+        '+'
+      end
+    end
+
+    def vertical_rule
+      if options[:unicode]
+        VERTICAL_RULE
+      else
+        '|'
+      end
+    end
+
+    def left_tee
+      if options[:unicode]
+        LEFT_TEE
+      else
+        '+'
+      end
+    end
+
+    def horizontal_rule
+      if options[:unicode]
+        HORIZONTAL_RULE
+      else
+        '-'
+      end
+    end
+
+    def single_cross
+      if options[:unicode]
+        SINGLE_CROSS
+      else
+        '+'
+      end
+    end
+
+    def right_tee
+      if options[:unicode]
+        RIGHT_TEE
+      else
+        '+'
+      end
+    end
+
+    def lower_left
+      if options[:unicode]
+        LOWER_LEFT
+      else
+        '+'
+      end
+    end
+
+    def lower_right
+      if options[:unicode]
+        LOWER_RIGHT
+      else
+        '+'
+      end
+    end
+
+    def lower_tee
+      if options[:unicode]
+        LOWER_TEE
+      else
+        '+'
+      end
+    end
+
+    # Does this Formatter require a second pass over the cells to align the
+    # columns according to the alignment formatting instruction to the width of
+    # the widest cell in each column?
+    def aligned?
+      true
+    end
+
+    def pre_header(widths)
+      result = upper_left
+      widths.values.each do |w|
+        result += double_rule * (w + 2) + upper_tee
+      end
+      result[-1] = upper_right
+      result = colorize(result, @options[:frame_fg], @options[:frame_bg])
+      result + "\n"
+    end
+
+    def pre_row
+      frame_colorize(vertical_rule)
+    end
+
+    def pre_cell(_h)
+      ''
+    end
+
+    def quote_cell(v)
+      v
+    end
+
+    def post_cell
+      ''
+    end
+
+    def inter_cell
+      frame_colorize(vertical_rule)
+    end
+
+    def post_row
+      frame_colorize(vertical_rule) + "\n"
+    end
+
+    def hline(widths)
+      result = left_tee
+      widths.values.each do |w|
+        result += horizontal_rule * (w + 2) + single_cross
+      end
+      result[-1] = right_tee
+      result = frame_colorize(result)
+      result + "\n"
+    end
+
+    def pre_group
+      ''
+    end
+
+    def post_group
+      ''
+    end
+
+    def pre_gfoot
+      ''
+    end
+
+    def post_gfoot
+      ''
+    end
+
+    def pre_foot
+      ''
+    end
+
+    def post_foot
+      ''
+    end
+
+    def post_footers(widths)
+      result = lower_left
+      widths.values.each do |w|
+        result += double_rule * (w + 2) + lower_tee
+      end
+      result[-1] = lower_right
+      result = frame_colorize(result)
+      result + "\n"
+    end
+  end
+end