0.0
No commit activity in last 3 years
No release in over 3 years
Deals with East Asian Width defined in Unicode
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
>= 0
 Project Readme

VisualWidth Build Status

This gem handles Unicode East Asian Width:

Installation

Add this line to your application's Gemfile:

gem 'visual_width'

And then execute:

$ bundle

Or install it yourself as:

$ gem install visual_width

Usage

visual_width:

    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 in the report.

visual_width/table:

    require 'visual_width/table'

    t = VisualWidth::Table.new(
      style: [
        { align: :center, width:  8 },
        { align: :center, width:  8 },
        { align: :right,  width:  5 },
      ],
      header: ['Nick', 'FullName', 'Age'],
    )

    rows = [
      ['カネダ', '金田 正太郎', 17],
      ['テツオ', '島 鉄雄', 16],
      ['ケイ', '?', 18],
    ]
    puts t.render(rows)
    # +--------+--------+-----+
    # |  Nick  |FullName| Age |
    # +--------+--------+-----+
    # | カネダ |金田 正 |   17|
    # |        |  太郎  |     |
    # | テツオ |島 鉄雄 |   16|
    # |  ケイ  |   ?    |   18|
    # +--------+--------+-----+

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  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 has the same feature as VisualWidth.measure() but it extends String class directly and is much slower than VisualWidth.measure()
  • terminal-table renders text table, but it cannot deal with East Asian Width characters