fat_table 0.2.7 → 0.3.1

data/lib/fat_table/formatters/latex_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 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
@@ -17,7 +19,6 @@ module FatTable
     #   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)
@@ -115,7 +116,8 @@ module FatTable
       result = ''
       result += '\\bfseries{}' if istruct.bold
       result += '\\itshape{}' if istruct.italic
-      result += "\\color{#{istruct.color}}" if istruct.color && istruct.color != 'none'
+      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)
@@ -173,14 +175,14 @@ module FatTable
       ''
     end
 
-    def pre_cell(_h)
+    def pre_cell(_head)
       ''
     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
+    def quote_cell(val)
+      val
     end
 
     def post_cell

data/lib/fat_table/formatters/org_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 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
@@ -30,12 +32,12 @@ module FatTable
       '|'
     end
 
-    def pre_cell(_h)
+    def pre_cell(_head)
       ''
     end
 
-    def quote_cell(v)
-      v
+    def quote_cell(val)
+      val
     end
 
     def post_cell

data/lib/fat_table/formatters/term_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rainbow'
 
 module FatTable
@@ -26,9 +28,10 @@ module FatTable
       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?
+      return unless @options[:framecolor] =~ /(?<co>[-_a-zA-Z]*)(\.(?<bg>[-_a-zA-Z]*))/
+
+      @options[:frame_fg] = Regexp.last_match[:co].downcase unless Regexp.last_match[:co].blank?
+      @options[:frame_bg] = Regexp.last_match[:bg].downcase unless Regexp.last_match[:bg].blank?
     end
 
     # Valid colors for ANSI terminal using the rainbow gem's X11ColorNames.
@@ -59,6 +62,7 @@ module FatTable
 
     def strip_ansi(str)
       return '' unless str
+
       str.gsub(/\e\[[0-9;]+m/, '')
     end
 
@@ -73,18 +77,19 @@ module FatTable
       result
     end
 
-    def colorize(str, fg, bg)
-      fg = nil if fg == 'none'
-      bg = nil if bg == 'none'
-      return str unless fg || bg
+    def colorize(str, fg_color, bg_color)
+      fg_color = nil if fg_color == 'none'
+      bg_color = nil if bg_color == 'none'
+      return str unless fg_color || bg_color
+
       result = Rainbow(str)
-      if fg
-        fg = fg.tr(' ', '').downcase.as_sym
-        result = result.color(fg) if fg
+      if fg_color
+        fg_color = fg_color.tr(' ', '').downcase.as_sym
+        result = result.color(fg_color) if fg_color
       end
-      if bg
-        bg = bg.tr(' ', '').downcase.as_sym
-        result = result.bg(bg) if bg
+      if bg_color
+        bg_color = bg_color.tr(' ', '').downcase.as_sym
+        result = result.bg(bg_color) if bg_color
       end
       result
     end
@@ -98,18 +103,18 @@ module FatTable
     # 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
+    UPPER_LEFT = "\u2552"
+    UPPER_RIGHT = "\u2555"
+    DOUBLE_RULE = "\u2550"
+    UPPER_TEE = "\u2564"
+    VERTICAL_RULE = "\u2502"
+    LEFT_TEE = "\u251C"
+    HORIZONTAL_RULE = "\u2500"
+    SINGLE_CROSS = "\u253C"
+    RIGHT_TEE = "\u2524"
+    LOWER_LEFT = "\u2558"
+    LOWER_RIGHT = "\u255B"
+    LOWER_TEE = "\u2567"
     # :startdoc:
 
     def upper_left
@@ -229,12 +234,12 @@ module FatTable
       frame_colorize(vertical_rule)
     end
 
-    def pre_cell(_h)
+    def pre_cell(_head)
       ''
     end
 
-    def quote_cell(v)
-      v
+    def quote_cell(val)
+      val
     end
 
     def post_cell

data/lib/fat_table/formatters/text_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FatTable
   # Output the table as plain text. This is almost identical to OrgFormatter
   # except that dates do not get formatted as inactive timestamps and the
@@ -26,12 +28,12 @@ module FatTable
       '|'
     end
 
-    def pre_cell(_h)
+    def pre_cell(_head)
       ''
     end
 
-    def quote_cell(v)
-      v
+    def quote_cell(val)
+      val
     end
 
     def post_cell

data/lib/fat_table/patches.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unless { a: 1 }.respond_to?(:fetch_values)
   # Add fetch_values if this version of ruby does not define it.
   class Hash
@@ -19,8 +21,8 @@ end
 unless ''.respond_to?(:match?)
   # Add String#match? to pre-2.4 ruby
   class String
-    def match?(re)
-      self =~ re
+    def match?(regexp)
+      self =~ regexp
     end
   end
 end
@@ -35,6 +37,7 @@ unless //.respond_to?(:match?)
 end
 
 unless ''.respond_to?(:strip_heredoc)
+  # Patch String to provide heredocs with whitespace stripped
   class String
     def strip_heredoc
       indent = chomp.scan(/^\s*/).min.size

data/lib/fat_table/table.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FatTable
   # A container for a two-dimensional table. All cells in the table must be a
   # String, a DateTime (or Date), a Numeric (Bignum, Integer, or BigDecimal), or
@@ -106,18 +108,19 @@ module FatTable
     # :category: Constructors
 
     # Construct a new table from an Array of Arrays +aoa+. By default, with
-    # +hlines+ set to false, do not look for separators, i.e. +nils+, just treat
-    # the first row as headers. With +hlines+ set true, expect +nil+ separators
-    # to mark the header row and any boundaries. If the second element of the
-    # array is a +nil+, interpret the first element of the array as a row of
-    # headers. Otherwise, synthesize headers of the form +:col_1+, +:col_2+, ...
-    # and so forth. The remaining elements are taken as the body of the table,
-    # except that if an element of the outer array is a +nil+, mark the
-    # preceding row as a group boundary. Note for Emacs users: In org mode code
-    # blocks when an org-mode table is passed in as a variable it is passed in
-    # as an Array of Arrays. By default (+ HEADER: :hlines no +) org-mode strips
-    # all from the table; otherwise (+ HEADER: :hlines yes +) they are indicated
-    # with nil elements in the outer array.
+    # +hlines+ set to false, do not look for separators, i.e. +nils+, just
+    # treat the first row as headers. With +hlines+ set true, expect +nil+
+    # separators to mark the header row and any boundaries. If the second
+    # element of the array is a +nil+, interpret the first element of the
+    # array as a row of headers. Otherwise, synthesize headers of the form
+    # +:col_1+, +:col_2+, ...  and so forth. The remaining elements are taken
+    # as the body of the table, except that if an element of the outer array
+    # is a +nil+, mark the preceding row as a group boundary. Note for Emacs
+    # users: In org mode code blocks when an org-mode table is passed in as a
+    # variable it is passed in as an Array of Arrays. By default (+ HEADER:
+    # :hlines no +) org-mode strips all hrules from the table; otherwise (+
+    # HEADER: :hlines yes +) they are indicated with nil elements in the outer
+    # array.
     def self.from_aoa(aoa, hlines: false)
       from_array_of_arrays(aoa, hlines: hlines)
     end
@@ -149,10 +152,11 @@ module FatTable
     # :category: Constructors
 
     # Construct a Table by running a SQL +query+ against the database set up
-    # with FatTable.set_db, with the rows of the query result as rows.
+    # with FatTable.connect, with the rows of the query result as rows.
     def self.from_sql(query)
-      msg = 'FatTable.db must be set with FatTable.set_db'
+      msg = 'FatTable.db must be set with FatTable.connect'
       raise UserError, msg if FatTable.db.nil?
+
       result = Table.new
       FatTable.db[query].each do |h|
         result << h
@@ -257,6 +261,7 @@ module FatTable
           unless table_found
             # Skip through the file until a table is found
             next unless line.match?(table_re)
+
             unless line.match?(hrule_re)
               line = line.sub(/\A\s*\|/, '').sub(/\|\s*\z/, '')
               rows << line.split('|').map(&:clean)
@@ -265,6 +270,7 @@ module FatTable
             next
           end
           break unless line.match?(table_re)
+
           if !header_found && line =~ hrule_re
             rows << nil
             header_found = true
@@ -272,7 +278,7 @@ module FatTable
           elsif header_found && line =~ hrule_re
             # Mark the boundary with a nil
             rows << nil
-          elsif line !~ table_re
+          elsif !line.match?(table_re)
             # Stop reading at the second hline
             break
           else
@@ -316,14 +322,17 @@ module FatTable
       when Integer
         msg = "index '#{key}' out of range"
         raise UserError, msg unless (0..size - 1).cover?(key.abs)
+
         rows[key]
       when String
         msg = "header '#{key}' not in table"
         raise UserError, msg unless headers.include?(key)
+
         column(key).items
       when Symbol
         msg = "header ':#{key}' not in table"
         raise UserError, msg unless headers.include?(key)
+
         column(key).items
       else
         raise UserError, "cannot index table with a #{key.class}"
@@ -360,6 +369,7 @@ module FatTable
     # Return the number of rows in the Table.
     def size
       return 0 if columns.empty?
+
       columns.first.size
     end
 
@@ -368,6 +378,7 @@ module FatTable
     # Return the number of Columns in the Table.
     def width
       return 0 if columns.empty?
+
       columns.size
     end
 
@@ -406,6 +417,7 @@ module FatTable
       last ||= size - 1
       last = [last, 0].max
       raise UserError, 'first must be <= last' unless first <= last
+
       rows = []
       unless columns.empty?
         first.upto(last) do |rnum|
@@ -493,12 +505,12 @@ module FatTable
       self
     end
 
-    # Mark a group boundary at row +k+, and if +k+ is +nil+, mark the last row
-    # in the table as a group boundary. This is mainly used for internal
+    # Mark a group boundary at row +row+, and if +row+ is +nil+, mark the last
+    # row in the table as a group boundary. This is mainly used for internal
     # purposes.
-    def mark_boundary(k = nil) # :nodoc:
-      if k
-        boundaries.push(k)
+    def mark_boundary(row = nil) # :nodoc:
+      if row
+        boundaries.push(row)
       else
         boundaries.push(size - 1)
       end
@@ -524,20 +536,21 @@ module FatTable
       @boundaries += bounds.map { |k| k + shift }
     end
 
-    # Return the group number to which row k belongs. Groups, from the user's
-    # point of view are indexed starting at 1.
-    def row_index_to_group_index(k)
+    # Return the group number to which row ~row~ belongs. Groups, from the
+    # user's point of view are indexed starting at 1.
+    def row_index_to_group_index(row)
       boundaries.each_with_index do |b_last, g_num|
-        return (g_num + 1) if k <= b_last
+        return (g_num + 1) if row <= b_last
       end
       1
     end
 
-    def group_rows(k) # :nodoc:
+    def group_rows(row) # :nodoc:
       normalize_boundaries
-      return [] unless k < boundaries.size
-      first = k.zero? ? 0 : boundaries[k - 1] + 1
-      last = boundaries[k]
+      return [] unless row < boundaries.size
+
+      first = row.zero? ? 0 : boundaries[row - 1] + 1
+      last = boundaries[row]
       rows_range(first, last)
     end
 
@@ -702,6 +715,7 @@ module FatTable
           h = k.as_sym
           msg = "Column '#{h}' in select does not exist"
           raise UserError, msg unless column?(h)
+
           new_row[h] = old_row[h]
         end
         new_cols.each_pair do |key, expr|
@@ -710,7 +724,8 @@ module FatTable
           case expr
           when Symbol
             msg = "Column '#{expr}' in select does not exist"
-            raise UserError, msg unless vars.keys.include?(expr)
+            raise UserError, msg unless vars.key?(expr)
+
             new_row[key] = vars[expr]
           when String
             new_row[key] = ev.evaluate(expr, locals: vars)
@@ -864,13 +879,10 @@ module FatTable
 
     private
 
-    # Apply the set operation given by op between this table and the other table
-    # given in the first argument.  If distinct is true, eliminate duplicates
-    # from the result.
-    def set_operation(other, op = :+,
-                      distinct: true,
-                      add_boundaries: true,
-                      inherit_boundaries: false)
+    # Apply the set operation given by ~oper~ between this table and the other
+    # table given in the first argument.  If distinct is true, eliminate
+    # duplicates from the result.
+    def set_operation(other, oper = :+, distinct: true, add_boundaries: true, inherit_boundaries: false)
       unless columns.size == other.columns.size
         msg = "can't apply set ops to tables with a different number of columns"
         raise UserError, msg
@@ -881,7 +893,7 @@ module FatTable
       end
       other_rows = other.rows.map { |r| r.replace_keys(headers) }
       result = Table.new
-      new_rows = rows.send(op, other_rows)
+      new_rows = rows.send(oper, other_rows)
       new_rows.each_with_index do |row, k|
         result << row
         result.mark_boundary if k == size - 1 && add_boundaries
@@ -975,6 +987,7 @@ module FatTable
       unless JOIN_TYPES.include?(join_type)
         raise UserError, "join_type may only be: #{JOIN_TYPES.join(', ')}"
       end
+
       # These may be needed for outer joins.
       self_row_nils = headers.map { |h| [h, nil] }.to_h
       other_row_nils = other.headers.map { |h| [h, nil] }.to_h
@@ -992,6 +1005,7 @@ module FatTable
           locals = build_locals_hash(row_a: self_row, row_b: other_row)
           matches = ev.evaluate(join_exp, locals: locals)
           next unless matches
+
           self_row_matched = other_row_matches[k] = true
           out_row = build_out_row(row_a: self_row, row_b: other_row,
                                   common_heads: other_common_heads,
@@ -1000,6 +1014,7 @@ module FatTable
         end
         next unless %i[left full].include?(join_type)
         next if self_row_matched
+
         result << build_out_row(row_a: self_row,
                                 row_b: other_row_nils,
                                 type: join_type)
@@ -1007,6 +1022,7 @@ module FatTable
       if %i[right full].include?(join_type)
         other_rows.each_with_index do |other_row, k|
           next if other_row_matches[k]
+
           result << build_out_row(row_a: self_row_nils,
                                   row_b: other_row,
                                   type: join_type)
@@ -1066,10 +1082,10 @@ module FatTable
       # Translate any remaining row_b heads to append '_b' if they have the
       # same name as a row_a key.
       a_heads = row_a.keys
-      row_b = row_b.to_a.each.map { |k, v|
+      row_b = row_b.to_a.each.map do |k, v|
         [a_heads.include?(k) ? "#{k}_b".to_sym : k, v]
-      }.to_h
-      row_a.merge(row_b)
+      end
+      row_a.merge(row_b.to_h)
     end
 
     # Return a hash for the local variables of a join expression in which all
@@ -1090,6 +1106,7 @@ module FatTable
     # and all the headers in the other table with '_b' appended.
     def build_join_expression(exps, other, type)
       return ['true', []] if type == :cross
+
       a_heads = headers
       b_heads = other.headers
       common_heads = a_heads & b_heads
@@ -1107,7 +1124,7 @@ module FatTable
           [nat_exp, common_heads]
         end
       else
-        # We have expressions to evaluate
+        # We have join expressions to evaluate
         and_conds = []
         partial_result = nil
         last_sym = nil
@@ -1115,11 +1132,12 @@ module FatTable
           case exp
           when Symbol
             case exp.to_s.clean
-            when /\A(.*)_a\z/
-              a_head = $1.to_sym
+            when /\A(?<sy>.*)_a\z/
+              a_head = Regexp.last_match[:sy].to_sym
               unless a_heads.include?(a_head)
                 raise UserError, "no column '#{a_head}' in table"
               end
+
               if partial_result
                 # Second of a pair
                 ensure_common_types!(self_h: a_head,
@@ -1130,14 +1148,15 @@ module FatTable
                 partial_result = nil
               else
                 # First of a pair of _a or _b
-                partial_result = "(#{a_head}_a == "
+                partial_result = String.new("(#{a_head}_a == ")
               end
               last_sym = a_head
-            when /\A(.*)_b\z/
-              b_head = $1.to_sym
+            when /\A(?<sy>.*)_b\z/
+              b_head = Regexp.last_match[:sy].to_sym
               unless b_heads.include?(b_head)
                 raise UserError, "no column '#{b_head}' in second table"
               end
+
               if partial_result
                 # Second of a pair
                 ensure_common_types!(self_h: last_sym,
@@ -1148,7 +1167,7 @@ module FatTable
                 partial_result = nil
               else
                 # First of a pair of _a or _b
-                partial_result = "(#{b_head}_b == "
+                partial_result = String.new("(#{b_head}_b == ")
               end
               b_common_heads << b_head
               last_sym = b_head
@@ -1270,7 +1289,7 @@ module FatTable
 
     # :category: Constructors
 
-    # Add a +row+ without marking it as a group boundary.
+    # Add a +row+ to this Table without marking it as a group boundary.
     def <<(row)
       add_row(row)
     end
@@ -1281,6 +1300,7 @@ module FatTable
     def add_column(col)
       msg = "Table already has a column with header '#{col.header}'"
       raise msg if column?(col.header)
+
       columns << col
       self
     end
@@ -1329,11 +1349,12 @@ module FatTable
       fmt = fmt_type.as_sym
       msg = "unknown format '#{fmt}'"
       raise UserError, msg unless FatTable::FORMATS.include?(fmt)
+
       method = "to_#{fmt}"
       if block_given?
-        send method, options, &Proc.new
+        send(method, options, &Proc.new)
       else
-        send method, options
+        send(method, options)
       end
     end
 
@@ -1347,7 +1368,7 @@ module FatTable
     # default format for Formatter, there is no class PsvFormatter as you might
     # expect.
     def to_psv(options = {})
-      fmt = Formatter.new(self, options)
+      fmt = Formatter.new(self, **options)
       yield fmt if block_given?
       fmt.output
     end
@@ -1360,7 +1381,7 @@ module FatTable
     # the block to which formatting instructions and footers can be added by
     # calling methods on it.
     def to_aoa(options = {})
-      fmt = FatTable::AoaFormatter.new(self, options)
+      fmt = FatTable::AoaFormatter.new(self, **options)
       yield fmt if block_given?
       fmt.output
     end
@@ -1374,7 +1395,7 @@ module FatTable
     # given, it yields an AohFormatter to the block to which formatting
     # instructions and footers can be added by calling methods on it.
     def to_aoh(options = {})
-      fmt = AohFormatter.new(self, options)
+      fmt = AohFormatter.new(self, **options)
       yield fmt if block_given?
       fmt.output
     end
@@ -1387,7 +1408,7 @@ module FatTable
     # LaTeXFormatter to the block to which formatting instructions and footers
     # can be added by calling methods on it.
     def to_latex(options = {})
-      fmt = LaTeXFormatter.new(self, options)
+      fmt = LaTeXFormatter.new(self, **options)
       yield fmt if block_given?
       fmt.output
     end
@@ -1400,7 +1421,7 @@ module FatTable
     # OrgFormatter to the block to which formatting instructions and footers can
     # be added by calling methods on it.
     def to_org(options = {})
-      fmt = OrgFormatter.new(self, options)
+      fmt = OrgFormatter.new(self, **options)
       yield fmt if block_given?
       fmt.output
     end
@@ -1413,7 +1434,7 @@ module FatTable
     # given, it yields a TermFormatter to the block to which formatting
     # instructions and footers can be added by calling methods on it.
     def to_term(options = {})
-      fmt = TermFormatter.new(self, options)
+      fmt = TermFormatter.new(self, **options)
       yield fmt if block_given?
       fmt.output
     end
@@ -1427,7 +1448,7 @@ module FatTable
     # footers can be added by calling methods on it.
     # @return [String]
     def to_text(options = {})
-      fmt = TextFormatter.new(self, options)
+      fmt = TextFormatter.new(self, **options)
       yield fmt if block_given?
       fmt.output
     end