visual_width 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05cf7a6f8d1cb732fa2f35fabbe3a495c727e4d3
-  data.tar.gz: 47a372ba9ede858b3cf1c1f697c6476027ecfa4f
+  metadata.gz: 4de483063c67cddbaca1f3ac3a1ac27536311218
+  data.tar.gz: 3d9ab9b361e41e1edc9d2f095c28a3591e72cfbb
 SHA512:
-  metadata.gz: 3077e27f95bf06842b167e819396557fe3337c48bed7f520e1225da0f08918004120676ec78e7fa1188f1c610628c3dc557d67af14ddb86616bded777ce90cb6
-  data.tar.gz: 7150d1b9c1f9fe84109098848d98f1b0da45cf56a2125b011b974a4ff8270a8f251077b508633245d73a78e85dc1faeaba85d3307f906bb91078660698f428df
+  metadata.gz: fd041e918922cf48e5686b8d9d7c4417b8bbde49c11fa65f6f2d3c6783f0afccd6f41397d2aae6b75f94ed3cdba3e3fbdd04901433df06ee1ee935ed724b68e0
+  data.tar.gz: 40a336d2d2e0e2b919109744910a17cb2860dfe13e59c69c7766c3707f65a614e8226402c1bbf5711953f81a154f1022c3c7e8df7bc93b76755d54fcd429f815

data/.travis.yml

@@ -0,0 +1,3 @@
+languages: ruby
+rvm:
+    - 2.0.0

data/README.md

@@ -21,12 +21,28 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
+    # VisualWidth
     require 'visual_width'
 
-    p VisualWidth.count("こんにちは") # => 10
-    p VisualWidth.count("abcdefghij") # => 10
+    p VisualWidth.measure("こんにちは") # => 10
+    p VisualWidth.measure("abcdefghij") # => 10
 
     p VisualWidth.truncate("恋すてふ 我が名はまだき 立ちにけり 人知れずこそ 思ひそめしか", 20) # => "恋すてふ 我が名は..."
+
+    # VisualWidth::Table
+    require 'visual_width/table'
+
+    t = VisualWidth::Table.new(
+      format: [VisualWidth::Table::LEFT, VisualWidth::Table::RIGHT, VisualWidth::Table::RIGHT]
+    )
+
+    header = ['Student', 'Mid-Terms', 'Finals']
+    rows = [
+      ['Sam', 94, 93],
+      ['Jane', 92, 99],
+      ['Average', 93, 96],
+    ]
+    t.draw(rows, header: header)
 ```
 
 Each method can take `east_asian: false` to tell it is not in an East Asian context, regarding ambiguous characters as half-width.
@@ -40,3 +56,7 @@ See [Ambiguous Characters](http://www.unicode.org/reports/tr11/#Ambiguous) in th
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## 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()`

data/example/table.rb

@@ -0,0 +1,13 @@
+# VisualWidth::Table
+require 'visual_width/table'
+t = VisualWidth::Table.new(
+  format: [VisualWidth::Table::LEFT, VisualWidth::Table::RIGHT, VisualWidth::Table::RIGHT]
+)
+
+header = ['Student', 'Mid-Terms', 'Finals']
+rows = [
+  ['Sam', 94, 93],
+  ['Jane', 92, 99],
+  ['Average', 93, 96],
+]
+puts t.draw(rows, header: header)

data/lib/visual_width/string_ext.rb

@@ -2,7 +2,7 @@ require 'visual_width'
 
 class String
   def width(opts = {})
-    VisualWidth.count(self, opts)
+    VisualWidth.measure(self, opts)
   end
 
   def truncate(max_length, opts = {})

data/lib/visual_width/string_refine.rb

@@ -3,7 +3,7 @@ require 'visual_width'
 module VisualWidth
   refine String do
     def width(opts = {})
-      VisualWidth.count(self, opts)
+      VisualWidth.measure(self, opts)
     end
 
     def truncate(max_length, opts = {})

data/lib/visual_width/table.rb

@@ -0,0 +1,83 @@
+require 'visual_width'
+
+class VisualWidth::Table
+  attr_accessor :header, :footer, :format
+
+  # align (left, right, center)
+  LEFT = -> (cell, fill) {
+    cell + (' ' * fill)
+  }
+
+  RIGHT = -> (cell, fill) {
+    (' ' * fill) + cell
+  }
+
+  CENTER = -> (cell, fill) {
+    half = fill / 2.0
+    (' ' * half.floor) + cell + (' ' * half.ceil)
+  }
+
+  def initialize(header: nil, format: [])
+    @header = header
+    @format = format
+  end
+
+  def draw(rows, header: nil, output: "")
+    max_widths = calc_max_widths(rows)
+    h = header || @header
+    if h
+      max_widths = h.map { |cell| VisualWidth.measure(cell) }
+        .zip(max_widths)
+        .map { |values| values.max }
+      format_header = [CENTER] * h.length
+    else
+      format_header = nil
+    end
+    draw_row(output, max_widths, format_header, h, separated: true)
+    rows.each do |row|
+      draw_row(output, max_widths, @format, row)
+    end
+    line(output, max_widths)
+    output
+  end
+  private
+
+  def draw_row(output, max_widths, format, row, separated: false)
+    if separated
+      line(output, max_widths)
+    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"
+
+      if separated
+        line(output, max_widths)
+      end
+    end
+  end
+
+  def line (output, max_widths)
+    output << '+' << max_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))
+  end
+
+  def calc_max_widths(rows) # -> [max_col0_width, max_col1_width, ...]
+    result = []
+    rows.each_with_index do |row|
+      row.each_with_index do |cell, i|
+        result[i] = [result[i] || 0, VisualWidth.measure(cell.to_s)].max
+      end
+    end
+    result
+  end
+end

data/lib/visual_width/version.rb

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

data/lib/visual_width.rb

@@ -4,44 +4,44 @@ require "visual_width/data"
 module VisualWidth
   EAST_ASIAN = true
 
-  @@c1 = /( (?:#{Fullwide} | #{Wide} | #{Ambiguous})+ )/x
-  @@c0 = /( (?:#{Fullwide} | #{Wide}               )+ )/x
+  r1 = /#{Fullwide} | #{Wide} | #{Ambiguous}/x;
+  r0 = /#{Fullwide} | #{Wide}               /x;
 
-  @@t1 = /( (?:#{Fullwide} | #{Wide} | #{Ambiguous}) ) | ./x
-  @@t0 = /( (?:#{Fullwide} | #{Wide}               ) ) | ./x
+  @@c1 = /( #{r1}+ )/x
+  @@c0 = /( #{r0}+ )/x
+
+  @@t1 = /( #{r1} ) | . /x
+  @@t0 = /( #{r0} ) | . /x
 
   module_function
 
-  def count(str, east_asian: EAST_ASIAN)
+  def count(*args)
+    warn "count() is deprecated. use measure() instead"
+    measure(*args)
+  end
+
+  def measure(str, east_asian: EAST_ASIAN)
     rx = east_asian ? @@c1 : @@c0
     full_width = 0
-    str.scan(rx) do |w,|
-      full_width += w.length
+    str.scan(rx) do |wide,|
+      full_width += wide.length
     end
     (full_width * 2) + (str.length - full_width)
   end
 
   def truncate(str, max_length, omission: '...', east_asian: EAST_ASIAN)
-    max = max_length - omission.length
     rx = east_asian ? @@t1 : @@t0
+    max = max_length - omission.length
     pos = 0
     width = 0
     str.scan(rx) do |wide,|
-      if wide
-        width += 2
-      else
-        width += 1
-      end
+      width += wide ? 2 : 1
 
-      if width > max
-        break
-      end
+      break if width > max
 
       pos += 1
 
-      if width == max
-        break
-      end
+      break if width == max
     end
 
     if width < str.length

data/spec/visual_width/string_refine_spec.rb

@@ -1,10 +1,13 @@
+# coding: utf-8
+
 require 'rspec'
 
+require 'visual_width/string_ext' # workaround Ruby 2.0.0 bug
 require 'visual_width/string_refine'
 
 using VisualWidth
 
-describe VisualWidth do
+describe VisualWidth, skip: RUBY_VERSION < "2.0.0" do
   context "String#width" do
     it do
       expect("こんにちは".width).to eql(10)

data/spec/visual_width/table_spec.rb

@@ -0,0 +1,77 @@
+# coding: utf-8
+
+require 'rspec'
+
+require 'visual_width/table'
+
+describe VisualWidth::Table do
+  let (:rows) do
+    rows = []
+    rows << %w(りんご なし)
+    rows << %w(べにしぐれ せいぎょく)
+    rows << %w(となみ いなぎ)
+    rows
+  end
+
+  context "#draw" do
+    it 'draws text table' do
+      t = VisualWidth::Table.new
+
+      expect(t.draw(rows)).to eql(<<-'TEXT')
++----------+----------+
+|りんご    |なし      |
+|べにしぐれ|せいぎょく|
+|となみ    |いなぎ    |
++----------+----------+
+      TEXT
+    end
+
+    it 'draws text table with formatter/CENTER, RIGHT' do
+      t = VisualWidth::Table.new(
+        format: [VisualWidth::Table::CENTER, VisualWidth::Table::RIGHT],
+      )
+
+      expect(t.draw(rows)).to eql(<<-'TEXT')
++----------+----------+
+|  りんご  |      なし|
+|べにしぐれ|せいぎょく|
+|  となみ  |    いなぎ|
++----------+----------+
+      TEXT
+    end
+
+    it 'draws text table with header/footer' do
+      t = VisualWidth::Table.new(
+        header: %w(A B),
+      )
+      expect(t.draw(rows)).to eql(<<-'TEXT')
++----------+----------+
+|    A     |    B     |
++----------+----------+
+|りんご    |なし      |
+|べにしぐれ|せいぎょく|
+|となみ    |いなぎ    |
++----------+----------+
+      TEXT
+    end
+
+    it "does jobs with non-string elements" do
+      header = ['Student', 'Mid-Terms', 'Finals']
+      rows = [
+        ['Sam', 94, 93],
+        ['Jane', 92, 99],
+        ['Average', 93, 96],
+      ]
+
+      expect(VisualWidth::Table.new.draw(rows, header: header)).to eql(<<-'TEXT')
++-------+---------+------+
+|Student|Mid-Terms|Finals|
++-------+---------+------+
+|Sam    |94       |93    |
+|Jane   |92       |99    |
+|Average|93       |96    |
++-------+---------+------+
+      TEXT
+    end
+  end
+end

data/spec/visual_width_spec.rb

@@ -1,40 +1,42 @@
+# coding: utf-8
+
 require 'rspec'
 
 require 'visual_width'
 require 'visual_width/string_ext'
 
 describe VisualWidth do
-  context ".count" do
-    it "counts Half characters" do
-      expect(VisualWidth.count("foo")).to eql(3)
+  context ".measure" do
+    it "measures Half characters" do
+      expect(VisualWidth.measure("foo")).to eql(3)
     end
-    it "counts Wide characters" do
-      expect(VisualWidth.count("こんにちは")).to eql(10)
+    it "measures Wide characters" do
+      expect(VisualWidth.measure("こんにちは")).to eql(10)
     end
 
-    it "counts Half characters" do
-      expect(VisualWidth.count("ｺﾝﾆﾁﾊ")).to eql(5)
+    it "measures Half characters" do
+      expect(VisualWidth.measure("ｺﾝﾆﾁﾊ")).to eql(5)
     end
 
-    it "counts Ambiguous characters" do
-      expect(VisualWidth.count("αβ")).to eql(4)
+    it "measures Ambiguous characters" do
+      expect(VisualWidth.measure("αβ")).to eql(4)
     end
   end
 
   context ".counnt with east_asian: false" do
-    it "counts Halfwide characters" do
-      expect(VisualWidth.count("foo", east_asian: false)).to eql(3)
+    it "measures Halfwide characters" do
+      expect(VisualWidth.measure("foo", east_asian: false)).to eql(3)
     end
-    it "counts Wide characters" do
-      expect(VisualWidth.count("こんにちは", east_asian: false)).to eql(10)
+    it "measures Wide characters" do
+      expect(VisualWidth.measure("こんにちは", east_asian: false)).to eql(10)
     end
 
-    it "counts Half characters" do
-      expect(VisualWidth.count("ｺﾝﾆﾁﾊ", east_asian: false)).to eql(5)
+    it "measures Half characters" do
+      expect(VisualWidth.measure("ｺﾝﾆﾁﾊ", east_asian: false)).to eql(5)
     end
 
-    it "counts Ambiguous characters" do
-      expect(VisualWidth.count("αβ", east_asian: false)).to eql(2)
+    it "measures Ambiguous characters" do
+      expect(VisualWidth.measure("αβ", east_asian: false)).to eql(2)
     end
   end
 
@@ -46,35 +48,35 @@ describe VisualWidth do
     it "truncates str, adding '...'" do
       str = "The quick brown fox jumps over the lazy dog."
       s = VisualWidth.truncate(str, 15)
-      expect(s.visual_width).to be <= 15
+      expect(s.width).to be <= 15
       expect(s).to eql('The quick br...')
     end
 
     it "truncates str, adding '(snip)'" do
       str = "The quick brown fox jumps over the lazy dog."
       s = VisualWidth.truncate(str, 15, omission: '(snip)')
-      expect(s.visual_width).to be <= 15
+      expect(s.width).to be <= 15
       expect(s).to eql('The quick(snip)')
     end
 
     it "truncates Wide characters" do
       str = "くにざかいのながいトンネルを抜けるとゆきぐにであった"
       s = VisualWidth.truncate(str, 20)
-      expect(s.visual_width).to be <= 20
+      expect(s.width).to be <= 20
       expect(s).to eql('くにざかいのなが...')
     end
 
     it "truncates mixed character types" do
       str = "くにざかいの ながい トンネルを 抜けると ゆきぐにであった"
       s = VisualWidth.truncate(str, 20)
-      expect(s.visual_width).to be <= 20
+      expect(s.width).to be <= 20
       expect(s).to eql('くにざかいの なが...')
     end
 
     it "truncates Ambiguous characters" do
       str = "αβγδεζηθικλμνξοπρστυφχψω"
       s = VisualWidth.truncate(str, 10)
-      expect(s.visual_width).to be <= 10
+      expect(s.width).to be <= 10
       expect(s).to eql('αβγ...')
     end
   end
@@ -83,7 +85,7 @@ describe VisualWidth do
     it "truncates str with Ambiguous characters" do
       str = "αβγδεζηθικλμνξοπρστυφχψω"
       s = VisualWidth.truncate(str, 10, east_asian: false)
-      expect(s.visual_width(east_asian: false)).to be <= 10
+      expect(s.width(east_asian: false)).to be <= 10
       expect(s).to eql('αβγδεζη...')
     end
   end

data/tool/benchmark.rb

@@ -6,13 +6,13 @@ require 'unicode/display_width'
 
 str = "foo あいうえお bar αβγδε baz"
 
-VisualWidth.count(str) == str.display_width(2)
+VisualWidth.measure(str) == str.display_width(2)
 
 [str, str * 5, str * 10].each do |str|
-  puts "\n", "for length #{str.length}:"
+  puts "\n", "measures string with length #{str.length}:"
   Benchmark.bmbm do |x|
     x.report("visual_width") do
-      1000.times { VisualWidth.count(str) }
+      1000.times { VisualWidth.measure(str) }
     end
     x.report("display_width") do
       1000.times { str.display_width(2) }

data/tool/tables.rb

@@ -0,0 +1,21 @@
+#!ruby
+require 'terminal-table'
+require 'text-table'
+require 'visual_width/table'
+
+table = Text::Table.new
+table.head = ['じゃがいも', 'さといも']
+table.rows = [['コロッケ', '雑煮']]
+table.rows << ['肉じゃが', '塩ゆで']
+puts table
+
+rows = []
+rows << ['じゃがいも', 'さといも']
+rows << ['コロッケ', '雑煮']
+rows << ['肉じゃが', '塩ゆで']
+table = Terminal::Table.new :rows => rows
+puts table
+
+t = VisualWidth::Table.new
+
+puts t.draw(rows)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: visual_width
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Fuji, Goro (gfx)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-23 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,20 +47,25 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Changes
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- example/table.rb
 - lib/visual_width.rb
 - lib/visual_width/data.rb
 - lib/visual_width/string_ext.rb
 - lib/visual_width/string_refine.rb
+- lib/visual_width/table.rb
 - lib/visual_width/version.rb
 - spec/visual_width/string_refine_spec.rb
+- spec/visual_width/table_spec.rb
 - spec/visual_width_spec.rb
 - tool/benchmark.rb
 - tool/east-asian-width.pl
+- tool/tables.rb
 - visual_width.gemspec
 homepage: https://github.com/gfx/visual_width.rb
 licenses:
@@ -88,5 +93,6 @@ specification_version: 4
 summary: Ruby Implementation of East Asian Width
 test_files:
 - spec/visual_width/string_refine_spec.rb
+- spec/visual_width/table_spec.rb
 - spec/visual_width_spec.rb
 has_rdoc: