tanuki_emoji 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe0dc4ae27d764f4f8e197ab0736035eb6cb082f3f3c7e365a7242af4fcc895c
-  data.tar.gz: 63306c6bfebf28a9ec7f762132d12370094f8d6121f441e621adec62e76d6563
+  metadata.gz: 80827a5454f2eb6ed96102851f315c04215bda544c83892570e6b035ce43cbdd
+  data.tar.gz: c3a97c5c042b909a8544173865f8921e23093333b465fc47ee4f6e306df9480f
 SHA512:
-  metadata.gz: 8da28b3ee32bbadba7c28581c840f2cb80e16a7f978fb8d14117204642324da8341868fc76f56ae47e51f50f179113ae007cec5c33f8965eeb8cd7608ab2abca
-  data.tar.gz: 1d4a177f172eeb488bd0016abfa5710a7154132c9a95882e802d6ee796334b485db611dc69233ad5b18befe02c83603902914a5169aab919c9313bb7394b969a
+  metadata.gz: b5d4fa24f4a0a954df5000d6a04f5c7f8621f6e1b9c2aa5fcb448b3e15af4df927f7033f57c125d9d1b0e11132175cf7351b631c19fe05aa4678c07f402e7636
+  data.tar.gz: 59439b83f98f62e9ace8756accfa327499182309b777864ad87847e567ddfe157b5056844a9033b50548784dec78d51b3d6ab358ef9b0c0a78ffff0e2fe20a67

data/.gitlab-ci.yml

@@ -47,3 +47,6 @@ include:
   - template: Dependency-Scanning.gitlab-ci.yml
   - template: Security/License-Scanning.gitlab-ci.yml
   - template: Code-Quality.gitlab-ci.yml
+  - project: 'gitlab-org/quality/pipeline-common'
+    file:
+      - '/ci/danger-review.yml'

data/.ruby-version

@@ -1 +1 @@
-2.7.4
+2.7.5

data/CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.0] - 2022-02-16
+### Added
+- `Character` responds to `ascii_aliases` which contain ASCII aliases from Gemojione
+
+### Fixed
+- Fixed `TanukiEmoji.add` command, which should now require `category:` to be provided
+- Fixed issue where `TanukiEmoji::Index#codepoints_pattern` would split apart emoji-modifier pairs
+
 ## [0.5.0] - 2021-09-16
 ### Added
 - Add Category information into `Character`
@@ -49,3 +57,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [0.3.0]:https://gitlab.com/gitlab-org/tanuki_emoji/-/releases/v0.3.0
 [0.4.0]:https://gitlab.com/gitlab-org/tanuki_emoji/-/releases/v0.4.0
 [0.5.0]:https://gitlab.com/gitlab-org/tanuki_emoji/-/releases/v0.5.0
+[0.6.0]:https://gitlab.com/gitlab-org/tanuki_emoji/-/releases/v0.6.0

data/Dangerfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'gitlab-dangerfiles'
+
+Gitlab::Dangerfiles.for_project(self, &:import_defaults)

data/Gemfile.lock

@@ -1,19 +1,98 @@
 PATH
   remote: .
   specs:
-    tanuki_emoji (0.5.0)
+    tanuki_emoji (0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    claide (1.1.0)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (8.4.2)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (>= 1, < 4)
+    danger-gitlab (8.0.0)
+      danger
+      gitlab (~> 4.2, >= 4.2.0)
     diff-lcs (1.4.4)
     docile (1.4.0)
+    faraday (1.9.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    git (1.10.2)
+      rchardet (~> 1.8)
+    gitlab (4.18.0)
+      httparty (~> 0.18)
+      terminal-table (>= 1.5.1)
+    gitlab-dangerfiles (2.8.0)
+      danger (>= 8.3.1)
+      danger-gitlab (>= 8.0.0)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    nap (1.1.0)
+    no_proxy_fix (0.1.2)
+    octokit (4.22.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
     parallel (1.20.1)
     parser (3.0.2.0)
       ast (~> 2.4.1)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.6)
+    rchardet (1.8.0)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -43,6 +122,10 @@ GEM
     rubocop-ast (1.8.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -51,6 +134,8 @@ GEM
       simplecov (~> 0.8)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
     unicode-display_width (2.0.0)
 
 PLATFORMS
@@ -59,6 +144,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  gitlab-dangerfiles (~> 2.8.0)
   rake (~> 13.0)
   rspec (~> 3.0)
   rspec_junit_formatter (~> 0.4.0)

data/README.md

@@ -70,17 +70,36 @@ File.join(TanukiEmoji.images_path, c.image_name)
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 
-You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+In order to contribute to TanukiEmoji gem, you need to:
 
-To install this gem onto your local machine, run `bundle exec rake install`. 
-To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, 
-which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to 
+1. Clone the repository to your local machine.
+1. Run `bin/setup` to initialize `git submodules` and install ruby dependencies.
+
+Many workflow tasks are available as Rake tasks:
+
+- `bundle exec rake spec` can be used to run tests.
+- `bundle exec rake install` will build and install the gem on your local machine.
+
+To load an interactive console with the gem you can use `bin/console`.
+
+### Releasing a new version
+
+Before releasing a new gem, create a MR with the following changes:
+
+- Update `CHANGELOG.md` by adding a version section and moving any changes from `[Unreleased]` to it.
+- Update the version number in `lib/tanuki_emoji/version.rb`.
+
+With that MR approved and merged, pull the changes to your `main` branch and run `bundle exec rake release`.
+This command will create a git tag for the version and push it, generate a new `.gem` file and publish into
 [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-See [CONTRIBUTING.md](CONTRIBUTING.md).
+See [CONTRIBUTING.md](CONTRIBUTING.md) and [Development](#development) section.
+
+When you create a new Merge Request, consider adding your change to the `CHANGELOG.md` if it includes a new feature, a feature change or a fix.
+
+Please do not increase the version numbers, as this is handled by a separate process when we [release a new version](#releasing-a-new-version).
 
 ## License
 

data/lib/tanuki_emoji/character.rb

@@ -16,11 +16,12 @@ module TanukiEmoji
 
     # This denotes a "plain" (black/white) or "textual" version
     PLAIN_VARIATION_SELECTOR = 0xFE0E
+    PLAIN_VARIATION_SELECTOR_STRING = PLAIN_VARIATION_SELECTOR.chr(Encoding::UTF_8)
 
     # Zero Width Joiner is used in sequences to indicate they should all be evaluated and displayed as a single thing
     ZWJ_TAG = 0x200D
 
-    attr_reader :name, :codepoints, :codepoints_alternates, :alpha_code, :aliases, :description, :category
+    attr_reader :name, :codepoints, :codepoints_alternates, :alpha_code, :aliases, :ascii_aliases, :description, :category
 
     attr_accessor :unicode_version
 
@@ -35,6 +36,7 @@ module TanukiEmoji
       @codepoints_alternates = []
       @alpha_code = self.class.format_alpha_code(alpha_code)
       @aliases = []
+      @ascii_aliases = []
       @description = description
       @category = category
     end
@@ -53,6 +55,13 @@ module TanukiEmoji
       aliases << self.class.format_alpha_code(alpha_code)
     end
 
+    # Add alternative ASCII aliases to this character
+    #
+    # @param [String] ascii_string
+    def add_ascii_alias(ascii_string)
+      ascii_aliases << ascii_string
+    end
+
     # Return a Hex formatted version of the Unicode code points
     #
     # @return [String] Hex formatted version of the unicode
@@ -94,6 +103,7 @@ module TanukiEmoji
         codepoints_alternates == other.codepoints_alternates &&
         alpha_code == other.alpha_code &&
         aliases == other.aliases &&
+        ascii_aliases == other.ascii_aliases &&
         description == other.description
     end
 

data/lib/tanuki_emoji/db/gemojione.rb

@@ -41,6 +41,10 @@ module TanukiEmoji
             emoji.add_alias(alpha_code)
           end
 
+          emoji_data[:aliases_ascii].each do |ascii_string|
+            emoji.add_ascii_alias(ascii_string)
+          end
+
           @index.add(emoji)
         end
       end

data/lib/tanuki_emoji/index.rb

@@ -14,6 +14,7 @@ module TanukiEmoji
     # Add a new Emoji to the index
     #
     # @param [TanukiEmoji::Character] emoji
+    # @return [TanukiEmoji::Character]
     def add(emoji)
       @name_index ||= {}
       @alpha_code_index ||= {}
@@ -88,9 +89,14 @@ module TanukiEmoji
 
     # Return a regular expression that can be used to search for emoji codepoints
     #
+    # @param [Boolean] exclude_text_presentation exclude codepoints and sequences with text presentation selector
     # @return [Regexp] regular expression that matches indexed emoji codepoints
-    def codepoints_pattern
-      /(#{@codepoints_index.keys.map { |moji| Regexp.escape(moji) }.join('|')})/
+    def codepoints_pattern(exclude_text_presentation: false)
+      possible_codepoints = sorted_codepoints.map { |moji, _| Regexp.escape(moji) }.join('|')
+      variation_selector = ""
+      variation_selector = /(?!#{TanukiEmoji::Character::PLAIN_VARIATION_SELECTOR_STRING})/ if exclude_text_presentation
+
+      /(#{possible_codepoints})#{variation_selector}/
     end
 
     private
@@ -109,5 +115,11 @@ module TanukiEmoji
       Db::Gemojione.new(index: self).load!
       Db::UnicodeVersion.new(index: self).load!
     end
+
+    # Order the codepoints to match the most specific (longest) sequences first,
+    # so #gsub doesn't unintentionally split an emoji from its modifier(s).
+    def sorted_codepoints
+      @sorted_codepoints ||= @codepoints_index.dup.sort_by { |_, v| -v.hex.length }
+    end
   end
 end

data/lib/tanuki_emoji/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TanukiEmoji
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/tanuki_emoji.rb

@@ -38,8 +38,15 @@ module TanukiEmoji
   # @param [String] name
   # @param [String] codepoints
   # @param [String] alpha_code
-  def self.add(name, codepoints:, alpha_code:, description:)
-    emoji = Character.new(name, codepoints: codepoints, alpha_code: alpha_code, description: description)
+  # @param [String] description
+  # @param [String] category
+  # @return [TanukiEmoji::Character]
+  def self.add(name, codepoints:, alpha_code:, description:, category:)
+    emoji = Character.new(name,
+                          codepoints: codepoints,
+                          alpha_code: alpha_code,
+                          description: description,
+                          category: category)
 
     index.add(emoji)
   end

data/tanuki_emoji.gemspec

@@ -15,8 +15,9 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://gitlab.com/gitlab-org/tanuki_emoji'
-  spec.metadata['changelog_uri'] = 'https://gitlab.com/gitlab-org/tanuki_emoji/-/blob/main/CHANGELOG.md'
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/-/blob/main/CHANGELOG.md"
+  spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/-/issues"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -27,4 +28,6 @@ Gem::Specification.new do |spec|
     git_files + asset_files
   end
   spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'gitlab-dangerfiles', '~> 2.8.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: tanuki_emoji
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Gabriel Mazetto
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
-dependencies: []
+date: 2022-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gitlab-dangerfiles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
 description: Tanuki Emoji provides Emoji character information and metadata with support
   for Noto Emoji resources as fallback
 email:
@@ -27,6 +41,7 @@ files:
 - ".ruby-version"
 - CHANGELOG.md
 - CONTRIBUTING.md
+- Dangerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -1860,7 +1875,8 @@ metadata:
   homepage_uri: https://gitlab.com/gitlab-org/tanuki_emoji
   source_code_uri: https://gitlab.com/gitlab-org/tanuki_emoji
   changelog_uri: https://gitlab.com/gitlab-org/tanuki_emoji/-/blob/main/CHANGELOG.md
-post_install_message:
+  bug_tracker_uri: https://gitlab.com/gitlab-org/tanuki_emoji/-/issues
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -1876,7 +1892,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Tanuki Emoji
 test_files: []