tablegen 0.1

data/lib/tablegen/column.rb

@@ -0,0 +1,87 @@
+# Instances of this class are created automatically by {TableGen#column TableGen#column}.
+class TableGen::Column
+  # The column's index.
+  #
+  # @return [Fixnum]
+  attr_reader :index
+
+  # The alignment of the row fields.
+  # Possible values:
+  # - :left
+  # - :center
+  # - :right
+  #
+  # (Defaults to *:left*)
+  #
+  # @return [Symbol]
+  # @see #header_alignment
+  attr_accessor :alignment
+
+  # Whether the column can be hidden to respect the table's width constraint.
+  # (Defaults to *false*)
+  #
+  # @return [Boolean]
+  attr_accessor :collapse
+
+  # The row formatter. The default block converts the original data to a {String}.
+  #
+  # @example Progress Bar
+  #   # formats 0.4 to [####      ]
+  #   column.format = proc {|fraction, width_hint|
+  #     fill_width = width_hint - 2 # bar borders
+  #     repeat = fraction * fill_width
+  #     "[%-#{fill_width}s]" % ['#' * repeat]
+  #   }
+  #   # works best with:
+  #   column.min_width = 12
+  #   column.stretch = true
+  #
+  # @param [Object] data whatever you passed to {TableGen#row}
+  # @param [Fixnum] width_hint
+  # @return [Proc]
+  attr_accessor :format
+
+  # The alignment of the header fields. Possible values:
+  # - :auto (row alignment)
+  # - :left
+  # - :center
+  # - :right
+  #
+  # (Defaults to *:auto*)
+  #
+  # @return [Symbol]
+  #
+  # @see #alignment
+  attr_accessor :header_alignment
+
+  # The column's minimum width (in characters).
+  # (Defaults to *0*)
+  #
+  # @return [Fixnum]
+  attr_accessor :min_width
+
+  # The field padding character.
+  # (Defaults to a space)
+  # 
+  # @return [String]
+  attr_accessor :padding
+
+  # Whether to stretch the column to fill the table's width constraint.
+  # (Defaults to *false*)
+  #
+  # @return [Boolean]
+  attr_accessor :stretch
+
+  # @api private
+  def initialize(index)
+    @index = index
+
+    @alignment = :left
+    @collapse = false
+    @format = proc {|data| data.to_s }
+    @header_alignment = :auto
+    @min_width = 0
+    @padding = "\x20"
+    @stretch = false
+  end
+end

data/lib/tablegen/version.rb

@@ -0,0 +1,3 @@
+class TableGen
+  VERSION = "0.1"
+end

data/tablegen.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path '../lib', __FILE__
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include? lib
+
+require 'tablegen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tablegen"
+  spec.version       = TableGen::VERSION
+  spec.authors       = ["cfi30"]
+  spec.email         = ["tablegen@cfillion.tk"]
+  spec.summary       = %q{plain text table generator}
+  spec.homepage      = "https://bitbucket.org/cfi30/tablegen"
+  spec.license       = "LGPL-3.0+"
+
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency 'minitest', '~> 5.4'
+  spec.add_development_dependency "rake"
+end

data/test/helper.rb

@@ -0,0 +1,2 @@
+require 'tablegen'
+require 'minitest/autorun'

data/test/test_table.rb

@@ -0,0 +1,516 @@
+require File.expand_path '../helper', __FILE__
+
+class TestTable < MiniTest::Test
+  def setup
+    @gen = TableGen.new
+  end
+
+  def test_row
+    assert_equal 0, @gen.height
+    assert_equal 0, @gen.real_height
+    assert_empty @gen.to_s
+
+    @gen.row 'test1', 'test2'
+    assert_equal 1, @gen.height
+    assert_equal 1, @gen.real_height
+
+    @gen.row 'test3', 'test4'
+    assert_equal 2, @gen.height
+    assert_equal 2, @gen.real_height
+
+    assert_equal \
+      'test1 test2' + $/ +
+      'test3 test4', @gen.to_s
+  end
+
+  def test_width
+    assert_equal 0, @gen.width
+    assert_equal 0, @gen.real_width
+
+    @gen.row 'test'
+
+    assert_equal 4, @gen.width
+    assert_equal 4, @gen.real_width
+
+    @gen.width = 100
+
+    assert_equal 100, @gen.width
+    assert_equal 4, @gen.real_width
+  end
+
+  def test_no_row
+    error = assert_raises ArgumentError do
+      @gen.row
+    end
+
+    assert_equal 'wrong number of arguments (0 for 1+)', error.message
+  end
+
+  def test_column
+    col = @gen.column 0
+    assert_equal :left, col.alignment
+    assert_equal false, col.collapse
+    assert_equal "\x20", col.padding
+    assert_equal :auto, col.header_alignment
+    assert_equal 0, col.min_width
+    assert_equal false, col.stretch
+    assert_equal 0, col.index
+
+    block_param = nil
+    @gen.column 0 do |col|
+      block_param = col
+    end
+    assert_equal col, block_param
+  end
+
+  def test_default_format
+    col = @gen.column 0
+
+    input = 'test'
+    assert_same input, col.format[input]
+
+    assert_equal '42', col.format[42]
+  end
+
+  def test_columns
+    block_params = []
+    @gen.columns 0, 1, 2, 3 do |col|
+      col.alignment = :left
+      block_params << col
+    end
+
+    cols = []
+    4.times {|i| cols << @gen.column(i) }
+
+    assert_equal cols, block_params
+  end
+
+  def test_clear
+    @gen.row 'test'
+
+    @gen.column 0 do |col|
+      col.padding = 'not cleared'
+    end
+
+    refute_equal 0, @gen.height
+    assert_equal 'not cleared', @gen.column(0).padding
+
+    @gen.clear
+
+    assert_equal 0, @gen.height
+    assert_equal 'not cleared', @gen.column(0).padding
+    assert_empty @gen.to_s
+  end
+
+  def test_clear!
+    @gen.row 'test'
+
+    @gen.column 0 do |col|
+      col.padding = 'cleared'
+    end
+
+    refute_equal 0, @gen.height
+    assert_equal 'cleared', @gen.column(0).padding
+
+    @gen.clear!
+
+    assert_empty @gen.to_s
+    assert_equal 0, @gen.height
+    refute_equal 'cleared', @gen.column(0).padding
+  end
+
+  def test_align_left
+    @gen.row 'long_text', 'short'
+    @gen.row 'short', 'long_text'
+
+    assert_equal \
+      'long_text short' + $/ +
+      'short     long_text', @gen.to_s
+  end
+
+  def test_align_right
+    @gen.row 'long_text', 'short'
+    @gen.row 'short', 'long_text'
+
+    col = @gen.column 1 do |col|
+      col.alignment = :right
+    end
+
+    assert_equal \
+      'long_text     short' + $/ +
+      'short     long_text', @gen.to_s
+  end
+
+  def test_align_center
+    @gen.row 'long_text', 'test'
+    @gen.row 'short', 'test'
+    @gen.row 'test', 'test'
+
+    col = @gen.column 0 do |col|
+      col.alignment = :center
+    end
+
+    assert_equal \
+      'long_text test' + $/ +
+      '  short   test' + $/ +
+      '  test    test', @gen.to_s
+  end
+
+  def test_align_other
+    @gen.row 'test'
+
+    col = @gen.column 0 do |col|
+      col.alignment = :top
+    end
+
+    error = assert_raises TableGen::Error do
+      @gen.to_s
+    end
+
+    assert_equal "invalid alignment 'top'", error.message
+  end
+
+  def test_align_cjk
+    @gen.row '新世界より', 'from'
+    @gen.row 'the', 'new world'
+
+    assert_equal \
+      '新世界より from' + $/ +
+      'the        new world', @gen.to_s
+  end
+
+  def test_custom_padding
+    @gen.row 'long_text', 'short'
+    @gen.row 'short', 'long_text'
+
+    @gen.column 0 do |col|
+      col.padding = '_'
+    end
+
+    @gen.column 1 do |col|
+      col.padding = '-='
+    end
+
+    assert_equal \
+      'long_text short----' + $/ +
+      'short____ long_text', @gen.to_s
+  end
+
+  def test_holes
+    @gen.row 'long_text', 'short'
+    @gen.row 'short'
+
+    assert_equal \
+      'long_text short' + $/ +
+      'short', @gen.to_s
+  end
+
+  def test_separator
+    @gen.separator '='
+    assert_equal '', @gen.to_s
+
+    @gen.row 'long_text', 'long_text'
+    @gen.row'short', 'short'
+    @gen.separator '-='
+
+    assert_equal \
+      '===================' + $/ +
+      'long_text long_text' + $/ +
+      'short     short' + $/ +
+      '-------------------', @gen.to_s
+  end
+
+  def test_separator_fixed_width
+    @gen.width = 100
+
+    assert_equal 0, @gen.height
+    @gen.separator '='
+    assert_equal 1, @gen.height
+
+    assert_equal '='*100, @gen.to_s
+  end
+
+  def test_custom_border
+    @gen.border = '-|-'
+    @gen.row 'long_text', 'short'
+    @gen.row 'short', 'long_text'
+
+    assert_equal \
+      'long_text-|-short' + $/ +
+      'short    -|-long_text', @gen.to_s
+  end
+
+  def test_custom_format
+    @gen.row 'test', 0.42
+    @gen.row 'test', 0.5678
+
+    sizes = []
+    @gen.column 1 do |col|
+      col.format = proc {|data, width|
+        sizes << width
+        "%d%%" % [data * 100]
+      }
+    end
+
+    assert_equal \
+      'test 42%' + $/ +
+      'test 56%', @gen.to_s
+
+    assert_equal [0, 3], sizes.uniq
+  end
+
+  def test_stretch
+    @gen.row 'test1', 'test2'
+    @gen.row 'test3', 'test4'
+
+    @gen.column 0 do |col|
+      col.stretch = true
+    end
+
+    assert_equal \
+      'test1 test2' + $/ +
+      'test3 test4', @gen.to_s
+
+    @gen.width = 20
+
+    assert_equal \
+      'test1          test2' + $/ +
+      'test3          test4', @gen.to_s
+  end
+
+  def test_stretch_long_border
+    @gen.row 'test1', 'test2'
+    @gen.row 'test3', 'test4'
+
+    @gen.column 0 do |col|
+      col.stretch = true
+    end
+
+    @gen.width = 20
+    @gen.border = '-||-'
+
+    assert_equal \
+      'test1      -||-test2' + $/ +
+      'test3      -||-test4', @gen.to_s
+  end
+
+  def test_stretch_format
+    @gen.row '-'
+    @gen.row '-', 'test'
+
+    sizes = []
+    @gen.column 0 do |col|
+      col.stretch = true
+      col.format = proc {|data, width|
+        sizes << width
+        data * width
+      }
+    end
+
+    @gen.width = 20
+
+    assert_equal \
+      '---------------' + $/ +
+      '--------------- test', @gen.to_s
+
+    assert_equal [0, 15], sizes.uniq
+  end
+
+  def test_multi_stretch
+    @gen.row 'test', 'test'
+
+    @gen.column 0 do |col|
+      col.stretch = true
+    end
+
+    @gen.column 1 do |col|
+      col.stretch = true
+    end
+
+    @gen.width = 20
+
+    assert_equal 'test            test', @gen.to_s
+  end
+
+  def test_table_outgrow
+    @gen.width = 2
+    @gen.row 'too long'
+
+    error = assert_raises TableGen::WidthError do
+      @gen.to_s
+    end
+
+    assert_equal 'insufficient width to generate the table', error.message
+  end
+
+  def test_stretch_outgrow
+    @gen.width = 2
+    @gen.row 'too long'
+
+    @gen.column 0 do |col|
+      col.stretch = true
+    end
+
+    error = assert_raises TableGen::WidthError do
+      @gen.to_s
+    end
+
+    assert_equal 'insufficient width to generate the table', error.message
+  end
+
+  def test_minimum_width
+    @gen.row 'long_text', 'short'
+    @gen.row 'short', 'long_text'
+
+    sizes = []
+    @gen.column 0 do |col|
+      col.min_width = 15
+      col.format = proc {|data, width|
+        sizes << width
+        data
+      }
+    end
+
+    assert_equal \
+      'long_text       short' + $/ +
+      'short           long_text', @gen.to_s
+    assert_equal [15], sizes.uniq
+  end
+
+  def test_collapse
+    @gen.row 'column1', 'col2', 'col3'
+
+    @gen.column 0 do |col|
+      col.collapse = true
+    end
+
+    @gen.column 2 do |col|
+      col.collapse = true
+    end
+
+    assert_equal 'column1 col2 col3', @gen.to_s
+
+    @gen.width = 4
+    assert_equal 'col2', @gen.to_s
+
+    @gen.width = 12
+    assert_equal 'column1 col2', @gen.to_s
+
+    @gen.width = 10
+    assert_equal 'col2 col3', @gen.to_s
+  end
+
+  def test_collapse_stretch
+    @gen.row 'col1', 'col2', 'col3'
+    @gen.column 1 do |col|
+      col.collapse = true
+      col.stretch = true
+    end
+
+    @gen.column 2 do |col|
+      col.stretch = true
+      col.alignment = :right
+    end
+
+    @gen.width = 12
+    assert_equal 'col1    col3', @gen.to_s
+  end
+
+  def test_unused_column
+    @gen.column 42
+    @gen.row 'test'
+    assert_equal 'test', @gen.to_s
+  end
+
+  def test_stretch_empty_column
+    @gen.column 0 do |col|
+      col.stretch = true
+    end
+
+    @gen.column 42
+    @gen.width = 15
+    @gen.row 'test1', 'test2'
+    assert_equal 'test1     test2', @gen.to_s
+  end
+
+  def test_header
+    @gen.column 0 do |col|
+      col.alignment = :right
+      col.format = proc {|data|
+        if data == 'long_text'
+          data
+        else
+          flunk 'format called'
+        end
+      }
+    end
+
+    @gen.header 'head'
+    @gen.row 'long_text'
+
+    assert_equal \
+      '     head' + $/ +
+      'long_text', @gen.to_s
+  end
+
+  def test_header_alignment
+    @gen.column 0 do |col|
+      col.alignment = :right
+      col.header_alignment = :left
+    end
+
+    @gen.header 'test1'
+    @gen.row 'long_text'
+    @gen.row 'test2'
+
+    assert_equal \
+      'test1' + $/ +
+      'long_text' + $/ +
+      '    test2', @gen.to_s
+  end
+
+  def test_text
+    assert_equal 0, @gen.height
+    @gen.text "Hello World!\x20\x20"
+
+    assert_equal 1, @gen.height
+    assert_equal 1, @gen.real_height
+    assert_equal 0, @gen.width
+    assert_equal 12, @gen.real_width
+    assert_equal 'Hello World!', @gen.to_s
+  end
+
+  def test_text_chunks
+    @gen.text 'long text!'
+    @gen.row '123'
+
+    assert_equal \
+      ['lon', 'g t', 'ext', '!'].join($/) + $/ +
+      '123', @gen.to_s
+
+    assert_equal 2, @gen.height
+    assert_equal 5, @gen.real_height
+  end
+
+  def test_mulitiline_text_chunks
+    @gen.text "long\ntext!"
+    @gen.width = 3
+
+    assert_equal ['lon', 'g', 'tex', 't!'].join($/), @gen.to_s
+
+    assert_equal 1, @gen.height
+    assert_equal 4, @gen.real_height
+  end
+
+  def test_empty_text
+    @gen.text ''
+    @gen.text '' # last line break is stripped from output
+
+    assert_equal 2, @gen.height
+    assert_equal 1, @gen.real_height
+    assert_equal 0, @gen.width
+    assert_equal 0, @gen.real_width
+
+    assert_equal $/, @gen.to_s
+  end
+end