legitable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6086efaf0670225d0febbaad3691f73445ff490
-  data.tar.gz: 2728c004d3cec600a73ef0f94158271630a1f5b1
+  metadata.gz: a0d7c93628d9188236bb2776136a10588c7ebcdc
+  data.tar.gz: 58146b9e5cad0513d64f7ade289159f0a3542c37
 SHA512:
-  metadata.gz: ff2a9c168c2da2d4f6caaaf979308b41ae44d0f76764ad68a4e630affb537b33144eb58ea16e6c7afc62b7d166a34e1ae83f3484b526366bf8f8eee510a36fe6
-  data.tar.gz: 8978a1b77ffe9b5ee7b9664c8d4cc26e645c4d7151a9cca47037a49126bd19a40ea8b9985e7a75d92a0d678db42c7539f5721e6aad4b727e01e083fc4304e35e
+  metadata.gz: 5883537c12f133b7b83cfd8a1a8b08bbfb82448eae96249839b0470f9a6baeb3d4647952384aed2374988483c068851088d3d721b50b7deed71e000f46aa15ee
+  data.tar.gz: 66a66de7148ba6f287683dd7bf9d337c41d6a25ea3412cdff5c4078903d49cdacaed64288a776e53e6a7e33c10e10959abd6604c373f17ad134f9cee8cc62ee3

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 Gemfile.lock
+legitable*.gem

data/README.md

@@ -116,7 +116,7 @@ Which, of course, improves the display of the names column:
 And, of course, you can do something similar for the column headings:
 
 ```ruby
-title = Legitable::Table.new do
+table = Legitable::Table.new do
   formatting_headers do |header|
     header.capitalize
   end
@@ -131,6 +131,25 @@ Which makes the headers a little nicer:
     jj abrams   | 333-555-1212
 
 
+### Markdown Style
+
+Sometimes your tables end up in a markdown document.  Legitable is nice
+for plain text viewing, but the default table style is not quite legit
+as a markdown table.  You can fix that with the markdown style:
+
+```ruby
+table = Legitable::Table.new(style: :markdown)
+```
+
+The result is very similar, but adds the delimiter to the header
+separator, which causes it to render properly as markdown:
+
+    NAME        | PHONE       
+    ------------|-------------
+    joss whedon | 444-555-1212
+    jj abrams   | 333-555-1212
+
+
 ## Caveats
 
 It should be obvious that this utility pulls in all rows, and then

data/lib/legitable/table.rb

@@ -2,9 +2,9 @@ require 'ostruct'
 
 module Legitable
   class Table
-    attr_reader :rows, :headers, :delimiter, :separator, :format
+    attr_reader :rows, :headers, :delimiter, :separator, :format, :style
 
-    def initialize(alignment: {}, delimiter: ' | ', separator: '-', &block)
+    def initialize(alignment: {}, delimiter: ' | ', separator: '-', style: nil, &block)
       @rows = []
       @headers = []
       @format = {}
@@ -12,6 +12,12 @@ module Legitable
       @alignment = alignment
       @delimiter = delimiter
       @separator = separator
+      @style = style
+
+      if style == :markdown
+        @delimiter = ' | '
+        @separator = '-'
+      end
 
       self.instance_eval(&block) unless block.nil?
     end
@@ -23,12 +29,10 @@ module Legitable
     end
 
     def to_s
-      render_headers +
-      rows.map do |row|
-        headers.map do |header|
-          render_cell(header, row[header])
-        end.join(delimiter)
-      end.join("\n") + "\n"
+      <<-EOS
+#{render_headers}
+#{render_rows}
+      EOS
     end
 
     private
@@ -59,7 +63,7 @@ module Legitable
     def render_headers
       headers.map do |header|
         render_cell(header, header_formatter.call(header))
-      end.join(delimiter) + "\n" + (separator * row_width) + "\n"
+      end.join(delimiter) + "\n" + render_separator
     end
 
     def row_width
@@ -69,6 +73,24 @@ module Legitable
       end
     end
 
+    def render_rows
+      rows.map { |row| render_row(row) }.join("\n")
+    end
+
+    def render_row(row)
+      headers.map { |header| render_cell header, row[header] }.join(delimiter)
+    end
+
+    def render_separator
+      if style == :markdown
+        headers.map do |header|
+          separator * format[header].width
+        end.join('-|-')
+      else
+        separator * row_width
+      end
+    end
+
     def render_cell(header, value)
       cell_width = format[header].width
 
@@ -90,7 +112,11 @@ module Legitable
     end
 
     def header_formatter
-      @header_formatter ||= Proc.new {|header| header.to_s.upcase }
+      @header_formatter ||= default_header_formatter
+    end
+
+    def default_header_formatter
+      @default_header_formatter ||= Proc.new { |header| header.to_s.upcase }
     end
   end
 end

data/lib/legitable/version.rb

@@ -1,3 +1,3 @@
 module Legitable
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: legitable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joel Helbling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-12 00:00:00.000000000 Z
+date: 2018-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler