Merge pull request #273 from github/dependabot-c67993ba-56b8-4f4e-a911-22640b185a14

Enable Dependabot

.github/dependabot.yaml

@@ -0,0 +1,11 @@
+---
+version: 2
+updates:
+  - package-ecosystem: 'bundler'
+    directory: '/'
+    schedule:
+        interval: 'weekly'
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+        interval: 'weekly'

.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.7", "3.0", "3.1"]
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+        bundler-cache: true
+    
+    - name: Run tests
+      run: bundle exec rake

.travis.yml

@@ -1,12 +0,0 @@
-sudo: false
-script: script/test
-rvm:
-  - 1.9.3
-  - '2.1'
-  - '2.2'
-  - '2.3'
-  - '2.4'
-  - '2.5'
-  - '2.6'
-notifications:
-  email: false

Gemfile

@@ -2,5 +2,6 @@ source "https://rubygems.org"
 
 gem "rake", "~> 10.3.2"
 gem "minitest", "~> 5.3.5"
+gem "i18n", "~> 1.8.5"
 
 gemspec

Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    gemoji (4.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.7)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.3.5)
+    rake (10.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gemoji!
+  i18n (~> 1.8.5)
+  minitest (~> 5.3.5)
+  rake (~> 10.3.2)
+
+BUNDLED WITH
+   2.4.10

Rakefile

@@ -20,5 +20,5 @@ namespace :db do
 end
 
 file 'vendor/unicode-emoji-test.txt' do |t|
-  system 'curl', '-fsSL', 'http://unicode.org/Public/emoji/12.1/emoji-test.txt', '-o', t.name
+  system 'curl', '-fsSL', 'http://unicode.org/Public/emoji/15.0/emoji-test.txt', '-o', t.name
 end

db/dump.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require "i18n"
 require 'emoji'
 require 'json'
 require_relative './emoji-test-parser'
 
+I18n.config.available_locales = :en
 items = []
 
 _, categories = EmojiTestParser.parse(File.expand_path("../../vendor/unicode-emoji-test.txt", __FILE__))
@@ -34,10 +36,10 @@ for category in categories
         )
       else
         output_item.update(
-          aliases: [description.gsub(/\W+/, '_').downcase],
+          aliases: [I18n.transliterate(description).gsub(/\W+/, '_').downcase],
           tags: [],
-          unicode_version: "12.1",
-          ios_version: "13.2",
+          unicode_version: "15.0",
+          ios_version: "16.4",
         )
       end
       output_item[:skin_tones] = true if emoji_item[:skin_tones]

gemoji.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name    = "gemoji"
-  s.version = "4.0.0.rc1"
+  s.version = "4.1.0"
   s.summary = "Unicode emoji library"
   s.description = "Character information and metadata for Unicode emoji."
 

lib/emoji.rb

@@ -51,11 +51,12 @@ module Emoji
 
   # Public: Find an emoji by its unicode character. Return nil if missing.
   def find_by_unicode(unicode)
-    unicodes_index[unicode]
+    unicodes_index[unicode] || unicodes_index[unicode.sub(SKIN_TONE_RE, "")]
   end
 
   private
     VARIATION_SELECTOR_16 = "\u{fe0f}".freeze
+    SKIN_TONE_RE = /[\u{1F3FB}-\u{1F3FF}]/
 
     # Characters which must have VARIATION_SELECTOR_16 to render as color emoji:
     TEXT_GLYPHS = [
@@ -70,7 +71,7 @@ module Emoji
       "\u{3030}",  # wavy dash
     ].freeze
 
-    private_constant :VARIATION_SELECTOR_16, :TEXT_GLYPHS
+    private_constant :VARIATION_SELECTOR_16, :TEXT_GLYPHS, :SKIN_TONE_RE
 
     def parse_data_file
       data = File.open(data_file, 'r:UTF-8') do |file|
@@ -118,6 +119,7 @@ module Emoji
           emoji.description = dedup.call(raw_emoji[:description])
           emoji.unicode_version = dedup.call(raw_emoji[:unicode_version])
           emoji.ios_version = dedup.call(raw_emoji[:ios_version])
+          emoji.skin_tones = raw_emoji.fetch(:skin_tones, false)
         end
       end
     end

lib/emoji/character.rb

@@ -11,6 +11,11 @@ module Emoji
     # True if the emoji is not a standard Emoji character.
     def custom?() !raw end
 
+    # True if the emoji supports Fitzpatrick scale skin tone modifiers
+    def skin_tones?() @skin_tones end
+
+    attr_writer :skin_tones
+
     # A list of names uniquely referring to this emoji.
     attr_reader :aliases
 
@@ -38,6 +43,28 @@ module Emoji
     # Raw Unicode string for an emoji. Nil if emoji is non-standard.
     def raw() unicode_aliases.first end
 
+    # Raw Unicode strings for each skin tone variant of this emoji. The result is an empty array
+    # unless the emoji supports skin tones.
+    #
+    # Note: for emojis that depict multiple people (e.g. couples or families), this will not produce
+    # every possible permutation of skin tone per person.
+    def raw_skin_tone_variants
+      return [] if custom? || !skin_tones?
+      raw_normalized = raw.sub(VARIATION_SELECTOR_16, "")
+      idx = raw_normalized.index(ZERO_WIDTH_JOINER)
+      SKIN_TONES.map do |modifier|
+        if raw_normalized == PEOPLE_HOLDING_HANDS
+          # special case to apply the modifier to both persons
+          raw_normalized[0...idx] + modifier + raw_normalized[idx..nil] + modifier
+        elsif idx
+          # insert modifier before zero-width joiner
+          raw_normalized[0...idx] + modifier + raw_normalized[idx..nil]
+        else
+          raw_normalized + modifier
+        end
+      end
+    end
+
     def add_unicode_alias(str)
       unicode_aliases << str
     end
@@ -54,6 +81,7 @@ module Emoji
       @aliases = Array(name)
       @unicode_aliases = []
       @tags = []
+      @skin_tones = false
     end
 
     def inspect
@@ -77,6 +105,20 @@ module Emoji
 
     private
 
+    VARIATION_SELECTOR_16 = "\u{fe0f}".freeze
+    ZERO_WIDTH_JOINER = "\u{200d}".freeze
+    PEOPLE_HOLDING_HANDS = "\u{1f9d1}\u{200d}\u{1f91d}\u{200d}\u{1f9d1}".freeze
+
+    SKIN_TONES = [
+      "\u{1F3FB}", # light skin tone
+      "\u{1F3FC}", # medium-light skin tone
+      "\u{1F3FD}", # medium skin tone
+      "\u{1F3FE}", # medium-dark skin tone
+      "\u{1F3FF}", # dark skin tone
+    ]
+
+    private_constant :VARIATION_SELECTOR_16, :ZERO_WIDTH_JOINER, :PEOPLE_HOLDING_HANDS, :SKIN_TONES
+
     def default_image_filename
       if custom?
         '%s.png' % name

test/emoji_test.rb

@@ -50,14 +50,19 @@ class EmojiTest < TestCase
   GENDER_EXCEPTIONS = [
     "man_with_gua_pi_mao",
     "woman_with_headscarf",
-    "man_in_tuxedo",
-    "pregnant_woman",
     "isle_of_man",
-    "blonde_woman",
+    "blonde_woman", # blond_haired_man
     /^couple(kiss)?_/,
     /^family_/,
   ]
 
+  DASH_EXCEPTIONS = [
+    "-1",
+    "t-rex",
+    "e-mail",
+    "non-potable_water",
+  ]
+
   test "emojis have valid names" do
     aliases = Emoji.all.flat_map(&:aliases)
 
@@ -76,7 +81,7 @@ class EmojiTest < TestCase
     alias_count = Hash.new(0)
     aliases.each do |name|
       alias_count[name] += 1
-      invalid << name if name !~ /\A[\w+-]+\Z/
+      invalid << name if name !~ /\A[\w+]+\Z/ && !DASH_EXCEPTIONS.include?(name)
       another_gender = to_another_gender.call(name)
       gender_mismatch << another_gender unless aliases.include?(another_gender)
     end
@@ -91,7 +96,6 @@ class EmojiTest < TestCase
   test "missing or incorrect unicodes" do
     emoji_map, _ = EmojiTestParser.parse(File.expand_path("../../vendor/unicode-emoji-test.txt", __FILE__))
     source_unicode_emoji = emoji_map.values
-    supported_sequences = Emoji.all.flat_map(&:unicode_aliases)
     text_glyphs = Emoji.const_get(:TEXT_GLYPHS)
 
     missing = 0
@@ -153,6 +157,36 @@ class EmojiTest < TestCase
     assert_equal '8.3', emoji.ios_version
   end
 
+  test "skin tones" do
+    smiley = Emoji.find_by_alias("smiley")
+    assert_equal false, smiley.skin_tones?
+    assert_equal [], smiley.raw_skin_tone_variants
+
+    wave = Emoji.find_by_alias("wave")
+    assert_equal true, wave.skin_tones?
+
+    wave = Emoji.find_by_unicode("\u{1f44b}\u{1f3ff}") # wave + dark skin tone
+    assert_equal "wave", wave.name
+
+    woman_with_beard = Emoji.find_by_unicode("\u{1f9d4}\u{200d}\u{2640}\u{fe0f}")
+    assert_equal [
+      "1f9d4-1f3fb-200d-2640",
+      "1f9d4-1f3fc-200d-2640",
+      "1f9d4-1f3fd-200d-2640",
+      "1f9d4-1f3fe-200d-2640",
+      "1f9d4-1f3ff-200d-2640",
+    ], woman_with_beard.raw_skin_tone_variants.map { |u| Emoji::Character.hex_inspect(u) }
+
+    people_holding_hands = Emoji.find_by_alias("people_holding_hands")
+    assert_equal [
+      "1f9d1-1f3fb-200d-1f91d-200d-1f9d1-1f3fb",
+      "1f9d1-1f3fc-200d-1f91d-200d-1f9d1-1f3fc",
+      "1f9d1-1f3fd-200d-1f91d-200d-1f9d1-1f3fd",
+      "1f9d1-1f3fe-200d-1f91d-200d-1f9d1-1f3fe",
+      "1f9d1-1f3ff-200d-1f91d-200d-1f9d1-1f3ff",
+    ], people_holding_hands.raw_skin_tone_variants.map { |u| Emoji::Character.hex_inspect(u) }
+  end
+
   test "no custom emojis" do
     custom = Emoji.all.select(&:custom?)
     assert 0, custom.size