ascii_table 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb6b0e8f1e8883e91e280970a4a75134b7e14fb8
+  data.tar.gz: 06c5af666a7641975c73b04fbd53c3efc1a9cbe1
+SHA512:
+  metadata.gz: ae1549f7b827d8d94e2de1269e3f8c9a2e055bd317b07e9d46b39a3676e4f85e98fa3c65e3e7384affc2ab125d748b785b1bbdea3b3f8d5757667e783c87d51c
+  data.tar.gz: 4df223cf10e81b60782ebb6bb63727173b9a59b103a088477499d097608441416143af4825fb07e57ee73862a5b3bdf7a072c967b2ccad3ff47dc27c856c65bb

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Peter Suschlik
+
+MIT License
+
+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,38 @@
+# AsciiTable
+
+Create ascii table from command line using [terminal-table](https://github.com/tj/terminal-table/)
+
+## Installation
+
+Install it yourself as:
+
+```shell
+gem install ascii_table
+```
+
+## Usage
+
+```shell
+$ ascii_table -h
+
+Message: Help!
+
+Usage: cat data.csv | ascii_table -H -d ";" [options]
+
+    -d, --delimiter DELIMITER        Delimiter. Default: ;
+    -H, --header                     First line is header. Default: no
+    -A, --table-align POSITION       Align all cells to POSITION. Default left
+    -a, --align COLUMN1=POSITION,... All specific cell to. Example 1=left,3=right,4=center
+    -s, --separator SEPARATOR        Add a separator. Default: empty line
+    -h, --help                       Help
+
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/neopoly/ascii_table/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+Rake::TestTask.new(:spec) do |test|
+  test.test_files = FileList.new('spec/**/*_spec.rb')
+  test.libs << 'spec'
+  test.verbose = true
+end
+
+task :default => :spec

data/ascii_table.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ascii_table/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ascii_table"
+  spec.version       = AsciiTable::VERSION
+  spec.authors       = ["Peter Suschlik"]
+  spec.email         = ["ps@neopoly.de"]
+  spec.summary       = %q{Create ascii table from command line}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/neopoly/ascii_table"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "terminal-table", "~> 1.4"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.5"
+end

data/bin/ascii_table

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'ascii_table'
+
+begin
+  puts AsciiTable.new(ARGV, STDIN)
+rescue AsciiTable::AbortError => e
+  puts e.message
+end

data/lib/ascii_table.rb

@@ -0,0 +1,126 @@
+require 'terminal-table'
+require 'optparse'
+require 'ostruct'
+
+class AsciiTable
+
+  class AbortError < StandardError; end
+
+  attr_reader :options, :table, :parser
+
+  DELIMITER_MAP = {
+    "t" => "\t",
+    "0" => "\0",
+    "v" => "\v",
+    "r" => "\r"
+  }
+
+  def initialize(args, reader)
+    @table  = nil
+    @parser = nil
+    @input  = []
+    # defaults
+    @options = OpenStruct.new(
+      :delimiter    => ";",
+      :headings     => false,
+      :table_align  => :left,
+      :cell_align   => {},
+      :separator    => ""
+    )
+
+    parse_options!(args)
+    read_input!(reader)
+  end
+
+  def to_s
+    generate_table! unless @table
+    @table.to_s
+  end
+
+  private
+
+  def generate_table!
+    @table = ::Terminal::Table.new
+    draw_header if @options.header
+    add_rows
+    align_rows
+  end
+
+  def draw_header
+    @table.headings = format_line(@input.shift)
+  end
+
+  def add_rows
+    @input.each do |line|
+      if @options.separator == line
+        @table.add_separator
+      else
+        @table.add_row format_line(line)
+      end
+    end
+  end
+
+  def align_rows
+    @table.number_of_columns.times do |i|
+      alignment = @options.cell_align[i + 1] || @options.table_align
+      @table.align_column(i, alignment)
+    end
+  end
+
+  def exit!(message)
+    message = "\nMessage: #{message}\n\n"
+    raise AbortError.new(message + @parser.help)
+  end
+
+  def format_line(line)
+    line.split(@options.delimiter)
+  end
+
+  def parse_options!(args)
+    OptionParser.new do |opts|
+      @parser = opts # HACK
+
+      opts.separator ""
+
+      opts.banner = %(Usage: cat data.csv | #{opts.program_name} -H -d ";" [options])
+
+      opts.on("-d", "--delimiter DELIMITER", "Delimiter. Default: ;") { |d| @options.delimiter = map_delimiter(d) }
+      opts.on("-H", "--header", "First line is header. Default: no") { @options.header = true }
+      opts.on("-A", "--table-align POSITION", "Align all cells to POSITION. Default left") { |a| @options.table_align = a.to_sym }
+      opts.on("-a", "--align COLUMN1=POSITION,...", "All specific cell to. Example 1=left,3=right,4=center") do |a|
+        a.split(/,/).each do |b|
+          column, position = b.split(/=/)
+          @options.cell_align[column.to_i] = position.to_sym
+        end
+      end
+      opts.on("-s", "--separator SEPARATOR", "Add a separator. Default: empty line") { |s| @options.separator = s }
+
+      opts.on("-h", "--help", "Help") { exit!("Help!") }
+
+      opts.separator ""
+    end
+
+    @parser.parse!(args)
+
+  rescue OptionParser::InvalidOption => e
+    exit!(e.message)
+  end
+
+  def map_delimiter(delimiter)
+    # TODO refactor
+    parts = delimiter.split(/\\/).reject { |part| part.empty? }.map do |part|
+      DELIMITER_MAP[part] || part
+    end
+    parts.join("")
+  end
+
+  def read_input!(reader)
+    exit!("Need input!") if reader.tty?
+
+    @input = reader.readlines.map { |l| l.chomp }
+
+    exit!("Empty input") if @input.empty?
+    exit!("Need rows!") if @options.header && @input.size == 1
+  end
+
+end

data/lib/ascii_table/version.rb

@@ -0,0 +1,3 @@
+class AsciiTable
+  VERSION = "0.9.0"
+end

data/spec/ascii_table_spec.rb

@@ -0,0 +1,161 @@
+require "spec_helper"
+
+describe AsciiTable do
+  describe "instance" do
+    describe "with default options" do
+      subject { ascii_table([]) }
+      let(:options) { subject.options }
+
+      it "has delimiter ;" do
+        assert_equal ";", options.delimiter
+      end
+
+      it "has no heading" do
+        assert_equal false, options.headings
+      end
+
+      it "has table aligment set to :left" do
+        assert_equal :left, options.table_align
+      end
+
+      it "has no cell aligments" do
+        assert_equal Hash.new, options.cell_align
+      end
+
+      it "has no separator" do
+        assert_equal "", options.separator
+      end
+    end
+
+    describe "parsing option" do
+      describe "help" do
+        it "parses short" do
+          assert_abort_with /Help/ do
+            ascii_table(%w(-h))
+          end
+        end
+
+        it "parses long" do
+          assert_abort_with /Help/ do
+            ascii_table(%w(---help))
+          end
+        end
+
+        it "help on invalid option" do
+          assert_abort_with /Help/ do
+            ascii_table(%w(---invalid-option))
+          end
+        end
+      end
+
+      describe "short" do
+        subject { ascii_table(%w(-d , -H -A right -a 1=left,2=right -s XXX)) }
+        let(:options) { subject.options }
+
+        it "parses delimiter" do
+          assert_equal ",", options.delimiter
+        end
+
+        it "parses header" do
+          assert_equal true, options.header
+        end
+
+        it "parses table_align" do
+          assert_equal :right, options.table_align
+        end
+
+        it "parses cell_align" do
+          assert_equal Hash[1 => :left, 2 => :right], options.cell_align
+        end
+
+        it "parses separator" do
+          assert_equal "XXX", options.separator
+        end
+      end
+
+      describe "long" do
+        subject { ascii_table(%w(--delimiter , --header --table-align right --align 1=left,2=right --separator XXX)) }
+        let(:options) { subject.options }
+
+        it "parses delimiter" do
+          assert_equal ",", options.delimiter
+        end
+
+        it "parses header" do
+          assert_equal true, options.header
+        end
+
+        it "parses table_align" do
+          assert_equal :right, options.table_align
+        end
+
+        it "parses cell_align" do
+          assert_equal Hash[1 => :left, 2 => :right], options.cell_align
+        end
+
+        it "parses separator" do
+          assert_equal "XXX", options.separator
+        end
+      end
+
+      describe "delimiter" do
+        attr_accessor :switches
+        subject { ascii_table(switches) }
+        let(:options) { subject.options }
+
+        it "parses tab" do
+          self.switches = %w(-d \t)
+          assert_equal "\t", options.delimiter
+        end
+
+        it "parses 2 tabs" do
+          self.switches = %w(-d \t\t)
+          assert_equal "\t\t", options.delimiter
+        end
+      end
+    end
+
+    describe "reading input" do
+      it "not bound to tty" do
+        assert_abort_with /Need input/ do
+          ascii_table([], FakeStdin[].tty!)
+        end
+      end
+
+      it "needs at least one row without headers" do
+        assert_abort_with /Empty input/ do
+          ascii_table([], FakeStdin[])
+        end
+      end
+
+      it "needs at least one row with header" do
+        assert_abort_with /Need rows/ do
+          ascii_table([%(-H)], FakeStdin[%w(a)])
+        end
+      end
+    end
+
+    describe "generating table" do
+      def self.generates(description, args, file)
+        it "generates #{description}" do
+          input = fixture("#{file}.csv")
+          expected = fixture("#{file}.txt").read.chomp
+
+          actual = ascii_table(args, input).to_s
+
+          assert_equal expected, actual
+        end
+      end
+
+      generates "without header", %w(), "without_header"
+      generates "with header", %w(-H), "with_header"
+      generates "with table_align", %w(-A right), "table_align"
+      generates "with cell_align", %w(-a 2=right,3=center,4=left), "cell_align"
+      generates "delimited", ["-d" "||"], "delimited"
+      generates "with tab delimited", ["-d", "\\t"], "tab_delimited"
+      generates "with separators", [], "separator"
+    end
+
+  end
+
+end

data/spec/fixtures/cell_align.csv

@@ -0,0 +1,3 @@
+xxxxxx;xxxxx;xxxxx;xxxxx
+aaa;bbb;ccc;dddd
+a;b;c;d

data/spec/fixtures/cell_align.txt

@@ -0,0 +1,5 @@
++--------+-------+-------+-------+
+| xxxxxx | xxxxx | xxxxx | xxxxx |
+| aaa    |   bbb |  ccc  | dddd  |
+| a      |     b |   c   | d     |
++--------+-------+-------+-------+

data/spec/fixtures/delimited.csv

@@ -0,0 +1,2 @@
+a||b
+c||d

data/spec/fixtures/delimited.txt

@@ -0,0 +1,4 @@
++---+---+
+| a | b |
+| c | d |
++---+---+

data/spec/fixtures/separator.csv

@@ -0,0 +1,5 @@
+1;2
+3;4
+5;6
+
+8;12

data/spec/fixtures/separator.txt

@@ -0,0 +1,7 @@
++---+----+
+| 1 | 2  |
+| 3 | 4  |
+| 5 | 6  |
++---+----+
+| 8 | 12 |
++---+----+

data/spec/fixtures/tab_delimited.csv

@@ -0,0 +1,2 @@
+a	b
+c	d

data/spec/fixtures/tab_delimited.txt

@@ -0,0 +1,4 @@
++---+---+
+| a | b |
+| c | d |
++---+---+

data/spec/fixtures/table_align.csv

@@ -0,0 +1,2 @@
+aaa;bbb
+c;d

data/spec/fixtures/table_align.txt

@@ -0,0 +1,4 @@
++-----+-----+
+| aaa | bbb |
+|   c |   d |
++-----+-----+

data/spec/fixtures/umlaute.csv

@@ -0,0 +1,2 @@
+Hätst
+world

data/spec/fixtures/with_header.csv

@@ -0,0 +1,2 @@
+a;b
+c;d

data/spec/fixtures/with_header.txt

@@ -0,0 +1,5 @@
++---+---+
+| a | b |
++---+---+
+| c | d |
++---+---+

data/spec/fixtures/without_header.csv

@@ -0,0 +1,2 @@
+a;b
+c;d

data/spec/fixtures/without_header.txt

@@ -0,0 +1,4 @@
++---+---+
+| a | b |
+| c | d |
++---+---+

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require "minitest/autorun"
+
+require "ascii_table"
+
+class FakeStdin < StringIO
+  def self.[](*args)
+    new(args.join("\n"))
+  end
+
+  def tty?
+    @tty ||= false
+  end
+
+  def tty!
+    @tty = true
+    self
+  end
+end
+
+Minitest::Spec.class_eval do
+  def ascii_table(args, stdin=FakeStdin[%w(a b)])
+    AsciiTable.new(Array(args), stdin)
+  end
+
+  def fixture(name)
+    name = File.join(File.dirname(__FILE__), "fixtures", name)
+    FakeStdin[File.read(name)]
+  end
+
+  def assert_abort_with(regexp)
+    e = assert_raises AsciiTable::AbortError do
+      yield
+    end
+    assert_match regexp, e.message
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: ascii_table
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Peter Suschlik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+description: Create ascii table from command line
+email:
+- ps@neopoly.de
+executables:
+- ascii_table
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ascii_table.gemspec
+- bin/ascii_table
+- lib/ascii_table.rb
+- lib/ascii_table/version.rb
+- spec/ascii_table_spec.rb
+- spec/fixtures/cell_align.csv
+- spec/fixtures/cell_align.txt
+- spec/fixtures/delimited.csv
+- spec/fixtures/delimited.txt
+- spec/fixtures/separator.csv
+- spec/fixtures/separator.txt
+- spec/fixtures/tab_delimited.csv
+- spec/fixtures/tab_delimited.txt
+- spec/fixtures/table_align.csv
+- spec/fixtures/table_align.txt
+- spec/fixtures/umlaute.csv
+- spec/fixtures/with_header.csv
+- spec/fixtures/with_header.txt
+- spec/fixtures/without_header.csv
+- spec/fixtures/without_header.txt
+- spec/spec_helper.rb
+homepage: https://github.com/neopoly/ascii_table
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Create ascii table from command line
+test_files:
+- spec/ascii_table_spec.rb
+- spec/fixtures/cell_align.csv
+- spec/fixtures/cell_align.txt
+- spec/fixtures/delimited.csv
+- spec/fixtures/delimited.txt
+- spec/fixtures/separator.csv
+- spec/fixtures/separator.txt
+- spec/fixtures/tab_delimited.csv
+- spec/fixtures/tab_delimited.txt
+- spec/fixtures/table_align.csv
+- spec/fixtures/table_align.txt
+- spec/fixtures/umlaute.csv
+- spec/fixtures/with_header.csv
+- spec/fixtures/with_header.txt
+- spec/fixtures/without_header.csv
+- spec/fixtures/without_header.txt
+- spec/spec_helper.rb