wcswidth 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3ceaaac3bc55ccc85ea05b9ccaf98b017b340ae
+  data.tar.gz: 963303ab5e2e82757d198356746ffbad58363845
+SHA512:
+  metadata.gz: 424bd3a2a633ea4ac9db70ddb54627e8e8d42b500ce77f32c4f68dfe5c57316945ce5a90c89e4760ea1e5a07262c8d066fe56a7b0fe7a0afd4a16518e563ad6a
+  data.tar.gz: c11a9df0a5c10d29d079d353d29078d5490dfa6fe3655b99dc3596a9a11b3cbfeadc3c4c0361198385bb18764412088b0f83813926e277a2fb9a899571dcc3ae

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+/pkg

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,18 @@
+sudo: false
+language: ruby
+
+rvm:
+- 2.3.0
+- 2.2
+- 2.1
+- 2.0
+- ruby-head
+- rbx-2
+- jruby-head
+- jruby-9000
+
+cache:
+- bundler
+
+# matrix:
+#   fast_finish: true

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## CHANGELOG
+
+### 1.0.0
+
+* Inital release
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at opensource@janlelis.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Jan Lelis, mail@janlelis.de
+
+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/README.md

@@ -0,0 +1,33 @@
+# wcswidth [![[version]](https://badge.fury.io/rb/wcswidth.svg)](http://badge.fury.io/rb/wcswidth)  [![[travis]](https://travis-ci.org/janlelis/wcswidth-ruby.png)](https://travis-ci.org/janlelis/wcswidth-ruby)
+
+Determine terminal display width (columns) of Ruby strings via [FFI bindings](https://github.com/ffi/ffi/wiki) to libc's [wcswidth()](http://man7.org/linux/man-pages/man3/wcswidth.3.html) function.
+
+See [unicode/display_width](https://github.com/janlelis/unicode-display_width) for a Ruby-only unicode data based approach.
+
+## Usage
+
+```ruby
+require 'wcswidth/kernel_method'
+
+# full width chars
+wcswidth("！") # => 2
+wcswidth("一") # => 2
+
+# single width chars
+wcswidth("A") # => 1
+wcswidth("·") # => 1
+
+# zero width chars
+wcswidth("ֿ") # => 0
+wcswidth("\0") # => 0
+
+# control chars
+wcswidth("\x01") # => -1
+wcswidth("\n") # => -1
+```
+
+Without opting in for `wcswidth/kernel_method` it is `Wcswidth.of("string")`
+
+## MIT License
+
+Copyright (C) 2016 Jan Lelis <http://janlelis.com>. Released under the MIT license.

data/Rakefile

@@ -0,0 +1,38 @@
+# # #
+# Get gemspec info
+
+gemspec_file = Dir['*.gemspec'].first
+gemspec = eval File.read(gemspec_file), binding, gemspec_file
+info = "#{gemspec.name} | #{gemspec.version} | " \
+       "#{gemspec.runtime_dependencies.size} dependencies | " \
+       "#{gemspec.files.size} files"
+
+# # #
+# Gem build and install task
+
+desc info
+task :gem do
+  puts info + "\n\n"
+  print "  "; sh "gem build #{gemspec_file}"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+  puts; sh %{gem install --no-document pkg/#{gemspec.name}-#{gemspec.version}.gem}
+end
+
+# # #
+# Start an IRB session with the gem loaded
+
+desc "#{gemspec.name} | IRB"
+task :irb do
+  sh "irb -I ./lib -r #{gemspec.name.gsub '-','/'}"
+end
+
+# # #
+# Run all specs
+
+desc "#{gemspec.name} | Test"
+task :test do
+  sh "rspec spec"
+end
+task :default => :test
+

data/lib/wcswidth.rb

@@ -0,0 +1,18 @@
+require_relative "wcswidth/version"
+require_relative "wcswidth/sizes"
+require_relative "wcswidth/libc"
+
+module Wcswidth
+  def self.of(string, max_width = MAX_WIDTH)
+    LibC.wcswidth(
+      [
+        *string.to_s.  # ensure we are working with a string
+        tr("\0", "").  # remove 0 bytes (length is 0)
+        codepoints,    # convert to integer character representations
+        0              # append 0 byte
+      ].pack(WCHAR_TEMPLATE), # generate wchar_t byte representation
+      max_width        # pass max column width
+    )
+  end
+end
+

data/lib/wcswidth/kernel_method.rb

@@ -0,0 +1,9 @@
+require_relative "../wcswidth"
+
+module Kernel
+  private
+
+  def wcswidth(string)
+    Wcswidth.of(string)
+  end
+end

data/lib/wcswidth/libc.rb

@@ -0,0 +1,12 @@
+require "ffi"
+
+module Wcswidth
+  module LibC
+    extend FFI::Library
+
+    ffi_lib FFI::Library::LIBC
+    attach_function :wcswidth, [ :buffer_in, :size_t ], :int
+  end
+
+  private_constant :LibC
+end

data/lib/wcswidth/sizes.rb

@@ -0,0 +1,31 @@
+module Wcswidth
+end
+
+begin
+  require "rbconfig/sizeof"
+
+  Wcswidth::MAX_WIDTH  = 256 ** RbConfig::SIZEOF["size_t"] - 1
+  Wcswidth::WCHAR_SIZE = RbConfig::SIZEOF["wchar_t"]
+rescue LoadError
+end
+
+require "rbconfig"
+
+unless defined?(Wcswidth::MAX_WIDTH) && Wcswidth::MAX_WIDTH
+  Wcswidth::MAX_WIDTH = 18446744073709551615
+end
+
+unless defined?(Wcswidth::WCHAR_SIZE) && Wcswidth::WCHAR_SIZE
+  if RbConfig::CONFIG["host_os"] =~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+    Wcswidth::WCHAR_SIZE = 2
+  else
+    Wcswidth::WCHAR_SIZE = 4
+  end
+end
+
+Wcswidth::WCHAR_TEMPLATE = {
+  1 => 'C*',
+  2 => 'S*',
+  4 => 'L*',
+  8 => 'Q*'
+}[Wcswidth::WCHAR_SIZE].freeze

data/lib/wcswidth/version.rb

@@ -0,0 +1,4 @@
+module Wcswidth
+  VERSION = "1.0.0".freeze
+end
+

data/spec/display_width_spec.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+require 'wcswidth/kernel_method'
+
+describe 'wcswidth()' do
+  describe '[east asian width]' do
+    it 'returns 2 for F chars' do
+      expect( wcswidth('！') ).to eq 2
+    end
+
+    it 'returns 2 for W chars' do
+      expect( wcswidth('一') ).to eq 2
+    end
+
+    it 'returns 1 for N chars' do
+      expect( wcswidth('À') ).to eq 1
+    end
+
+    it 'returns 1 for Na chars' do
+      expect( wcswidth('A') ).to eq 1
+    end
+
+    it 'returns 1 for H chars' do
+      expect( wcswidth('｡') ).to eq 1
+    end
+
+    # NOTE: This is not always correct
+    it 'returns 1 for A chars' do
+      expect( wcswidth('·') ).to eq 1
+    end
+  end
+
+  describe '[general category]' do
+    it 'returns 1 for non-special (non east width) chars' do
+      expect( wcswidth('A') ).to eq 1
+    end
+
+    it 'returns 0 for Mn chars' do
+      expect( wcswidth('ֿ') ).to eq 0
+    end
+  end
+end

data/wcswidth.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+require File.dirname(__FILE__) + "/lib/wcswidth/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "wcswidth"
+  gem.version       = Wcswidth::VERSION
+  gem.summary       = "FFI bindings to libc's wcswidth()"
+  gem.description   = "Determine terminal display width (columns) of Ruby strings via FFI bindings to libc's wcswidth() function"
+  gem.authors       = ["Jan Lelis"]
+  gem.email         = ["mail@janlelis.de"]
+  gem.homepage      = "https://github.com/janlelis/wcswidth-ruby"
+  gem.license       = "MIT"
+
+  gem.files         = Dir["{**/}{.*,*}"].select{ |path| File.file?(path) && path !~ /^pkg/ }
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = "~> 2.0"
+  gem.add_dependency 'ffi', "~> 1.9"
+  gem.add_development_dependency 'rake', "~> 10.5"
+  gem.add_development_dependency 'rspec', "~> 3.4"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: wcswidth
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Lelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Determine terminal display width (columns) of Ruby strings via FFI bindings
+  to libc's wcswidth() function
+email:
+- mail@janlelis.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- lib/wcswidth.rb
+- lib/wcswidth/kernel_method.rb
+- lib/wcswidth/libc.rb
+- lib/wcswidth/sizes.rb
+- lib/wcswidth/version.rb
+- spec/display_width_spec.rb
+- wcswidth.gemspec
+homepage: https://github.com/janlelis/wcswidth-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: FFI bindings to libc's wcswidth()
+test_files:
+- spec/display_width_spec.rb