tabularize 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+pkg/*
+*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in tabularize.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Junegunn Choi
+
+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,115 @@
+tabularize
+==========
+
+Formatting tabular data with paddings.
+Inspired by tabular.vim (https://github.com/godlygeek/tabular)
+
+Installation
+------------
+
+```
+gem install tabularize
+```
+
+Basic usage
+-----------
+
+### Formatting CSV data
+
+#### Sample data in CSV
+
+```
+Name|Dept|Location|Phone
+John Doe|Finance|Los Angeles, CA 90089|555-1555
+Average Joe|Engineering|Somewhere over the rainbow|N/A
+Hong Gildong|HR|Nowhere|555-5555
+```
+
+#### Tabularize.it
+
+```ruby
+require 'csv'
+require 'awesome_print'
+require 'tabularize'
+
+data = CSV.read 'test.csv', :col_sep => '|'
+ap data
+ap Tabularize.it(data).map { |row| row.join ' | ' }
+```
+
+#### Output
+
+```
+[
+    [0] [
+        [0] "Name",
+        [1] "Dept",
+        [2] "Location",
+        [3] "Phone"
+    ],
+    [1] [
+        [0] "John Doe",
+        [1] "Finance",
+        [2] "Los Angeles, CA 90089",
+        [3] "555-1555"
+    ],
+    [2] [
+        [0] "Average Joe",
+        [1] "Engineering",
+        [2] "Somewhere over the rainbow",
+        [3] "N/A"
+    ],
+    [3] [
+        [0] "Hong Gildong",
+        [1] "HR",
+        [2] "Nowhere",
+        [3] "555-5555"
+    ]
+]
+[
+    [0] "Name         | Dept        | Location                   | Phone   ",
+    [1] "John Doe     | Finance     | Los Angeles, CA 90089      | 555-1555",
+    [2] "Average Joe  | Engineering | Somewhere over the rainbow | N/A     ",
+    [3] "Hong Gildong | HR          | Nowhere                    | 555-5555"
+]
+```
+
+#### Alignments
+
+```ruby
+puts Tabularize.it(data, :align => :right).map { |row| row.join ' | ' }
+puts
+puts Tabularize.it(data, :align => :center).map { |row| row.join ' | ' }
+```
+
+```
+        Name |        Dept |                   Location |    Phone
+    John Doe |     Finance |      Los Angeles, CA 90089 | 555-1555
+ Average Joe | Engineering | Somewhere over the rainbow |      N/A
+Hong Gildong |          HR |                    Nowhere | 555-5555
+
+    Name     |    Dept     |          Location          |  Phone  
+  John Doe   |   Finance   |   Los Angeles, CA 90089    | 555-1555
+Average Joe  | Engineering | Somewhere over the rainbow |   N/A   
+Hong Gildong |     HR      |          Nowhere           | 555-5555
+```
+
+#### Padding with other characters
+
+```ruby
+puts Tabularize.it(data, :pad => '_').map { |row| row.join ' | ' }
+```
+
+```
+Name________ | Dept_______ | Location__________________ | Phone___
+John Doe____ | Finance____ | Los Angeles, CA 90089_____ | 555-1555
+Average Joe_ | Engineering | Somewhere over the rainbow | N/A_____
+Hong Gildong | HR_________ | Nowhere___________________ | 555-5555
+```
+
+Copyright
+---------
+
+Copyright (c) 2012 Junegunn Choi. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/lib/tabularize/version.rb

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

data/lib/tabularize.rb

@@ -0,0 +1,52 @@
+require "tabularize/version"
+
+module Tabularize
+  DEFAULT_OPTIONS = {
+    :pad => ' ',
+    :align => :left
+  }
+
+  # Formats two-dimensional tabular data.
+  # One-dimensional data (e.g. Array of Strings) is treated as tabular data 
+  # of which each row has only one column.
+  # @param [Enumerable] table_data
+  # @param [Hash] options Formatting options.
+  # @return [Array] Two-dimensional Array of formatted cells.
+  def self.it table_data, options = {}
+    raise ArgumentError.new("Not enumerable") unless 
+        table_data.respond_to?(:each)
+
+    options = DEFAULT_OPTIONS.merge(options)
+    pad     = options[:pad].to_s
+    align   = options[:align]
+    raise ArgumentError.new("Invalid alignment") unless pad.length == 1
+    raise ArgumentError.new("Invalid alignment") unless
+        [:left, :right, :center].include?(align)
+
+    rows       = []
+    max_widths = []
+    table_data.each do |row|
+      rows << row = [*row].map(&:to_s).map(&:chomp)
+
+      row.each_with_index do |cell, idx|
+        max_widths[idx] = [ cell.length, max_widths[idx] || 0 ].max
+      end
+    end
+
+    rows.map { |row| 
+      idx = -1
+      row.map { |str|
+        idx += 1
+        w = max_widths[idx]
+        case align
+        when :left
+          str.ljust(w, pad)
+        when :right
+          str.rjust(w, pad)
+        when :center
+          str.rjust((w - str.length) / 2 + str.length, pad).ljust(w, pad)
+        end
+      }
+    }
+  end
+end

data/tabularize.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tabularize/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tabularize"
+  s.version     = Tabularize::VERSION
+  s.authors     = ["Junegunn Choi"]
+  s.email       = ["junegunn.c@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Formatting tabular data}
+  s.description = %q{Formatting tabular data with paddings and alignments}
+
+  s.rubyforge_project = "tabularize"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "awesome_print"
+end

data/test/test.csv

@@ -0,0 +1,4 @@
+Name|Dept|Location|Phone
+John Doe|Finance|Los Angeles, CA 90089|555-1555
+Average Joe|Engineering|Somewhere over the rainbow|N/A
+Hong Gildong|HR|Nowhere|555-5555

data/test/test_tabularize.rb

@@ -0,0 +1,125 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :development)
+require 'test/unit'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'tabularize'
+require 'awesome_print'
+require 'csv'
+
+class TestTabularize < Test::Unit::TestCase
+  DATA0 = %w[a aa aaa aaaa aaaaa]
+  DATA1 = 
+    [
+      %w[a aa aaa aaaa],
+      %w[bbbb bbb bb b]
+    ]
+  DATA2 = 
+    [
+      %w[a aa aaa aaaa],
+      %w[cccccccccccccccccccc],
+      %w[ddd dddd d],
+      %w[bbbb bbb bb b]
+    ]
+  RESULT = {
+    DATA0 => {
+      :left => [
+        "a    ",
+        "aa   ",
+        "aaa  ",
+        "aaaa ",
+        "aaaaa",
+      ],
+      :right => [
+        "    a",
+        "   aa",
+        "  aaa",
+        " aaaa",
+        "aaaaa",
+      ],
+      :center => [
+        "  a  ",
+        " aa  ",
+        " aaa ",
+        "aaaa ",
+        "aaaaa",
+      ],
+    },
+    DATA1 => {
+      :left => 
+        [
+          "a   |aa |aaa|aaaa",
+          "bbbb|bbb|bb |b   "
+        ],
+      :right => 
+        [
+          "   a| aa|aaa|aaaa",
+          "bbbb|bbb| bb|   b"
+        ],
+      :center => 
+        [
+          " a  |aa |aaa|aaaa",
+          "bbbb|bbb|bb | b  "
+        ]
+    },
+    DATA2 => {
+      :left =>
+        [
+          "a                   |aa  |aaa|aaaa",
+          "cccccccccccccccccccc",
+          "ddd                 |dddd|d  ",
+          "bbbb                |bbb |bb |b   "
+        ],
+      :right =>
+        [
+          "                   a|  aa|aaa|aaaa",
+          "cccccccccccccccccccc",
+          "                 ddd|dddd|  d",
+          "                bbbb| bbb| bb|   b"
+        ],
+      :center =>
+        [
+          "         a          | aa |aaa|aaaa",
+          "cccccccccccccccccccc",
+          "        ddd         |dddd| d ",
+          "        bbbb        |bbb |bb | b  "
+        ]
+    }
+  }
+
+  def test_tabularize
+    data_lines = DATA0.join($/).lines
+    RESULT[data_lines] = RESULT[DATA0]
+    [DATA0, data_lines, DATA1, DATA2].each do |data|
+      [ '.', '_' ].each do |pad|
+        [:left, :right, :center].each do |align|
+          result = Tabularize.it(data, :pad => pad, :align => align)
+          ap :align => align, :pad => pad, :from => data, :to => result.map { |r| r.join('|') }
+          assert_equal RESULT[data][align], result.map { |row| row.join('|').gsub(pad, ' ') }
+        end
+      end
+    end
+  end
+
+  def test_tabularize_csv
+    data = CSV.read(File.join(File.dirname(__FILE__), 'test.csv'), :col_sep => '|')
+    ap data
+    output = Tabularize.it(data).map { |row| row.join ' | ' }
+    ap output
+    puts
+    puts output
+
+    puts Tabularize.it(data, :align => :right).map { |row| row.join ' | ' }
+    puts
+    puts Tabularize.it(data, :align => :center).map { |row| row.join ' | ' }
+    puts
+    puts Tabularize.it(data, :pad => '_').map { |row| row.join ' | ' }
+  end
+
+  def test_invalid_arguments
+    assert_raise(ArgumentError) { Tabularize.it(5) }
+    assert_raise(ArgumentError) { Tabularize.it("hello") }
+    assert_raise(ArgumentError) { Tabularize.it([1, 2, 3], :align => :noidea) }
+    assert_raise(ArgumentError) { Tabularize.it([1, 2, 3], :pad => 'long') }
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: tabularize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Junegunn Choi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: &2152636520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152636520
+description: Formatting tabular data with paddings and alignments
+email:
+- junegunn.c@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tabularize.rb
+- lib/tabularize/version.rb
+- tabularize.gemspec
+- test/test.csv
+- test/test_tabularize.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: tabularize
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Formatting tabular data
+test_files:
+- test/test.csv
+- test/test_tabularize.rb
+has_rdoc: