brakeman 6.1.2 → 7.1.0

data/bundle/ruby/{3.3.0/gems/tilt-2.0.11 → 3.2.0/gems/tilt-2.6.1}/lib/tilt.rb

@@ -1,73 +1,101 @@
-require 'tilt/mapping'
-require 'tilt/template'
+# frozen_string_literal: true
+require_relative 'tilt/mapping'
+require_relative 'tilt/template'
 
 # Namespace for Tilt. This module is not intended to be included anywhere.
 module Tilt
   # Current version.
-  VERSION = '2.0.11'
+  VERSION = '2.6.1'
+
+  EMPTY_ARRAY = [].freeze
+  private_constant :EMPTY_ARRAY
+
+  EMPTY_HASH = {}.freeze
+  private_constant :EMPTY_HASH
 
   @default_mapping = Mapping.new
+  @extract_fixed_locals = false
+
+  # Replace the default mapping with a finalized version of the default
+  # mapping. This can be done to improve performance after the template
+  # libraries you desire to use have already been loaded.  Once this is
+  # is called, all attempts to modify the default mapping will fail.
+  # This also freezes Tilt itself.
+  def self.finalize!
+    return self if @default_mapping.is_a?(FinalizedMapping)
+
+    class << self
+      prepend(Module.new do
+        def lazy_map(*)
+          raise "Tilt.#{__callee__} not supported after Tilt.finalize! has been called"
+        end
+        alias register lazy_map
+        alias register_lazy lazy_map
+        alias register_pipeline lazy_map
+        alias prefer lazy_map
+      end)
+    end
 
-  # @return [Tilt::Mapping] the main mapping object
-  def self.default_mapping
-    @default_mapping
+    @default_mapping = @default_mapping.finalized
+
+    freeze
   end
 
   # @private
   def self.lazy_map
-    default_mapping.lazy_map
+    @default_mapping.lazy_map
   end
 
   # @see Tilt::Mapping#register
   def self.register(template_class, *extensions)
-    default_mapping.register(template_class, *extensions)
+    @default_mapping.register(template_class, *extensions)
   end
 
   # @see Tilt::Mapping#register_lazy
   def self.register_lazy(class_name, file, *extensions)
-    default_mapping.register_lazy(class_name, file, *extensions)
+    @default_mapping.register_lazy(class_name, file, *extensions)
   end
 
-  # @deprecated Use {register} instead.
-  def self.prefer(template_class, *extensions)
-    register(template_class, *extensions)
+  # @see Tilt::Mapping#register_pipeline
+  def self.register_pipeline(ext, options=EMPTY_HASH)
+    @default_mapping.register_pipeline(ext, options)
   end
 
   # @see Tilt::Mapping#registered?
   def self.registered?(ext)
-    default_mapping.registered?(ext)
+    @default_mapping.registered?(ext)
   end
 
   # @see Tilt::Mapping#new
-  def self.new(file, line=nil, options={}, &block)
-    default_mapping.new(file, line, options, &block)
+  def self.new(file, line=nil, options=nil, &block)
+    @default_mapping.new(file, line, options, &block)
   end
 
   # @see Tilt::Mapping#[]
   def self.[](file)
-    default_mapping[file]
+    @default_mapping[file]
   end
 
   # @see Tilt::Mapping#template_for
   def self.template_for(file)
-    default_mapping.template_for(file)
+    @default_mapping.template_for(file)
   end
 
   # @see Tilt::Mapping#templates_for
   def self.templates_for(file)
-    default_mapping.templates_for(file)
+    @default_mapping.templates_for(file)
   end
 
-  # @return the template object that is currently rendering.
-  #
-  # @example
-  #   tmpl = Tilt['index.erb'].new { '<%= Tilt.current_template %>' }
-  #   tmpl.render == tmpl.to_s
-  #
-  # @note This is currently an experimental feature and might return nil
-  #   in the future.
-  def self.current_template
-    Thread.current[:tilt_current_template]
+  class << self
+    # @return [Tilt::Mapping] the main mapping object
+    attr_reader :default_mapping
+
+    # Whether to extract fixed locals from templates by scanning the
+    # template content.
+    attr_accessor :extract_fixed_locals
+
+    # Alias register as prefer for Tilt 1.x compatibility.
+    alias prefer register
   end
 
   # Extremely simple template cache implementation. Calling applications
@@ -110,18 +138,18 @@ module Tilt
       @cache = {}
     end
   end
-
+  # :nocov:
+  # TILT3: Remove Tilt::Cache
+  deprecate_constant :Cache if respond_to?(:deprecate_constant, true)
+  # :nocov:
 
   # Template Implementations ================================================
 
   # ERB
   register_lazy :ERBTemplate,    'tilt/erb',    'erb', 'rhtml'
-  register_lazy :ErubisTemplate, 'tilt/erubis', 'erb', 'rhtml', 'erubis'
   register_lazy :ErubiTemplate,  'tilt/erubi',  'erb', 'rhtml', 'erubi'
 
   # Markdown
-  register_lazy :BlueClothTemplate,    'tilt/bluecloth',    'markdown', 'mkd', 'md'
-  register_lazy :MarukuTemplate,       'tilt/maruku',       'markdown', 'mkd', 'md'
   register_lazy :KramdownTemplate,     'tilt/kramdown',     'markdown', 'mkd', 'md'
   register_lazy :RDiscountTemplate,    'tilt/rdiscount',    'markdown', 'mkd', 'md'
   register_lazy :RedcarpetTemplate,    'tilt/redcarpet',    'markdown', 'mkd', 'md'
@@ -138,9 +166,8 @@ module Tilt
   register_lazy :CreoleTemplate,       'tilt/creole',    'wiki', 'creole'
   register_lazy :EtanniTemplate,       'tilt/etanni',    'etn', 'etanni'
   register_lazy :HamlTemplate,         'tilt/haml',      'haml'
-  register_lazy :LessTemplate,         'tilt/less',      'less'
   register_lazy :LiquidTemplate,       'tilt/liquid',    'liquid'
-  register_lazy :LiveScriptTemplate,   'tilt/livescript','ls'
+  register_lazy :LiveScriptTemplate,   'tilt/livescript','ls', 'livescript'
   register_lazy :MarkabyTemplate,      'tilt/markaby',   'mab'
   register_lazy :NokogiriTemplate,     'tilt/nokogiri',  'nokogiri'
   register_lazy :PlainTemplate,        'tilt/plain',     'html'
@@ -151,17 +178,15 @@ module Tilt
   register_lazy :RstPandocTemplate,    'tilt/rst-pandoc', 'rst'
   register_lazy :SassTemplate,         'tilt/sass',      'sass'
   register_lazy :ScssTemplate,         'tilt/sass',      'scss'
-  register_lazy :SigilTemplate,        'tilt/sigil',     'sigil'
+  register_lazy :SlimTemplate,         'tilt/slim',      'slim'
   register_lazy :StringTemplate,       'tilt/string',    'str'
   register_lazy :TypeScriptTemplate,   'tilt/typescript', 'ts', 'tsx'
-  register_lazy :WikiClothTemplate,    'tilt/wikicloth', 'wiki', 'mediawiki', 'mw'
   register_lazy :YajlTemplate,         'tilt/yajl',      'yajl'
 
-  # External template engines
-  register_lazy 'Slim::Template',            'slim',            'slim'
-  register_lazy 'Tilt::HandlebarsTemplate',  'tilt/handlebars', 'handlebars', 'hbs'
-  register_lazy 'Tilt::OrgTemplate',         'org-ruby',        'org'
-  register_lazy 'Tilt::EmacsOrgTemplate',    'tilt/emacs_org',  'org'
-  register_lazy 'Opal::Processor',           'opal',            'opal', 'rb'
-  register_lazy 'Tilt::JbuilderTemplate',    'tilt/jbuilder',   'jbuilder'
+  # TILT3: Remove
+  # Deprecated lazy loading of external template engines
+  register_lazy 'Tilt::HandlebarsTemplate',  'tilt/_handlebars', 'handlebars', 'hbs'
+  register_lazy 'Tilt::OrgTemplate',         'tilt/_org',        'org'
+  register_lazy 'Tilt::OrgTemplate',         'tilt/_emacs_org',  'org'
+  register_lazy 'Tilt::JbuilderTemplate',    'tilt/_jbuilder',   'jbuilder'
 end

data/bundle/ruby/3.2.0/gems/unicode-display_width-3.1.4/CHANGELOG.md

@@ -0,0 +1,291 @@
+# CHANGELOG
+
+## 3.1.4
+
+- Fix that skin tone modifiers were ignored when used in a non-ZWJ sequence
+  context (= single emoji char + modifier) #29
+- Add more docs and specs about modifier handling
+
+## 3.1.3
+
+Better handling of non-UTF-8 strings, patch by @Earlopain:
+
+- Data with *BINARY* encoding is interpreted as UTF-8, if possible
+- Use `invalid: :replace` and `undef: :replace` options when converting to UTF-8
+
+## 3.1.2
+
+- Performance improvements
+
+## 3.1.1
+
+- Performance improvements
+
+## 3.1.0
+
+**Improve Emoji support:**
+
+- Emoji modes: Differentiate between well-formed Emoji (`:possible`) and any
+  ZWJ/modifier sequence (`:all`). The latter is more common and more efficient
+  to implement.
+- Unify `:rgi_{fqe,mqe,uqe}` options to just `:rgi` to keep things simpler (corresponds to
+  the former `:rgi_uqe` option). Most terminals that want to support the RGI set
+  will probably want to catch Emoji sequences with missing VS16s.
+- Add new `:all_no_vs16` and `:rgi_at` modes to be able to support some terminals
+  that needs these quirks
+- Add alias `emoji: :auto` for `emoji: true` and `emoji: :none` for `emoji: false`
+- `:auto` mode: Only consider terminal cells when recommending Emoji support level
+  (Emoji themselves might display differently)
+- `:auto` mode: Set default Emoji mode for unknown/unsupported terminals to `:none`
+- Rename `:basic` mode to `:vs16`
+
+## 3.0.1
+
+
+- Add WezTerm and foot as good Emoji terminals
+
+## 3.0.0
+
+**Rework Emoji support:**
+
+- Emoji widths are now enabled by default
+- Only reduce Emoji width to 2 when RGI Emoji detected (configurable)
+- VS16 turns Emoji characters of width 1 into full-width
+- Please note that Emoji parsing has a notable impact on performance.
+  You can use the `emoji: false` option to disable Emoji adjustments
+- Tries to detect terminal's Emoji support level automatically (from ENV vars)
+
+**Index fixes and updates:**
+
+- Private-use characters are considered ambiguous (were given width 1 before)
+- Fix that a few zero-width ignorable codepoints from recent Unicode were missing
+- Consider the following separators to be zero-width:
+  - U+2028 - LINE SEPARATOR - Zl
+  - U+2029 - PARAGRAPH SEPARATOR - Zp
+
+**Other:**
+
+- Add keyword arguments to `Unicode::DisplayWidth.of`. If you are using a hash
+  with overwrite values as third parameter, be sure to put it in curly braces.
+- Using third parameter or explicit hash as fourth parameter is deprecated,
+  please migrate to the keyword arguments API
+- Gem raises `ArgumentError` for ambiguous values other than 1 or 2
+- Performance optimizations
+- Require Ruby 2.5
+
+## 2.6.0
+
+- Unicode 16
+
+## 2.5.0
+
+- Unicode 15.1
+
+## 2.4.2
+
+More performance improvements:
+
+- Optimize lookup of first 4096 codepoints
+- Avoid overwrite lookup if no overwrites are set
+
+## 2.4.1
+
+- Improve general performance!
+- Further improve performance for ASCII strings
+
+*You should really upgrade - it's much faster now!*
+
+## 2.4.0
+- Improve performance for ASCII-only strings, by @fatkodima
+- Require Ruby 2.4
+
+## 2.3.0
+
+- Unicode 15.0
+
+## 2.2.0
+
+- Add *Hangul Jamo Extended-B* block to zero-width chars, thanks @ninjalj #22
+
+## 2.1.0
+
+- Unicode 14.0
+
+## 2.0.0
+
+Add Support for Ruby 3.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"
+```
+
+## 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
+
+## 1.6.1
+
+- Fix that ambiguous and overwrite options where ignored for emoji-measuring
+
+## 1.6.0
+
+- Unicode 12.1
+
+## 1.5.0
+
+- Unicode 12
+
+## 1.4.1
+
+- Only bundle required lib/* and data/* files in actual rubygem, patch by @tas50
+
+## 1.4.0
+
+- Unicode 11
+
+## 1.3.3
+
+- Replace Gem::Util.gunzip with direct zlib implementation
+  This removes the dependency on rubygems, fixes #17
+
+## 1.3.2
+
+- Explicitly load rubygems/util, fixes regression in 1.3.1 (autoload issue)
+
+## 1.3.1
+
+- Use `Gem::Util` for `gunzip`, removes deprecation warning, patch by @Schwad
+
+## 1.3.0
+
+- Unicode 10
+
+## 1.2.1
+
+- Fix bug that `emoji: true` would fail for emoji without modifier
+
+## 1.2.0
+
+- Add zero-width codepoint ranges: U+2060..U+206F, U+FFF0..U+FFF8, U+E0000..U+E0FFF
+- Add full-witdh codepoint ranges: U+3400..U+4DBF, U+4E00..U+9FFF, U+F900..U+FAFF, U+20000..U+2FFFD, U+30000..U+3FFFD
+- Experimental emoji support using the [unicode-emoji](https://github.com/janlelis/unicode-emoji) gem
+- Fix minor bug in index compression scheme
+
+## 1.1.3
+
+- Fix that non-UTF-8 encodings do not throw errors, patch by @windwiny
+
+## 1.1.2
+
+- Reduce memory consumption and increase performance, patch by @rrosenblum
+
+## 1.1.1
+
+- Always load index into memory, fixes #9
+
+## 1.1.0
+
+- Support Unicode 9.0
+
+## 1.0.5
+
+- Actually include new index from 1.0.4
+
+## 1.0.4
+
+- New index format (much smaller) and internal API changes
+- Move index generation to a builder plugin for the unicoder gem
+- No public API changes
+
+## 1.0.3
+
+- Avoid circular dependency warning
+
+## 1.0.2
+
+- Fix error that gemspec might be invalid under some circumstances (see gh#6)
+
+## 1.0.1
+
+- Inofficially allow Ruby 1.9
+
+## 1.0.0
+
+- Faster than 0.3.1
+- Advanced determination of character width
+- This includes: Treat width of most chars of general categories (Mn, Me, Cf) as 0
+- This includes: Introduce list of characters with special widths
+- Allow custom overrides for specific codepoints
+- Set required Ruby version to 2.0
+- Add NO_STRING_EXT mode to disable monkey patching
+- Internal API & index format changed drastically
+- Remove require 'unicode/display_size' (use 'unicode/display_width' instead)
+
+## 0.3.1
+
+- Faster than 0.3.0
+- Deprecate usage of aliases: String#display_size and String#display_length
+- Eliminate Ruby warnings (@amatsuda)
+
+## 0.3.0
+
+- Update EastAsianWidth from 7.0 to 8.0
+- Add rake task to update EastAsianWidth.txt
+- Move code to generate index from library to Rakefile
+- Update project's meta files
+- Deprecate requiring 'unicode-display_size'
+
+## 0.2.0
+
+- Update EastAsianWidth from 6.0 to 7.0
+- Don't build index table automatically when not available
+- Don't include EastAsianWidth.txt in gem (only index)
+
+
+## 0.1.0
+
+- Fix github issue #1
+
+
+## 0.1.0
+
+- Initial release

data/bundle/ruby/{3.3.0/gems/unicode-display_width-1.8.0 → 3.2.0/gems/unicode-display_width-3.1.4}/MIT-LICENSE.txt

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

data/bundle/ruby/3.2.0/gems/unicode-display_width-3.1.4/README.md

@@ -0,0 +1,194 @@
+# 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, which is useful for all kinds of terminal-based applications. The implementation is based on [EastAsianWidth.txt](https://www.unicode.org/Public/UNIDATA/EastAsianWidth.txt), the [Emoji specfication](https://www.unicode.org/reports/tr51/) and other data, 100% in Ruby. It does not rely on the OS vendor ([wcwidth()](https://github.com/janlelis/wcswidth-ruby)) to provide an up-to-date method for measuring string width in terminals.
+
+Unicode version: **16.0.0** (September 2024)
+
+## Gem Version 3 — Improved Emoji Support
+
+**Emoji support is now enabled by default.** See below for description and configuration possibilities.
+
+**Unicode::DisplayWidth.of now takes keyword arguments:** { ambiguous:, emoji:, overwrite: }
+
+See [CHANGELOG](/CHANGELOG.md) for details.
+
+## Gem Version 2.4.2 — Performance Updates
+
+**If you use this gem, you should really upgrade to 2.4.2 or newer. It's often 100x faster, sometimes even 1000x and more!**
+
+This is possible because the gem now detects if you use very basic (and common) characters, like ASCII characters. Furthermore, the character width lookup code has been optimized, so even when the string involves full-width or ambiguous characters, the gem is much faster now.
+
+## Introduction to Character Widths
+
+Guessing the correct space a character will consume on terminals is not easy. There is no single standard. Most implementations combine data from [East Asian Width](https://www.unicode.org/reports/tr11/), some [General Categories](https://en.wikipedia.org/wiki/Unicode_character_property#General_Category), and hand-picked adjustments.
+
+### How this Library Handles Widths
+
+Further at the top means higher precedence. Please expect changes to this algorithm with every MINOR version update (the X in 1.X.0)!
+
+Width  | Characters                   | Comment
+-------|------------------------------|--------------------------------------------------
+?      | (user defined)               | Overwrites any other values
+?      | Emoji                        | See "How this Library Handles Emoji Width" below
+-1     | `"\b"`                       | Backspace (total width never below 0)
+0      | `"\0"`, `"\x05"`, `"\a"`, `"\n"`, `"\v"`, `"\f"`, `"\r"`, `"\x0E"`, `"\x0F"` | [C0 control codes](https://en.wikipedia.org/wiki/C0_and_C1_control_codes#C0_.28ASCII_and_derivatives.29) which do not change horizontal width
+1      | `"\u{00AD}"`                 | SOFT HYPHEN
+2      | `"\u{2E3A}"`                 | TWO-EM DASH
+3      | `"\u{2E3B}"`                 | THREE-EM DASH
+0      | General Categories: Mn, Me, Zl, Zp, Cf (non-arabic)| Excludes ARABIC format characters
+0      | Derived Property: Default_Ignorable_Code_Point     | Ignorable ranges
+0      | `"\u{1160}".."\u{11FF}"`, `"\u{D7B0}".."\u{D7FF}"` | HANGUL JUNGSEONG
+2      | East Asian Width: F, W       | Full-width characters
+2      | `"\u{3400}".."\u{4DBF}"`, `"\u{4E00}".."\u{9FFF}"`, `"\u{F900}".."\u{FAFF}"`, `"\u{20000}".."\u{2FFFD}"`, `"\u{30000}".."\u{3FFFD}"` | Full-width ranges
+1 or 2 | East Asian Width: A          | Ambiguous characters, user defined, default: 1
+1      | All other codepoints         | -
+
+## Install
+
+Install the gem with:
+
+    $ gem install unicode-display_width
+
+Or add to your Gemfile:
+
+    gem 'unicode-display_width'
+
+## Usage
+
+```ruby
+require 'unicode/display_width'
+
+Unicode::DisplayWidth.of("⚀") # => 1
+Unicode::DisplayWidth.of("一") # => 2
+```
+
+### Ambiguous Characters
+
+The second parameter defines the value returned by characters defined as ambiguous:
+
+```ruby
+Unicode::DisplayWidth.of("·", 1) # => 1
+Unicode::DisplayWidth.of("·", 2) # => 2
+```
+
+### Encoding Notes
+
+- Data with *BINARY* encoding is interpreted as UTF-8, if possible
+- Non-UTF-8 strings are converted to UTF-8 before measuring, using the [`{invalid: :replace, undef: :replace}`) options](https://ruby-doc.org/3.3.5/encodings_rdoc.html#label-Encoding+Options)
+
+### Custom Overwrites
+
+You can overwrite how to handle specific code points by passing a hash (or even a proc) as `overwrite:` parameter:
+
+```ruby
+Unicode::DisplayWidth.of("a\tb", 1, overwrite: { "\t".ord => 10 })) # => TAB counted as 10, result is 12
+```
+
+Please note that using overwrites disables some perfomance optimizations of this gem.
+
+### Emoji
+
+If your terminal supports it, the gem detects Emoji and Emoji sequences and adjusts the width of the measured string. This can be disabled by passing `emoji: false` as an argument:
+
+```ruby
+Unicode::DisplayWidth.of "🤾🏽‍♀️", emoji: :all # => 2
+Unicode::DisplayWidth.of "🤾🏽‍♀️", emoji: false # => 5
+```
+
+#### How this Library Handles Emoji Width
+
+There are many Emoji which get constructed by combining other Emoji in a sequence. This makes measuring the width complicated, since terminals might either display the combined Emoji or the separate parts of the Emoji individually.
+
+Another aspect where terminals disagree is whether Emoji characters which have a text presentation by default (width 1) should be turned into full-width (width 2) when combined with Variation Selector 16 (*U+FEOF*).
+
+Finally, it varies if Skin Tone Modifiers can be applied to all characters or just to those with the "Emoji Base" property.
+
+Emoji Type  | Width / Comment
+------------|----------------
+Basic/Single Emoji character without Variation Selector   | No special handling
+Basic/Single Emoji character with VS15 (Text)             | No special handling
+Basic/Single Emoji character with VS16 (Emoji)            | 2 or East Asian Width (see table below)
+Single Emoji character with Skin Tone Modifier            | 2
+Skin Tone Modifier used in isolation or with invalid base | 2 if Emoji mode is configured to `:rgi` / `:rgi_at`
+Emoji Sequence                                            | 2 if Emoji belongs to configured Emoji set (see table below)
+
+#### Emoji Modes
+
+The `emoji:` option can be used to configure which type of Emoji should be considered to have a width of 2 and if VS16-Emoji should be widened. Other sequences are treated as non-combined Emoji, so the widths of all partial Emoji add up (e.g. width of one basic Emoji + one skin tone modifier + another basic Emoji). The following Emoji settings can be used:
+
+`emoji:` Option | VS16-Emoji Width | Emoji Sequences Width / Comment | Example Terminals
+----------------|------------------|---------------------------------|------------------
+`true` or `:auto`  | - | Automatically use recommended Emoji setting for your terminal | -
+`:all`     | 2                | 2 for all ZWJ/modifier/keycap sequences, even if they are not well-formed Emoji sequences | iTerm, foot
+`:all_no_vs16` | EAW (1 or 2) | 2 for all ZWJ/modifier/keycap sequences, even if they are not well-formed Emoji sequences | WezTerm
+`:possible`| 2                | 2 for all possible/well-formed Emoji sequences | ?
+`:rgi`     | 2                | 2 for all [RGI Emoji](https://www.unicode.org/reports/tr51/#def_rgi_set) sequences | ?
+`:rgi_at`  | EAW (1 or 2)     | 1 or 2: Like `:rgi`, but Emoji sequences starting with a default-text Emoji have EAW | Apple Terminal
+`:vs16`    | 2                | 2 * number of partial Emoji (sequences never considered to represent a combined Emoji) | kitty?
+`false` or  `:none` | EAW (1 or 2) | No Emoji adjustments | gnome-terminal, many older terminals
+
+- *EAW:* East Asian Width
+- *RGI Emoji:* Emoji Recommended for General Interchange
+- *ZWJ:* Zero-width Joiner: Codepoint `U+200D`,used in many Emoji sequences
+
+#### Emoji Support in Terminals
+
+Unfortunately, the level of Emoji support varies a lot between terminals. While some of them are able to display (almost) all Emoji sequences correctly, others fall back to displaying sequences of basic Emoji. When `emoji: true` or `emoji: :auto` is used, the gem will attempt to set the best fitting Emoji setting for you (e.g. `:rgi_at` on "Apple_Terminal" or `false` on Gnome's terminal widget).
+
+Please note that Emoji display and number of terminal columns used might differs a lot. For example, it might be the case that a terminal does not understand which Emoji to display, but still manages to calculate the proper amount of terminal cells. The automatic Emoji support level per terminal only considers the latter (cursor position), not the actual Emoji image(s) displayed. Please [open an issue](https://github.com/janlelis/unicode-display_width/issues/new) if you notice your terminal application could use a better default value. Also see the [ucs-detect project](https://ucs-detect.readthedocs.io/results.html), which is a great resource that compares various terminal's Unicode/Emoji capabilities. You can visually check how your terminals renders different kind of Emoji types with the [terminal-emoji-width.rb script](https://github.com/janlelis/unicode-display_width/blob/main/misc/terminal-emoji-width.rb).
+
+**To terminal implementors reading this:** Although the practice of giving all Emoji/ZWJ sequences a width of 2 (`:all` mode described above) has some advantages, it does not lead to a particularly good developer experience. Since there is always the possibility of well-formed Emoji that are currently not supported (non-RGI / future Unicode) appearing, those sequences will take more cells. Instead of overflowing, cutting off sequences or displaying placeholder-Emoji, could it be worthwile to implement the `:rgi` option (only known Emoji get width 2) and give those unknown Emoji the space they need? This would support the idea that the meaning of an unknown Emoji sequence can still be conveyed (without messing up the terminal at the same time). Just a thought…
+
+### Usage with String Extension
+
+```ruby
+require 'unicode/display_width/string_ext'
+
+"⚀".display_width # => 1
+'一'.display_width # => 2
+```
+
+### Usage with Config Object
+
+You can use a config object that 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: :all,
+)
+
+display_width.of "⚀" # => 1
+display_width.of "🤠‍🤢" # => 2
+display_width.of "A" # => 100
+```
+
+### Usage from the Command-Line
+
+Use this one-liner to print out display widths for strings from the command-line:
+
+```
+$ gem install unicode-display_width
+$ ruby -r unicode/display_width -e 'puts Unicode::DisplayWidth.of $*[0]' -- "一"
+```
+Replace "一" with the actual string to measure
+
+## Other Implementations & Discussion
+
+- Python: https://github.com/jquast/wcwidth
+- JavaScript: https://github.com/mycoboco/wcwidth.js
+- C: https://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
+- C for Julia: https://github.com/JuliaLang/utf8proc/issues/2
+- Golang: https://github.com/rivo/uniseg
+
+See [unicode-x](https://github.com/janlelis/unicode-x) for more Unicode related micro libraries.
+
+## Copyright & Info
+
+- Copyright (c) 2011, 2015-2024 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