legitable 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d6086efaf0670225d0febbaad3691f73445ff490
-  data.tar.gz: 2728c004d3cec600a73ef0f94158271630a1f5b1
+SHA256:
+  metadata.gz: f3691facd3a9d75752074edc878b8b4a838a448057786b0fc63e743dd1c7d779
+  data.tar.gz: b4376d57b9cf0d17cf00821fcc47a9769dd6c4f4962f6140f1b44c0f85ff5dbc
 SHA512:
-  metadata.gz: ff2a9c168c2da2d4f6caaaf979308b41ae44d0f76764ad68a4e630affb537b33144eb58ea16e6c7afc62b7d166a34e1ae83f3484b526366bf8f8eee510a36fe6
-  data.tar.gz: 8978a1b77ffe9b5ee7b9664c8d4cc26e645c4d7151a9cca47037a49126bd19a40ea8b9985e7a75d92a0d678db42c7539f5721e6aad4b727e01e083fc4304e35e
+  metadata.gz: a8683049e85e94342dc26f77642f2023ab58dcfd0ae481e11d2f3bd70fb4e31b61ed518e79c035dc9f1d3a3a45cdfce1b35092636ea97b29b67eb148b5742289
+  data.tar.gz: f8db001d5bda976b36b2d93be151434fb988224c2a6aeb16c9d1b12d893db9da203e4e9b7a59898df4e17d68a105ca888e5d91b0358b7e0dbd973c6d8bccc83a

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "10:00"
+  open-pull-requests-limit: 10

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

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

data/README.md

@@ -1,3 +1,4 @@
+![Tests](https://github.com/joelhelbling/legitable/actions/workflows/ruby.yml/badge.svg)
 # Legitable
 
 Tables are easier to read.  Legitable makes it easy to display plain text output in tabular form.
@@ -116,7 +117,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 +132,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/legitable.gemspec

@@ -1,28 +1,27 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "legitable/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "legitable"
-  spec.version       = Legitable::VERSION
-  spec.authors       = ["Joel Helbling"]
-  spec.email         = ["joel@joelhelbling.com"]
+  spec.name = "legitable"
+  spec.version = Legitable::VERSION
+  spec.authors = ["Joel Helbling"]
+  spec.email = ["joel@joelhelbling.com"]
 
-  spec.summary       = %q{Easy plain text tables}
-  spec.description   = %q{Tables are easier to read.  Legitable makes it easy to display plain text output in tabular form.}
-  spec.homepage      = "https://github.com/joelhelbling/legitable"
-  spec.license       = "MIT"
+  spec.summary = "Easy plain text tables"
+  spec.description = "Tables are easier to read.  Legitable makes it easy to display plain text output in tabular form."
+  spec.homepage = "https://github.com/joelhelbling/legitable"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|\.vim.*|\.rspec.*)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16.a"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.2.rc"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.7"
   spec.add_development_dependency "rspec-given", "~> 3.8"
   spec.add_development_dependency "pry", "~> 0.11"

data/lib/legitable/table.rb

@@ -1,10 +1,10 @@
-require 'ostruct'
+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,23 +12,34 @@ module Legitable
       @alignment = alignment
       @delimiter = delimiter
       @separator = separator
+      @style = style
 
-      self.instance_eval(&block) unless block.nil?
+      if style == :markdown
+        @delimiter = " | "
+        @separator = "-"
+      end
+
+      instance_eval(&block) unless block.nil?
     end
 
-    def <<(row)
-      initialize_headers(row) if headers.empty?
-      add_row row
+    def <<(data)
+      case data
+      when Array
+        data.each { |row| self << row }
+      when Hash
+        initialize_headers(data) if headers.empty?
+        add_row data
+      when Enumerable
+        data.each { |row| self << row }
+      end
       self
     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
@@ -45,21 +56,20 @@ module Legitable
     end
 
     def add_row(row)
-      rows << headers.inject({}) do |memo, header|
+      rows << headers.each_with_object({}) do |header, memo|
         formatter = format[header].formatter
         value = formatter.call(row[header].to_s).to_s
         if format[header].width < value.length
           format[header].width = value.length
         end
         memo[header] = value
-        memo
       end
     end
 
     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,20 +79,38 @@ 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
 
-      (format[header].align == :right) ?
-        value.rjust(cell_width, ' ') :
-        value.to_s + (' ' * (cell_width - value.to_s.length))
+      format[header].align == :right ?
+        value.rjust(cell_width, " ") :
+        value.to_s + (" " * (cell_width - value.to_s.length))
     end
 
     def formatting(header, &block)
-      @formatters[header] = block ? block : default_formatter
+      @formatters[header] = block || default_formatter
     end
 
     def default_formatter
-      @default_formatter ||= Proc.new {|value| value.to_s }
+      @default_formatter ||= proc { |value| value.to_s }
     end
 
     def formatting_headers(&block)
@@ -90,7 +118,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 { |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.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: legitable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Joel Helbling
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-12-12 00:00:00.000000000 Z
+date: 2022-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.a
+        version: 2.2.rc
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.a
+        version: 2.2.rc
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -88,9 +88,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -105,7 +106,7 @@ homepage: https://github.com/joelhelbling/legitable
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,9 +121,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Easy plain text tables
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.2
-before_install: gem install bundler -v 1.16.0.pre.3