unicode-emoji 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8a2374f40fac31061e825e42b16bbed3ad4455c
+  data.tar.gz: 567004277315d4a7a05dd7a86e07056e968e78ef
+SHA512:
+  metadata.gz: 317e769c1426b946ff102670024dda19f8fbe0975af670a01ff79fc0e3c50571ccac503082dda8468b696dd9574ad206c39e20989f8b283993b7c3b48591c356
+  data.tar.gz: b2608a118f51a6c11d579696b4949ceef9827ee45c93609e3816c303199246942842150e240a9f33a013c2290ee1abd8e1b82960b2dcd93ffcc28c9c8debc4f8

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,23 @@
+sudo: false
+language: ruby
+
+rvm:
+- ruby-head
+- 2.4.1
+- 2.3.4
+- 2.2
+- 2.1
+- 2.0
+- jruby-head
+- jruby-9.1.8.0
+
+cache:
+- bundler
+
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head
+    - rvm: 2.0
+#   fast_finish: true
+

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## CHANGELOG
+
+### 0.9.0
+
+* Initial release (Emoji version 5.0)
+

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,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'minitest'
+gem 'rake'

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2017 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,68 @@
+# Unicode::Emoji [![[version]](https://badge.fury.io/rb/unicode-emoji.svg)](http://badge.fury.io/rb/unicode-emoji)  [![[travis]](https://travis-ci.org/janlelis/unicode-emoji.svg)](https://travis-ci.org/janlelis/unicode-emoji)
+
+A small Ruby library which provides Unicode Emoji data and regexes.
+
+Emoji version: **5.0**
+
+Supported Rubies: **2.4**, **2.3**, **2.2**, **2.1**
+
+## Gemfile
+
+```ruby
+gem "unicode-emoji"
+```
+
+## Usage
+
+### Properties
+
+Allows you to access the codepoint data form Unicode's [emoji-data.txt](http://unicode.org/Public/emoji/5.0/emoji-data.txt) file:
+
+```ruby
+require "unicode/emoji"
+
+Unicode::Emoji.properties "☝" # => ["Emoji", "Emoji_Modifier_Base"]
+```
+
+### Regex
+
+Five Emoji regexes are included, which are compiled out of various Emoji Unicode data.
+
+```ruby
+require "unicode/emoji"
+
+string = "String which contains all kinds of emoji:
+
+- Singleton Emoji: 😴
+- Textual singleton Emoji with Emoji variation: ▶️
+- Emoji with skin tone modifier: 🛌🏽
+- Region flag: 🇵🇹
+- Sub-Region flag: 🏴󠁧󠁢󠁳󠁣󠁴󠁿
+- Keycap sequence: 2️⃣
+- Sequence using ZWJ (zero width joiner): 🤾🏽‍♀️
+
+"
+
+string.scan(Unicode::Emoji::REGEX) # => ["😴", "▶️", "🛌🏽", "🇵🇹", "🏴󠁧󠁢󠁳󠁣󠁴󠁿", "2️⃣", "🤾🏽‍♀️"]
+```
+
+Regex                         | Description | Example Matches | Example Non-Matches
+------------------------------|-------------|-----------------|--------------------
+`Unicode::Emoji::REGEX`       | Matches (non-textual) singleton Emoji (except for singleton components, like a skin tone modifier without base Emoji) and all kind of valid Emoji sequences, but restrict ZWJ and TAG sequences to recommended sequences | `😴`, `▶️`, `🛌🏽`, `🇵🇹`, `2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🤾🏽‍♀️` | `😴︎`, `▶`, `🏻`, `🇵🇵`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤠‍🤢`
+`Unicode::Emoji::REGEX_VALID` | Matches (non-textual) singleton Emoji (except for singleton components, like a skin tone modifier without base Emoji) and all kind of valid Emoji sequences | `😴`, `▶️`, `🛌🏽`, `🇵🇹`, `2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤾🏽‍♀️`, `🤠‍🤢` | `😴︎`, `▶`, `🏻`, `🇵🇵`
+`Unicode::Emoji::REGEX_BASIC` | Matches (non-textual) singleton Emoji (except for singleton components, like a skin tone modifier without base Emoji), but no sequences | `😴`, `▶️` | `😴︎`, `▶`, `🏻`, `🛌🏽`, `🇵🇹`, `🇵🇵`,`2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤾🏽‍♀️`, `🤠‍🤢`
+`Unicode::Emoji::REGEX_TEXT`  | Matches only textual singleton Emoji (except for singleton components, like digit 1) | `😴︎`, `▶` | `😴`, `▶️`, `🏻`, `🛌🏽`, `🇵🇹`, `🇵🇵`,`2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤾🏽‍♀️`, `🤠‍🤢`
+`Unicode::Emoji::REGEX_ANY`   | Matches any Emoji-related codepoint (but no variation selectors or tags) | `😴`, `▶`, `🏻`, `🛌`, `🏽`, `🇵`, `🇹`, `2`, `🏴`, `🤾`, `♀`, `🤠`, `🤢` | -
+
+
+## Also See
+
+- [Unicode® Technical Standard #51](http://www.unicode.org/reports/tr51/proposed.html)
+- [Emoji data](http://unicode.org/Public/emoji/5.0/)
+- [Emoji sequence names](https://github.com/janlelis/unicode-sequence_name)
+- Part of [unicode-x](https://github.com/janlelis/unicode-x)
+
+## MIT
+
+- Copyright (C) 2017 Jan Lelis <http://janlelis.com>. Released under the MIT license.
+- Unicode data: http://www.unicode.org/copyright.html#Exhibit1

data/Rakefile

@@ -0,0 +1,37 @@
+# # #
+# 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 Specs
+
+desc "#{gemspec.name} | Spec"
+task :spec do
+  sh "for file in spec/*.rb; do ruby $file; done"
+end
+task default: :spec

data/lib/unicode/emoji.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require_relative "emoji/constants"
+require_relative "emoji/index"
+
+module Unicode
+  module Emoji
+    PROPERTY_NAMES = {
+      B: "Emoji_Modifier_Base",
+      M: "Emoji_Modifier",
+      C: "Emoji_Component",
+      P: "Emoji_Presentation",
+    }
+
+    EMOJI_VARIATION_SELECTOR      = 0xFE0F
+    TEXT_VARIATION_SELECTOR       = 0xFE0E
+    EMOJI_TAG_BASE_FLAG           = 0x1F3F4
+    CANCEL_TAG                    = 0xE007F
+    EMOJI_KEYCAP_SUFFIX           = 0x20E3
+    ZWJ                           = 0x200D
+
+    EMOJI_CHAR                    = INDEX[:PROPERTIES].keys.freeze
+    EMOJI_PRESENTATION            = INDEX[:PROPERTIES].select{ |ord, props| props.include?(:P) }.keys.freeze
+    TEXT_PRESENTATION             = INDEX[:PROPERTIES].select{ |ord, props| !props.include?(:P) }.keys.freeze
+    EMOJI_COMPONENT               = INDEX[:PROPERTIES].select{ |ord, props| props.include?(:C) }.keys.freeze
+    EMOJI_MODIFIER_BASES          = INDEX[:PROPERTIES].select{ |ord, props| props.include?(:B) }.keys.freeze
+    EMOJI_MODIFIERS               = INDEX[:PROPERTIES].select{ |ord, props| props.include?(:M) }.keys.freeze
+    EMOJI_KEYCAPS                 = INDEX[:KEYCAPS].freeze
+    VALID_REGION_FLAGS            = INDEX[:FLAGS].freeze
+    VALID_SUBDIVISIONS            = INDEX[:SD].freeze
+    RECOMMENDED_SUBDIVISION_FLAGS = INDEX[:TAGS].freeze
+    RECOMMENDED_ZWJ_SEQUENCES     = INDEX[:ZWJ].freeze
+
+    pack = ->(ord){ Regexp.escape(Array(ord).pack("U*")) }
+    join = -> (*strings){ "(?:" + strings.join("|") + ")" }
+    pack_and_join = ->(ords){  join[*ords.map{ |ord| pack[ord] }] }
+
+    emoji_character = \
+      pack_and_join[EMOJI_CHAR]
+
+    emoji_presentation_sequence = \
+      join[
+        pack_and_join[TEXT_PRESENTATION] + pack[EMOJI_VARIATION_SELECTOR],
+        pack_and_join[EMOJI_PRESENTATION] + "(?!" + pack[TEXT_VARIATION_SELECTOR] + ")" + pack[EMOJI_VARIATION_SELECTOR] + "?",
+      ]
+
+    text_presentation_sequence = \
+      join[
+        pack_and_join[TEXT_PRESENTATION]+ "(?!" + pack[EMOJI_VARIATION_SELECTOR] + ")" + pack[TEXT_VARIATION_SELECTOR] + "?",
+        pack_and_join[EMOJI_PRESENTATION] + pack[TEXT_VARIATION_SELECTOR]
+      ]
+
+    emoji_component = \
+      pack_and_join[EMOJI_COMPONENT]
+
+    emoji_modifier_sequence = \
+      pack_and_join[EMOJI_MODIFIER_BASES] + pack_and_join[EMOJI_MODIFIERS]
+
+    emoji_keycap_sequence = \
+      pack_and_join[EMOJI_KEYCAPS] + pack[[EMOJI_VARIATION_SELECTOR, EMOJI_KEYCAP_SUFFIX]]
+
+    emoji_valid_region_sequence = \
+      pack_and_join[VALID_REGION_FLAGS]
+
+    emoji_valid_tag_sequence = \
+      "(?:" +
+        pack[EMOJI_TAG_BASE_FLAG] +
+        "(?:" + VALID_SUBDIVISIONS.map{ |sd| Regexp.escape(sd.tr("\u{20}-\u{7E}", "\u{E0020}-\u{E007E}"))}.join("|") + ")" +
+        pack[CANCEL_TAG] +
+      ")"
+
+    emoji_zwj_element = \
+      join[
+        emoji_modifier_sequence,
+        emoji_presentation_sequence,
+        emoji_character,
+      ]
+
+    # Matches basic singleton emoji and all kind of sequences, but restrict zwj and tag sequences to known sequences
+    REGEX = Regexp.compile(
+      pack_and_join[RECOMMENDED_ZWJ_SEQUENCES] +
+      ?| + pack_and_join[RECOMMENDED_SUBDIVISION_FLAGS] +
+      ?| + emoji_modifier_sequence +
+      ?| + "(?!" + emoji_component + ")" + emoji_presentation_sequence +
+      ?| + emoji_keycap_sequence +
+      ?| + emoji_valid_region_sequence  +
+      ""
+    )
+
+    # Matches basic singleton emoji and all kind of valid sequences
+    REGEX_VALID = Regexp.compile(
+      # EMOJI_TAGS.map{ |base, spec| "(?:" + pack[base] + "[" + pack[spec] + "]+" + pack[CANCEL_TAG] + ")" }.join("|") +
+      emoji_valid_tag_sequence +
+      ?| + "(?:" + "(?:" + emoji_zwj_element + pack[ZWJ] + "){1,3}" + emoji_zwj_element + ")" +
+      ?| + emoji_modifier_sequence +
+      ?| + "(?!" + emoji_component + ")" + emoji_presentation_sequence +
+      ?| + emoji_keycap_sequence +
+      ?| + emoji_valid_region_sequence +
+      ""
+    )
+
+    # Matches only basic single, non-textual emoji
+    # Ignores "components" like modifiers or simple digits
+    REGEX_BASIC = Regexp.compile(
+      "(?!" + emoji_component + ")" + emoji_presentation_sequence
+    )
+
+    # Matches only basic single, textual emoji
+    # Ignores "components" like modifiers or simple digits
+    REGEX_TEXT = Regexp.compile(
+      "(?!" + emoji_component + ")" + text_presentation_sequence
+    )
+
+    # Matches any emoji-related codepoint
+    REGEX_ANY = Regexp.compile(
+      emoji_character
+    )
+
+    def self.properties(char)
+      ord = get_codepoint_value(char)
+      props = INDEX[:PROPERTIES][ord]
+
+      if props
+        ["Emoji"] + props.map{ |prop| PROPERTY_NAMES[prop] }
+      else
+        # nothing
+      end
+    end
+
+    def self.get_codepoint_value(char)
+      ord = nil
+
+      if char.valid_encoding?
+        ord = char.ord
+      elsif char.encoding.name == "UTF-8"
+        begin
+          ord = char.unpack("U*")[0]
+        rescue ArgumentError
+        end
+      end
+
+      if ord
+        ord
+      else
+        raise(ArgumentError, "Unicode::Emoji must be given a valid string")
+      end
+    end
+
+    class << self
+      private :get_codepoint_value
+    end
+  end
+end

data/lib/unicode/emoji/constants.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Unicode
+  module Emoji
+    VERSION = "0.9.0".freeze
+    EMOJI_VERSION = "5.0".freeze
+    DATA_DIRECTORY = File.expand_path(File.dirname(__FILE__) + '/../../../data/').freeze
+    INDEX_FILENAME = (DATA_DIRECTORY + '/emoji.marshal.gz').freeze
+  end
+end
+

data/lib/unicode/emoji/index.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'constants'
+
+module Unicode
+  module Emoji
+    INDEX = Marshal.load(Gem.gunzip(File.binread(INDEX_FILENAME)))
+  end
+end

data/spec/unicode_emoji_spec.rb

@@ -0,0 +1,295 @@
+require_relative "../lib/unicode/emoji"
+require "minitest/autorun"
+
+describe Unicode::Emoji do
+  describe ".properties" do
+    it "will return an Array with Emoji properties if codepoints has some" do
+      assert_equal ["Emoji", "Emoji_Presentation"], Unicode::Emoji.properties("😴")
+      assert_equal ["Emoji"], Unicode::Emoji.properties("♠")
+    end
+
+    it "will return nil with Emoji properties if codepoints has some" do
+      assert_nil Unicode::Emoji.properties("A")
+    end
+  end
+
+  describe "REGEX" do
+    it "matches most singleton emoji codepoints" do
+      "😴 sleeping face" =~ Unicode::Emoji::REGEX
+      assert_equal "😴", $&
+    end
+
+    it "matches singleton emoji in combination with emoji variation selector" do
+      "😴\u{FE0F} sleeping face" =~ Unicode::Emoji::REGEX
+      assert_equal "😴\u{FE0F}", $&
+    end
+
+    it "does not match singleton emoji when in combination with text variation selector" do
+      "😴\u{FE0E} sleeping face" =~ Unicode::Emoji::REGEX
+      assert_nil $&
+    end
+
+    it "does not match textual singleton emoji" do
+      "▶ play button" =~ Unicode::Emoji::REGEX
+      assert_nil $&
+    end
+
+    it "does match textual singleton emoji in combination with emoji variation selector" do
+      "▶\u{FE0F} play button" =~ Unicode::Emoji::REGEX
+      assert_equal "▶\u{FE0F}", $&
+    end
+
+    it "does not match singleton 'component' emoji codepoints" do
+      "🏻 light skin tone" =~ Unicode::Emoji::REGEX
+      assert_nil $&
+    end
+
+    it "does match modified emoji if modifier base emoji is used" do
+      "🛌🏽 person in bed: medium skin tone" =~ Unicode::Emoji::REGEX
+      assert_equal "🛌🏽", $&
+    end
+
+    it "does not match modified emoji if no modifier base emoji is used" do
+      "🌵🏽 cactus" =~ Unicode::Emoji::REGEX
+      assert_equal "🌵", $&
+    end
+
+    it "does match valid region flags" do
+      "🇵🇹 Portugal" =~ Unicode::Emoji::REGEX
+      assert_equal "🇵🇹", $&
+    end
+
+    it "does not match invalid region flags" do
+      "🇵🇵 PP Land" =~ Unicode::Emoji::REGEX
+      assert_nil $&
+    end
+
+    it "does match emoji keycap sequences" do
+      "2️⃣ keycap: 2" =~ Unicode::Emoji::REGEX
+      assert_equal "2️⃣", $&
+    end
+
+    it "does match recommended tag sequences" do
+      "🏴󠁧󠁢󠁳󠁣󠁴󠁿 Scotland" =~ Unicode::Emoji::REGEX
+      assert_equal "🏴󠁧󠁢󠁳󠁣󠁴󠁿", $&
+    end
+
+    it "does not match valid tag sequences which are not recommended" do
+      "🏴󠁧󠁢󠁡󠁧󠁢󠁿 GB AGB" =~ Unicode::Emoji::REGEX
+      assert_equal "🏴", $& # only base flag is matched
+    end
+
+    it "does match recommended zwj sequences" do
+      "🤾🏽‍♀️ woman playing handball: medium skin tone" =~ Unicode::Emoji::REGEX
+      assert_equal "🤾🏽‍♀️", $&
+    end
+
+    it "does not match valid zwj sequences which are not recommended" do
+      "🤠‍🤢 vomiting cowboy" =~ Unicode::Emoji::REGEX
+      assert_equal "🤠", $&
+    end
+  end
+
+  describe "REGEX_VALID" do
+    it "matches most singleton emoji codepoints" do
+      "😴 sleeping face" =~ Unicode::Emoji::REGEX_VALID
+      assert_equal "😴", $&
+    end
+
+    it "matches singleton emoji in combination with emoji variation selector" do
+      "😴\u{FE0F} sleeping face" =~ Unicode::Emoji::REGEX_VALID
+      assert_equal "😴\u{FE0F}", $&
+    end
+
+    it "does not match singleton emoji when in combination with text variation selector" do
+      "😴\u{FE0E} sleeping face" =~ Unicode::Emoji::REGEX_VALID
+      assert_nil $&
+    end
+
+    it "does not match textual singleton emoji" do
+      "▶ play button" =~ Unicode::Emoji::REGEX_VALID
+      assert_nil $&
+    end
+
+    it "does match textual singleton emoji in combination with emoji variation selector" do
+      "▶\u{FE0F} play button" =~ Unicode::Emoji::REGEX_VALID
+      assert_equal "▶\u{FE0F}", $&
+    end
+
+    it "does not match singleton 'component' emoji codepoints" do
+      "🏻 light skin tone" =~ Unicode::Emoji::REGEX_VALID
+      assert_nil $&
+    end
+
+    it "does match modified emoji if modifier base emoji is used" do
+      "🛌🏽 person in bed: medium skin tone" =~ Unicode::Emoji::REGEX_VALID
+      assert_equal "🛌🏽", $&
+    end
+
+    it "does not match modified emoji if no modifier base emoji is used" do
+      "🌵🏽 cactus" =~ Unicode::Emoji::REGEX_VALID
+      assert_equal "🌵", $&
+    end
+
+    it "does match valid region flags" do
+      "🇵🇹 Portugal" =~ Unicode::Emoji::REGEX_VALID
+      assert_equal "🇵🇹", $&
+    end
+
+    it "does not match invalid region flags" do
+      "🇵🇵 PP Land" =~ Unicode::Emoji::REGEX_VALID
+      assert_nil $&
+    end
+
+    it "does match emoji keycap sequences" do
+      "2️⃣ keycap: 2" =~ Unicode::Emoji::REGEX_VALID
+      assert_equal "2️⃣", $&
+    end
+
+    it "does match recommended tag sequences" do
+      "🏴󠁧󠁢󠁳󠁣󠁴󠁿 Scotland" =~ Unicode::Emoji::REGEX_VALID
+      assert_equal "🏴󠁧󠁢󠁳󠁣󠁴󠁿", $&
+    end
+
+    it "does match valid tag sequences, even though they are not recommended" do
+      "🏴󠁧󠁢󠁡󠁧󠁢󠁿 GB AGB" =~ Unicode::Emoji::REGEX_VALID
+      assert_equal "🏴󠁧󠁢󠁡󠁧󠁢󠁿", $&
+    end
+
+    it "does not match invalid tag sequences" do
+      "🏴󠁧󠁢󠁡󠁡󠁡󠁿 GB AAA" =~ Unicode::Emoji::REGEX_VALID
+      assert_equal "🏴", $&
+    end
+
+    it "does match recommended zwj sequences" do
+      "🤾🏽‍♀️ woman playing handball: medium skin tone" =~ Unicode::Emoji::REGEX_VALID
+      assert_equal "🤾🏽‍♀️", $&
+    end
+
+    it "does match valid zwj sequences, even though they are not recommended" do
+      "🤠‍🤢 vomiting cowboy" =~ Unicode::Emoji::REGEX_VALID
+      assert_equal "🤠‍🤢", $&
+    end
+  end
+
+  describe "REGEX_BASIC" do
+    it "matches most singleton emoji codepoints" do
+      "😴 sleeping face" =~ Unicode::Emoji::REGEX_BASIC
+      assert_equal "😴", $&
+    end
+
+    it "matches singleton emoji in combination with emoji variation selector" do
+      "😴\u{FE0F} sleeping face" =~ Unicode::Emoji::REGEX_BASIC
+      assert_equal "😴\u{FE0F}", $&
+    end
+
+    it "does not match singleton emoji when in combination with text variation selector" do
+      "😴\u{FE0E} sleeping face" =~ Unicode::Emoji::REGEX_BASIC
+      assert_nil $&
+    end
+
+    it "does not match textual singleton emoji" do
+      "▶ play button" =~ Unicode::Emoji::REGEX
+      assert_nil $&
+    end
+
+    it "does match textual singleton emoji in combination with emoji variation selector" do
+      "▶\u{FE0F} play button" =~ Unicode::Emoji::REGEX
+      assert_equal "▶\u{FE0F}", $&
+    end
+
+    it "does not match singleton 'component' emoji codepoints" do
+      "🏻 light skin tone" =~ Unicode::Emoji::REGEX_BASIC
+      assert_nil $&
+    end
+
+    it "does not match modified emoji" do
+      "🛌🏽 person in bed: medium skin tone" =~ Unicode::Emoji::REGEX_BASIC
+      assert_equal "🛌", $&
+    end
+
+    it "does not match region flags" do
+      "🇵🇹 Portugal" =~ Unicode::Emoji::REGEX_BASIC
+      assert_nil $&
+    end
+
+    it "does not match emoji keycap sequences" do
+      "2️⃣ keycap: 2" =~ Unicode::Emoji::REGEX_BASIC
+      assert_nil $&
+    end
+
+    it "does not match tag sequences" do
+      "🏴󠁧󠁢󠁳󠁣󠁴󠁿 Scotland" =~ Unicode::Emoji::REGEX_BASIC
+      assert_equal "🏴", $& # only base flag is matched
+    end
+
+    it "does not match zwj sequences" do
+      "🤾🏽‍♀️ woman playing handball: medium skin tone" =~ Unicode::Emoji::REGEX_BASIC
+      assert_equal "🤾", $&
+    end
+  end
+
+  describe "REGEX_TEXT" do
+    it "deos not match singleton emoji codepoints with emoji presentation and no variation selector" do
+      "😴 sleeping face" =~ Unicode::Emoji::REGEX_TEXT
+      assert_nil $&
+    end
+
+    it "does not match singleton emoji in combination with emoji variation selector" do
+      "😴\u{FE0F} sleeping face" =~ Unicode::Emoji::REGEX_TEXT
+      assert_nil $&
+    end
+
+    it "does match singleton emoji in combination with text variation selector" do
+      "😴\u{FE0E} sleeping face" =~ Unicode::Emoji::REGEX_TEXT
+      assert_equal "😴\u{FE0E}", $&
+    end
+
+    it "does match textual singleton emoji" do
+      "▶ play button" =~ Unicode::Emoji::REGEX_TEXT
+      assert_equal "▶", $&
+    end
+
+    it "does not match textual singleton emoji in combination with emoji variation selector" do
+      "▶\u{FE0F} play button" =~ Unicode::Emoji::REGEX_TEXT
+      assert_nil $&
+    end
+
+    it "does not match singleton 'component' emoji codepoints" do
+      "🏻 light skin tone" =~ Unicode::Emoji::REGEX_TEXT
+      assert_nil $&
+    end
+
+    it "does not match modified emoji" do
+      "🛌🏽 person in bed: medium skin tone" =~ Unicode::Emoji::REGEX_TEXT
+      assert_nil $&
+    end
+
+    it "does not match region flags" do
+      "🇵🇹 Portugal" =~ Unicode::Emoji::REGEX_TEXT
+      assert_nil $&
+    end
+
+    it "does not match emoji keycap sequences" do
+      "2️⃣ keycap: 2" =~ Unicode::Emoji::REGEX_TEXT
+      assert_nil $&
+    end
+
+    it "does not match tag sequences" do
+      "🏴󠁧󠁢󠁳󠁣󠁴󠁿 Scotland" =~ Unicode::Emoji::REGEX_TEXT
+      assert_nil $&
+    end
+
+    it "does not match zwj sequences" do
+      "🤾🏽‍♀️ woman playing handball: medium skin tone" =~ Unicode::Emoji::REGEX_TEXT
+      assert_nil $&
+    end
+  end
+
+  describe "REGEX_ANY" do
+    it "returns any emoji-related codepoint (but no variation selectors or tags)" do
+      matches = "1 string 😴\u{FE0F} sleeping face with 🇵 and modifier 🏾, also 🏴󠁧󠁢󠁳󠁣󠁴󠁿 Scotland".scan(Unicode::Emoji::REGEX_ANY)
+      assert_equal ["1", "😴", "🇵", "🏾", "🏴"], matches
+    end
+  end
+end

data/unicode-emoji.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+require File.dirname(__FILE__) + "/lib/unicode/emoji/constants"
+
+Gem::Specification.new do |gem|
+  gem.name          = "unicode-emoji"
+  gem.version       = Unicode::Emoji::VERSION
+  gem.summary       = "Retrieve Emoji data about Unicode codepoints."
+  gem.description   = "[Emoji #{Unicode::Emoji::EMOJI_VERSION}] Retrieve emoji data about Unicode codepoints. Also contains a regex to match emoji."
+  gem.authors       = ["Jan Lelis"]
+  gem.email         = ["mail@janlelis.de"]
+  gem.homepage      = "https://github.com/janlelis/unicode-emoji"
+  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"
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: unicode-emoji
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Jan Lelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-08 00:00:00.000000000 Z
+dependencies: []
+description: "[Emoji 5.0] Retrieve emoji data about Unicode codepoints. Also contains
+  a regex to match emoji."
+email:
+- mail@janlelis.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- data/emoji.marshal.gz
+- lib/unicode/emoji.rb
+- lib/unicode/emoji/constants.rb
+- lib/unicode/emoji/index.rb
+- spec/unicode_emoji_spec.rb
+- unicode-emoji.gemspec
+homepage: https://github.com/janlelis/unicode-emoji
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Retrieve Emoji data about Unicode codepoints.
+test_files:
+- spec/unicode_emoji_spec.rb