tanuki_emoji 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e14e9a274c028f5da0ca9855c5ea0c15e39c67c9a555213bba590f0b72b3d072
-  data.tar.gz: e4c90eaabfaed8eb22c87f4097162978dec6f73edcbdf21db36cb5d2c939c587
+  metadata.gz: 7a6ee4f67c87849b86336bc442feb7d1f5602283fd95e342b71ac21ccabae1a4
+  data.tar.gz: 6e89b4ccf8a3c6594cde8467e1b87c4bcfee510dcf2f4410748e0e8b51b2cb4c
 SHA512:
-  metadata.gz: f06e63daa5501849456c2cf95d754286fdb41bc96283f11ada069cc9c97a2f6ea5f608f453c07f9138e7e19579857193c7ebb79d5413a65ff4832c053732c0c2
-  data.tar.gz: 3b3362d115678f62563757e655121e901a26c23c674da95a6a10ae7553d6d01d00609243f0a5f591f775ecb70c3588122c127e5615de50c3e1503a05424df24f
+  metadata.gz: f5433abbe6cec569661761beca4b27ab922e4c39276fd42bd90e2f1c5e5e7607578e1c37f21261cf269133155195bfb827f33e4356cd6e197c63e024ea2bf72a
+  data.tar.gz: d647ac40d0daf77aace7f048acfcb5ef6ddc3a6d5b9087cd0f3619cf0b106a67f3d2ae29ba4a59fa023083404eb0002c7bf418d39373b66c81c7c24b01cbd56c

data/.gitignore

@@ -9,6 +9,8 @@
 /.idea
 .rspec_status
 /*.gem
+/app/assets/**/*
+.DS_Store
 
 # rspec failure tracking
 .rspec_status

data/.gitlab-ci.yml

@@ -17,20 +17,33 @@
 
 rspec:
   extends: .ruby
+  variables:
+    GIT_SUBMODULE_STRATEGY: recursive
   script:
+    - bundle exec rake update_assets
     - bundle exec rake spec
   artifacts:
     reports:
       junit: rspec.xml
       cobertura: coverage/coverage.xml
 
+gem:
+  extends: .ruby
+  variables:
+    GIT_SUBMODULE_STRATEGY: recursive
+  script:
+    - bundle exec rake install
+  artifacts:
+    paths:
+      - pkg/*.gem
+
 rubocop:
   extends: .ruby
   script:
     - bundle exec rake rubocop
 
 include:
-  - template: SAST.gitlab-ci.yml
+  - template: Security/SAST.gitlab-ci.yml
   - template: Dependency-Scanning.gitlab-ci.yml
   - template: Security/License-Scanning.gitlab-ci.yml
   - template: Code-Quality.gitlab-ci.yml

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/noto-emoji"]
+	path = vendor/noto-emoji
+	url = https://github.com/googlefonts/noto-emoji

data/CHANGELOG.md

@@ -6,8 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2021-07-09
+### Added
+- Bundled Noto Emoji assets for each corresponding indexed Emoji
+- `Character` responds to `#image_name` pointing to Noto Emoji filenames
+- `TanukiEmoji` responds to `.images_path` pointing to Emoji assets folder
+
 ## [0.1.0] - 2021-07-04
 ### Added
 - Initial release with index and Character information support
 
 [0.1.0]:https://gitlab.com/brodock/tanuki_emoji/-/releases/v0.1.0
+[0.2.0]:https://gitlab.com/brodock/tanuki_emoji/-/releases/v0.2.0

data/CONTRIBUTING.md

@@ -0,0 +1,41 @@
+## Developer Certificate of Origin and License
+
+By contributing to GitLab B.V., you accept and agree to the following terms and
+conditions for your present and future contributions submitted to GitLab B.V.
+Except for the license granted herein to GitLab B.V. and recipients of software
+distributed by GitLab B.V., you reserve all right, title, and interest in and to
+your Contributions.
+
+All contributions are subject to the Developer Certificate of Origin and license set out at 
+[docs.gitlab.com/ce/legal/developer_certificate_of_origin](https://docs.gitlab.com/ce/legal/developer_certificate_of_origin).
+
+<!-- This notice should stay as the first item in the CONTRIBUTING.md file. -->
+
+## Code of conduct
+
+As contributors and maintainers of this project, we pledge to respect all people
+who contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual
+language or imagery, derogatory comments or personal attacks, trolling, public
+or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the
+Code of Conduct may be removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior can be
+reported by emailing contact@gitlab.com.
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org), version 1.1.0,
+available at [https://contributor-covenant.org/version/1/1/0/](https://contributor-covenant.org/version/1/1/0/).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tanuki_emoji (0.1.0)
+    tanuki_emoji (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -4,7 +4,10 @@ This library helps you implement Emoji support in a ruby application by providin
 information.
 
 We currently provides a pre-indexed set of Emojis, compatible with [Gemojione](https://github.com/bonusly/gemojione)
-index from 3.3.0. In the future we expect to cover the most recent version of Unicode. 
+index from 3.3.0. In the future we expect to cover the most recent version of Unicode.
+
+This gem bundles Emoji assets from [Noto Emoji](https://github.com/googlefonts/noto-emoji), to be used as fallback when
+Emoji is not available or not fully supported on target system.
 
 ## Installation
 
@@ -17,7 +20,7 @@ gem 'tanuki_emoji'
 And then execute:
 
 ```shell
-    $ bundle install
+$ bundle install
 ```
 
 ## Usage
@@ -52,6 +55,19 @@ TanukiEmoji.find_by_alpha_code('horse')
 #=> #<TanukiEmoji::Character:horse 🐴(1f434)>
 ```
 
+To retrieve an alternative image for the character:
+```ruby
+c = TanukiEmoji.find_by_alpha_code('horse')
+#=> #<TanukiEmoji::Character:horse 🐴(1f434)>
+
+c.image_name
+#=> "emoji_u1f434.png"
+
+# Use the image_name with bundled assets from Noto Emoji:
+File.join(TanukiEmoji.images_path, c.image_name)
+#=> "/path/to/tanuki_emoji/app/assets/images/tanuki_emoji/emoji_u1f434.png"
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 
@@ -64,8 +80,15 @@ which will create a git tag for the version, push git commits and the created ta
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitLab at https://gitlab.com/brodock/tanuki_emoji.
+See [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+Noto Emoji assets and build tools are [Apache license, version 2.0](https://github.com/googlefonts/noto-emoji/blob/main/LICENSE)
+licensed.
+
+Flag images are under
+public domain or otherwise excempt from copyright
+([more info](https://github.com/googlefonts/noto-emoji/blob/main/third_party/region-flags/LICENSE)).

data/Rakefile

@@ -3,6 +3,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rubocop/rake_task"
+require "tanuki_emoji"
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = %w[--format documentation --color --require spec_helper]
@@ -11,10 +12,44 @@ end
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
-
 desc 'Code coverage detail'
 task :simplecov do
   ENV['COVERAGE'] = 'true'
   Rake::Task['spec'].execute
 end
+
+task default: %i[spec rubocop]
+
+desc 'Update images from vendor/noto-emoji to app/assets folder'
+task update_assets: ['noto_emoji:generate_flags'] do
+  png_path = File.join(__dir__, 'vendor/noto-emoji/png/72')
+  flag_path = File.join(__dir__, 'vendor/noto-emoji/build/flags')
+  TanukiEmoji.index.all.each do |emoji|
+    if emoji.flag?
+      source_flag = File.join(flag_path, emoji.image_name)
+      cp(source_flag, TanukiEmoji.images_path)
+
+      next
+    end
+
+    source_png = File.join(png_path, emoji.image_name)
+    cp(source_png, TanukiEmoji.images_path)
+  end
+end
+
+namespace :noto_emoji do
+  noto_emoji_path = File.join(__dir__, 'vendor/noto-emoji')
+
+  task :generate_flags do
+    chdir(File.expand_path(noto_emoji_path)) do
+      Dir['third_party/region-flags/png/*.png'].each do |file|
+        filename = File.basename(file)
+        puts filename
+
+        sh("make build/flags/#{filename}")
+      end
+    end
+  end
+end
+
+Rake::Task[:build].enhance [:update_assets]

data/lib/tanuki_emoji.rb

@@ -10,14 +10,6 @@ module TanukiEmoji
   autoload :Character, './lib/tanuki_emoji/character'
   autoload :Db, './lib/tanuki_emoji/db'
 
-  # This denotes a "color" or "emoji" version
-  EMOJI_VARIATION_SELECTOR = 0xFE0F
-  # This denotes a "plain" (black/white) or "textual" version
-  PLAIN_VARIATION_SELECTOR = 0xFE0E
-  BASE_FLAG_TAG = 0x1F3F4
-  # Zero Width Joiner is used in sequences to indicate they should all be evaluated and displayed as a single thing
-  ZWJ_TAG = 0x200D
-
   # Find an Emoji by its :alpha_code:
   #
   # @param [String] alpha_code
@@ -51,4 +43,8 @@ module TanukiEmoji
 
     index.add(emoji)
   end
+
+  def self.images_path
+    File.expand_path(File.join(__dir__, "../app/assets/images/tanuki_emoji"))
+  end
 end

data/lib/tanuki_emoji/character.rb

@@ -6,6 +6,19 @@ module TanukiEmoji
   #
   # @see https://www.unicode.org/reports/tr51/
   class Character
+    IMAGE_PREFIX = 'emoji_u'
+    IMAGE_EXTENSION = '.png'
+    FLAG_REGEXP = /[🇦-🇿]{2}/u.freeze
+
+    # This denotes a "color" or "emoji" version
+    EMOJI_VARIATION_SELECTOR = 0xFE0F
+
+    # This denotes a "plain" (black/white) or "textual" version
+    PLAIN_VARIATION_SELECTOR = 0xFE0E
+
+    # 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
 
     # @param [String] name
@@ -41,6 +54,26 @@ module TanukiEmoji
       unicode_to_hex(codepoints).join('-')
     end
 
+    # Generate the image name to be used as fallback for this character
+    #
+    # @return [String] image name with extension
+    def image_name
+      # Noto doesn't ship flags as part of regular hex-named files
+      # Flags are stored in a separate third-party folder and follow ISO-3166-1 codes
+      # @see http://en.wikipedia.org/wiki/ISO_3166-1
+      return alpha_code.tr(':', '').sub('flag_', '').upcase + IMAGE_EXTENSION if flag?
+
+      # Noto omits Emoji Variation Selector on their resources file names
+      IMAGE_PREFIX + unicode_to_hex(codepoints).reject { |i| i == EMOJI_VARIATION_SELECTOR.to_s(16) }.join('_') + IMAGE_EXTENSION
+    end
+
+    # Return whether current character represents a flag or not
+    #
+    # @return [Boolean] whether character represents a flag or not
+    def flag?
+      codepoints.match?(FLAG_REGEXP)
+    end
+
     def to_s
       codepoints
     end

data/lib/tanuki_emoji/version.rb

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

data/tanuki_emoji.gemspec

@@ -11,19 +11,17 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Tanuki Emoji}
   spec.description   = %q{Tanuki Emoji provides Emoji character information and metadata with support for Noto Emoji resources as fallback}
   spec.homepage      = 'https://gitlab.com/brodock/tanuki_emoji'
-  spec.license       = 'MIT'
+  spec.licenses       = %w[MIT Apache2]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://gitlab.com/brodock/tanuki_emoji'
-  spec.metadata['changelog_uri'] = "https://gitlab.com/brodock/tanuki_emoji/-/blob/main/CHANGELOG.md"
+  spec.metadata['changelog_uri'] = 'https://gitlab.com/brodock/tanuki_emoji/-/blob/main/CHANGELOG.md'
 
   # 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.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|bin)/}) }
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 end

data/vendor/gemojione/index-3.3.0.json

@@ -14486,7 +14486,7 @@
     ],
     "aliases_ascii": [],
     "keywords": [],
-    "moji": "🏳🌈"
+    "moji": "🏳️‍🌈"
   },
   "gemini": {
     "unicode": "264A",

data/vendor/gemojione/index-4.1.0.json

@@ -18624,7 +18624,7 @@
     "keywords": [
 
     ],
-    "moji": "🏳🌈"
+    "moji": "🏳️‍🌈"
   },
   "gemini": {
     "unicode": "264A",
@@ -45108,4 +45108,4 @@
 
     ]
   }
-}
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tanuki_emoji
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gabriel Mazetto
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2021-08-09 00:00:00.000000000 Z
 dependencies: []
 description: Tanuki Emoji provides Emoji character information and metadata with support
   for Noto Emoji resources as fallback
@@ -20,17 +20,17 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitlab-ci.yml"
-- ".idea/.gitignore"
+- ".gitmodules"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- app/assets/images/tanuki_emoji/.gitkeep
 - lib/tanuki_emoji.rb
 - lib/tanuki_emoji/character.rb
 - lib/tanuki_emoji/db.rb
@@ -56,6 +56,7 @@ files:
 homepage: https://gitlab.com/brodock/tanuki_emoji
 licenses:
 - MIT
+- Apache2
 metadata:
   homepage_uri: https://gitlab.com/brodock/tanuki_emoji
   source_code_uri: https://gitlab.com/brodock/tanuki_emoji
@@ -75,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Tanuki Emoji

data/.idea/.gitignore

@@ -1,8 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml
-# Datasource local storage ignored files
-/dataSources/
-/dataSources.local.xml
-# Editor-based HTTP Client requests
-/httpRequests/

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "tanuki_emoji"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here