unicode-display_width 1.8.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 482905db9c50997ae4a1a05a972fe17d4d7c547297b1052e61de95ca2cc8c9fa
-  data.tar.gz: f65af84de6f278a23626f5777d6453267cf8882b77a4752bb7bcec520b6788d1
+  metadata.gz: 83f868860aad325832499e0994c9b727daac6bc8f2f2059a2c3762d947372c80
+  data.tar.gz: f7e6c78087266834cd0edd4e4728b0742455309cc1f83dd6562efbfcd62dac92
 SHA512:
-  metadata.gz: cf8867e9e4d81cea462399f1a7cb00c4875806033d66d3b8744f39741f0f0d0a1bc2853abf8e02d4799bdb0f052d00293626c07f57333d9b66459fb831250771
-  data.tar.gz: eb82ce51aaa94fe4038f000122f2dc38f83ae93dade3183a25be60ad4018d937c3482e9bfe29d4e2ddd0679ec3c01fa89ae2eebd0a64819ce1e70e0f5f6244ca
+  metadata.gz: 1c765285a14f5b45fed8add2fa4d35e144465de2e1943d0d4e8aaab54e1f225fca88858408e24ac7ad110ec9b71fb14d4ea1165282e3f9aae733b34962cacb4d
+  data.tar.gz: 585579fa0a392c9005a8ef43aaba4c6f69ca2282c5474f873f5287d39604cf042eaa1448edc818de5f4bacd94a1522a3f9dfbd3b7c9b2630aa30d696fe82c2d4

data/CHANGELOG.md

@@ -1,9 +1,38 @@
 # CHANGELOG
 
+## 2.1.0
+
+- Unicode 14.0
+
+## 2.0.0
+
+- Release 2.0.0
+- Supports Ruby 3.0
+
+## 2.0.0.pre2
+
+- Update 2.0 branch to Unicode 13
+
+## 2.0.0.pre1
+
+Will be published as non-pre version on rubygems.org when Ruby 3.0 is released (December 2020)
+
+- Introduce new class-based API, which remembers your string-width configuration. See README for details.
+- Remove auto-loading of string extension
+  - You can: `require "unicode/display_width/string_ext"` to continue to use the string extension
+  - The manual opt-out `require "unicode/display_width/no_string_ext"` is not needed anymore and will
+    issue a warning in the future
+- Remove (already deprecated) String#display_size and String#display_width aliases
+
+Refactorings / Internal Changes:
+
+- Freeze string literals
+- The Unicode::DisplayWidth now is class, instead of a module, this enables the new config-object API
+
 ## 1.8.0
- 
+
 - Unicode 14.0 (last release of 1.x)
- 
+
 ## 1.7.0
 
 - Unicode 13

data/MIT-LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT LICENSE
 
-Copyright (c) 2011, 2015-2020 Jan Lelis
+Copyright (c) 2011, 2015-2021 Jan Lelis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,12 +1,31 @@
-## Unicode::DisplayWidth [![[version]](https://badge.fury.io/rb/unicode-display_width.svg)](https://badge.fury.io/rb/unicode-display_width) [<img src="https://travis-ci.org/janlelis/unicode-display_width.png" />](https://travis-ci.org/janlelis/unicode-display_width)
+## Unicode::DisplayWidth [![[version]](https://badge.fury.io/rb/unicode-display_width.svg)](https://badge.fury.io/rb/unicode-display_width) [<img src="https://github.com/janlelis/unicode-display_width/workflows/Test/badge.svg" />](https://github.com/janlelis/unicode-display_width/actions?query=workflow%3ATest)
 
-Determines the monospace display width of a string in Ruby. Implementation based on [EastAsianWidth.txt](https://www.unicode.org/Public/UNIDATA/EastAsianWidth.txt) and other data, 100% in Ruby. Other than [wcwidth()](https://github.com/janlelis/wcswidth-ruby), which fulfills a similar purpose, it does not rely on the OS vendor to provide an up-to-date method for measuring string width.
+Determines the monospace display width of a string in Ruby. Implementation based on [EastAsianWidth.txt](https://www.unicode.org/Public/UNIDATA/EastAsianWidth.txt) and other data, 100% in Ruby. It does not rely on the OS vendor (like [wcwidth()](https://github.com/janlelis/wcswidth-ruby)) to provide an up-to-date method for measuring string width.
 
 Unicode version: **14.0.0** (September 2021)
 
-Supported Rubies: **2.7**, **2.6**, **2.5**, **2.4**
+Supported Rubies: **3.0**, **2.7**
 
-Old Rubies that might still work: **2.3**, **2.2**, **2.1**, **2.0**, **1.9**
+Old Rubies which might still work: **2.6**, **2.5**, **2.4**, **2.3**, **2.2**, **2.1**, **2.0**, **1.9**
+
+## Version 2.0 — Breaking Changes
+
+Some features of this library were marked deprecated for a long time and have been removed with Version 2.0:
+
+- Aliases of display_width (…\_size, …\_length) have been removed
+- Auto-loading of string core extension has been removed:
+
+If you are relying on the `String#display_width` string extension to be automatically loaded (old behavior), please load it explicitly now:
+
+```ruby
+require "unicode/display_width/string_ext"
+```
+
+You could also change your `Gemfile` line to achieve this:
+
+```ruby
+gem "unicode-display_width", require: "unicode/display_width/string_ext"
+```
 
 ## Introduction to Character Widths
 
@@ -44,6 +63,8 @@ Or add to your Gemfile:
 
 ## Usage
 
+### Classic API
+
 ```ruby
 require 'unicode/display_width'
 
@@ -51,7 +72,7 @@ Unicode::DisplayWidth.of("⚀") # => 1
 Unicode::DisplayWidth.of("一") # => 2
 ```
 
-### Ambiguous Characters
+#### Ambiguous Characters
 
 The second parameter defines the value returned by characters defined as ambiguous:
 
@@ -60,42 +81,56 @@ Unicode::DisplayWidth.of("·", 1) # => 1
 Unicode::DisplayWidth.of("·", 2) # => 2
 ```
 
-### Custom Overwrites
+#### Custom Overwrites
 
 You can overwrite how to handle specific code points by passing a hash (or even a proc) as third parameter:
 
 ```ruby
-Unicode::DisplayWidth.of("a\tb", 1, 0x09 => 10)) # => 12
+Unicode::DisplayWidth.of("a\tb", 1, "\t".ord => 10)) # => tab counted as 10, so result is 12
 ```
 
-### Emoji Support
+#### Emoji Support
 
-Experimental emoji support is included. It will adjust the string's size for modifier and zero-width joiner sequences. You will need to add the [unicode-emoji](https://github.com/janlelis/unicode-emoji) gem to your Gemfile:
+Emoji width support is included, but in must be activated manually. It will adjust the string's size for modifier and zero-width joiner sequences. You also need to add the [unicode-emoji](https://github.com/janlelis/unicode-emoji) gem to your Gemfile:
 
 ```ruby
 gem 'unicode-display_width'
 gem 'unicode-emoji'
 ```
 
-You can then activate the emoji string width adjustments by passing `emoji: true` as fourth parameter:
+Enable the emoji string width adjustments by passing `emoji: true` as fourth parameter:
 
 ```ruby
 Unicode::DisplayWidth.of "🤾🏽‍♀️" # => 5
 Unicode::DisplayWidth.of "🤾🏽‍♀️", 1, {}, emoji: true # => 2
 ```
 
-### Usage with String Extension
-
-Activated by default. Will be deactivated in version 2.0:
+#### Usage with String Extension
 
 ```ruby
 require 'unicode/display_width/string_ext'
 
-"⚀".display_width #=> 1
-'一'.display_width #=> 2
+"⚀".display_width # => 1
+'一'.display_width # => 2
 ```
 
-You can actively opt-out from the string extension with: `require 'unicode/display_width/no_string_ext'`
+### Modern API: Keyword-arguments Based Config Object
+
+Version 2.0 introduces a keyword-argument based API, which allows you to save your configuration for later-reuse. This requires an extra line of code, but has the advantage that you'll need to define your string-width options only once:
+
+```ruby
+require 'unicode/display_width'
+
+display_width = Unicode::DisplayWidth.new(
+  # ambiguous: 1,
+  overwrite: { "A".ord => 100 },
+  emoji: true,
+)
+
+display_width.of "⚀" # => 1
+display_width.of "🤾🏽‍♀️" # => 2
+display_width.of "A" # => 100
+```
 
 ### Usage From the CLI
 
@@ -118,7 +153,7 @@ See [unicode-x](https://github.com/janlelis/unicode-x) for more Unicode related
 
 ## Copyright & Info
 
-- Copyright (c) 2011, 2015-2020 Jan Lelis, https://janlelis.com, released under the MIT
+- Copyright (c) 2011, 2015-2021 Jan Lelis, https://janlelis.com, released under the MIT
 license
 - Early versions based on runpaint's unicode-data interface: Copyright (c) 2009 Run Paint Run Run
 - Unicode data: https://www.unicode.org/copyright.html#Exhibit1

data/lib/unicode/display_width/constants.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Unicode
-  module DisplayWidth
-    VERSION = '1.8.0'
+  class DisplayWidth
+    VERSION = "2.1.0"
     UNICODE_VERSION = "14.0.0"
-    DATA_DIRECTORY = File.expand_path(File.dirname(__FILE__) + '/../../../data/').freeze
-    INDEX_FILENAME = (DATA_DIRECTORY + '/display_width.marshal.gz').freeze
+    DATA_DIRECTORY = File.expand_path(File.dirname(__FILE__) + "/../../../data/")
+    INDEX_FILENAME = DATA_DIRECTORY + "/display_width.marshal.gz"
   end
 end

data/lib/unicode/display_width/index.rb

@@ -1,8 +1,10 @@
-require 'zlib'
-require_relative 'constants'
+# frozen_string_literal: true
+
+require "zlib"
+require_relative "constants"
 
 module Unicode
-  module DisplayWidth
+  class DisplayWidth
     File.open(INDEX_FILENAME, "rb") do |file|
       serialized_data = Zlib::GzipReader.new(file).read
       serialized_data.force_encoding Encoding::BINARY

data/lib/unicode/display_width/no_string_ext.rb

@@ -1,7 +1,8 @@
-module Unicode
-  module DisplayWidth
-    NO_STRING_EXT = true
-  end
-end
+# frozen_string_literal: true
 
-require_relative '../display_width'
+warn "You are loading 'unicode-display_width/no_string_ext'\n" \
+     "Beginning with version 2.0, this is not necessary anymore\n"\
+     "You can just require 'unicode-display_width' now and no\n"\
+     "string extension will be loaded"
+
+require_relative "../display_width"

data/lib/unicode/display_width/string_ext.rb

@@ -1,17 +1,9 @@
-require_relative '../display_width' unless defined? Unicode::DisplayWidth
+# frozen_string_literal: true
+
+require_relative "../display_width" unless defined? Unicode::DisplayWidth
 
 class String
   def display_width(ambiguous = 1, overwrite = {}, options = {})
     Unicode::DisplayWidth.of(self, ambiguous, overwrite, options)
   end
-
-  def display_size(*args)
-    warn "Deprecation warning: Please use `String#display_width` instead of `String#display_size`"
-    display_width(*args)
-  end
-
-  def display_length(*args)
-    warn "Deprecation warning: Please use `String#display_width` instead of `String#display_length`"
-    display_width(*args)
-  end
 end

data/lib/unicode/display_width.rb

@@ -1,8 +1,10 @@
-require_relative 'display_width/constants'
-require_relative 'display_width/index'
+# frozen_string_literal: true
+
+require_relative "display_width/constants"
+require_relative "display_width/index"
 
 module Unicode
-  module DisplayWidth
+  class DisplayWidth
     DEPTHS = [0x10000, 0x1000, 0x100, 0x10].freeze
 
     def self.of(string, ambiguous = 1, overwrite = {}, options = {})
@@ -40,12 +42,24 @@ module Unicode
 
       extra_width
     end
-  end
-end
 
-# Allows you to opt-out of the default string extension. Will eventually be removed,
-# so you must opt-in for the core extension by requiring 'display_width/string_ext'
-unless defined?(Unicode::DisplayWidth::NO_STRING_EXT) && Unicode::DisplayWidth::NO_STRING_EXT
-  require_relative 'display_width/string_ext'
+    def initialize(ambiguous: 1, overwrite: {}, emoji: false)
+      @ambiguous = ambiguous
+      @overwrite = overwrite
+      @emoji     = emoji
+    end
+
+    def get_config(**kwargs)
+      [
+        kwargs[:ambiguous] || @ambiguous,
+        kwargs[:overwrite] || @overwrite,
+        { emoji: kwargs[:emoji] || @emoji },
+      ]
+    end
+
+    def of(string, **kwargs)
+      self.class.of(string, *get_config(**kwargs))
+    end
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unicode-display_width
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jan Lelis
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
 description: "[Unicode 14.0.0] Determines the monospace display width of a string
   using EastAsianWidth.txt, Unicode general category, and other data."
 email: