dashes 0.0.1

data/LICENSE.md

@@ -0,0 +1,23 @@
+Copyright (c) 2012, Hugh Bien
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list
+of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this
+list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,87 @@
+Description
+===========
+
+Dashline formats data into a dashboard of charts/tables on the command line.
+
+Installation
+============
+
+    $ gem install dashline
+
+Usage
+=====
+
+Making a table:
+
+    > table = Dashline::Table.new
+    > table.align :left, :right, :right  # :center is available too
+    > table.row 'Label', 'Num', 'Pct'
+    > table.separator
+    > table.row 'First', 1, 2
+    > table.row 'Second', 3, 4
+    > puts table.to_s
+    +--------+-----+-----+
+    | Label  | Num | Pct |
+    +--------+-----+-----+
+    | First  |   1 |   2 |
+    | Second |   3 |   4 |
+    +--------+-----+-----+
+
+Some display options for tables:
+
+    table.width(integer)
+    table.max_width(integer) # width takes priority
+    table.align(*alignments) # :left, :center, or :right
+    table.spacing(*spaces)   # :min or :max, :min means never pad the cell
+
+Making a chart:
+
+    > chart = Dashline::Chart.new
+    > chart.title 'Title'
+    > chart.row 'First', 7
+    > chart.row 'Second', 12
+    > chart.row 'Third', 2
+    > puts chart.to_s
+    +---------------------+
+    | Title               |
+    +---------------------+
+    |  First =======      |
+    | Second ============ |
+    |  Third ==           |
+    +---------------------+
+
+Some display options for charts:
+
+    chart.width(integer)
+    chart.max_width(integer) # width takes priority
+
+Combine tables and charts into a grid:
+
+    > grid = Dashline::Grid.new
+    > grid.width(30) # 80 is the default , use `tput cols`.to_i for max width
+    > grid.add table1
+    > grid.add chart1
+    > grid.add table2
+    > grid.add table3
+    > puts grid.to_s
+    +---+---+---+ +-----------+
+    | 1 | 1 | 1 | |   a ===== |
+    | 1 | 1 | 1 | |  bb ===   |
+    | 1 | 1 | 1 | +-----------+
+    +---+---+---+ +-----------+
+    | 3 | 3 | 3 | | 2 | 2 | 2 |
+    +---+---+---+ +---+---+---+
+
+Nodes (tables or charts) are added in a left-to-right, top-to-down order.
+The Grid class will fill in nodes as space allows.
+
+Development
+===========
+
+Tests are setup to run via `ruby test/*_test.rb` or via `rake`.
+
+License
+=======
+
+Copyright Hugh Bien - http://hughbien.com.
+Released under BSD License, see LICENSE.md for more info.

data/lib/dashes.rb

@@ -0,0 +1,260 @@
+require 'rubygems'
+
+module Dashes
+  VERSION = '0.0.1'
+
+  def self.clean(str)
+    str.to_s.
+      gsub(/\x1b(\[|\(|\))[;?0-9]*[0-9A-Za-z]/, '').
+      gsub(/\x1b(\[|\(|\))[;?0-9]*[0-9A-Za-z]/, '').
+      gsub(/(\x03|\x1a)/, '')
+  end
+
+  def self.strlen(str)
+    str.nil? ? 0 : clean(str).length
+  end
+
+  class Node
+    def width(width); raise NotImplementedError; end
+    def max_width(max_width); raise NotImplementedError; end
+    def to_s; raise NotImplementedError; end
+    def total_width; raise NotImplementedError; end
+
+    private
+    def cell(data, width, align=:left)
+      str = data.to_s
+      length = Dashes.strlen(str)
+      if length > width
+        str[0...width]
+      elsif align == :center
+        lpad = " " * ((width - length) / 2)
+        rpad = lpad.clone
+        lpad += " " if (width - length).odd?
+        lpad + str + rpad
+      else
+        pad = " " * (width - length)
+        align == :left ?
+          "#{str}#{pad}" :
+          "#{pad}#{str}"
+      end
+    end
+  end
+
+  class Table < Node
+    def initialize
+      @rows = []
+      @separators = []
+      @aligns = []
+      @width = nil
+      @max_width = nil
+      @spacing = nil
+    end
+
+    def row(*data)
+      @rows << data.map(&:to_s)
+    end
+
+    def separator
+      @separators << @rows.length
+    end
+
+    def align(*alignments)
+      @aligns = alignments
+    end
+
+    def width(width)
+      @width = width
+    end
+
+    def max_width(max_width)
+      @max_width = max_width
+    end
+
+    def spacing(*spacing)
+      @spacing = spacing
+    end
+
+    def to_s
+      return '' if @rows.empty?
+      widths = col_widths
+      format = []
+      separator = "+-#{widths.map {|w| '-'*w}.join('-+-')}-+"
+      format << separator
+      @rows.each_with_index do |row, index|
+        @separators.select { |s| s == index }.count.times { format << separator }
+        line = []
+        row.each_with_index do |data, col|
+          line << cell(data, widths[col], @aligns[col] || :left)
+        end
+        format << "| #{line.join(' | ')} |"
+      end
+      @separators.select { |s| s == @rows.length }.count.times { format << separator }
+      format << separator
+      format.join("\n")
+    end
+
+    def total_width
+      if @rows.empty?
+        0
+      elsif @width
+        @width
+      else
+        width = col_widths.reduce { |a,b| a+b }
+        cols = @rows.first.size
+        twidth = width + (2 * cols) + (cols + 1)
+        @max_width ? [twidth, @max_width].min : twidth
+      end
+    end
+
+    private
+    def col_widths
+      return [] if @rows.empty?
+      cols = @rows.first.size
+      widths = [0] * cols
+      (0...cols).map do |col|
+        @rows.each do |row|
+          widths[col] = [Dashes.strlen(row[col]), widths[col]].max
+        end
+      end
+      pad = (2 * cols) + (cols + 1) # cell padding/borders
+      sum = widths.reduce {|a,b| a+b} + pad
+      if sum == @width || (@width.nil? && (@max_width.nil? || sum <= @max_width))
+        widths
+      else
+        indexes = (0...cols).to_a
+        if @spacing && @spacing.uniq.length > 1
+          # which columns to spread the padding within
+          cols = @spacing.select { |s| s == :max }.length
+          indexes = @spacing.each_index.select { |i| @spacing[i] == :max }
+        end
+        twidth = @width || (@max_width ? [sum, @max_width].min : sum)
+        delta = twidth >= sum ? 1 : -1
+        pad = ((twidth - sum).abs / cols) * delta
+        uneven = (twidth - sum).abs % cols
+        indexes.each do |index|
+          widths[index] += pad
+          widths[index] += delta if index < uneven
+          widths[index] = 0 if widths[index] < 0
+        end
+        widths
+      end
+    end
+  end
+
+  class Chart < Node
+    def initialize
+      @title = nil
+      @rows = []
+      @width = nil
+      @max_width = nil
+    end
+
+    def title(title)
+      @title = title
+    end
+
+    def row(label, num)
+      @rows << [label, num]
+    end
+
+    def width(width)
+      @width = width
+    end
+
+    def max_width(max_width)
+      @max_width = max_width
+    end
+
+    def to_s
+      return '' if @rows.empty?
+      wbar, wlabel = bar_width, label_width
+      wtotal = total_width - 4 # 4 for side borders and padding
+      bar_space = wtotal - wlabel - 1
+      bar_ratio = wbar > bar_space ? bar_space/wbar.to_f : 1
+
+      separator = "+-#{'-'*wtotal}-+"
+      format = [separator]
+      if @title
+        format << "| #{cell(@title, wtotal)} |"
+        format << separator
+      end
+      @rows.each do |label, num|
+        bar = '=' * (num * bar_ratio).floor
+        format << "| #{cell(label, wlabel, :right)} #{cell(bar, bar_space)} |"
+      end
+      format << separator
+      format.join("\n")
+    end
+
+    def total_width
+      if @rows.empty?
+        0
+      elsif @width
+        @width
+      else
+        # 4 for borders/padding
+        twidth = [bar_width + label_width + 1, title_width].max + 4
+        @max_width ? [twidth, @max_width].min : twidth
+      end
+    end
+
+    private
+    def bar_width
+      @rows.map { |row| row[1] }.max
+    end
+
+    def label_width
+      @rows.map { |row| Dashes.strlen(row[0]) }.max
+    end
+
+    def title_width
+      Dashes.strlen(@title)
+    end
+  end
+
+  class Grid
+    def initialize
+      @nodes = []
+      @width = 80
+    end
+
+    def add(node)
+      @nodes << node
+    end
+
+    def width(width)
+      @width = width
+    end
+
+    def to_s
+      return '' if @nodes.empty?
+      buffer = []
+      node_width = [@nodes.map(&:total_width).max, @width].min
+      space_matcher = " "*(node_width+1) # 1 for padding
+      @nodes.each do |node|
+        node = node.clone
+        node.width(node_width)
+        if (index = buffer.index { |l| l.include?(space_matcher) }) 
+          # there's space for the table in a row, fit it in
+          col = Dashes.clean(buffer[index]) =~ Regexp.new(space_matcher)
+          node.to_s.split("\n").each do |line|
+            if buffer[index].nil?
+              buffer[index] = "#{" "*@width}"
+            end
+            new_line = col == 0 ?  "#{line} " : " #{line}"
+            # handle offset from special characters like color strings
+            pre_line = buffer[index].split(space_matcher).first.to_s
+            offset = pre_line.length - Dashes.clean(pre_line).length
+            buffer[index][col+offset..(col+node_width+offset)] = new_line
+            index += 1
+          end
+        else
+          # there's no more room, just add the table below
+          rpad = " "*(@width - node_width)
+          buffer += node.to_s.split("\n").map { |line| "#{line}#{rpad}" }
+        end
+      end
+      buffer.map(&:rstrip).join("\n")
+    end
+  end
+end

data/test/dashes_test.rb

@@ -0,0 +1,332 @@
+require File.expand_path('../lib/dashes', File.dirname(__FILE__))
+require 'minitest/autorun'
+
+class DashesTableTest < MiniTest::Unit::TestCase
+  def test_empty
+    table = Dashes::Table.new
+    assert_equal('', table.to_s)
+    assert_equal(0, table.total_width)
+  end
+
+  def test_cell
+    table = Dashes::Table.new
+    assert_equal("x", table.send(:cell, "x", 1))
+    assert_equal("xx", table.send(:cell, "xxxxx", 2))
+    assert_equal("x    ", table.send(:cell, "x", 5))
+  end
+
+  def test_cell_alignment
+    table = Dashes::Table.new
+    assert_equal("x  ", table.send(:cell, "x", 3, :left))
+    assert_equal(" x ", table.send(:cell, "x", 3, :center))
+    assert_equal("  x", table.send(:cell, "x", 3, :right))
+  end
+
+  def test_separators
+    table = Dashes::Table.new
+    table.separator
+    table.separator
+    table.row 'First', 'Second', 'Third'
+    table.separator
+    table.separator
+    table.row 1, 2, 3
+    table.separator
+    table.separator
+
+    assert_equal([5, 6, 5], table.send(:col_widths))
+    assert_equal(26, table.total_width)
+    assert_equal(
+      "+-------+--------+-------+\n" +
+      "+-------+--------+-------+\n" +
+      "+-------+--------+-------+\n" +
+      "| First | Second | Third |\n" +
+      "+-------+--------+-------+\n" +
+      "+-------+--------+-------+\n" +
+      "| 1     | 2      | 3     |\n" +
+      "+-------+--------+-------+\n" +
+      "+-------+--------+-------+\n" +
+      "+-------+--------+-------+",
+      table.to_s)
+  end
+
+  def test_alignment
+    table = Dashes::Table.new
+    table.align :left, :center, :right
+    table.row 'First', 'Second', 'Third'
+    table.separator
+    table.row 1, 2, 3
+    assert_equal(
+      "+-------+--------+-------+\n" +
+      "| First | Second | Third |\n" +
+      "+-------+--------+-------+\n" +
+      "| 1     |    2   |     3 |\n" +
+      "+-------+--------+-------+",
+      table.to_s)
+  end
+
+  def test_width
+    table = Dashes::Table.new
+    table.width 26
+    table.row '1', '2', '3'
+    assert_equal(26, table.total_width)
+    assert_equal(
+      "+--------+-------+-------+\n" +
+      "| 1      | 2     | 3     |\n" +
+      "+--------+-------+-------+",
+      table.to_s)
+
+    table.spacing :min, :min, :max
+    assert_equal(
+      "+---+---+----------------+\n" +
+      "| 1 | 2 | 3              |\n" +
+      "+---+---+----------------+",
+      table.to_s)
+
+    table.spacing :max, :max, :min
+    assert_equal(
+      "+----------+---------+---+\n" +
+      "| 1        | 2       | 3 |\n" +
+      "+----------+---------+---+",
+      table.to_s)
+
+    table.spacing :min, :min, :min
+    assert_equal(
+      "+--------+-------+-------+\n" +
+      "| 1      | 2     | 3     |\n" +
+      "+--------+-------+-------+",
+      table.to_s)
+
+    table.spacing :max, :max, :max
+    assert_equal(
+      "+--------+-------+-------+\n" +
+      "| 1      | 2     | 3     |\n" +
+      "+--------+-------+-------+",
+      table.to_s)
+  end
+
+  def test_max_width
+    table = Dashes::Table.new
+    table.max_width 26
+    table.row 'First', 'Second', 'Third'
+    table.row 1, 2, 3
+    assert_equal(
+      "+-------+--------+-------+\n" +
+      "| First | Second | Third |\n" +
+      "| 1     | 2      | 3     |\n" +
+      "+-------+--------+-------+",
+      table.to_s)
+
+    table.max_width 14
+    assert_equal(
+      "+---+----+---+\n" +
+      "| F | Se | T |\n" +
+      "| 1 | 2  | 3 |\n" +
+      "+---+----+---+",
+      table.to_s)
+
+    table.width 26 # width takes priority
+    assert_equal(
+      "+-------+--------+-------+\n" +
+      "| First | Second | Third |\n" +
+      "| 1     | 2      | 3     |\n" +
+      "+-------+--------+-------+",
+      table.to_s)
+  end
+end
+
+class DashesChartTest < MiniTest::Unit::TestCase
+  def test_empty
+    chart = Dashes::Chart.new
+    assert_equal('', chart.to_s)
+    assert_equal(0, chart.total_width)
+  end
+
+  def test_basic_chart
+    chart = Dashes::Chart.new
+    chart.title 'Title'
+    chart.row 'a', 20
+    chart.row 'bb', 15
+    chart.row 'ccc', 5
+    chart.row 'dddd', 1
+
+    assert_equal(
+      "+---------------------------+\n" +
+      "| Title                     |\n" +
+      "+---------------------------+\n" +
+      "|    a ==================== |\n" +
+      "|   bb ===============      |\n" +
+      "|  ccc =====                |\n" +
+      "| dddd =                    |\n" +
+      "+---------------------------+",
+      chart.to_s)
+  end
+
+  def test_normalized_width
+    chart = Dashes::Chart.new
+    chart.width(29)
+    chart.row 'a', 40
+    chart.row 'bb', 30
+    chart.row 'ccc', 10
+    chart.row 'dddd', 2
+    assert_equal(
+      "+---------------------------+\n" +
+      "|    a ==================== |\n" +
+      "|   bb ===============      |\n" +
+      "|  ccc =====                |\n" +
+      "| dddd =                    |\n" +
+      "+---------------------------+",
+      chart.to_s)
+  end
+
+  def test_max_width
+    chart = Dashes::Chart.new
+    chart.max_width(100)
+    chart.row 'a', 4
+    chart.row 'bb', 3
+    chart.row 'ccc', 2
+    chart.row 'dddd', 1
+    assert_equal(
+      "+-----------+\n" +
+      "|    a ==== |\n" +
+      "|   bb ===  |\n" +
+      "|  ccc ==   |\n" +
+      "| dddd =    |\n" +
+      "+-----------+",
+      chart.to_s)
+
+    chart2 = Dashes::Chart.new
+    chart2.max_width(13)
+    chart2.row 'a', 8
+    chart2.row 'bb', 6
+    chart2.row 'ccc', 4
+    chart2.row 'dddd', 2
+    assert_equal(
+      "+-----------+\n" +
+      "|    a ==== |\n" +
+      "|   bb ===  |\n" +
+      "|  ccc ==   |\n" +
+      "| dddd =    |\n" +
+      "+-----------+",
+      chart2.to_s)
+
+    chart2.width(17) # width should take priority
+    assert_equal(
+      "+---------------+\n" +
+      "|    a ======== |\n" +
+      "|   bb ======   |\n" +
+      "|  ccc ====     |\n" +
+      "| dddd ==       |\n" +
+      "+---------------+",
+      chart2.to_s)
+  end
+end
+
+class DashesGridTest < MiniTest::Unit::TestCase
+  def test_empty
+    grid = Dashes::Grid.new
+    assert_equal('', grid.to_s)
+
+    grid.add Dashes::Table.new
+    grid.add Dashes::Chart.new
+    assert_equal('', grid.to_s)
+  end
+
+  def test_basic_grid
+    table = Dashes::Table.new
+    table.row 'a', 'a', 'a'
+    table.separator
+    table.row 'a', 'a', 'a'
+    table.separator
+    table.row 'a', 'a', 'a'
+    table2 = Dashes::Table.new
+    table2.row 'b', 'b', 'b'
+    table3 = Dashes::Table.new
+    table3.row 'c', 'c', 'c'
+
+    grid = Dashes::Grid.new
+    grid.width 27
+    grid.add table
+    grid.add table2
+    grid.add table3
+
+    assert_equal(
+      "+---+---+---+ +---+---+---+\n" +
+      "| a | a | a | | b | b | b |\n" +
+      "+---+---+---+ +---+---+---+\n" +
+      "| a | a | a | +---+---+---+\n" +
+      "+---+---+---+ | c | c | c |\n" +
+      "| a | a | a | +---+---+---+\n" +
+      "+---+---+---+",
+      grid.to_s)
+
+    table4 = Dashes::Table.new
+    table4.row 'a', 'a', 'a'
+    table4.row 'a', 'a', 'a'
+    table4.row 'a', 'a', 'a'
+
+    grid2 = Dashes::Grid.new
+    grid2.width 27
+    grid2.add table4
+    grid2.add table3
+    grid2.add table2
+
+    assert_equal(
+      "+---+---+---+ +---+---+---+\n" +
+      "| a | a | a | | c | c | c |\n" +
+      "| a | a | a | +---+---+---+\n" +
+      "| a | a | a | +---+---+---+\n" +
+      "+---+---+---+ | b | b | b |\n" +
+      "              +---+---+---+",
+      grid2.to_s)
+  end
+
+  def test_mixed_grid
+    table = Dashes::Table.new
+    table.row 'a', 'a', 'a'
+    table.row 'a', 'a', 'a'
+    table.row 'a', 'a', 'a'
+
+    chart = Dashes::Chart.new
+    chart.row 'a', 5
+    chart.row 'bb', 3
+    chart.row 'ccc', 1
+
+    grid = Dashes::Grid.new
+    grid.add table
+    grid.add chart
+    assert_equal(
+      "+---+---+---+ +-----------+\n" +
+      "| a | a | a | |   a ===== |\n" +
+      "| a | a | a | |  bb ===   |\n" +
+      "| a | a | a | | ccc =     |\n" +
+      "+---+---+---+ +-----------+",
+      grid.to_s)
+  end
+
+  def test_alternating_grid
+    short = Dashes::Table.new
+    short.row 'a', 'a', 'a'
+
+    short2 = Dashes::Table.new
+    short2.row 'b', 'b', 'b'
+
+    long = Dashes::Table.new
+    long.row 'd', 'd', 'd'
+    long.row 'd', 'd', 'd'
+    long.row 'd', 'd', 'd'
+
+    grid = Dashes::Grid.new
+    grid.width(27)
+    grid.add short
+    grid.add long
+    grid.add short2
+    assert_equal(
+      "+---+---+---+ +---+---+---+\n" +
+      "| a | a | a | | d | d | d |\n" +
+      "+---+---+---+ | d | d | d |\n" +
+      "+---+---+---+ | d | d | d |\n" +
+      "| b | b | b | +---+---+---+\n" +
+      "+---+---+---+",
+      grid.to_s)
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: dashes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Hugh Bien
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: Format data into a dashboard of charts/tables on the command line.
+email:
+- hugh@hughbien.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/dashes.rb
+- test/dashes_test.rb
+homepage: https://github.com/hughbien/dashes
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Good looking charts for your terminal.
+test_files: []