negarmoji 0.1.0 → 0.1.1

data/lib/{emoji.rb → negarmoji/emoji.rb}

@@ -1,14 +1,14 @@
 # encoding: utf-8
 # frozen_string_literal: true
 
-require 'emoji/character'
-require 'json'
+require "negarmoji/character"
+require "json"
 
 module Emoji
   extend self
 
   def data_file
-    File.expand_path('../../db/emoji.json', __FILE__)
+    File.expand_path("../../../db/negarmoji.json", __FILE__)
   end
 
   def all
@@ -26,7 +26,7 @@ module Emoji
     emoji
   end
 
-  # Public: Yield an emoji to the block and update the indices in case its
+  # Public: Yield an negarmoji to the block and update the indices in case its
   # aliases or unicode_aliases lists changed.
   def edit_emoji(emoji)
     @names_index ||= Hash.new
@@ -44,12 +44,12 @@ module Emoji
     emoji
   end
 
-  # Public: Find an emoji by its aliased name. Return nil if missing.
+  # Public: Find an negarmoji by its aliased name. Return nil if missing.
   def find_by_alias(name)
     names_index[name]
   end
 
-  # Public: Find an emoji by its unicode character. Return nil if missing.
+  # Public: Find an negarmoji by its unicode character. Return nil if missing.
   def find_by_unicode(unicode)
     unicodes_index[unicode]
   end
@@ -57,7 +57,7 @@ module Emoji
   private
     VARIATION_SELECTOR_16 = "\u{fe0f}".freeze
 
-    # Characters which must have VARIATION_SELECTOR_16 to render as color emoji:
+  # Characters which must have VARIATION_SELECTOR_16 to render as color negarmoji:
     TEXT_GLYPHS = [
       "\u{1f237}", # Japanese “monthly amount” button
       "\u{1f202}", # Japanese “service charge” button
@@ -149,7 +149,7 @@ module Emoji
     private_constant :VARIATION_SELECTOR_16, :TEXT_GLYPHS
 
     def parse_data_file
-      data = File.open(data_file, 'r:UTF-8') do |file|
+      data = File.open(data_file, "r:UTF-8") do |file|
         JSON.parse(file.read, symbolize_names: true)
       end
 
@@ -170,10 +170,10 @@ module Emoji
       data.each do |raw_emoji|
         self.create(nil) do |emoji|
           raw_emoji.fetch(:aliases).each { |name| emoji.add_alias(dedup.call(name)) }
-          if raw = raw_emoji[:emoji]
+          if (raw = raw_emoji[:emoji])
             append_unicode.call(emoji, raw)
             start_pos = 0
-            while found_index = raw.index(VARIATION_SELECTOR_16, start_pos)
+            while (found_index = raw.index(VARIATION_SELECTOR_16, start_pos))
               # register every variant where one VARIATION_SELECTOR_16 is removed
               raw_alternate = raw.dup
               raw_alternate[found_index] = ""
@@ -209,5 +209,5 @@ module Emoji
     end
 end
 
-# Preload emoji into memory
+# Preload negarmoji into memory
 Emoji.all

data/lib/negarmoji/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Emoji
+      VERSION = "0.1.1"
+end

data/negarmoji.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "negarmoji/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "negarmoji"
+  spec.version = Emoji::VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.authors = ["Mohammad Mahdi Baghbani Pourvahid"]
+  spec.email = "MahdiBaghbani@protonmail.com"
+  spec.homepage = "https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-Library"
+  spec.description = "%(Character information and metadata for Unicode emoji)"
+  spec.summary = "Unicode emoji library"
+  spec.licenses = "GPL-3.0"
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r!^bin/!) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r!^test/!)
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.3.0"
+end

data/script/bootstrap

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -e
+
+if type -p bundle >/dev/null; then
+  bundle install --path vendor/bundle
+  bundle binstub rake
+else
+  echo "You must \`gem install bundler\` first." >&2
+  exit 1
+fi

data/script/console

@@ -0,0 +1,16 @@
+#!/bin/bash
+set -e
+
+public_methods() {
+  sed '/^ *private/,$d' "$1" | grep -w def | sed -E 's/^ *def /  /; s/).+/)/'
+}
+
+echo "Emoji methods:"
+public_methods lib/negarmoji.rb
+echo
+echo "Emoji::Character methods:"
+public_methods lib/negarmoji/character.rb
+echo
+
+exec irb -I lib -r negarmoji
+zz

data/script/release

@@ -0,0 +1,31 @@
+#!/bin/bash
+# Usage: script/release
+#
+# 1. Checks if tests pass,
+# 2. commits gemspec,
+# 3. tags the release with the version in the gemspec,
+# 4. pushes "negarmoji" gem to RubyGems.org.
+
+set -e
+
+case "$1" in
+-h | --help )
+  sed -ne '/^#/!q;s/.\{1,2\}//;1d;p' < "$0"
+  exit 0
+  ;;
+esac
+
+if git diff --quiet negarmoji.gemspec; then
+  echo "You must bump the version in the gemspec first." >&2
+  exit 1
+fi
+
+script/test
+
+trap 'rm *.gem' EXIT
+
+version="$(gem build negarmoji.gemspec | awk '/Version:/ { print $2 }')"
+git commit negarmoji.gemspec -m "negarmoji $version"
+git tag "v${version}"
+git push origin HEAD "v${version}"
+

data/script/test

@@ -0,0 +1,14 @@
+#!/bin/bash
+# Usage: script/test [file]
+set -e
+
+case "$1" in
+-h | --help )
+  sed -ne '/^#/!q;s/.\{1,2\}//;1d;p' < "$0"
+  exit 0
+  ;;
+esac
+
+export RUBYOPT="$RUBYOPT -w"
+
+exec bundle exec rake ${1:+TEST="$1"}

data/test/documentation_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+# Pull the EmojiHelper example from the docs
+readme = File.expand_path('../../README.md', __FILE__)
+docs = File.open(readme, 'r:UTF-8') { |f| f.read }
+eval docs.match(/^module.+?^end/m)[0]
+
+String.class_eval do
+  def html_safe() self end
+  def present?() !empty? end
+end
+
+class DocumentationTest < TestCase
+  module Helper
+    extend EmojiHelper
+
+    def self.h(str)
+      str.gsub('<', '&lt;').gsub('>', '&gt;')
+    end
+
+    def self.image_path(img)
+      "/images/#{img}?123"
+    end
+  end
+
+  test "replaces emoji syntax with images" do
+    assert_equal "It's raining " \
+        '<img alt="cat" src="/images/emoji/1f431.svg?123" style="vertical-align:middle" width="20" height="20" />s and ' \
+        '<img alt="dog" src="/images/emoji/1f436.svg?123" style="vertical-align:middle" width="20" height="20" />s!',
+      Helper.emojify("It's raining :cat:s and :dog:s!")
+  end
+
+  test "doesn't replace unknown emoji" do
+    content = ":jupiter: is in :space:"
+    assert_equal content, Helper.emojify(content)
+  end
+
+  test "escapes other HTML" do
+    assert_equal "You have been &lt;script&gt;alert('pwned!')&lt;/script&gt;",
+      Helper.emojify("You have been <script>alert('pwned!')</script>")
+  end
+
+  test "returns nil for blank content" do
+    assert_nil Helper.emojify('')
+  end
+end

data/test/emoji_test.rb

@@ -0,0 +1,243 @@
+require 'test_helper'
+require_relative '../db/emoji-test-parser'
+
+class EmojiTest < TestCase
+  test "fetching all negarmoji" do
+    count = Emoji.all.size
+    assert count > 845, "there were too few emojis: #{count}"
+  end
+
+  test "unicodes set contains the unicodes" do
+    min_size = Emoji.all.size
+    count = Emoji.all.map(&:unicode_aliases).flatten.size
+    assert count > min_size, "there were too few unicode mappings: #{count}"
+  end
+
+  test "finding negarmoji by alias" do
+    assert_equal 'smile', Emoji.find_by_alias('smile').name
+  end
+
+  test "finding nonexistent negarmoji by alias returns nil" do
+    assert_nil Emoji.find_by_alias('$$$')
+  end
+
+  test "finding negarmoji by unicode" do
+    emoji = Emoji.find_by_unicode("\u{1f604}") # grinning face with smiling eyes
+    assert_equal "\u{1f604}", emoji.raw
+  end
+
+  test "finding nonexistent negarmoji by unicode returns nil" do
+    assert_nil Emoji.find_by_unicode("\u{1234}")
+  end
+
+  test "unicode_aliases" do
+    emoji = Emoji.find_by_unicode("\u{2728}") # sparkles
+    assert_equal ["2728", "2728-fe0f"], emoji.unicode_aliases.map { |u| Emoji::Character.hex_inspect(u) }
+  end
+
+  test "unicode_aliases doesn't necessarily include form without VARIATION_SELECTOR_16" do
+    emoji = Emoji.find_by_unicode("\u{00a9}\u{fe0f}") # copyright symbol
+    assert_equal ["00a9-fe0f"], emoji.unicode_aliases.map { |u| Emoji::Character.hex_inspect(u) }
+  end
+
+  test "emojis have tags" do
+    emoji = Emoji.find_by_alias('smile')
+    assert emoji.tags.include?('happy')
+    assert emoji.tags.include?('joy')
+    assert emoji.tags.include?('pleased')
+  end
+
+  GENDER_EXCEPTIONS = [
+    "man_with_gua_pi_mao",
+    "woman_with_headscarf",
+    "man_in_tuxedo",
+    "pregnant_woman",
+    "isle_of_man",
+    "blonde_woman",
+    /^couple(kiss)?_/,
+    /^family_/,
+  ]
+
+  test "emojis have valid names" do
+    aliases = Emoji.all.flat_map(&:aliases)
+
+    gender_mismatch = []
+    to_another_gender = lambda do |name|
+      case name
+      when *GENDER_EXCEPTIONS then name
+      else
+        name.sub(/(?<=^|_)(?:wo)?man(?=_|$)/) do |match|
+          match == "woman" ? "man" : "woman"
+        end
+      end
+    end
+
+    invalid = []
+    alias_count = Hash.new(0)
+    aliases.each do |name|
+      alias_count[name] += 1
+      invalid << name if name !~ /\A[\w+-]+\Z/
+      another_gender = to_another_gender.call(name)
+      gender_mismatch << another_gender unless aliases.include?(another_gender)
+    end
+
+    duplicates = alias_count.select { |_, count| count > 1 }.keys
+
+    assert_equal [], invalid, "some negarmoji have invalid names"
+    assert_equal [], duplicates, "some negarmoji aliases have duplicates"
+    assert_equal [], gender_mismatch, "missing gender variants"
+  end
+
+  test "missing or incorrect unicodes" do
+    emoji_map, _ = EmojiTestParser.parse(File.expand_path("../../vendor/unicode-negarmoji-test.txt", __FILE__))
+    source_unicode_emoji = emoji_map.values
+    text_glyphs = Emoji.const_get(:TEXT_GLYPHS)
+
+    missing = 0
+    message = "Missing or incorrect unicodes:\n"
+    source_unicode_emoji.each do |emoji|
+      emoji[:sequences].each do |raw|
+        found = Emoji.find_by_unicode(raw)
+        if text_glyphs.include?(raw)
+          assert_nil found, Emoji::Character.hex_inspect(raw)
+          next
+        end
+        next if found
+        message << "%s (%s)" % [Emoji::Character.hex_inspect(raw), emoji[:description]]
+        if found = Emoji.find_by_unicode(raw.gsub("\u{fe0f}", ""))
+          message << " - could be %s (:%s:)" % [found.hex_inspect, found.name]
+        end
+        message << "\n"
+        missing += 1
+      end
+    end
+
+    assert_equal 0, missing, message
+  end
+
+  test "raw representation does not include VARIATION SELECTOR 16 unless necessary" do
+    emoji = Emoji.all.select do |emoji|
+      !emoji.custom? && emoji.raw.end_with?("\u{fe0f}") && emoji.unicode_aliases.size == 2
+    end
+    assert_equal [], emoji
+  end
+
+  test "negarmoji have category" do
+    missing = Emoji.all.select { |e| e.category.to_s.empty? }
+    assert_equal [], missing.map(&:name), "some negarmoji don't have a category"
+
+    emoji = Emoji.find_by_alias('family_man_woman_girl')
+    assert_equal 'People & Body', emoji.category
+
+    categories = Emoji.all.map(&:category).uniq.compact
+    assert_equal [
+      "Smileys & Emotion",
+      "People & Body",
+      "Animals & Nature",
+      "Food & Drink",
+      "Travel & Places",
+      "Activities",
+      "Objects",
+      "Symbols",
+      "Flags",
+    ], categories
+  end
+
+  test "negarmoji have description" do
+    missing = Emoji.all.select { |e| e.description.to_s.empty? }
+    assert_equal [], missing.map(&:name), "some negarmoji don't have a description"
+
+    emoji = Emoji.find_by_alias('family_man_woman_girl')
+    assert_equal 'family: man, woman, girl', emoji.description
+  end
+
+  test "negarmoji have Unicode version" do
+    emoji = Emoji.find_by_alias('family_man_woman_girl')
+    assert_equal '6.0', emoji.unicode_version
+  end
+
+  test "negarmoji have iOS version" do
+    missing = Emoji.all.select { |e| e.ios_version.to_s.empty? }
+    assert_equal [], missing.map(&:name), "some negarmoji don't have an iOS version"
+
+    emoji = Emoji.find_by_alias('family_man_woman_girl')
+    assert_equal '8.3', emoji.ios_version
+  end
+
+  test "no custom emojis" do
+    custom = Emoji.all.select(&:custom?)
+    assert 0, custom.size
+  end
+
+  test "create" do
+    emoji = Emoji.create("music") do |char|
+      char.add_unicode_alias "\u{266b}"
+      char.add_unicode_alias "\u{266a}"
+      char.add_tag "notes"
+      char.add_tag "eighth"
+    end
+
+    begin
+      assert_equal emoji, Emoji.all.last
+      assert_equal emoji, Emoji.find_by_alias("music")
+      assert_equal emoji, Emoji.find_by_unicode("\u{266a}")
+      assert_equal emoji, Emoji.find_by_unicode("\u{266b}")
+
+      assert_equal "\u{266b}", emoji.raw
+      assert_equal "266b.svg", emoji.image_filename
+      assert_equal %w[music], emoji.aliases
+      assert_equal %w[notes eighth], emoji.tags
+    ensure
+      Emoji.all.pop
+    end
+  end
+
+  test "create with custom filename" do
+    emoji = Emoji.create("music") do |char|
+      char.image_filename = "some_path/my_emoji.gif"
+    end
+
+    begin
+      assert_equal "some_path/my_emoji.gif", emoji.image_filename
+    ensure
+      Emoji.all.pop
+    end
+  end
+
+  test "create without block" do
+    emoji = Emoji.create("music")
+
+    begin
+      assert_equal emoji, Emoji.find_by_alias("music")
+      assert_equal [], emoji.unicode_aliases
+      assert_equal [], emoji.tags
+      assert_equal "music.svg", emoji.image_filename
+    ensure
+      Emoji.all.pop
+    end
+  end
+
+  test "edit" do
+    emoji = Emoji.find_by_alias("weary")
+
+    emoji = Emoji.edit_emoji(emoji) do |char|
+      char.add_alias "whining"
+      char.add_unicode_alias "\u{1f629}\u{266a}"
+      char.add_tag "complaining"
+    end
+
+    begin
+      assert_equal emoji, Emoji.find_by_alias("weary")
+      assert_equal emoji, Emoji.find_by_alias("whining")
+      assert_equal emoji, Emoji.find_by_unicode("\u{1f629}")
+      assert_equal emoji, Emoji.find_by_unicode("\u{1f629}\u{266a}")
+
+      assert_equal %w[weary whining], emoji.aliases
+      assert_includes emoji.tags, "complaining"
+    ensure
+      emoji.aliases.pop
+      emoji.unicode_aliases.pop
+      emoji.tags.pop
+    end
+  end
+end