markdown-tables 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d81c56a6b5704f57fe1b02ecf891051306873b50
-  data.tar.gz: 78e3d1343aaadb46e5ea768b498960c73f1ea699
+  metadata.gz: ce5cc9285eabf5477a6520866af564cd1d8f90b6
+  data.tar.gz: 73042b5f303ff8d1c703a67d62244937206845f1
 SHA512:
-  metadata.gz: f31cc74738da99e034bfef0791247d24c7bba6425295c183f95cd2f4ff0928f78bfec11747ebb078c2de6d6cec314a4f8fdec350200458f0721120658dfcb0c5
-  data.tar.gz: 6295dd0283ae39e794cec164469114faa379331271c46ee364d8b7d4c9b88909a7bc8e28e0e5ec68ce78bac94264b2429fe20b49055872c52ba55ce24657b1e3
+  metadata.gz: 0d8a6a6fa9cd1029568c54c2e6da2d0145c5b06f6a9a0f68c9e09240bc0d3c6d4c26533d4c676a1f91385294893da1f6eab01e9affc0e6730e6c90079af52f54
+  data.tar.gz: 56ac0af7a9e34b01ae7f2dfb0a2dd7c285cb06f9d3a86434268d4299aad09346004074411c04eafd7edc16ddd7ef1572c5797b69588851f3eeec33906685280a

data/lib/markdown-tables.rb

@@ -1,89 +1,156 @@
-# Sanity checks for make_table.
-def validate(labels, data, align, is_rows)
-  if labels.class != Array
-    raise('labels must be an Array')
-  elsif data.class != Array || data.any? {|datum| datum.class != Array}
-    raise('data must be a two-dimensional array')
-  elsif labels.empty?
-    raise('No column labels given')
-  elsif data.empty?
-    raise('No columns given')
-  elsif data.all? {|datum| datum.empty?}
-    raise('No cells given')
-  elsif labels.any? {|label| !label.respond_to?(:to_s)}
-    raise('One or more column labels cannot be made into a string')
-  elsif data.any? {|datum| datum.any? {|cell| !cell.respond_to?(:to_s)}}
-    raise('One or more cells cannot be made into a string')
-  elsif ![String, Array].include?(align.class)
-    raise('align must be a String or Array')
-  elsif align.class == Array && align.any? {|val| val.class != String}
-    raise('One or more align values is not a String')
-  elsif !is_rows && data.length > labels.length
-    raise('Too many data columns given')
-  elsif is_rows && data.any? {|row| row.length > labels.length}
-    raise('One or more rows has too many cells')
+class MarkdownTables
+
+  # Generate a Markdown table.
+  # labels and data are one and two-dimensional arrays, respectively.
+  # All input must have a to_s method.
+  # Pass align: 'l' for left alignment or 'r' for right  alignment. Anything
+  # else will result in cells being centered. Pass an array of align values
+  # to specify alignment per column.
+  # If is_rows is true, then each sub-array represents a row.
+  # Conversely, if is_rows is false, each sub-array of data represents a column.
+  # Empty cells can be given with nil or an empty string.
+  def self.make_table(labels, data, align: '', is_rows: false)
+    labels = Marshal.load(Marshal.dump(labels))
+    data = Marshal.load(Marshal.dump(data))
+    validate(labels, data, align, is_rows)
+    sanitize!(labels, data)
+
+    header_line = labels.join('|')
+    alignment_line = alignment(align, labels.length)
+
+    if is_rows
+      rows = data.map {|row| row.join('|')}
+    else
+      max_len = data.map(&:size).max
+      rows = []
+      max_len.times do |i|
+        row = []
+        data.each {|col| row.push(col[i])}
+        rows.push(row.join('|'))
+      end
+    end
+
+    return [header_line, alignment_line, rows.join("\n")].join("\n")
   end
-end
 
-# Convert all input to strings and replace  any '|' characters  with
-# non-breaking equivalents,
-def sanitize!(labels, data)
-  bar = '|'  # Non-breaking HTML vertical bar.
-  labels.map! {|label| label.to_s.gsub('|', bar)}
-  data.length.times {|i| data[i].map! {|cell| cell.to_s.gsub('|', bar)}}
-end
+  # Convert a Markdown table into human-readable form.
+  def self.plain_text(md_table)
+    lines = md_table.split("\n")
+    labels = lines[0].split('|')
+    alignments = lines[1].split('|')
+    rows = lines[2..-1].map {|line| line.split('|')}
+
+    # Replace non-breaking HTML characters with their plaintext counterparts.
+    rows.each do |row|
+      row.each do |cell|
+        cell.gsub!(/( )|(|)/, ' ' => ' ', '|' => '|')
+      end
+    end
+
+    # Get the width for each column.
+    widths = labels.map(&:length)  # Lengths of each column's longest element.
+    rows.length.times do |i|
+      rows[i].length.times do |j|
+        rows[i][j].length > widths[j] && widths[j] = rows[i][j].length
+      end
+    end
+    widths.map! {|w| w + 2}  # Add padding on each side.
+
+    # Align the column labels.
+    labels.length.times do |i|
+      label_length = labels[i].length
+      start = align_cell(label_length, widths[i], alignments[i])
+
+      labels[i].prepend(' ' * start)
+      labels[i] += ' ' * (widths[i] - start - label_length)
+    end
 
-# Generate the alignment line from a string or array.
-# align must be a string or array or strings.
-# n: number of labels in the table to be created.
-def alignment(align, n)
-  if align.class == String
-    alignment = align == 'l' ? ':-' : align == 'r' ? '-:' : ':-:'
-    alignment_line = ([alignment] * n).join('|')
-  else
-    alignments = align.map {
-      |a| a.downcase == 'l' ? ':-' : a.downcase == 'r' ? '-:' : ':-l'
-    }
-    if alignments.length < n
-      alignments += [':-:'] * (n - alignments.length)
+    # Align the cells.
+    rows.each do |row|
+      row.length.times do |i|
+        cell_length = row[i].length
+        start = align_cell(cell_length, widths[i], alignments[i])
+        row[i].prepend(' ' * start)
+        row[i] += ' ' * (widths[i] - start - cell_length)
+      end
     end
-    alignment_line = alignments.join('|')
+
+    border = "\n|" + widths.map {|w| '=' * w}.join('|') + "|\n"
+    separator = border.gsub('=', '-')
+
+    table = border[1..-1]  # Don't include the first newline.
+    table += '|' + labels.join('|') + '|'
+    table += border
+    table += rows.map {|row| '|' + row.join('|') + '|'}.join(separator)
+    table += border
+
+    return table.chomp
   end
-  return alignment_line
-end
 
-# Generate a Markdown table.
-# labels and data are one and two-dimensional arrays, respectively.
-# All input must have a to_s method.
-# Pass align: 'l' for left alignment or 'r' for right  alignment. Anything
-# else will result in cells being centered. Pass an array of align values
-# to specify alignment per column.
-# If is_rows is true, then each sub-array represents a row.
-# Conversely, if is_rows is false, each sub-array of data represents a column.
-# Empty cells can be given with nil or an empty string.
-def make_table(labels, data, align: '', is_rows: false)
-  labels = Marshal.load(Marshal.dump(labels))
-  data = Marshal.load(Marshal.dump(data))
-  validate(labels, data, align, is_rows)
-  sanitize!(labels, data)
-
-  header_line = labels.join('|')
-  alignment_line = alignment(align, labels.length)
-
-  if is_rows
-    rows = data.map {|row| row.join('|')}
-  else
-    max_len = data.map(&:size).max
-    rows = []
-    max_len.times do |i|
-      row = []
-      data.each {|col| row.push(col[i])}
-      rows.push(row.join('|'))
+  # Sanity checks for make_table.
+  private_class_method def self.validate(labels, data, align, is_rows)
+    if labels.class != Array
+      raise('labels must be an Array')
+    elsif data.class != Array || data.any? {|datum| datum.class != Array}
+      raise('data must be a two-dimensional array')
+    elsif labels.empty?
+      raise('No column labels given')
+    elsif data.empty?
+      raise('No columns given')
+    elsif data.all? {|datum| datum.empty?}
+      raise('No cells given')
+    elsif labels.any? {|label| !label.respond_to?(:to_s)}
+      raise('One or more column labels cannot be made into a string')
+    elsif data.any? {|datum| datum.any? {|cell| !cell.respond_to?(:to_s)}}
+      raise('One or more cells cannot be made into a string')
+    elsif ![String, Array].include?(align.class)
+      raise('align must be a String or Array')
+    elsif align.class == Array && align.any? {|val| val.class != String}
+      raise('One or more align values is not a String')
+    elsif !is_rows && data.length > labels.length
+      raise('Too many data columns given')
+    elsif is_rows && data.any? {|row| row.length > labels.length}
+      raise('One or more rows has too many cells')
     end
   end
 
-  return [header_line, alignment_line, rows.join("\n")].join("\n")
-end
+  # Convert all input to strings and replace  any '|' characters  with
+  # non-breaking equivalents,
+  private_class_method def self.sanitize!(labels, data)
+    bar = '&#124;'  # Non-breaking HTML vertical bar.
+    labels.map! {|label| label.to_s.gsub('|', bar)}
+    data.length.times {|i| data[i].map! {|cell| cell.to_s.gsub('|', bar)}}
+  end
 
-# Print out a Markdown table in human-readable form.
-def print_table(table) end
+  # Generate the alignment line from a string or array.
+  # align must be a string or array or strings.
+  # n: number of labels in the table to be created.
+  private_class_method def self.alignment(align, n)
+    if align.class == String
+      alignment = align == 'l' ? ':-' : align == 'r' ? '-:' : ':-:'
+      alignment_line = ([alignment] * n).join('|')
+    else
+      alignments = align.map {
+        |a| a.downcase == 'l' ? ':-' : a.downcase == 'r' ? '-:' : ':-:'
+      }
+      if alignments.length < n
+        alignments += [':-:'] * (n - alignments.length)
+      end
+      alignment_line = alignments.join('|')
+    end
+    return alignment_line
+  end
+
+  # Get the starting index of a cell's text from the text's length, the cell's
+  # width, and the alignment.
+  private_class_method def self.align_cell(length, width, align)
+    if align =~ /:-+:/
+      return (width / 2) - (length / 2)
+    elsif align =~ /-+:/
+      return width - length - 1
+    else
+      return 1
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markdown-tables
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Chris de Graaf
@@ -29,7 +29,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -40,5 +40,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Utilities for creating and displaying Markdown tables in Ruby
+summary: Utilities for creating and displaying Markdown tables in Ruby.
 test_files: []