text_layout 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.1.0 / 2011-09-14
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+lib/text_layout/table.rb
+lib/text_layout/wrap.rb
+lib/text_layout.rb
+Manifest.txt
+Rakefile
+README.rdoc
+test/test_text_layout.rb

data/README.rdoc

@@ -0,0 +1,83 @@
+= text_layout
+
+* http://github.com/nanki/text_layout
+
+== DESCRIPTION:
+
+Text layout engine for CUI apps.
+
+== FEATURES/PROBLEMS:
+
+* Full-width character support.
+* Line wrapping.
+* Table layout with colspan and rowspan.
+
+== SYNOPSIS:
+
+    # (from http://en.wikipedia.org/wiki/MacBook_Air)
+    table = [
+      [{:colspan => 6, :value => "Table of models"}],
+      ["Model", "Early 2008", "Late 2008", "Mid 2009", "Late 2010", "Mid 2011"],
+      ["Model Identifier", "MacBookAir1,1", {:colspan=>2, :value => "MacBookAir2,1"}, "MacBookAir3,1(11\")\nMacBookAir3,2(13\")", "MacBookAir4,1(11\")\nMacBookAir4,2(13\")"],
+      ["Model number", "MB003LL/A", "MB543LL/A\nMB940LL/A", "MC233LL/A\nMC234LL/A", "MC505LL/A\nMC503LL/A", "MC968ZP/A\nMC969ZP/A\nMC965ZP/A\nMC966ZP/A"],
+      [{:rowspan => 2, :value => "Battery"}, {:colspan => 3, :value => "N/A"}, {:colspan => 2, :value => "35Wh(11\")"}],
+      [{:colspan => 2, :value => "37Wh(13\")"}, "40Wh(13\")", {:colspan => 2, :value => "50Wh(13\")"}]
+    ]
+
+    puts TextLayout::Table.new(table).layout
+
+    ---
+
+    |                                                                                    Table of models |
+    |            Model |    Early 2008 | Late 2008 |  Mid 2009 |          Late 2010 |           Mid 2011 |
+    | Model Identifier | MacBookAir1,1 |         MacBookAir2,1 | MacBookAir3,1(11") | MacBookAir4,1(11") |
+    |                  |               |                       | MacBookAir3,2(13") | MacBookAir4,2(13") |
+    |     Model number |     MB003LL/A | MB543LL/A | MC233LL/A |          MC505LL/A |          MC968ZP/A |
+    |                  |               | MB940LL/A | MC234LL/A |          MC503LL/A |          MC969ZP/A |
+    |                  |               |           |           |                    |          MC965ZP/A |
+    |                  |               |           |           |                    |          MC966ZP/A |
+    |          Battery |                                   N/A |                               35Wh(11") |
+    |                  |                 37Wh(13") | 40Wh(13") |                               50Wh(13") |
+
+
+== REQUIREMENTS:
+
+* unicode-display_width
+
+== INSTALL:
+
+* $ gem install text_layout
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 FIX
+
+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/Rakefile

@@ -0,0 +1,11 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'text_layout' do
+  developer('nanki', 'nanki@dotswitch.net')
+  extra_deps << ['unicode-display_width']
+end
+
+# vim: syntax=ruby

data/lib/text_layout.rb

@@ -0,0 +1,8 @@
+require 'unicode/display_width'
+
+module TextLayout
+  VERSION = '0.1.0'
+
+  autoload :Wrap, 'text_layout/wrap'
+  autoload :Table, 'text_layout/table'
+end

data/lib/text_layout/table.rb

@@ -0,0 +1,138 @@
+class TextLayout::Table
+  def initialize(array)
+    @array = array
+  end
+
+  def normalize(cell)
+    unless Hash === cell
+      cell = {:value => cell}
+    end
+
+    cell[:value] = cell[:value].to_s.lines.map(&:strip)
+    cell
+  end
+
+  class Cell < Struct.new(:col, :row, :attr)
+    def width
+      attr[:value].map(&:display_width).max
+    end
+
+    def height
+      attr[:value].size
+    end
+  end
+  
+  class Span < Cell
+    def main?(col, row)
+      self.col == col && self.row == row
+    end
+  end
+
+  def layout
+    spanss = {:row => Hash.new{[]}, :col => Hash.new{[]}}
+    layout = @array.map{[]}
+
+    @array.each_with_index do |cols, row|
+      cols.each_with_index do |attr, col|
+        attr = normalize(attr)
+
+        unless col = layout[row].index(nil)
+          col = layout[row].size
+        end
+
+        if !attr[:rowspan] && !attr[:colspan]
+          layout[row][col] = Cell.new(col, row, attr)
+        else
+          span = Span.new(col, row, attr)
+          spanss[:row][row...row+attr[:rowspan]] <<= span if attr[:rowspan]
+          spanss[:col][col...col+attr[:colspan]] <<= span if attr[:colspan]
+          
+          (attr[:rowspan] || 1).times do |rr|
+            (attr[:colspan] || 1).times do |cc|
+              layout[row+rr][col+cc] = span
+            end
+          end
+        end
+      end
+    end
+
+    max = {:row => [], :col => []}
+
+    layout.each_with_index do |cols, row|
+      cols.each_with_index do |cell, col|
+        next if Span === cell && !cell.main?(col, row)
+
+        unless cell.attr[:colspan]
+          max[:col][col] = [max[:col][col] || 0, cell.width].max
+        end
+        
+        unless cell.attr[:rowspan]
+          max[:row][row] = [max[:row][row] || 0, cell.height].max
+        end
+      end
+    end
+
+    [[:col, 3], [:row, 0]].each do |dir, margin|
+      spanss[dir].each do |range, spans|
+        range_size = range.end - range.begin
+        spans.each do |span|
+          size = sum(max[dir][range]) + margin * (range_size - 1)
+          diff = (dir == :col ? span.width : span.height) - size
+
+          next unless diff > 0
+          q, r = diff.divmod range_size 
+          range.each_with_index do |i, rr|
+            max[dir][i] += q + (rr < r ? 1 : 0)
+          end
+        end
+      end
+    end
+
+    result = ""
+    sum(max[:row]).times do |layout_row|
+      n = layout_row
+      row = max[:row].each_with_index do |height, i|
+        if n - height >= 0
+          n -= height
+        else
+          break i 
+        end
+      end
+
+      line = []
+      layout[row].each_with_index do |cell, col|
+        next unless cell.col == col
+        n = layout_row - sum(max[:row][0...cell.row])
+        width = 
+          if Span === cell && colspan = cell.attr[:colspan]
+            sum(max[:col][col...col+colspan]) + 3 * (colspan - 1)
+          else
+            max[:col][col]
+          end
+
+        line << justify(cell.attr[:value][n].to_s, width)
+      end
+
+      result += "| " + line.join(" | ") + " |\n"
+    end
+
+    result
+  end
+
+  def sum(array)
+    array.inject(0) {|r, i| r + i }
+  end
+
+  def justify(str, width, type=:right)
+    pad = width - str.display_width
+    pad = 0 if pad < 0 
+    case type
+    when :right
+      " " * pad + str
+    when :left
+      str + " " * pad
+    when :center
+      " " * (pad / 2) + str + " " * (pad - pad / 2)
+    end
+  end
+end

data/lib/text_layout/wrap.rb

@@ -0,0 +1,51 @@
+class TextLayout::Wrap
+  def initialize(str)
+    @str = str
+  end
+
+  def layout(width=80)
+    raise "width must be greater than 1" if width < 2
+    words = @str.scan(/[[:alnum:]]+|./)
+
+    lines = []
+    line = ''
+    while word = words.shift
+      word.lstrip! if line.empty?
+      rest_width = width - line.display_width
+
+      if word.display_width <= rest_width
+        line += word
+        flush = line.display_width == width
+      else
+        word, rest = split_word(word, rest_width - 1)
+        line += word + "-" unless word.empty?
+        words.unshift rest
+        flush = true
+      end
+
+      if flush
+        lines << line
+        line = ''
+      end
+    end
+
+    lines << line
+
+    lines.pop if lines.last.empty?
+
+    lines.join("\n")
+  end
+
+  private
+  def split_word(word, width)
+    if word.display_width < width
+      [word, ''] 
+    else
+      i, dw = 0, 0
+      chars = word.chars.to_a
+      dw += chars[i += 1].display_width while dw < width
+      i -= 1 if dw > width
+      [chars[0...i].join, chars[i..-1].join]
+    end
+  end
+end

data/test/test_text_layout.rb

@@ -0,0 +1,61 @@
+$: << '../lib';require 'rubygems';$KCODE = 'u'
+require "test/unit"
+require "text_layout"
+
+class TestTextLayout < Test::Unit::TestCase
+  def test_wrap_private
+    wrap = TextLayout::Wrap.new("")
+    assert_equal %w(linew rap), wrap.send(:split_word, "linewrap", 5)
+    assert_equal %w(あい うえ), wrap.send(:split_word, "あいうえ", 5)
+  end
+
+  def test_wrap
+    assert_equal (["+"*20] * 4).join("\n"), TextLayout::Wrap.new("+"*80).layout(20)
+    assert_equal "line-\nwrap", TextLayout::Wrap.new("linewrap").layout(5)
+  end
+
+  def test_table_simple
+    assert_table [
+      [1, 2],
+      [3, 4]
+    ], <<-RESULT
+| 1 | 2 |
+| 3 | 4 |
+    RESULT
+  end
+
+  def test_table_multipleline
+    assert_table [
+      ["1\n2", 2],
+      [3, 4]
+    ], <<-RESULT
+| 1 | 2 |
+| 2 |   |
+| 3 | 4 |
+    RESULT
+  end
+
+  def test_table_span
+    assert_table [
+      [{:value => 1, :rowspan => 2}, 2, 3],
+      [{:value => 4, :colspan => 2}]
+    ], <<-RESULT
+| 1 | 2 | 3 |
+|   |     4 |
+    RESULT
+  end
+
+  def test_expand_multicolumn
+    assert_table [
+      [1, 2, 3],
+      [4, {:value => "too loooooong", :colspan => 2}]
+    ], <<-RESULT
+| 1 |     2 |     3 |
+| 4 | too loooooong |
+    RESULT
+  end
+
+  def assert_table(array, result)
+    assert_equal result, TextLayout::Table.new(array).layout
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: text_layout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- nanki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unicode-display_width
+  requirement: &70131146946840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70131146946840
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &70131146946300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: *70131146946300
+description: ''
+email:
+- nanki@dotswitch.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+files:
+- History.txt
+- lib/text_layout/table.rb
+- lib/text_layout/wrap.rb
+- lib/text_layout.rb
+- Manifest.txt
+- Rakefile
+- README.rdoc
+- test/test_text_layout.rb
+- .gemtest
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.txt
+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: text_layout
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- test/test_text_layout.rb