legitable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6086efaf0670225d0febbaad3691f73445ff490
+  data.tar.gz: 2728c004d3cec600a73ef0f94158271630a1f5b1
+SHA512:
+  metadata.gz: ff2a9c168c2da2d4f6caaaf979308b41ae44d0f76764ad68a4e630affb537b33144eb58ea16e6c7afc62b7d166a34e1ae83f3484b526366bf8f8eee510a36fe6
+  data.tar.gz: 8978a1b77ffe9b5ee7b9664c8d4cc26e645c4d7151a9cca47037a49126bd19a40ea8b9985e7a75d92a0d678db42c7539f5721e6aad4b727e01e083fc4304e35e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in legitable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Joel Helbling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,167 @@
+# Legitable
+
+Tables are easier to read.  Legitable makes it easy to display plain text output in tabular form.
+
+Given a normal series of hash objects as rows _(where "normal" means that all hashes have the same
+keys)_, the first row's keys will be taken as the table's column headers; deviations in subsequent
+hashes will be ignored.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'legitable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install legitable
+
+## Usage
+
+First, require it:
+
+```ruby
+require 'legitable'
+```
+
+Then, create a table object:
+
+```ruby
+table = Legitable::Table.new
+```
+
+Now add some rows:
+
+```ruby
+table << { name: 'joss whedon', phone: '444-555-1212' }
+table << { name: 'jj abrams', phone: '333-555-1212' }
+```
+
+And then you can display it:
+```ruby
+puts table.to_s
+```
+
+    NAME        | PHONE       
+    --------------------------
+    joss whedon | 444-555-1212
+    jj abrams   | 333-555-1212
+
+### Right-aligned columns
+
+Some data, such as numbers, look better aligned to the right instead
+of to the left:
+
+```ruby
+table = Legitable::Table.new(alignment: { bytes: :right })
+
+table << { bytes: 12, file: 'foo.zip' }
+table << { bytes: 1200, file: 'bar.zip' }
+table << { bytes: 12000000, file: 'baz.zip' }
+```
+
+Which makes the numbers much easier to read:
+
+       BYTES | FILE   
+    ------------------
+          12 | foo.zip
+        1200 | bar.zip
+    12000000 | baz.zip
+
+### Changing up the look
+
+Some aspects of the table are configurable, such as the column
+delimiter (which defaults to `" | "`) and the character used as
+a header row separator (which defaults to `"-"`).
+
+```ruby
+table = Legitable::Table.new(delimiter: '  ', separator: '=')
+```
+
+Which would give us this:
+
+
+    NAME         PHONE       
+    =========================
+    joss whedon  444-555-1212
+    jj abrams    333-555-1212
+
+### Formatting columns
+
+Sometimes the raw data as it comes in isn't exactly what you want
+to display.  So you can define formatters:
+
+```ruby
+title = Legitable::Table.new do
+  formatting :name do |value|
+    "_#{value.titleize}_"
+  end
+end
+```
+
+Which, of course, improves the display of the names column:
+
+
+    NAME          | PHONE       
+    ----------------------------
+    _Joss Whedon_ | 444-555-1212
+    _JJ Abrams_   | 333-555-1212
+
+And, of course, you can do something similar for the column headings:
+
+```ruby
+title = Legitable::Table.new do
+  formatting_headers do |header|
+    header.capitalize
+  end
+end
+```
+
+Which makes the headers a little nicer:
+
+    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
+displays them taking into account the widest values when determining
+the appropriate column width.  Accordingly, all rows to be processed
+will be in memory as long as the table object exists.  So this isn't
+a good tool for formatting a terrabyte of tabular data.
+
+The focus is on _display_ of data.  Think of a `Legitable::Table` as
+a _page_ of data.  If you have multiple pages of data, you'd probably
+want to repeat the headers anyway at some point, so it makes sense to
+just create a new table after every *n* rows.
+
+This puts me in mind of some ideas for the future:
+
+- ability to "flush" all rows so that the table's formatting can be
+  re-used and re-loaded.
+- ability to fix the width of a column and to word wrap within that
+  width in order to control the overall width of the table.
+- ANSI color support
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joelhelbling/legitable.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "legitable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/legitable.gemspec

@@ -0,0 +1,29 @@
+
+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.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.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  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 "rspec", "~> 3.7"
+  spec.add_development_dependency "rspec-given", "~> 3.8"
+  spec.add_development_dependency "pry", "~> 0.11"
+end

data/lib/legitable.rb

@@ -0,0 +1,2 @@
+require "legitable/version"
+require "legitable/table"

data/lib/legitable/table.rb

@@ -0,0 +1,96 @@
+require 'ostruct'
+
+module Legitable
+  class Table
+    attr_reader :rows, :headers, :delimiter, :separator, :format
+
+    def initialize(alignment: {}, delimiter: ' | ', separator: '-', &block)
+      @rows = []
+      @headers = []
+      @format = {}
+      @formatters = {}
+      @alignment = alignment
+      @delimiter = delimiter
+      @separator = separator
+
+      self.instance_eval(&block) unless block.nil?
+    end
+
+    def <<(row)
+      initialize_headers(row) if headers.empty?
+      add_row row
+      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"
+    end
+
+    private
+
+    def initialize_headers(row)
+      @headers = row.keys
+      headers.each do |header|
+        format[header] = OpenStruct.new(
+          width: header.to_s.length,
+          formatter: @formatters[header] || default_formatter,
+          align: @alignment[header] || :left
+        )
+      end
+    end
+
+    def add_row(row)
+      rows << headers.inject({}) do |memo, header|
+        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
+
+    def row_width
+      width = (headers.size - 1) * delimiter.length
+      headers.sum(width) do |header|
+        format[header].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))
+    end
+
+    def formatting(header, &block)
+      @formatters[header] = block ? block : default_formatter
+    end
+
+    def default_formatter
+      @default_formatter ||= Proc.new {|value| value.to_s }
+    end
+
+    def formatting_headers(&block)
+      @header_formatter = block
+    end
+
+    def header_formatter
+      @header_formatter ||= Proc.new {|header| header.to_s.upcase }
+    end
+  end
+end

data/lib/legitable/version.rb

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

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: legitable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Helbling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Tables are easier to read.  Legitable makes it easy to display plain
+  text output in tabular form.
+email:
+- joel@joelhelbling.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- legitable.gemspec
+- lib/legitable.rb
+- lib/legitable/table.rb
+- lib/legitable/version.rb
+homepage: https://github.com/joelhelbling/legitable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Easy plain text tables
+test_files: []