negarmoji 0.1.1 → 0.1.3

data/negarmoji.gemspec

@@ -11,14 +11,21 @@ Gem::Specification.new do |spec|
   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.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.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"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "minitest", "~> 5.13"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.77"
+  spec.add_development_dependency "simplecov", "~> 0.17.0"
 end

data/script/ci_rubygems.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+# Usage: script/ci_rubygems.sh
+#
+# Create credential file for rubygems.org.
+
+# set flag for shell execution.
+# -e  Exit immediately if a command exits with a non-zero status.
+set -e
+
+mkdir -p ~/.gem
+touch ~/.gem/credentials
+chmod 0600 ~/.gem/credentials
+printf -- "---\r\n:rubygems_api_key: %s\n" "${RUBYGEMS_API_KEY}" > ~/.gem/credentials

data/script/dev_release.py

@@ -0,0 +1,91 @@
+#!/usr/bin/env python3
+
+# Python Standard Library
+import os
+import subprocess
+
+# get path to this file's directory, then go one directory up.
+file_path = os.path.abspath(os.path.dirname(__file__))
+base_path = os.path.abspath(os.path.dirname(file_path))
+version_file_path = os.path.join(base_path, "lib", "negarmoji", "version.rb")
+
+# open version file.
+with open(version_file_path) as file:
+    version_file = file.readlines()
+
+# set version and version_info to None, so if we didn't find
+# a version in version.rb, we can throw an error.
+version = None
+version_info = None
+
+# find version.
+for line in version_file:
+    if "VERSION = " in line:
+        # find version string and covert it to
+        # standard x.y.z version format.
+        double_quote_left = line.index("\"") + 1
+        double_quote_right = line[double_quote_left:].index("\"") + double_quote_left
+        version = line[double_quote_left:double_quote_right]
+        # creat a list from x.y.z string which has [x, y, z]
+        # notice that x, y , z must be converted to integer
+        version_info = [int(number) for number in version.split(".")]
+
+# throw error if version not found.
+if not version or not version_info:
+    raise ValueError("ERROR: version not found at version.rb.")
+
+print("This program will tag a new release of Negareh Emoji Library\n"
+      + "and it will push to gitlab and github for building,\n"
+      + "gitlab will push a built gem to rubygems.org.\n\n"
+      + f"current version is {version}\n\n")
+
+# read and convert to integer.
+print("Version is in X.Y.Z form.\n"
+      "X is version major, Y is version minor, Z is version minor.\n\n")
+new_major = int(input("Enter version major number:\n"))
+new_minor = int(input("Enter version minor  number:\n"))
+new_patch = int(input("Enter version patch number:\n"))
+
+new_version = ".".join(map(str, [new_major, new_minor, new_patch]))
+
+# check version to be bigger than last version.
+if new_version == version:
+    raise ValueError("Version can't be same as current version!")
+
+if new_major < version_info[0]:
+    raise ValueError("Major version can't be less than current version!")
+elif new_minor < version_info[1]:
+    raise ValueError("Minor version can't be less than current version!")
+elif new_patch < version_info[2]:
+    raise ValueError("Patch version can't be less than current version!")
+
+
+# creat an empty list for new version.rb file
+print("Writing new version. \n\n")
+
+new_version_rb = list()
+
+# write new VERSION in version.rb.
+new_version_info = f"  VERSION = \"{new_major}.{new_minor}.{new_patch}\"\n"
+
+# replace old version with new one.
+with open(version_file_path, "r") as file:
+    lines = file.readlines()
+    for line in lines:
+        if "VERSION = " in line:
+            new_version_rb.append(new_version_info)
+        else:
+            new_version_rb.append(line)
+
+# write updated content from new_version_rb
+# back into version.rb. file
+with open(version_file_path, "w+") as file:
+    file.writelines(new_version_rb)
+
+# do git commit and tag and push to upstreams
+print("Commit and Tag and Push to upstream. \n\n")
+
+subprocess.call(f"git commit \"{version_file_path}\" -m \"version: Negareh Emoji Library v{new_version}\"", shell=True)
+subprocess.call(f"git tag \"v{new_version}\"", shell=True)
+subprocess.call(f"git push origin HEAD \"v{new_version}\"", shell=True)
+subprocess.call(f"git push github HEAD \"v{new_version}\"", shell=True)

data/script/dev_revert_tag.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python3
+
+# Python Standard Library
+import os
+import subprocess
+
+# get path to this file's directory, then go one directory up.
+file_path = os.path.abspath(os.path.dirname(__file__))
+base_path = os.path.abspath(os.path.dirname(file_path))
+version_file_path = os.path.join(base_path, "lib", "negarmoji", "version.rb")
+
+# open version file.
+with open(version_file_path) as file:
+    version_file = file.readlines()
+
+# set version and version_info to None, so if we didn't find
+# a version in version.rb, we can throw an error.
+version = None
+
+# find version
+for line in version_file:
+    if "VERSION = " in line:
+        # find version string and covert it to
+        # standard x.y.z version format.
+        double_quote_left = line.index("\"") + 1
+        double_quote_right = line[double_quote_left:].index("\"") + double_quote_left
+        version = line[double_quote_left:double_quote_right]
+
+# throe error if version not found
+if not version:
+    raise ValueError("ERROR: version not found at version.rb.")
+
+# remove tag in local and remote repository
+subprocess.call(f"git tag -d \"v{version}\"", shell=True)
+subprocess.call(f"git push --delete origin \"v{version}\"", shell=True)
+subprocess.call(f"git push --delete github \"v{version}\"", shell=True)
+
+# revert last commit
+subprocess.call(f"git revert HEAD", shell=True)

data/script/test.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+# Usage: script/ci_test.sh
+#
+# run all the tests.
+
+# set flag for shell execution.
+# -e  Exit immediately if a command exits with a non-zero status.
+# -x  Print commands and their arguments as they are executed.
+set -ex
+
+script/test_style.sh
+script/test_module.sh

data/script/test_module.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+# Usage: script/test_modu;e.sh
+#
+# Test modules with minitest.
+
+# set flag for shell execution.
+# -e  Exit immediately if a command exits with a non-zero status.
+set -e
+
+exec bundle exec rake test

data/script/test_style.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+# Usage: script/test_style.sh
+#
+# Check code style wit rubocop.
+
+# set flag for shell execution.
+# -e  Exit immediately if a command exits with a non-zero status.
+set -e
+
+echo "Rubocop $(bundle exec rubocop --version)"
+bundle exec rubocop -S -D -E "$@"
+
+success=$?
+if ((success != 0)); then
+   echo -e "\nTry running \`script/fmt -a\` to automatically fix errors"
+fi
+
+exit $success

data/test/documentation_test.rb

@@ -1,13 +1,20 @@
-require 'test_helper'
+# frozen_string_literal: true
+
+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]
+readme = File.expand_path("../README.md", __dir__)
+docs = File.open(readme, "r:UTF-8", &:read)
+eval docs.match(%r{^module.+?^end}m)[0]
 
 String.class_eval do
-  def html_safe() self end
-  def present?() !empty? end
+  def html_safe
+    self
+  end
+
+  def present?
+    !empty?
+  end
 end
 
 class DocumentationTest < TestCase
@@ -15,7 +22,7 @@ class DocumentationTest < TestCase
     extend EmojiHelper
 
     def self.h(str)
-      str.gsub('<', '&lt;').gsub('>', '&gt;')
+      str.gsub("<", "&lt;").gsub(">", "&gt;")
     end
 
     def self.image_path(img)
@@ -27,7 +34,7 @@ class DocumentationTest < TestCase
     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!")
+                 Helper.emojify("It's raining :cat:s and :dog:s!")
   end
 
   test "doesn't replace unknown emoji" do
@@ -37,10 +44,10 @@ class DocumentationTest < TestCase
 
   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>")
+                 Helper.emojify("You have been <script>alert('pwned!')</script>")
   end
 
   test "returns nil for blank content" do
-    assert_nil Helper.emojify('')
+    assert_nil Helper.emojify("")
   end
 end

data/test/emoji_test.rb

@@ -1,5 +1,5 @@
-require 'test_helper'
-require_relative '../db/emoji-test-parser'
+require "test_helper"
+require_relative "../db/emoji-test-parser"
 
 class EmojiTest < TestCase
   test "fetching all negarmoji" do
@@ -14,11 +14,11 @@ class EmojiTest < TestCase
   end
 
   test "finding negarmoji by alias" do
-    assert_equal 'smile', Emoji.find_by_alias('smile').name
+    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('$$$')
+    assert_nil Emoji.find_by_alias("$$$")
   end
 
   test "finding negarmoji by unicode" do
@@ -32,7 +32,7 @@ class EmojiTest < TestCase
 
   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) }
+    assert_equal %w[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
@@ -41,22 +41,22 @@ class EmojiTest < TestCase
   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')
+    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_/,
-  ]
+      "man_with_gua_pi_mao",
+      "woman_with_headscarf",
+      "man_in_tuxedo",
+      "pregnant_woman",
+      "isle_of_man",
+      "blonde_woman",
+      %r{^couple(kiss)?_},
+      %r{^family_}
+  ].freeze
 
   test "emojis have valid names" do
     aliases = Emoji.all.flat_map(&:aliases)
@@ -66,7 +66,7 @@ class EmojiTest < TestCase
       case name
       when *GENDER_EXCEPTIONS then name
       else
-        name.sub(/(?<=^|_)(?:wo)?man(?=_|$)/) do |match|
+        name.sub(%r{(?<=^|_)(?:wo)?man(?=_|$)}) do |match|
           match == "woman" ? "man" : "woman"
         end
       end
@@ -76,7 +76,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 !~ %r{\A[\w+-]+\Z}
       another_gender = to_another_gender.call(name)
       gender_mismatch << another_gender unless aliases.include?(another_gender)
     end
@@ -89,23 +89,20 @@ class EmojiTest < TestCase
   end
 
   test "missing or incorrect unicodes" do
-    emoji_map, _ = EmojiTestParser.parse(File.expand_path("../../vendor/unicode-negarmoji-test.txt", __FILE__))
+    emoji_map, = EmojiTestParser.parse(File.expand_path("../vendor/unicode-emoji-test.txt", __dir__))
     source_unicode_emoji = emoji_map.values
+    supported_sequences = Emoji.all.flat_map(&:unicode_aliases)
     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]
+        next if text_glyphs.include?(raw) || Emoji.find_by_unicode(raw)
+
+        message << format("%s (%s)", Emoji::Character.hex_inspect(raw), emoji[:description])
+        if (found = Emoji.find_by_unicode(raw.gsub("\u{fe0f}", "")))
+          message << format(" - could be %s (:%s:)", found.hex_inspect, found.name)
         end
         message << "\n"
         missing += 1
@@ -115,31 +112,24 @@ class EmojiTest < TestCase
     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
+    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",
+                     "Smileys & Emotion",
+                     "People & Body",
+                     "Animals & Nature",
+                     "Food & Drink",
+                     "Travel & Places",
+                     "Activities",
+                     "Objects",
+                     "Symbols",
+                     "Flags"
     ], categories
   end
 
@@ -147,21 +137,21 @@ class EmojiTest < TestCase
     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
+    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
+    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
+    emoji = Emoji.find_by_alias("family_man_woman_girl")
+    assert_equal "8.3", emoji.ios_version
   end
 
   test "no custom emojis" do