tablify 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+tablify

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p327

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec"
+  gem "yard"
+  gem "rdoc"
+  gem "bundler"
+  gem "jeweler"
+  gem "simplecov"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Max Thom Stahl
+
+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,61 @@
+# tablify
+
+Ever want those super pretty old-school UNIX style tables in your program's
+output? Do you have tables or paragraphs you want to gussy up for a night on
+the town? Then Tablify is your jam. Use it.
+
+Make an array of hashes into something truly beautiful:
+
+    ruby> foo = [{foo: 1, bar: 2}, {foo: 11, bar: 22, baz: 42}, {foo: 111, bar: 222}]
+    ruby> puts Tablify(foo)
+    +-----+-----+-----+
+    | foo | bar | baz |
+    +-----+-----+-----+
+    |   1 |   2 |     |
+    |  11 |  22 |  42 |
+    | 111 | 222 |     |
+    +-----+-----+-----+
+
+What's that? You didn't want that `baz` column in there after all? Jam this
+into your input pipe and smoke it:
+
+    ruby> puts Tablify(foo).omit(:baz)
+    +-----+-----+
+    | foo | bar |
+    +-----+-----+
+    |   1 |   2 |
+    |  11 |  22 |
+    | 111 | 222 |
+    +-----+-----+
+
+or...
+
+    ruby> puts Tablify(foo).include(:foo, :bar)
+    +-----+-----+
+    | foo | bar |
+    +-----+-----+
+    |   1 |   2 |
+    |  11 |  22 |
+    | 111 | 222 |
+    +-----+-----+
+
+## Contributing to tablify
+ 
+  * Check out the latest master to make sure the feature hasn't been
+    implemented or the bug hasn't been fixed yet.
+  * Check out the issue tracker to make sure someone already hasn't requested
+    it and/or contributed it.
+  * Fork the project.
+  * Start a feature/bugfix branch.
+  * Commit and push until you are happy with your contribution.
+  * Make sure to add tests for it. This is important so I don't break it in a
+    future version unintentionally.
+  * Please try not to mess with the Rakefile, version, or history. If you want
+    to have your own version, or is otherwise necessary, that is fine, but
+    please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 Max Thom Stahl. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "tablify"
+  gem.homepage = "http://github.com/mstahl/tablify"
+  gem.license = "MIT"
+  gem.summary = %Q{Gussied up tables for your consoles.}
+  gem.description = %Q{Use Tablify to make prettier tabulated output in the console.}
+  gem.email = "max@villainousindustri.es"
+  gem.authors = ["max thom stahl"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/tablify.rb

@@ -0,0 +1,44 @@
+module Tablify
+  def self.table(array, opts = {})
+    headers = array.map(&:keys).flatten.uniq.sort
+
+    if opts[:include]
+      headers = headers & opts[:include]
+    end
+    if opts[:exclude]
+      headers = headers - opts[:exclude]
+    end
+
+    column_widths = headers.map(&:length)
+
+    array.each do |hash|
+      headers.each_with_index do |header, i|
+        l = hash[header].to_s.length
+        if l > column_widths[i]
+          column_widths[i] = l
+        end
+      end
+    end
+
+    lines = [horizontal_rule(column_widths)]
+    lines << aligned_row(headers, column_widths)
+    lines << horizontal_rule(column_widths)
+    array.each do |row|
+      row_elements = headers.map{|h| row[h]}
+      lines << aligned_row(row_elements, column_widths)
+    end
+    lines << horizontal_rule(column_widths)
+
+    lines.join("\n")
+  end
+
+  private
+
+  def self.aligned_row(row, widths)
+    "| " + (widths.map{|width| "%0#{width}s"}.join(" | ") % row) + " |"
+  end
+
+  def self.horizontal_rule(widths)
+    "+" + widths.map{|w| "-" * (w + 2)}.join("+") + "+"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'tablify'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/tablify_spec.rb

@@ -0,0 +1,151 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Tablify do
+  describe '::table' do
+
+    context 'with only an array argument, with no options specified' do
+      it 'should convert an array of hashes by itself into a table with alphabetized key columns' do
+        table = [
+          {
+            a: 1,
+            b: 2,
+            c: 3
+          }, {
+            a: 4,
+            b: 5,
+            c: 6
+          }, {
+            a: 7,
+            b: 8,
+            c: 9
+          }
+        ]
+
+        Tablify.table(table).strip.should == %{
++---+---+---+
+| a | b | c |
++---+---+---+
+| 1 | 2 | 3 |
+| 4 | 5 | 6 |
+| 7 | 8 | 9 |
++---+---+---+
+}.strip
+      end
+
+      it 'should convert an array of hashes when not all hashes contain all keys' do
+        table = [
+          {
+            a: 1,
+            c: 3
+          }, {
+            b: 5,
+          }, {
+            a: 7,
+            c: 9
+          }
+        ]
+
+        Tablify.table(table).strip.should == %{
++---+---+---+
+| a | b | c |
++---+---+---+
+| 1 |   | 3 |
+|   | 5 |   |
+| 7 |   | 9 |
++---+---+---+
+}.strip
+      end
+
+      it 'should throw an error if called on a non-enumerable' do
+        pending "Not implemented yet."
+      end
+
+      it 'should throw an error if called on an array that contains nil or non-Hash elements' do
+        pending "Not implemented yet."
+      end
+    end
+
+    context 'with :include specified' do
+      it 'should only include the columns specified with :include' do
+        table = [
+          {
+            a: 1,
+            b: 2,
+            c: 3
+          }, {
+            a: 4,
+            b: 5,
+            c: 6
+          }, {
+            a: 7,
+            b: 8,
+            c: 9
+          }
+        ]
+
+        Tablify.table(table, include: [:a, :c]).strip.should == %{
++---+---+
+| a | c |
++---+---+
+| 1 | 3 |
+| 4 | 6 |
+| 7 | 9 |
++---+---+
+}.strip
+      end
+
+      it 'should convert an array of hashes when not all hashes contain all keys' do
+        pending "Not implemented yet."
+      end
+    end
+
+    context 'with :exclude specified' do
+      it 'should only include the columns not specified with :exclude' do
+        table = [
+          {
+            a: 1,
+            b: 2,
+            c: 3
+          }, {
+            a: 4,
+            b: 5,
+            c: 6
+          }, {
+            a: 7,
+            b: 8,
+            c: 9
+          }
+        ]
+
+        Tablify.table(table, exclude: [:a]).strip.should == %{
++---+---+
+| b | c |
++---+---+
+| 2 | 3 |
+| 5 | 6 |
+| 8 | 9 |
++---+---+
+}.strip
+      end
+
+      it 'should convert an array of hashes when not all hashes contain all keys' do
+        pending "Not implemented yet."
+      end
+    end
+
+    context 'with :horizontal specified' do
+      it 'should convert an array of hashes, arranging their keys in the first column of a table' do
+        pending "Not implemented yet."
+      end
+
+      it 'should convert an array of hashes when not all hashes contain all keys' do
+        pending "Not implemented yet."
+      end
+    end
+
+  end
+
+  describe '::paragraph' do
+    pending "Not implemented yet."
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: tablify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- max thom stahl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use Tablify to make prettier tabulated output in the console.
+email: max@villainousindustri.es
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/tablify.rb
+- spec/spec_helper.rb
+- spec/tablify_spec.rb
+homepage: http://github.com/mstahl/tablify
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3072618796010270161
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Gussied up tables for your consoles.
+test_files: []