tanuki_emoji 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e14e9a274c028f5da0ca9855c5ea0c15e39c67c9a555213bba590f0b72b3d072
+  data.tar.gz: e4c90eaabfaed8eb22c87f4097162978dec6f73edcbdf21db36cb5d2c939c587
+SHA512:
+  metadata.gz: f06e63daa5501849456c2cf95d754286fdb41bc96283f11ada069cc9c97a2f6ea5f608f453c07f9138e7e19579857193c7ebb79d5413a65ff4832c053732c0c2
+  data.tar.gz: 3b3362d115678f62563757e655121e901a26c23c674da95a6a10ae7553d6d01d00609243f0a5f591f775ecb70c3588122c127e5615de50c3e1503a05424df24f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+.rspec_status
+/*.gem
+
+# rspec failure tracking
+.rspec_status

data/.gitlab-ci.yml

@@ -0,0 +1,36 @@
+.ruby: &ruby
+  variables:
+    LANG: "C.UTF-8"
+  before_script:
+    - ruby -v                                   # Print out ruby version for debugging
+    - gem install bundler  --no-document        # Bundler is not installed with the image
+    - bundle config set --local path 'vendor'
+    - bundle install -j $(nproc)                # Install dependencies into ./vendor/ruby
+  parallel:
+    matrix:
+      - RUBY_VERSION: ['2.7', '3.0']
+  image: "ruby:$RUBY_VERSION"
+  cache:
+    paths:
+      - vendor/ruby
+    key: 'ruby$RUBY_VERSION'
+
+rspec:
+  extends: .ruby
+  script:
+    - bundle exec rake spec
+  artifacts:
+    reports:
+      junit: rspec.xml
+      cobertura: coverage/coverage.xml
+
+rubocop:
+  extends: .ruby
+  script:
+    - bundle exec rake rubocop
+
+include:
+  - template: SAST.gitlab-ci.yml
+  - template: Dependency-Scanning.gitlab-ci.yml
+  - template: Security/License-Scanning.gitlab-ci.yml
+  - template: Code-Quality.gitlab-ci.yml

data/.idea/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  Exclude:
+    - '*.gemspec'
+    - 'vendor/**/*'
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 140
+
+Metrics:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [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

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rspec_junit_formatter", "~> 0.4.0"
+gem "rubocop", "~> 1.7"
+gem "simplecov", require: false
+gem "simplecov-cobertura", "~> 1.4.2"

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    tanuki_emoji (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.18.4)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.8.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (1.4.2)
+      simplecov (~> 0.8)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.4.0)
+  rubocop (~> 1.7)
+  simplecov
+  simplecov-cobertura (~> 1.4.2)
+  tanuki_emoji!
+
+BUNDLED WITH
+   2.2.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 GitLab B.V.
+
+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,71 @@
+# Tanuki Emoji
+
+This library helps you implement Emoji support in a ruby application by providing you access to native Emoji character 
+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. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tanuki_emoji'
+```
+
+And then execute:
+
+```shell
+    $ bundle install
+```
+
+## Usage
+
+To access the index and list all known Emoji Characters:
+
+```ruby
+TanukiEmoji.index.all 
+```
+
+To search for an Emoji by it's codepoints (the unicode character):
+
+```ruby
+# Find by providing the Emoji Character itself
+TanukiEmoji.find_by_codepoints('🐴')
+#=> #<TanukiEmoji::Character:horse 🐴(1f434)>
+
+# Find by providing a string representation of the hexadecimal of the codepoint:
+TanukiEmoji.find_by_codepoints("\u{1f434}")
+#=> #<TanukiEmoji::Character:horse 🐴(1f434)>
+```
+
+To search for an Emoji by it's `:alpha_code:`
+
+```ruby
+# Find by providing the :alpha_code:
+TanukiEmoji.find_by_alpha_code(':horse:')
+#=> #<TanukiEmoji::Character:horse 🐴(1f434)>
+
+# It also accepts a `shortcode` (an alpha_code not surrounded by colons)
+TanukiEmoji.find_by_alpha_code('horse')
+#=> #<TanukiEmoji::Character:horse 🐴(1f434)>
+```
+
+## 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.
+
+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 
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/brodock/tanuki_emoji.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--format documentation --color --require spec_helper]
+  t.rspec_opts += %w[--format RspecJunitFormatter --out rspec.xml] if ENV['GITLAB_CI']
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+desc 'Code coverage detail'
+task :simplecov do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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

data/lib/tanuki_emoji.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Tanuki Emoji
+module TanukiEmoji
+  autoload :VERSION, './lib/tanuki_emoji/version'
+  autoload :Error, './lib/tanuki_emoji/errors'
+  autoload :AlphaCodeAlreadyIndexedError, './lib/tanuki_emoji/errors'
+  autoload :CodepointAlreadyIndexedError, './lib/tanuki_emoji/errors'
+  autoload :Index, './lib/tanuki_emoji/index'
+  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
+  # @return [TanukiEmoji::Character]
+  def self.find_by_alpha_code(alpha_code)
+    index.find_by_alpha_code(alpha_code)
+  end
+
+  # Find an Emoji by its Unicode representation
+  #
+  # @param [String] unicode_codepoints
+  # @return [TanukiEmoji::Character]
+  def self.find_by_codepoints(unicode_codepoints)
+    index.find_by_codepoints(unicode_codepoints)
+  end
+
+  # Index contains all known emojis
+  #
+  # @return [Array<TanukiEmoji::Character>]
+  def self.index
+    TanukiEmoji::Index.instance
+  end
+
+  # Add a new Emoji to the index
+  #
+  # @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)
+
+    index.add(emoji)
+  end
+end

data/lib/tanuki_emoji/character.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module TanukiEmoji
+  # Character represents an Emoji character or sequence which can be formed by one or more Unicode code points
+  # respectively which combined form a unique pictographic representation (known as Emoji)
+  #
+  # @see https://www.unicode.org/reports/tr51/
+  class Character
+    attr_reader :name, :codepoints, :codepoints_alternates, :alpha_code, :aliases, :description
+
+    # @param [String] name
+    # @param [String] codepoints
+    # @param [String] alpha_code
+    def initialize(name, codepoints:, alpha_code:, description:)
+      @name = name
+      @codepoints = codepoints
+      @codepoints_alternates = []
+      @alpha_code = self.class.format_alpha_code(alpha_code)
+      @aliases = []
+      @description = description
+    end
+
+    # Add alternative codepoints to this character
+    #
+    # @param [String] codepoints
+    def add_codepoints(codepoints)
+      codepoints_alternates << codepoints
+    end
+
+    # Add alternative alpha_codes to this character
+    #
+    # @param [String] alpha_code
+    def add_alias(alpha_code)
+      aliases << self.class.format_alpha_code(alpha_code)
+    end
+
+    # Return a Hex formatted version of the Unicode code points
+    #
+    # @return [String] Hex formatted version of the unicode
+    def hex
+      unicode_to_hex(codepoints).join('-')
+    end
+
+    def to_s
+      codepoints
+    end
+
+    def inspect
+      "#<#{self.class.name}:#{name} #{codepoints}(#{hex})>"
+    end
+
+    # Convert Unicode code points to Hex format for inspection
+    #
+    # ensure alpha code is formatted with colons
+    #
+    # @param [String] alpha_code
+    # @return [String] formatted alpha code
+    def self.format_alpha_code(alpha_code)
+      alpha_code.match?(/:([a-z_0-9]+):/) ? alpha_code : ":#{alpha_code}:"
+    end
+
+    private
+
+    # Return each codepoint converted to its hex value as string
+    #
+    # @param [String] value
+    # @return [Array<String>] hex value as string
+    def unicode_to_hex(value)
+      value.unpack('U*').map { |i| i.to_s(16).rjust(4, '0') }
+    end
+  end
+end