visual_width 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4de483063c67cddbaca1f3ac3a1ac27536311218
-  data.tar.gz: 3d9ab9b361e41e1edc9d2f095c28a3591e72cfbb
+  metadata.gz: 970d02ea37970eae029eb5078fd36eb85e662d9e
+  data.tar.gz: 619d3e14f123e4c9858b9328731209d8fe2f5efd
 SHA512:
-  metadata.gz: fd041e918922cf48e5686b8d9d7c4417b8bbde49c11fa65f6f2d3c6783f0afccd6f41397d2aae6b75f94ed3cdba3e3fbdd04901433df06ee1ee935ed724b68e0
-  data.tar.gz: 40a336d2d2e0e2b919109744910a17cb2860dfe13e59c69c7766c3707f65a614e8226402c1bbf5711953f81a154f1022c3c7e8df7bc93b76755d54fcd429f815
+  metadata.gz: 1c531f47569a9c8c4b616be2cf20d6f5bbc8235f61f07ae1e04f02f83863858e47efc73c44d73c5357c51711159c7d4158e2d3e09651ce95d9036e58402ca864
+  data.tar.gz: b2b573865cb4e4ec041f2bc12e5344ac01636dec1a3198273cd1dbf2ba5eb6c723216f436d7d5b72f0ff4e2b6c39677ca69699527a3949bb589343bdf1133cfb

data/.rspec

@@ -1,2 +1 @@
 --color
---format doc

data/Changes

@@ -1,4 +1,7 @@
 This is a revision history of visual_width gem.
 
+0.0.2 2013-10-26 08:51:02+0900
+    - Added visual_width/table.rb to draw text tables
+
 0.0.1 2013-10-24 00:22:53+0900
     - This is the initial release of visual_width

data/README.md

@@ -20,35 +20,48 @@ Or install it yourself as:
 
 ## Usage
 
-```ruby
-    # VisualWidth
-    require 'visual_width'
+## `visual_width`:
 
+```ruby
     p VisualWidth.measure("こんにちは") # => 10
     p VisualWidth.measure("abcdefghij") # => 10
 
     p VisualWidth.truncate("恋すてふ 我が名はまだき 立ちにけり 人知れずこそ 思ひそめしか", 20) # => "恋すてふ 我が名は..."
+```
+
+`.measure()` and `truncate()` methods takes `east_asian: false` option to tell it is not in an East Asian context, regarding ambiguous characters as half-width.
+See [Ambiguous Characters](http://www.unicode.org/reports/tr11/#Ambiguous) in the report.
 
-    # VisualWidth::Table
+## `visual_width/table`:
+
+```ruby
     require 'visual_width/table'
 
     t = VisualWidth::Table.new(
-      format: [VisualWidth::Table::LEFT, VisualWidth::Table::RIGHT, VisualWidth::Table::RIGHT]
+      style: [
+        { align: :center, width:  8 },
+        { align: :center, width:  8 },
+        { align: :right,  width:  5 },
+      ],
     )
 
-    header = ['Student', 'Mid-Terms', 'Finals']
+    header = ['Nick', 'FullName', 'Age']
     rows = [
-      ['Sam', 94, 93],
-      ['Jane', 92, 99],
-      ['Average', 93, 96],
+      ['カネダ', '金田 正太郎', 17],
+      ['テツオ', '島 鉄雄', 16],
+      ['ケイ', '?', 18],
     ]
-    t.draw(rows, header: header)
+    puts t.render(rows, header: header)
+    # +--------+--------+-----+
+    # |  Nick  |FullName| Age |
+    # +--------+--------+-----+
+    # | カネダ |金田 正 |   17|
+    # |        |  太郎  |     |
+    # | テツオ |島 鉄雄 |   16|
+    # |  ケイ  |   ?    |   18|
+    # +--------+--------+-----+
 ```
 
-Each method can take `east_asian: false` to tell it is not in an East Asian context, regarding ambiguous characters as half-width.
-
-See [Ambiguous Characters](http://www.unicode.org/reports/tr11/#Ambiguous) in the report.
-
 ## Contributing
 
 1. Fork it
@@ -60,3 +73,4 @@ See [Ambiguous Characters](http://www.unicode.org/reports/tr11/#Ambiguous) in th
 ## See Also
 
 * [unicode-display_width](https://rubygems.org/gems/unicode-display_width) has the same feature as `VisualWidth.measure()` but it extends String class directly and is much slower than `VisualWidth.measure()`
+* [terminal-table](https://rubygems.org/gems/terminal-table) renders text table, but it cannot deal with East Asian Width characters

data/example/table.rb

@@ -1,13 +1,17 @@
 # VisualWidth::Table
 require 'visual_width/table'
 t = VisualWidth::Table.new(
-  format: [VisualWidth::Table::LEFT, VisualWidth::Table::RIGHT, VisualWidth::Table::RIGHT]
+  style: [
+    { align: :center, width:  8 },
+    { align: :center, width:  8 },
+    { align: :right,  width:  5 },
+  ],
 )
 
-header = ['Student', 'Mid-Terms', 'Finals']
+header = ['Nick', 'FullName', 'Age']
 rows = [
-  ['Sam', 94, 93],
-  ['Jane', 92, 99],
-  ['Average', 93, 96],
+  ['カネダ', '金田 正太郎', 17],
+  ['テツオ', '島 鉄雄', 16],
+  ['ケイ', '?', 18],
 ]
-puts t.draw(rows, header: header)
+puts t.render(rows, header: header)

data/lib/visual_width.rb

@@ -29,25 +29,36 @@ module VisualWidth
     (full_width * 2) + (str.length - full_width)
   end
 
-  def truncate(str, max_length, omission: '...', east_asian: EAST_ASIAN)
+  def each_width(str, max_width, east_asian: EAST_ASIAN) # requires block
     rx = east_asian ? @@t1 : @@t0
-    max = max_length - omission.length
     pos = 0
     width = 0
     str.scan(rx) do |wide,|
       width += wide ? 2 : 1
-
-      break if width > max
-
       pos += 1
 
-      break if width == max
+      next_char = str[pos]
+      next_char_width = next_char ? measure(next_char, east_asian: east_asian) : 0
+      if (width + next_char_width) > max_width
+        yield str.slice(0, pos)
+        str = str.slice(pos, str.length)
+        pos = 0
+        width = 0
+      end
     end
+    if str.length > 0
+      yield str
+    end
+  end
 
-    if width < str.length
-      str.slice(0, pos) + omission
-    else
-      str
+  def truncate(str, max_length, omission: '...', east_asian: EAST_ASIAN)
+    max = max_length - omission.length
+    each_width(str, max, east_asian: east_asian) do |line|
+      if line.length == str.length
+        return line
+      else
+        return line + omission
+      end
     end
   end
 end

data/lib/visual_width/formatter.rb

@@ -0,0 +1,34 @@
+require 'visual_width'
+
+module VisualWidth::Formatter
+  class Align
+    def left(cell, width)
+      align(cell, width) do |line, fill|
+        line + (' ' * fill)
+      end
+    end
+
+    def right(cell, width)
+      align(cell, width) do |line, fill|
+        (' ' * fill) + line
+      end
+    end
+
+    def center(cell, width)
+      align(cell, width) do |line, fill|
+        half = fill / 2.0
+        (' ' * half.floor) + line + (' ' * half.ceil)
+      end
+    end
+
+    private
+
+    def align(cell, width)
+      w = VisualWidth.measure(cell)
+      if w > width
+        raise ArgumentError, "Invalid width cell: #{cell.inspect}, width: #{width.inspect}"
+      end
+      yield cell, width - w
+    end
+  end
+end

data/lib/visual_width/table.rb

@@ -1,83 +1,130 @@
 require 'visual_width'
+require 'visual_width/formatter'
 
 class VisualWidth::Table
-  attr_accessor :header, :footer, :format
+  include VisualWidth
 
-  # align (left, right, center)
-  LEFT = -> (cell, fill) {
-    cell + (' ' * fill)
-  }
+  attr_accessor :header, :style
 
-  RIGHT = -> (cell, fill) {
-    (' ' * fill) + cell
-  }
-
-  CENTER = -> (cell, fill) {
-    half = fill / 2.0
-    (' ' * half.floor) + cell + (' ' * half.ceil)
-  }
-
-  def initialize(header: nil, format: [])
+  def initialize(header: nil, style: [])
     @header = header
-    @format = format
+    @style  = style
+
+    @needs_wrap = @style.any? { |style| style[:width] != nil }
   end
 
-  def draw(rows, header: nil, output: "")
+  def render(rows, header: nil, output: "")
+    if @needs_wrap
+      default_style = {}
+      rows = rows.map do |row|
+        i = 0
+        row.map do |cell|
+          cell = "#{cell}"
+          width = (@style[i] || default_style)[:width]
+          i += 1
+          if width
+            wrap(cell, width)
+          else
+            cell
+          end
+        end
+      end
+    end
     max_widths = calc_max_widths(rows)
     h = header || @header
+    style_header = []
     if h
-      max_widths = h.map { |cell| VisualWidth.measure(cell) }
+      max_widths = calc_max_widths([h])
         .zip(max_widths)
         .map { |values| values.max }
-      format_header = [CENTER] * h.length
-    else
-      format_header = nil
+      h.length.times do |i|
+        style = @style[i] || {}
+
+        style_header << style.merge(align: :center)
+      end
     end
-    draw_row(output, max_widths, format_header, h, separated: true)
+    draw_header(output, max_widths, style_header, h)
     rows.each do |row|
-      draw_row(output, max_widths, @format, row)
+      draw_row(output, max_widths, @style, row)
     end
     line(output, max_widths)
     output
   end
+
+  def draw(*args)
+    warn "draw() is deprecated. Use render() instead."
+    render(*args)
+  end
+
   private
 
-  def draw_row(output, max_widths, format, row, separated: false)
-    if separated
+  def draw_header(output, max_widths, style, row)
+    line(output, max_widths)
+
+    if row && row.length > 0
+      draw_row(output, max_widths, style, row)
       line(output, max_widths)
     end
+  end
 
-    if row
-      output << '|'
-      row.each_with_index do |cell, i|
-        fill(output, max_widths[i], cell.to_s, format[i])
-        output << '|'
-      end
-      output << "\n"
+  def draw_row(output, max_widths, style, row)
+    output << '|'
 
-      if separated
-        line(output, max_widths)
+    rows = []
+    max_widths.length.times do |i|
+      cell = "#{row[i]}"
+      s = style[i] || {}
+      align = s[:align] || :left
+      width = s[:width] || max_widths[i]
+      c = cell.split(/\n/)
+      if c.length == 0
+        c << ""
       end
+      output << aligner.send(align, c.shift.strip, width) << '|'
+      if c.length > 0
+        c.each_with_index do |new_cell, row_id|
+          rows[row_id] ||= []
+          rows[row_id][i] = new_cell
+        end
+      end
+    end
+    output << "\n"
+
+    rows.each do |row|
+      draw_row(output, max_widths, style, row)
     end
+
+    output
   end
 
-  def line (output, max_widths)
-    output << '+' << max_widths.map { |width| '-' * width }.join('+') << "+\n"
+  def line (output, widths)
+    output << '+' << widths.map { |width| '-' * width }.join('+') << "+\n"
   end
 
-  def fill(output, max_width, cell, f)
-    f ||= LEFT
-    w = VisualWidth.measure(cell)
-    output << f.call(cell, (max_width - w))
+  def aligner
+    VisualWidth::Formatter::Align.new
   end
 
   def calc_max_widths(rows) # -> [max_col0_width, max_col1_width, ...]
     result = []
+    default_style = {}
     rows.each_with_index do |row|
       row.each_with_index do |cell, i|
-        result[i] = [result[i] || 0, VisualWidth.measure(cell.to_s)].max
+        ws = "#{cell}".split(/\n/).map do |line|
+          measure(line)
+        end
+        style = @style[i] || default_style
+        result[i] = (ws << (result[i] || 0) << (style[:width] || 0)).max
       end
     end
     result
   end
+
+  def wrap(cell, width)
+    s = ""
+    each_width(cell.strip, width) do |line|
+      s << line.strip << "\n"
+    end
+    s
+  end
 end

data/lib/visual_width/version.rb

@@ -1,3 +1,3 @@
 module VisualWidth
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/visual_width/table_spec.rb

@@ -13,11 +13,11 @@ describe VisualWidth::Table do
     rows
   end
 
-  context "#draw" do
-    it 'draws text table' do
+  context "#render" do
+    it 'renders text table' do
       t = VisualWidth::Table.new
 
-      expect(t.draw(rows)).to eql(<<-'TEXT')
+      expect(t.render(rows)).to eql(<<-'TEXT')
 +----------+----------+
 |りんご    |なし      |
 |べにしぐれ|せいぎょく|
@@ -26,12 +26,12 @@ describe VisualWidth::Table do
       TEXT
     end
 
-    it 'draws text table with formatter/CENTER, RIGHT' do
+    it 'renders text table with style/CENTER, RIGHT' do
       t = VisualWidth::Table.new(
-        format: [VisualWidth::Table::CENTER, VisualWidth::Table::RIGHT],
+        style: [{align: :center}, {align: :right}],
       )
 
-      expect(t.draw(rows)).to eql(<<-'TEXT')
+      expect(t.render(rows)).to eql(<<-'TEXT')
 +----------+----------+
 |  りんご  |      なし|
 |べにしぐれ|せいぎょく|
@@ -40,11 +40,11 @@ describe VisualWidth::Table do
       TEXT
     end
 
-    it 'draws text table with header/footer' do
+    it 'renders text table with header/footer' do
       t = VisualWidth::Table.new(
         header: %w(A B),
       )
-      expect(t.draw(rows)).to eql(<<-'TEXT')
+      expect(t.render(rows)).to eql(<<-'TEXT')
 +----------+----------+
 |    A     |    B     |
 +----------+----------+
@@ -63,7 +63,7 @@ describe VisualWidth::Table do
         ['Average', 93, 96],
       ]
 
-      expect(VisualWidth::Table.new.draw(rows, header: header)).to eql(<<-'TEXT')
+      expect(VisualWidth::Table.new.render(rows, header: header)).to eql(<<-'TEXT')
 +-------+---------+------+
 |Student|Mid-Terms|Finals|
 +-------+---------+------+
@@ -74,4 +74,16 @@ describe VisualWidth::Table do
       TEXT
     end
   end
+
+  context "#render with wrap" do
+    it "wraps with 10 width" do
+      t = VisualWidth::Table.new(style: [{width: 10}, {width: 10}])
+      expect(t.render([['テレポーター！', '*いしのなかにいる*']])).to eql(<<-'TEXT')
++----------+----------+
+|テレポータ|*いしのな |
+|ー！      |かにいる* |
++----------+----------+
+      TEXT
+    end
+  end
 end

data/spec/visual_width_spec.rb

@@ -89,4 +89,24 @@ describe VisualWidth do
       expect(s).to eql('αβγδεζη...')
     end
   end
+
+  context ".each_width" do
+    it "splits str in visual width" do
+      str = "恋すてふ_我が名はまだき_立ちにけり_人知れずこそ_思ひそめしか"
+
+      values = []
+      VisualWidth.each_width(str, 10) do |line|
+        values << line
+      end
+      expect(values).to eql(%w(
+        恋すてふ_
+        我が名はま
+        だき_立ち
+        にけり_人
+        知れずこそ
+        _思ひそめ
+        しか
+      ))
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: visual_width
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Fuji, Goro (gfx)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,6 +56,7 @@ files:
 - example/table.rb
 - lib/visual_width.rb
 - lib/visual_width/data.rb
+- lib/visual_width/formatter.rb
 - lib/visual_width/string_ext.rb
 - lib/visual_width/string_refine.rb
 - lib/visual_width/table.rb