restify 2.0.1 → 2.1.0

data/vendor/bundle/ruby/4.0.0/gems/unicode-display_width-3.2.0/MIT-LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT LICENSE
+
+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
+"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/vendor/bundle/ruby/4.0.0/gems/unicode-display_width-3.2.0/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: **17.0.0** (September 2025)
+
+## 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 unless Emoji mode is `:none` or `vs16`
+Skin Tone Modifier used in isolation or with invalid base | 2 if Emoji mode is `: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-2025 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/vendor/bundle/ruby/4.0.0/gems/unicode-emoji-4.2.0/CHANGELOG.md

@@ -0,0 +1,202 @@
+# CHANGELOG
+
+## 4.2.0
+
+- Allow Ruby 4.0
+- Remove Non-Emoji pictographs from spec, since they have been removed in Unicode 17
+- Update valid subdivisions to CLDR 48 (no changes)
+
+## 4.1.0
+
+- Unicode 17
+- Update valid subdivisions to CLDR 47 (no changes)
+
+## 4.0.4
+
+- Add `REGEX_TEXT_PRESENTATION` to be able to match for raw default-text Emoji codepoints
+
+## 4.0.3
+
+- Remove emoji-test.txt from Rubygems package
+
+## 4.0.2
+
+- Directly use `RbConfig::CONFIG["UNICODE_EMOJI_VERSION"]` to detect Ruby's Emoji version,
+  drop unicode-version dependency
+
+## 4.0.0
+
+- **Breaking change:** Regexes now include single skin tone modifiers (`🏻`) and hair components (`🦰`).
+  They were previously considered to be invalid partial Emoji, however since they are supposed to be
+  displayed as Emoji in isolation, they are now part of the regexes (see *ED-20* in UTS51).
+- **Breaking change:** Drop `REGEX_ANY` in favor of `REGEX_PROP_EMOJI`
+- Expose regexes for Emoji props (`REGEX_PROP_*`). The advantage over using the native regex properties
+  directly is that you will be able to use the Emoji support level of this gem instead of Ruby's.
+  For example, as of releasing this, the current Emoji version is 16.0, while Ruby is at 15.0.
+  Also see README for a table listing the regexes that match Emoji properties.
+- Add `REGEX_EMOJI_KEYCAP` for matching specifically Emoji keycaps
+- Use character class instead of lookbehind for native text emoji and non-emoji pictographic regexes
+
+## 3.8.0
+
+- Add new RGI-based regexes `REGEX_INCLUDE_MQE` and `REGEX_INCLUDE_MQE_UQE` which allows to match
+  for minimally-qualified and unqualified RGI sequences (Emoji that lack some VS16)
+- Add specs running through `emoji-text.txt` and classify qualification statuses per regex
+- Improve documentation and add detailed table about which regex has which features
+- Native regexes: Use native Emoji props for Emoji text presentation
+- Update CLDR to v46 (valid subdivisions)
+- Further improvements (see commit log)
+
+## 3.7.0
+
+- Bump required Ruby slightly to 2.5
+- Introduce new `REGEX_POSSIBLE` which contains the regex described in
+  https://www.unicode.org/reports/tr51/#EBNF_and_Regex
+- Fix that some valid subdivisions were not decompressed (`REGEX_VALID`)
+- Be stricter about selection of tag characters in `REGEX_WELL_FORMED`
+  - Only U+E0030..U+E0039, U+E0061..U+E007A allowed
+  - Max tag sequence length
+- Use native `/\p{RI}/` regex for regional indicators
+- Separately autoload emoji list, so it can be loaded when other indexes
+  are not needed
+
+## 3.6.0
+
+- `Unicode::Emoji::REGEX_TEXT` now matches non-emoji keycaps like "3⃣"  (U+0033 U+20E3)
+- Minor refactorings
+
+## 3.5.0
+
+- Emoji 16.0
+
+## 3.4.0
+
+- Emoji 15.1
+
+## 3.3.2
+
+- Update valid subdivisions to CLDR 43 (no changes)
+  -> there won't be any new RGI subdivision flags in Emoji
+
+## 3.3.1
+
+- Update valid subdivisions to CLDR 42 (no changes)
+
+## 3.3.0
+
+- Emoji 15.0
+
+## 3.2.0
+
+- Update valid subdivisions to CLDR 41
+
+## 3.1.1
+
+- Fix `REGEX` to be able to match complete family emoji, instead of
+  sub-matching partial families, thanks @matt17r
+
+## 3.1.0
+
+- Update valid subdivisions to CLDR 40
+
+## 3.0.0
+
+- Vastly improve memory usage, patch by @radarek
+  - Emoji regexes are now pre-generated and bundled with the release
+  - Regexes use character classes instead of unions when possible
+  - Most constants (e.g. regexes) now get autoloaded
+  - See https://github.com/janlelis/unicode-emoji/pull/9 for more details
+
+## 2.9.0
+
+- Emoji 14.0
+
+## 2.8.0
+
+- Update valid subdivisions to CLDR 39
+
+## 2.7.1
+
+- Update valid subdivisions to CLDR 38.1
+
+## 2.7.0
+
+- Update valid subdivisions to CLDR 38
+- Loosen Ruby dependency to allow Ruby 3.0
+
+## 2.6.0
+
+- Emoji 13.1
+
+## 2.5.0
+
+- Use native Emoji regex properties when current Ruby's Emoji support is the same as our current Emoji version
+- Update valid subdivisions to CLDR 37
+
+## 2.4.0
+
+- Emoji 13.0
+
+## 2.3.1
+
+- Fix index to actually include Emoji 12.1
+
+## 2.3.0
+
+- Emoji 12.1
+
+## 2.2.0
+
+- Update subdivisions to CLDR 36
+
+## 2.1.0
+
+- Add `REGEX_PICTO` which matches codepoints with the **Extended_Pictographic** property
+- Add `REGEX_PICTO_NO_EMOJI` which matches codepoints with the **Extended_Pictographic** property, but no **Emoji** property
+
+## 2.0.0
+
+- Emoji 12.0 data (including valid subdivisions)
+- Introduce new `REGEX_WELL_FORMED` to be able to match for invalid tag and region sequences
+- Introduce new `*_INCLUDE_TEXT` regexes which include matching for textual presentation emoji
+- Refactoring: Update Emoji matching to latest standard while keeping naming close to standard
+- Issue warning when using `#list` method to retrieve outdated category
+- Change matching for ZWJ sequences: Do not limit sequence to a maximum of 3 ZWJs
+
+## 1.1.0
+
+- Emoji 11.0
+- Do not depend on rubygems (only use zlib stdlib for unzipping)
+
+## 1.0.3
+
+- Explicitly load rubygems/util, fixes regression in 1.2.1
+
+## 1.0.2
+
+- Use `Gem::Util` for `gunzip`, removes deprecation warning
+
+## 1.0.1
+
+- Actually set required Ruby version to 2.3 in gemspec
+
+## 1.0.0
+
+- Drop support for Ruby below 2.3, use 0.9 if you need to
+- Internal refactorings, no API change
+
+## 0.9.3
+
+- Implement native Emoji regex matchers, but do not activate or document, yet
+
+## 0.9.2
+
+- REGEX_TEXT: Do not match if the text emoji is followed by a emoji modifier
+
+## 0.9.1
+
+- Include a categorized list of recommended Emoji
+
+## 0.9.0
+
+- Initial release (Emoji version 5.0)

data/vendor/bundle/ruby/4.0.0/gems/unicode-emoji-4.2.0/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2017-2024 Jan Lelis, https://janlelis.com
+
+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/vendor/bundle/ruby/4.0.0/gems/unicode-emoji-4.2.0/README.md

@@ -0,0 +1,205 @@
+# Unicode::Emoji [![[version]](https://badge.fury.io/rb/unicode-emoji.svg)](https://badge.fury.io/rb/unicode-emoji)  [![[ci]](https://github.com/janlelis/unicode-emoji/workflows/Test/badge.svg)](https://github.com/janlelis/unicode-emoji/actions?query=workflow%3ATest)
+
+Provides various sophisticated regular expressions to work with Emoji in strings,
+incorporating the latest Unicode / Emoji standards.
+
+Additional features:
+
+- A categorized list of Emoji (RGI: Recommended for General Interchange)
+- Retrieve Emoji properties info about specific codepoints (Emoji_Modifier, Emoji_Presentation, etc.)
+
+Emoji version: **17.0** (September 2025)
+
+CLDR version (used for sub-region flags): **47** (March 2025)
+
+## Gemfile
+
+```ruby
+gem "unicode-emoji"
+```
+
+## Usage – Regex Matching
+
+The gem includes multiple Emoji regexes, which are compiled out of various Emoji Unicode data sources.
+
+```ruby
+require "unicode/emoji"
+
+string = "String which contains all types of Emoji sequences:
+
+- Basic Emoji: 😴
+- Textual Emoji with Emoji variation (VS16): ▶️
+- Emoji with skin tone modifier: 🛌🏽
+- Region flag: 🇵🇹
+- Sub-Region flag: 🏴󠁧󠁢󠁳󠁣󠁴󠁿
+- Keycap sequence: 2️⃣
+- Skin tone modifier: 🏻
+- Sequence using ZWJ (zero width joiner): 🤾🏽‍♀️
+"
+
+string.scan(Unicode::Emoji::REGEX) # => ["😴", "▶️", "🛌🏽", "🇵🇹", "🏴󠁧󠁢󠁳󠁣󠁴󠁿", "2️⃣", "🏻", "🤾🏽‍♀️"]
+```
+
+Depending on your exact usecase, you can choose between multiple levels of Emoji detection:
+
+### Main Regexes
+
+Regex                         | Description | Example Matches | Example Non-Matches
+------------------------------|-------------|-----------------|--------------------
+`Unicode::Emoji::REGEX`       | **Use this one if unsure!** Matches (non-textual) Basic Emoji and all kinds of *recommended* Emoji sequences (RGI/FQE) | `😴`, `▶️`, `🛌🏽`, `🇵🇹`, `2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🤾🏽‍♀️`, `🏻` |  `🤾🏽‍♀`, `🏌‍♂️`, `😴︎`, `▶`, `🇵🇵`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤠‍🤢`, `1`, `1⃣`
+`Unicode::Emoji::REGEX_VALID` | Matches (non-textual) Basic Emoji and all kinds of *valid* Emoji sequences | `😴`, `▶️`, `🛌🏽`, `🇵🇹`, `2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤾🏽‍♀️`, `🤾🏽‍♀` ,`🏌‍♂️`, `🤠‍🤢`, `🏻` | `😴︎`, `▶`, `🇵🇵`, `1`, `1⃣`
+`Unicode::Emoji::REGEX_WELL_FORMED` | Matches (non-textual) Basic Emoji and all kinds of *well-formed* Emoji sequences | `😴`, `▶️`, `🛌🏽`, `🇵🇹`, `2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤾🏽‍♀️`, `🤾🏽‍♀`,`🏌‍♂️` , `🤠‍🤢`,  `🇵🇵`, `🏻` | `😴︎`, `▶`, `1`, `1⃣`
+`Unicode::Emoji::REGEX_POSSIBLE` | Matches all singleton Emoji, all kinds of Emoji sequences, and even non-Emoji singleton components like digits. Only exception: Unqualified keycap sequences are not matched | `😴`, `▶️`, `🛌🏽`, `🇵🇹`, `2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤾🏽‍♀️`, `🤾🏽‍♀`, `🏌‍♂️`, `🤠‍🤢`,  `🇵🇵`, `😴︎`, `▶`, `🏻`, `1` | `1⃣`
+
+#### Include Text Emoji
+
+By default, textual Emoji (emoji characters with text variation selector or those that have a default text presentation) will not be included in the default regexes (except in `REGEX_POSSIBLE`). However, if you wish to match for them too, you can include them in your regex by appending the `_INCLUDE_TEXT` suffix:
+
+Regex                         | Description | Example Matches | Example Non-Matches
+------------------------------|-------------|-----------------|--------------------
+`Unicode::Emoji::REGEX_INCLUDE_TEXT`       | `REGEX` + `REGEX_TEXT` | `😴`, `▶️`, `🛌🏽`, `🇵🇹`, `2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🤾🏽‍♀️`, `😴︎`, `▶`, `1⃣` , `🏻`| `🤾🏽‍♀`, `🏌‍♂️`, `🇵🇵`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤠‍🤢`, `1`
+`Unicode::Emoji::REGEX_VALID_INCLUDE_TEXT` | `REGEX_VALID` + `REGEX_TEXT` | `😴`, `▶️`, `🛌🏽`, `🇵🇹`, `2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤾🏽‍♀️`, `🤾🏽‍♀`, `🏌‍♂️`, `🤠‍🤢`, `😴︎`, `▶`, `1⃣` , `🏻` | `🇵🇵`, `1`
+`Unicode::Emoji::REGEX_WELL_FORMED_INCLUDE_TEXT` | `REGEX_WELL_FORMED` + `REGEX_TEXT` | `😴`, `▶️`, `🛌🏽`, `🇵🇹`, `2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤾🏽‍♀️`, `🤾🏽‍♀`, `🏌‍♂️`, `🤠‍🤢`,  `🇵🇵`, `😴︎`, `▶`, `1⃣` , `🏻` | `1`
+
+#### Minimally-qualified and Unqualified Sequences
+
+Regex                         | Description | Example Matches | Example Non-Matches
+------------------------------|-------------|-----------------|--------------------
+`Unicode::Emoji::REGEX_INCLUDE_MQE` | Like `REGEX`, but additionally includes Emoji with missing Emoji Presentation Variation Selectors, where the first partial Emoji has all required Variation Selectors | `😴`, `▶️`, `🛌🏽`, `🇵🇹`, `2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🤾🏽‍♀️`, `🤾🏽‍♀`, `🏻` | `🏌‍♂️`, `😴︎`, `▶`, `🇵🇵`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤠‍🤢`, `1`, `1⃣`
+`Unicode::Emoji::REGEX_INCLUDE_MQE_UQE` | Like `REGEX`, but additionally includes Emoji with missing Emoji Presentation Variation Selectors | `😴`, `▶️`, `🛌🏽`, `🇵🇹`, `2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🤾🏽‍♀️`, `🤾🏽‍♀`, `🏌‍♂️`, `🏻` | `😴︎`, `▶`, `🇵🇵`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤠‍🤢`, `1`, `1⃣`
+
+[List of MQE and UQE Emoji sequences](https://character.construction/unqualified-emoji)
+
+#### Singleton Regexes
+
+Matches only simple one-codepoint (+ optional variation selector) Emoji:
+
+Regex                         | Description | Example Matches | Example Non-Matches
+------------------------------|-------------|-----------------|--------------------
+`Unicode::Emoji::REGEX_BASIC` | Matches (non-textual) Basic Emoji, but no sequences at all | `😴`, `▶️`, `🏻` | `😴︎`, `▶`, `🛌🏽`, `🇵🇹`, `🇵🇵`,`2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤾🏽‍♀️`, `🤾🏽‍♀`, `🏌‍♂️`, `🤠‍🤢`, `1`
+`Unicode::Emoji::REGEX_TEXT`  | Matches only textual singleton Emoji | `😴︎`, `▶` | `😴`, `▶️`, `🏻`, `🛌🏽`, `🇵🇹`, `🇵🇵`,`2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤾🏽‍♀️`, `🤾🏽‍♀`, `🏌‍♂️`, `🤠‍🤢`, `1`
+
+Here is a list of all Emoji that can be matched using the two regexes: [character.construction/emoji-vs-text](https://character.construction/emoji-vs-text). The `REGEX_BASIC` regex also matches [visual Emoji components](https://character.construction/emoji-components) (skin tone modifiers and hair components).
+
+While `REGEX_BASIC` is part of the above regexes, `REGEX_TEXT` is only included in the `*_INCLUDE_TEXT` or `*_UQE` variants.
+
+### Comparison 
+
+1) Fully-qualified RGI Emoji ZWJ sequence
+2) Minimally-qualified RGI Emoji ZWJ sequence (lacks Emoji Presentation Selectors, but not in the first Emoji character)
+3) Unqualified RGI Emoji ZWJ sequence (lacks Emoji Presentation Selector, including in the first Emoji character). Unqualified Emoji include all basic Emoji in Text Presentation (see column 11/12).
+4) Non-RGI Emoji ZWJ sequence
+5) Valid Region made from a pair of Regional Indicators
+6) Any Region made from a pair of Regional Indicators
+7) RGI Flag Emoji Tag Sequences (England, Scotland, Wales)
+8) Valid Flag Emoji Tag Sequences (any known subdivision)
+9) Any Emoji Tag Sequences (any tag sequence with any base)
+10) Basic Default Emoji Presentation Characters or Text characters with Emoji Presentation Selector
+11) Basic Default Text Presentation Characters or Basic Emoji with Text Presentation Selector
+12) Non-Emoji (unqualified) keycap
+
+Regex | 1 RGI/FQE | 2 RGI/MQE | 3 RGI/UQE | 4 Non-RGI | 5 Valid Re­gion | 6 Any Re­gion | 7 RGI Tag | 8 Valid Tag | 9 Any Tag | 10 Basic Emoji | 11 Basic Text | 12 Text Key­cap
+-|-|-|-|-|-|-|-|-|-|-|-|-
+REGEX                          | ✅ | ❌ | ❌    | ❌ | ✅ | ❌ | ✅ | ❌ | ❌ | ✅ | ❌ | ❌
+REGEX INCLUDE TEXT             | ✅ | ❌ | ❌    | ❌ | ✅ | ❌ | ✅ | ❌ | ❌ | ✅ | ✅ | ✅
+REGEX INCLUDE MQE              | ✅ | ✅ | ❌    | ❌ | ✅ | ❌ | ✅ | ❌ | ❌ | ✅ | ❌ | ❌
+REGEX INCLUDE MQE UQE          | ✅ | ✅ | ✅    | ❌ | ✅ | ❌ | ✅ | ❌ | ❌ | ✅ | ✅ | ✅
+REGEX VALID                    | ✅ | ✅ | (✅)¹ | ✅ | ✅ | ❌ | ✅ | ✅ | ❌ | ✅ | ❌ | ❌
+REGEX VALID INCLUDE TEXT       | ✅ | ✅ | ✅    | ✅ | ✅ | ❌ | ✅ | ✅ | ❌ | ✅ | ✅ | ✅
+REGEX WELL FORMED              | ✅ | ✅ | (✅)¹ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ❌
+REGEX WELL FORMED INCLUDE TEXT | ✅ | ✅ | ✅    | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅
+REGEX POSSIBLE                 | ✅ | ✅ | ✅    | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌
+REGEX BASIC                    | ❌ | ❌ | ❌    | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌
+REGEX TEXT                     | ❌ | ❌ | ❌    | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅
+
+¹ Matches all unqualified Emoji, except for textual singleton Emoji (see columns 11, 12)
+
+See [spec files](/spec) for detailed examples about which regex matches which kind of Emoji.
+
+### Picking the Right Emoji Regex
+
+- Usually you just want `REGEX` (recommended Emoji set, RGI)
+- Use `REGEX_INCLUDE_MQE` or `REGEX_INCLUDE_MQE_UQE` if you want to catch Emoji sequences with missing Variation Selectors.
+- If you want broader matching (any ZWJ sequences, more sub-region flags), choose `REGEX_VALID`
+- If you need to match any region flag and any tag sequence, choose `REGEX_WELL_FORMED`
+- Use the `_INCLUDE_TEXT` suffix with any of the above base regexes, if you want to also match basic textual Emoji
+- And finally, there is also the option to use `REGEX_POSSIBLE`, which is a simplified test for possible Emoji, comparable to `REGEX_WELL_FORMED*`. It might contain false positives, however, the regex is less complex and [suggested in the Unicode standard itself](https://www.unicode.org/reports/tr51/#EBNF_and_Regex) as a first check.
+
+### Examples
+
+Desc | Emoji | Escaped | `REGEX` (RGI/FQE) | `REGEX_INCLUDE_MQE` (RGI/MQE) | `REGEX_VALID` | `REGEX_WELL_FORMED` / `REGEX_POSSIBLE`
+-----|-------|---------|---------------|-----------------------|-----------------------------------|-----------------
+RGI ZWJ Sequence   | 🤾🏽‍♀️ | `\u{1F93E 1F3FD 200D 2640 FE0F}` | ✅ | ✅ | ✅ | ✅
+RGI ZWJ Sequence MQE | 🤾🏽‍♀ | `\u{1F93E 1F3FD 200D 2640}` | ❌ | ✅ | ✅ | ✅
+Valid ZWJ Sequence, Non-RGI | 🤠‍🤢 | `\u{1F920 200D 1F922}` | ❌ | ❌  | ✅ | ✅
+Known Region       | 🇵🇹 | `\u{1F1F5 1F1F9}` | ✅ | ✅ | ✅ | ✅
+Unknown Region     | 🇵🇵 | `\u{1F1F5 1F1F5}` | ❌ | ❌  | ❌  | ✅
+RGI Tag Sequence   | 🏴󠁧󠁢󠁳󠁣󠁴󠁿 | `\u{1F3F4 E0067 E0062 E0073 E0063 E0074 E007F}` | ✅ | ✅ | ✅ | ✅
+Valid Tag Sequence | 🏴󠁧󠁢󠁡󠁧󠁢󠁿 | `\u{1F3F4 E0067 E0062 E0061 E0067 E0062 E007F}` | ❌ | ❌  | ✅ | ✅
+Well-formed Tag Sequence | 😴󠁧󠁢󠁡󠁡󠁡󠁿 | `\u{1F634 E0067 E0062 E0061 E0061 E0061 E007F}` | ❌ | ❌  | ❌  | ✅
+
+Please see [the standard](https://www.unicode.org/reports/tr51/#Emoji_Sets) for more details, examples, explanations.
+
+More info about valid vs. recommended Emoji can also be found in this [blog article on Emojipedia](https://blog.emojipedia.org/unicode-behind-the-curtain/).
+
+### Emoji Property Regexes
+
+Ruby includes native regex Emoji properties, as listed in the following table. You can also opt-in to use the `*_PROP_*` regexes to get the Emoji support level of this gem (instead of Ruby's). [Which Emoji version does Ruby support?](https://idiosyncratic-ruby.com/73-unicode-version-mapping.html#ruby--emoji)
+
+Gem Regex (`Unicode::Emoji`'s Emoji support level) | Native Regex (Ruby's Emoji support level)
+---------------------------------------------------|------------------------------------------
+`Unicode::Emoji::REGEX_PROP_EMOJI`         | `/\p{Emoji}/`
+`Unicode::Emoji::REGEX_PROP_MODIFIER`      | `/\p{EMod}/`
+`Unicode::Emoji::REGEX_PROP_MODIFIER_BASE` | `/\p{EBase}/`
+`Unicode::Emoji::REGEX_PROP_COMPONENT`     | `/\p{EComp}/`
+`Unicode::Emoji::REGEX_PROP_PRESENTATION`  | `/\p{EPres}/`
+`Unicode::Emoji::REGEX_TEXT_PRESENTATION`  | `/[\p{Emoji}&&\P{EPres}]/`
+
+#### Extended Pictographic Regex
+
+`Unicode::Emoji::REGEX_PICTO` matches single codepoints with the **Extended_Pictographic** property. For example, it will match `✀` BLACK SAFETY SCISSORS.
+
+`Unicode::Emoji::REGEX_PICTO_NO_EMOJI` matches single codepoints with the **Extended_Pictographic** property, but excludes Emoji characters.
+
+See [character.construction/picto](https://character.construction/picto) for a list of all non-Emoji pictographic characters.
+
+## Usage – List
+
+Use `Unicode::Emoji::LIST` or the **list** method to get a ordered and categorized list of Emoji:
+
+```ruby
+Unicode::Emoji.list.keys
+# => ["Smileys & Emotion", "People & Body", "Component", "Animals & Nature", "Food & Drink", "Travel & Places", "Activities", "Objects", "Symbols", "Flags"]
+
+Unicode::Emoji.list("Food & Drink").keys
+# => ["food-fruit", "food-vegetable", "food-prepared", "food-asian", "food-marine", "food-sweet", "drink", "dishware"]
+
+Unicode::Emoji.list("Food & Drink", "food-asian")
+=> ["🍱", "🍘", "🍙", "🍚", "🍛", "🍜", "🍝", "🍠", "🍢", "🍣", "🍤", "🍥", "🥮", "🍡", "🥟", "🥠", "🥡"]
+```
+
+Please note that categories might change with future versions of the Emoji standard, although this has not happened often.
+
+A list of all Emoji (generated from this gem) can be found at [character.construction/emoji](https://character.construction/emoji).
+
+## Usage – Properties Data
+
+Allows you to access the codepoint data for a single character form Unicode's [emoji-data.txt](https://www.unicode.org/Public/16.0.0/ucd/emoji/emoji-data.txt) file:
+
+```ruby
+require "unicode/emoji"
+
+Unicode::Emoji.properties "☝" # => ["Emoji", "Emoji_Modifier_Base"]
+```
+
+## Also See
+
+- [Unicode® Technical Standard #51](https://www.unicode.org/reports/tr51/)
+- [Emoji categories](https://unicode.org/emoji/charts/emoji-ordering.html)
+- Ruby gem which displays [Emoji sequence names](https://github.com/janlelis/unicode-sequence_name) ([as website](https://character.construction/name))
+- Part of [unicode-x](https://github.com/janlelis/unicode-x)
+
+## MIT
+
+- Copyright (C) 2017-2025 Jan Lelis <https://janlelis.com>. Released under the MIT license.
+- Unicode data: https://www.unicode.org/copyright.html#Exhibit1