tablegen 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57a14ccba33ed27298a35cbe25625d55d837b6e2
+  data.tar.gz: 0f0a6c29b6761d162d459d64a919008f9cf6aaaf
+SHA512:
+  metadata.gz: 480697a91c71dff89565c3d65a9a813e83c17f457c1e42e18c795cfb14dc395939a0b4e2a642694be0b952870f1847bdbca425b8556cc042558294d1365d5b15
+  data.tar.gz: ab342a58c97afd5156a670df6eca9ed71c73213ce8128bd5789fe4b543497d4ab3a917de54188bd82411bcc3cac042763985654c94af39ce3de019093f1058b2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,91 @@
+# Table Generator
+
+Plain text table generator for ruby.
+
+Main features:
+
+- Choose column/header alignment (left, center or right)
+- CJK characters support
+- Embed progress bars (example in the documentation)
+- Insert text in the table
+- Minimum column length
+- Optional size constraint
+- Per column data formatter (data is separated from the layout)
+- Scale down large tables with collapsible columns
+- Scale up small tables with stretchable columns
+- Unlimited border length
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tablegen'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tablegen
+
+## Documentation
+
+The documentation is hosted at
+[http://rubydoc.info/gems/tablegen/TableGen](http://rubydoc.info/gems/tablegen/TableGen).
+
+## Basic Usage
+
+```ruby
+require 'tablegen'
+
+table = TableGen.new
+table.header 'Browser Name', 'Layout Engine', 'License'
+table.separator
+table.row 'Chromium', 'Blink', 'BSD'
+table.row 'dwb', 'WebKit', 'GNU GPLv3'
+table.row 'Internet Explorer', 'Trident', 'Proprietary'
+table.row 'Mozilla Firefox', 'Gecko', 'MPL'
+puts table
+```
+
+Output:
+
+```text
+Browser Name      Layout Engine License
+===========================================
+Chromium          Blink         BSD
+dwb               WebKit        GNU GPLv3
+Internet Explorer Trident       Proprietary
+Mozilla Firefox   Gecko         MPL
+```
+
+Set the size constraint and stretch the first column:
+
+```ruby
+table.width = 50
+table.column 0 do |col|
+  col.stretch = true
+end
+puts table
+```
+
+Output:
+
+```text
+Browser Name             Layout Engine License
+==================================================
+Chromium                 Blink         BSD
+dwb                      WebKit        GNU GPLv3
+Internet Explorer        Trident       Proprietary
+Mozilla Firefox          Gecko         MPL
+```
+
+## Contributing
+
+1. [Fork it](https://bitbucket.org/cfi30/tablegen/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Test your changes (`rake`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => [:test]
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/helper.rb', 'test/test_*.rb']
+end

data/lib/tablegen.rb

@@ -0,0 +1,368 @@
+require 'tablegen/version'
+
+# TableGen is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+class TableGen
+  require 'tablegen/column'
+
+  # Base class for exceptions.
+  class Error < RuntimeError; end
+
+  # Raised when the table cannot respect the width constraint.
+  class WidthError < Error; end
+
+  # @api private
+  Header = Struct.new \
+    :name
+
+  # @api private
+  Line = Struct.new \
+    :type,
+    :data
+
+  # @attribute border [rw] The column separator.
+  #   May be of any length. Defaults to a space.
+  #
+  #   @return [String]
+  attr_accessor :border
+  attr_writer   :width
+
+  def initialize
+    @border = "\x20"
+    @columns = []
+    @lines = []
+    @collapsed = []
+  end
+
+  # Yields and returns the column at the specified index.
+  #
+  # @example Change the alignment of the first column
+  #   table.column 0 do |col|
+  #     col.alignment = :right
+  #   end
+  #
+  # @param index [Fixnum]
+  # @yield [Column column] the requested column
+  # @return [Column] the requested column
+  #
+  # @see #columns
+  # @see Column
+  def column(index)
+    unless col = @columns[index]
+      if @columns.count < index
+        # create columns so the holes are not filled with nil
+        (@columns.count..index).each {|i| column i }
+      end
+
+      col = Column.new index
+      @columns[index] = col
+    end
+
+    yield col if block_given?
+    col
+  end
+
+  # Shorthand to {#column}: Yields specified columns.
+  #
+  # @example Allow columns 6 and 8 to be collapsed
+  #   table.columns 6, 8 do |col|
+  #     col.collapse = true
+  #   end
+  #
+  # @param [Array<Fixnum>] indexes
+  # @yield [Column column] a column from the index list
+  #
+  # @see #column
+  # @see Column
+  def columns(*indexes, &block)
+    indexes.each {|index|
+      column index, &block
+    }
+  end
+
+  # Add a row to the table. The fields are formatted with {Column#format}.
+  #
+  # @example
+  #   table.column 2 do |col|
+  #     col.format = proc {|price|
+  #       "$%.2f" % price
+  #     }
+  #   end
+  #
+  #   # Product Name, Quantity, Price
+  #   table.row 'Table Generator', 42, 0
+  #
+  # @param [Array<Object>] fields
+  # @raise [ArgumentError] at least one field is required
+  #
+  # @see #header
+  def row(*fields)
+    raise ArgumentError, 'wrong number of arguments (0 for 1+)' if fields.empty?
+    @lines << Line.new(:row, fields)
+  end
+
+  # Add a header row to the table. The fields are not formatted.
+  #
+  # @example
+  #   table.header 'Product Name', 'Quantity', 'Price'
+  #
+  # @param [Array<String>] fields
+  # @raise [ArgumentError] at least one field is required
+  #
+  # @see #row
+  def header(*fields)
+    row *fields.map {|name| Header.new name }
+  end
+
+  # Add a separator to the table.
+  #
+  # @param [String] char the character to repeat
+  def separator(char = '=')
+    @lines << Line.new(:separator, char)
+  end
+
+  # Add a text line to the table.
+  # The text is wrapped automatically to fit into the table.
+  #
+  # @param line [String]
+  def text(line)
+    @lines << Line.new(:text, line)
+  end
+
+  # Empty the table. Columns settings are conserved.
+  #
+  # @see #clear!
+  def clear
+    @lines.clear
+  end
+
+  # Empty the table AND delete the columns.
+  #
+  # @see #clear
+  def clear!
+    clear
+    @columns.clear
+  end
+
+  # The maximum width (in characters) of the table.
+  # If unspecified (nil), returns the space required to display every row and header.
+  #
+  # @example Fit the table in the terminal
+  #   if STDOUT.tty?
+  #     table.width = STDOUT.winsize[1]
+  #   end
+  #
+  # @return [Fixnum]
+  #
+  # @see #real_width
+  def width
+    return @width unless @width.nil?
+
+    width = 0
+    rows.each {|row|
+      format = format_row row.data
+      length = real_length format
+      width = [width, length].max
+    }
+    width
+  end
+
+  # Calculates the exact width (in characters) of the entire table.
+  #
+  # @return [Fixnum]
+  #
+  # @see #width
+  def real_width
+    to_s.each_line.map {|l| real_length l.chomp }.max || 0
+  end
+
+  # The minimum height (in lines) of the table.
+  # @note Does not calculate wrapped text lines. If required, use {#real_height} instead.
+  #
+  # @!attribute [r] height
+  # @return [Fixnum]
+  #
+  # @see #real_height
+  def height
+    @lines.count
+  end
+
+  # Calculates the exact height (in lines) of the table.
+  #
+  # @return [Fixnum]
+  #
+  # @see #height
+  def real_height
+    to_s.lines.count
+  end
+
+  # Generate the table.
+  #
+  #   begin
+  #     puts table
+  #   rescue TableGen::WidthError
+  #     puts 'Terminal is too small'
+  #   end
+  #
+  # @return [String] the table
+  # @raise [WidthError] if the table is too large to fit in the {#width} constraint
+  # @raise [Error] if something is wrong (eg. invalid column alignment)
+  def to_s
+    create_columns
+
+    table = ''
+    @collapsed.clear
+
+    loop do
+      table, missing_width = generate_table
+      break if missing_width == 0
+
+      candidates = []
+      @columns.each_with_index {|col, index|
+        if col.collapse && !@collapsed.include?(index)
+          candidates << index
+        end
+      }
+
+      if candidates.empty?
+        raise WidthError, "insufficient width to generate the table"
+      end
+
+      @collapsed << candidates.min_by {|index|
+        (column_width(index, false) - missing_width).abs
+      }
+    end
+
+    table
+  end
+
+  private
+  def rows
+    @lines.select {|l| l.type == :row }
+  end
+
+  def real_length(string)
+    doublesize = string.scan(/\p{Han}|\p{Katakana}|\p{Hiragana}|\p{Hangul}/).count
+    string.length + doublesize
+  end
+
+  def format_row(fields)
+    out = ''
+
+    fields.each_with_index {|data, index|
+      next if @collapsed.include? index
+      col = column index
+
+      width = column_width index
+      field = format_field(col, data, width)
+      length = real_length field
+
+      pad_width = width - length
+      padding = col.padding[0] * pad_width
+
+      alignment = if data.is_a?(Header) && col.header_alignment != :auto
+        col.header_alignment
+      else
+        col.alignment
+      end
+
+      out += @border unless out.empty?
+      out += \
+      case alignment
+      when :left
+        field + padding
+      when :right
+        padding + field
+      when :center
+        left = pad_width / 2
+        right = left + (pad_width % 2)
+        padding[0...left] + field + padding[0...right]
+      else
+        raise Error, "invalid alignment '%s'" % col.alignment
+      end
+    }
+    out
+  end
+
+  def column_width(index, can_stretch = true)
+    col = column index
+
+    stretch_index = @columns.find_index {|c|
+      c.stretch && !@collapsed.include?(@columns.index(c))
+    }
+
+    if can_stretch && index == stretch_index && @width
+      used_width = 0
+      @columns.each_with_index {|dist_col, dist_index|
+        next if dist_index == stretch_index || @collapsed.include?(dist_index)
+
+        dist_width = column_width(dist_index, false)
+        next if dist_width.nil?
+
+        used_width += dist_width
+        used_width += real_length @border
+      }
+
+      remaining_width = @width - used_width
+      needed_width = column_width index, false
+      [remaining_width, needed_width].max
+    else
+      sizes = []
+      rows.each {|row|
+        data = row.data[index]
+        next unless data
+
+        length = real_length format_field(col, data, col.min_width)
+        sizes << [col.min_width, length].max
+      }
+      sizes.max
+    end
+  end
+
+  def format_field(column, data, width)
+    if data.is_a? Header
+      data.name
+    else
+      column.format[data, width]
+    end
+  end
+
+  def create_columns
+    rows.each {|row|
+      # creates all columns up to the specified index
+      column row.data.count - 1
+    }
+  end
+
+  def generate_table
+    table = ''
+    missing_width = [0]
+
+    @lines.each {|line|
+      out = case line.type
+      when :row
+        format_row line.data
+      when :separator
+        line.data[0] * width
+      when :text
+        if width > 0
+          line.data.scan(/.{1,#{width}}/).join $/
+        else
+          line.data
+        end
+      end
+      out.rstrip!
+
+      if line.type == :row
+        line_length = real_length out
+        missing_width << line_length - @width if @width
+      end
+
+      table += out + $/
+    }
+
+    return table.chomp, missing_width.max
+  end
+end