negarmoji 0.1.1 → 0.1.3

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-12-06 11:59:49 +0100 using RuboCop version 0.61.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 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).
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,78 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [MahdiBaghbani@protonmail.com][email]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+[email]: mailto:MahdiBaghbani@protonmail.com
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/CONTRIBUTING.md

@@ -1,31 +1,200 @@
-Contributions to this project are released to the public under the [project's open source license](LICENSE).
+# Contributing to Negareh Emoji Library
 
-Some useful tools in development are:
+Welcome! Azadeh Afzar - Negareh Emoji Library (AA-NEL) is a hobby project that
+aims to implement an easy way to generate emoji database for using in other packages.
+If you're trying AA-NEL, your experience and what you can contribute are important to
+the project's success.
 
-```
-script/bootstrap
-```
 
-Sets up the development environment. The prerequisites are:
+## Getting started, building, and testing
 
-* Ruby 1.9+
-* Bundler
+If you haven't already, take a look at the project's [README.md file](README.md).
 
-```
-script/test
-```
+### Git repository 
 
-Runs the test suite.
+All project's development and discussion takes place on  [GitLab][gitlab repo],
+there is also a mirror on [GitHub][github repo].
 
-```
-script/console
-```
+For contributing to this project, first login into your GitLab account and fork this
+repository. After forking this repo, clone it into your local machine and create a 
+new branch from `master` branch with a descriptive name that describes your new feature
+or `fix #issue-code` when you are fixing an issue. This part is important!
+we do not accept MRs from master branch.
 
-Opens `irb` console with negarmoji library preloded for experimentation.
+After doing your changes, commit and push your new branch to your forked repository on
+GitLab and then ask for a Merge Request to `master` branch of this repository.
 
-```
-script/release
-```
+### Environment and dependency
 
-For maintainers only: after the gemspec has been edited, this commits the
-change, tags a release, and pushes it to both GitHub and RubyGems.org.
+
+[gitlab repo]: https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-Library
+[github repo]: https://github.com/azadeh-afzar/Negareh-Emoji-Library
+
+## Discussion
+
+If you've run into behavior in Negareh Emoji Library you don't understand,
+or you're having trouble working out a good way to apply it to your code, or
+you've found a bug or would like a feature it doesn't have, we want to hear from you!
+
+Our main forum for discussion is the project's [GitLab issue tracker][gitlab issue].
+This is the right place to start a discussion of any of the above or most any other
+topic concerning the project.
+
+### Code of Conduct
+
+Everyone participating in the AA-NEL community, and in particular
+in our issue tracker, pull requests, and IRC channel, is expected to treat
+other people with respect and more generally to follow the guidelines
+articulated in the [Negareh Emoji Library Code of Conduct](CODE_OF_CONDUCT.md).
+
+[gitlab issue]: https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-Library/issues
+
+## First Time Contributors
+
+Negareh Emoji Library appreciates your contribution! If you are interested in 
+helping improve AA-NEL, there are several ways to get started:
+
+* Find bugs and open issues on GitLab! this is almost one of the best ways to contribute.
+* Work on [documentation issues][project documentation].
+* Write tests for existing modules.
+* Add new features (first discuss it as an issue).
+
+[project documentation]: https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-Library/labels/documentation
+
+## Submitting Changes
+
+Even more excellent than a good bug report is a fix for a bug, or the
+implementation of a much-needed new feature. (*)  We'd love to have
+your contributions.
+
+(*) If your new feature will be a lot of work, we recommend talking to
+    us early -- see below.
+
+We use the usual [GitLab merge-request flow][gitlab flow],
+which may be familiar to you if you've contributed to other projects on GitLab.
+
+Anyone interested in Negareh Emoji Library may review your code. 
+One of the AA-NEL core developers will merge your 
+merge request when they think it's ready.
+For every merge request, we aim to promptly either merge it or say why
+it's not yet ready; if you go a few days without a reply, please feel
+free to ping the thread by adding a new comment.
+
+For a list of AA-NEL core developers, see the file [CREDITS](CREDITS).
+
+[gitlab flow]: https://docs.gitlab.com/ee/user/project/merge_requests
+
+## Preparing Changes
+
+Before you begin: if your change will be a significant amount of work
+to write, we highly recommend starting by opening an issue laying out
+what you want to do.  That lets a conversation happen early in case
+other contributors disagree with what you'd like to do or have ideas
+that will help you do it.
+
+The best pull requests are focused, clearly describe what they're for
+and why they're correct, and contain tests for whatever changes they
+make to the code's behavior.  As a bonus these are easiest for someone
+to review, which helps your merge request get merged quickly!  Standard
+advice about good merge requests for open-source projects applies; we
+have [our own writeup][good merge request]
+of this advice. (adapted from mypy guidelines)
+
+See also our [coding conventions][code conventions] -- which consist mainly of a 
+reference to [Ruby Style Guide][ruby style] -- for the code you
+put in the merge request.
+
+Also, do not squash your commits after you have submitted a merge request, as this
+erases context during review. We will squash commits when the merge request is merged.
+
+You may also find other pages in the [AA-NEL wiki][wiki]
+helpful in developing your change.
+
+[goode merge request]: https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-Library/wikis/Good-Merge-Request
+[code conventions]: https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-Library/wikis/Code-Conventions
+[wiki]: https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-Library/wikis
+[ruby style]: https://www.rubystyle.guide
+
+# Core developer guidelines
+
+Core developers should follow these rules when processing merge requests:
+
+* Always wait for tests to pass before merging MRs.
+* Use "[Squash and merge](https://gitlab.com/blog/2141-squash-your-commits)"
+  to merge MRs.
+* Delete branches for merged MRs (by core devs pushing to the main repo).
+* Edit the final commit message before merging to conform to the following
+  style (we wish to have a clean `git log` output):
+  * all commit messages should start with one of these keywords in the subject:
+    - init: for initial commits.
+    - add: for adding new feature.
+    - fix: for fixing an issue.
+    - modify: for changing existing code for optimization/readability etc.
+    - update: for changing doc files or comments.
+    - remove: for deleting code or file.
+    - build: for updating MakeFiles, etc for build process.
+    - style: for fixing indentation or line breaks, etc.
+    - document: for adding new documentation.
+    - version: for releasing version tags.
+    - ci: for DevOps jobs, like editing `.travis.yml` file.
+    - [skip ci]: use this keyword when you change docs to avoid running CI/CD jobs.
+  
+  * When merging a multi-commit MR make sure that the commit message doesn't
+    contain the local history from the committer and the review history from
+    the MR. Edit the message to only describe the end state of the MR.
+  * Make sure there is a *single* newline at the end of the commit message.
+    This way there is a single empty line between commits in `git log`
+    output.
+  * Split lines as needed so that the maximum line length of the commit
+    message is under 80 characters, including the subject line.
+  * Do not capitalize the subject and each paragraph.
+  * Make sure that the subject of the commit message has no trailing dot.
+  * If the MR fixes an issue, make sure something like "issue #xxx." occurs
+    in the body of the message and not in the subject (e.g. `fix: issue #32`).
+  * Use Markdown for formatting.
+
+
+## Issue-tracker conventions
+
+We aim to reply to all new issues promptly.  We'll assign a milestone
+to help us track which issues we intend to get to when, and may apply
+labels to carry some other information.  Here's what our milestones
+and labels mean.
+
+### Task priority and sizing
+
+We use GitLab "labels" ([see our list][labels])
+to roughly order what we want to do soon and less soon.  There's two dimensions
+taken into account: **priority** (does it matter to our users) and **size** (how
+long will it take to complete).
+
+Bugs that aren't a huge deal but do matter to users and don't seem
+like a lot of work to fix generally will be dealt with sooner; things
+that will take longer may go further out.
+
+We are trying to keep the backlog at a manageable size, an issue that is
+unlikely to be acted upon in foreseeable future is going to be
+respectfully closed.  This doesn't mean the issue is not important, but
+rather reflects the limits of the team.
+
+The **question** label is for issue threads where a user is asking a
+question but it isn't yet clear that it represents something to actually
+change.  We use the issue tracker as the preferred venue for such
+questions, even when they aren't literally issues, to keep down the
+number of distinct discussion venues anyone needs to track.  These might
+evolve into a bug or feature request.
+
+Issues **without a priority or size** haven't been triaged.  We aim to
+triage all new issues promptly, but there are some issues from previous
+years that we haven't yet re-reviewed since adopting these conventions.
+
+### Other labels
+
+* **discussion**: This issue needs agreement on some kind of
+  design before it makes sense to implement it, and it either doesn't
+  yet have a design or doesn't yet have agreement on one.
+* **feature**, **bug**, **crash**, **refactoring**, **documentation**:
+  These classify the user-facing impact of the change.  Specifically
+  "refactoring" means there should be no user-facing effect.
+  
+[labels]: https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-Library/labels

data/CREDITS

@@ -0,0 +1,11 @@
+# Credits
+
+For full list of contributors you can mine the commit history:
+https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-Library/commits/master
+
+or see graphs:
+https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-Library/-/graphs/master
+
+Core team:
+
+    Mohammad Mahdi Baghbani Pourvahid <MahdiBaghbani@protonmail.com>

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-gem "rake", "~> 10.3.2"
-gem "minitest", "~> 5.3.5"
+source "https://rubygems.org"
 
 gemspec
+
+gem "minitest", "~> 5.3.5"
+gem "rake", "~> 10.3.2"

data/README.md

@@ -1,3 +1,65 @@
+<p align="center">
+  <br>
+  <a href="#">
+    <img src="logo.svg" width="100" alt="Negareh Emoji Library"/>
+  </a>
+</p>
+
+<h1 align="center">Negareh Emoji Library</h1>
+<h3 align="center">Character information and metadata for Unicode emoji.</h3>
+
+<p align="center">
+  <a title="Open Source" href="https://opensource.com/resources/what-open-source" target="_blank">
+    <img src="https://img.shields.io/badge/Open%20Source-Forever-brightgreen?logo=open-source-initiative&style=flat-square" alt="Open Source">
+  </a>
+  <a title="License: GPLv3" href="https://www.opensource.org/licenses/GPL-3.0" target="_blank">
+    <img src="https://img.shields.io/github/license/azadeh-afzar/Negareh-Emoji-Library?logo=gnu&style=flat-square" alt="License: GPLv3">
+  </a>
+  <a title="Language counter" href="#" target="_blank">
+    <img src="https://img.shields.io/github/languages/count/azadeh-afzar/Negareh-Emoji-Library?logo=gitlab&style=flat-square" alt="Language counter">
+  </a>
+  <a title="Top language" href="#" target="_blank">
+    <img src="https://img.shields.io/github/languages/top/azadeh-afzar/Negareh-Emoji-Library?logo=gitlab&style=flat-square" alt="Top language">
+  </a>
+  
+  <br>
+  
+  <a title="Code Quality: Codefactor.io" href="https://www.codefactor.io/repository/github/azadeh-afzar/Negareh-Emoji-Library" target="_blank">
+    <img src="https://www.codefactor.io/repository/github/azadeh-afzar/Negareh-Emoji-Library/badge?style=flat-square" alt="CodeFactor"/>
+  </a>
+  <a title="Code Quality: CodeClimate.com" href="https://codeclimate.com/github/azadeh-afzar/Negareh-Emoji-Library/maintainability" target="_blank">
+    <img src="https://img.shields.io/codeclimate/maintainability/azadeh-afzar/Negareh-Emoji-Library?logo=code-climate&style=flat-square" alt="CodeClimate rating"/>
+  </a>
+  <a title="Code Technical Debt: CodeClimate.com" href="https://codeclimate.com/github/azadeh-afzar/Negareh-Emoji-Library/maintainability" target="_blank">
+    <img src="https://img.shields.io/codeclimate/tech-debt/azadeh-afzar/Negareh-Emoji-Library?logo=code-climate&style=flat-square" alt="CodeClimate technical debt"/>
+  </a>
+  <a title="Code Issues: CodeClimate.com" href="https://codeclimate.com/github/azadeh-afzar/Negareh-Emoji-Library/maintainability" target="_blank">
+    <img src="https://img.shields.io/codeclimate/issues/azadeh-afzar/Negareh-Emoji-Library?logo=code-climate&style=flat-square" alt="CodeClimate issues"/>
+  </a>
+  
+  <br>
+
+  <a title="GitLab: pipeline status" href="https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-Library/commits/master" target="_blank">
+    <img src="https://img.shields.io/gitlab/pipeline/Web-Development/Negareh-Emoji-Library?gitlab_url=https%3A%2F%2Fgitlab.com%2FAzadeh-Afzar&logo=gitlab&style=flat-square"  alt="pipeline status" />
+  </a>
+  <a title="Test Coverage: CodeClimate.com" href="https://codeclimate.com/github/azadeh-afzar/Negareh-Emoji-Library" target="_blank">
+    <img src="https://img.shields.io/codeclimate/coverage/azadeh-afzar/Negareh-Emoji-Library?logo=code-climate&style=flat-square" alt="CodeClimate"/>
+  </a>
+  
+  <br>
+
+  <a title="Gem Version" href="https://rubygems.org/gems/negarmoji">
+    <img src="https://img.shields.io/gem/v/negarmoji?color=red&label=Negareh%20Emoji%20Library&logo=rubygems&style=flat-square" alt="Gem Version">
+  </a>
+</p>
+
+> If you are viewing this repository on GitHub, this GitHub repository is a mirror of the Negareh Emoji Library,
+> the main repository is served on 
+><a href="https://gitlab.com/Azadeh-Afzar/Web-Development/Negareh-Emoji-Library">GitLab</a>, all developments and
+>discussions, issue tracking and merge requests take place in GitLab.  
+
+> This project is a fork of <a href="https://github.com/github/jemoji">Gemoji</a>. 
+
 negarmoji
 ======
 
@@ -98,3 +160,22 @@ end
 Emoji.find_by_alias "music"       #=> emoji
 Emoji.find_by_unicode "\u{266b}"  #=> emoji
 ```
+## Contribution
+
+If you want to contribute to this project, please read [CONTRIBUTING](CONTRIBUTING.md).
+
+## Code of Conduct
+
+Visit the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Roadmap
+
+Visit the [Roadmap](ROADMAP.md) to keep track of which features we are currently
+working on.
+
+## License
+
+Licensed under the [GPLv3](LICENSE).
+
+## Attribution
+2. This project is a fork of [Gemoji](https://github.com/github/gemoji). License: MIT

data/ROADMAP.md

@@ -0,0 +1,28 @@
+# Negareh Emoji Library v1.0 Roadmap
+
+## Overview
+
+This document outlines our roadmap to delivering Azadeh Afzar - Negareh Emoji Library
+v1.0 by Summer 2021.
+
+## Milestones
+
+The Azadeh Afzar - Negareh Emoji Library
+v1.0 project milestones:
+
+Milestone name: No milestones.
+Start date of this Milestone: None
+
+| Feature | Duration |
+| --- | --- |
+
+
+## Terminal Roadmap / Timeline
+
+Ultimately, we're aiming for Negareh Emoji Library v1.0 to be feature-complete by Jan 2021,
+and to declare v1.0 by Jul 2021:
+
+| Milestone end date | Milestone Name | Key Deliverables |
+| --- | --- | --- |
+| 2019-09-8 | Start | Azadeh Afzar forked Gemoji package from GitHub
+| 2019-12-12| fundamental refactor | Add skin tone variations, update to emoji 12.1