jekyll-openmoji 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: feb8c2e3b8485082d627573c5c5ba37689b7d3920b6a58be5235d268dd1565d7
-  data.tar.gz: 8b4997c7635d5e6362461f5880edeebba6fcbf53528e0f3e89017e180a6e598c
+  metadata.gz: 374f056a176d49f49060ba22194f3f2ec700f9c07a7587d58fa51de54be5c339
+  data.tar.gz: 44411f8abefb2995728e15554e3516fddc521d11a9ba4b0aad69c9f102dfc449
 SHA512:
-  metadata.gz: '0491f04b3255a8f48cfd677864693b044f292b003166885743355cab412f0e458ce0bc4dc901a11b34e7a134ca8ee2dffc8fa5accea25f86d23b2f42521723d0'
-  data.tar.gz: 4c8573632bb07250738f9adbb17fa4390d97f9c906cbb6ea0195cfe472105fe2da57a92176b75542ae8e9ccfa4cf44cdf3d2f7550c937bea65faa3d7072c23e0
+  metadata.gz: 39a6ccd929dff7cd86752a001adf12620d259e2a3c06a6b687f25a5115bfe9417a835047762ad32bf499856245accdb97e48e57f536e1e2190c28f68751deab6
+  data.tar.gz: 503cce036b2b024c0c6a1cd859f3092c684f4e2bba6ccbff05dc585a5cc1e79e08673dea0e647cf119fe604fcdc887e82e35b06adaf053555c634d46181c460c

data/.codeclimate.yml

@@ -0,0 +1,64 @@
+version: "2"
+checks:
+  argument-count:
+    enabled: true
+    config:
+      threshold: 5
+  complex-logic:
+    enabled: true
+    config:
+      threshold: 5
+  file-lines:
+    enabled: true
+    config:
+      threshold: 350
+  method-complexity:
+    enabled: true
+    config:
+      threshold: 10
+  method-count:
+    enabled: true
+    config:
+      threshold: 20
+  method-lines:
+    enabled: true
+    config:
+      threshold: 30
+  nested-control-flow:
+    enabled: true
+    config:
+      threshold: 5
+  return-statements:
+    enabled: true
+    config:
+      threshold: 4
+  similar-code:
+    enabled: true
+    config:
+      threshold: #language-specific defaults. overrides affect all languages.
+  identical-code:
+    enabled: true
+    config:
+      threshold: #language-specific defaults. overrides affect all languages.
+plugins:
+ git-legal:
+  enabled: true
+  config:
+    allow_affero_copyleft: true
+    allow_strong_copyleft: true
+ rubocop:
+   enabled: true
+
+exclude_patterns:
+- "config/"
+- "db/"
+- "dist/"
+- "features/"
+- "images/"
+- "**/node_modules/"
+- "script/"
+- "**/spec/"
+- "**/test/"
+- "**/tests/"
+- "**/vendor/"
+- "**/*.d.ts"

data/.gitlab-ci.yml

@@ -1,31 +1,66 @@
 stages:
   - test
-  - deploy
+  - release
 
+# default settings for all ci jobs.
 default:
   image: ruby:latest
   cache:
     paths:
       - vendor/
+
+# job for testing package on master branch
+# and send test coverage result to codeclimate.
+test_master:
+  stage: test
   before_script:
-    # upgrade bundler to latest version
+    # upgrade bundler to latest version.
     - gem install bundler
-    # install required gems
+    # install dependency gems.
     - bundle install --path vendor
+    # setup ci environment.
+    - script/ci_setup.sh
+    # run code climate test reporter agent.
+    - cc-test-reporter before-build
+  # run tests.
+  script:
+    - script/test.sh
+  # send test coverage result to codeclimate.
+  after_script:
+    - cc-test-reporter after-build --coverage-input-type simplecov
+  only:
+    - master
 
-test:
+# job for testing package on other branches
+# and merge requests.
+test_branches:
   stage: test
-#  before_script:
+  # run tests.
   script:
-    - script/ci-test
+    - script/test.sh
+  # run on branches and merge requests.
   only:
-    - master
+    - branches
     - merge_requests
+  # don't run on master branch.
+  except:
+    - master
+
+# deploy gems to rubygems.org whenever a tag is released.
+release_rubygems:
+  stage: release
+  script:
+    # create rubygems credential file for auto login.
+    - script/ci_rubygems.sh
+    # extract tag from git log and strip "v".
+    - version=$(git describe --tags)
+    - version=${version:1}
+    # build and push gem.
+    - gem build jekyll-openmoji.gemspec
+    - gem push "jekyll-openmoji-$version.gem"
+  # only run for new tags.
+  only:
+    - tags
+  when: manual
 
-#deploy-gem:
-#  stage: deploy
-#  before_script:
-#    - chmod +x ./deploy-gem
-#  script: ./deploy-gem
-#  only:
-#    - master
+  ed2351ca478dfefecd8d346d0b5c213f

data/.gitlab/issue_templates/Default.md

@@ -0,0 +1,20 @@
+## Details
+Mersad version:
+OS name and version: (e.g. Ubuntu 18.04)
+
+## Description
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**To Reproduce**
+Steps to reproduce the behavior.
+
+**Additional context**
+Add any other context about the problem here.

data/.gitlab/merge_request_templates/Default.md

@@ -0,0 +1,25 @@
+# Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules

data/.rubocop.yml

@@ -1,6 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 require: rubocop-jekyll
+
 inherit_gem:
   rubocop-jekyll: .rubocop.yml
 
@@ -8,3 +9,31 @@ AllCops:
   TargetRubyVersion: 2.3
   Exclude:
     - vendor/**/*
+
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+  IndentationWidth: 2
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/BlockLength:
+  Max: 50
+
+Metrics/LineLength:
+  Max: 85
+
+Metrics/MethodLength:
+  Max: 25
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -11,15 +11,15 @@
 # ExcludedMethods: refine
 Metrics/BlockLength:
   Exclude:
-    - "spec/jekyll-openmoji_spec.rb"
+    - "spec/jekyll_openmoji_spec.rb"
 
 # Offense count: 1
 # Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
   Exclude:
-    - "spec/jekyll-openmoji_spec.rb"
+    - "spec/jekyll_openmoji_spec.rb"
 
 Metrics/AbcSize:
   Exclude:
-    - "lib/jekyll-openmoji/plugin.rb"
+    - "lib/jekyll_openmoji/plugin.rb"

data/CODE_OF_CONDUCT.md

@@ -76,4 +76,3 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht
 
 For answers to common questions about this code of conduct, see
 https://www.contributor-covenant.org/faq
-

data/CONTRIBUTING.md

@@ -1,16 +1,199 @@
-## Contribute to OpenMoji Jekyll Plugin
-
-### Quick start
-
- 1. Open an issue about your feature request or bug report at the first place to discuss it before starting coding
- 2. Fork this repo on GitLab
- 3. Create a new branch e.g. my-awesome-new-feature
- 4. Follow guidelines in commit messages
- 5. Edit `CHANGELOG.md` file
- 6. Run `script/test` to see if you didn't break anything
- 7. Create a pull request on GitLab
- 
- ### Commit message guideline
- In order to keep git logs clean and easy to understand for future development, please follow this
- guideline:
+# Contributing to OpenMoji Jekyll Plugin
 
+Welcome! Azadeh Afzar - OpenMoji Jekyll Plugin (AA-OMJP) is a hobby project that
+aims to implement a wide range of cryptography and cryptanalysis algorithms.
+If you're trying AA-OMJP, your experience and what you can contribute are important to
+the project's success.
+
+
+## Getting started, building, and testing
+
+If you haven't already, take a look at the project's [README.md file](README.md).
+
+### Git repository 
+
+All project's development and discussion takes place on  [GitLab][gitlab repo],
+there is also a mirror on [GitHub][github repo].
+
+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.
+
+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.
+
+### Environment and dependency
+
+
+[gitlab repo]: https://gitlab.com/Azadeh-Afzar/Web-Development/OpenMoji-Jekyll-Plugin
+[github repo]: https://github.com/azadeh-afzar/OpenMoji-Jekyll-Plugin
+
+## Discussion
+
+If you've run into behavior in OpenMoji Jekyll Plugin 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-OMJP 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 [OpenMoji Jekyll Plugin Code of Conduct](CODE_OF_CONDUCT.md).
+
+[gitlab issue]: https://gitlab.com/Azadeh-Afzar/Web-Development/OpenMoji-Jekyll-Plugin/issues
+
+## First Time Contributors
+
+OpenMoji Jekyll Plugin appreciates your contribution! If you are interested in 
+helping improve AA-OMJP, 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 cryptography or cryptanalysis algorithms to the project.
+
+[project documentation]: https://gitlab.com/Azadeh-Afzar/Web-Development/OpenMoji-Jekyll-Plugin/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 OpenMoji Jekyll Plugin may review your code. 
+One of the AA-OMJP 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-OMJP 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 [PEP 8](https://www.python.org/dev/peps/pep-0008/) -- 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-OMJP wiki][wiki]
+helpful in developing your change.
+
+[goode merge request]: https://gitlab.com/Azadeh-Afzar/Web-Development/OpenMoji-Jekyll-Plugin/wikis/Good-Merge-Request
+[code conventions]: https://gitlab.com/Azadeh-Afzar/Web-Development/OpenMoji-Jekyll-Plugin/wikis/Code-Conventions
+[wiki]: https://gitlab.com/Azadeh-Afzar/Web-Development/OpenMoji-Jekyll-Plugin/wikis
+
+# 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/OpenMoji-Jekyll-Plugin/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/OpenMoji-Jekyll-Plugin/commits/master
+
+or see graphs:
+https://gitlab.com/Azadeh-Afzar/Web-Development/OpenMoji-Jekyll-Plugin/-/graphs/master
+
+Core team:
+
+    Mohammad Mahdi Baghbani Pourvahid <MahdiBaghbani@protonmail.com>

data/README.md

@@ -6,38 +6,82 @@
 </p>
 
 <h1 align="center">OpenMoji Jekyll Plugin</h1>
-<h3 align="center">Beautiful OpenMoji emojis on your Jekyll websites.</h3>
+<h3 align="center">Bring beautiful OpenMoji emojis to your Jekyll websites.</h3>
 <p align="center">
-<a href="https://openmoji.org">OpenMoji</a> is a free and open source emoji library which can be used
- for variety of purposes.</p>
+    <a href="https://openmoji.org">
+        OpenMoji
+    </a> 
+    is a free and open source emoji library which can be used
+    for variety of purposes. it is licensed under CC BY-SA 4.0 .
+</p>
 
 <p align="center">
-  <a title="Open Source" href="https://opensource.com/resources/what-open-source/">
-    <img src="https://img.shields.io/badge/Open%20Source-Forever-brightgreen?style=flat-square" alt="Open Source">
+  <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: GPL v3" href="https://www.opensource.org/licenses/GPL-3.0">
-    <img src="https://img.shields.io/badge/License-GPL%20v3-blue?style=flat-square&logo=gnu" alt="License: GPL v3">
+  <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/OpenMoji-Jekyll-Plugin?logo=gnu&style=flat-square" alt="License: GPLv3">
   </a>
-  <a title="OpenMoji Version" href="https://github.com/hfg-gmuend/openmoji/releases/tag/12.0.0">
-    <img src="https://img.shields.io/badge/OpenMoji-v12.0.0-yellow?style=flat-square" alt="OpenMoji Version">
+  <a title="Language counter" href="#" target="_blank">
+    <img src="https://img.shields.io/github/languages/count/azadeh-afzar/OpenMoji-Jekyll-Plugin?logo=gitlab&style=flat-square" alt="Language counter">
   </a>
-  <a title="Gem Version" href="https://rubygems.org/gems/negarmoji">
-    <img src="https://img.shields.io/badge/Jekyll%20OpenMoji-v0.0.1-yellow?style=flat-square" alt="Gem Version">
+  <a title="Top language" href="#" target="_blank">
+    <img src="https://img.shields.io/github/languages/top/azadeh-afzar/OpenMoji-Jekyll-Plugin?logo=gitlab&style=flat-square" alt="Top language">
   </a>
-  <a title="jsDelivr CDN" href="https://www.jsdelivr.com/package/gh/azadeh=afzar/OpenMoji-Jekyll-Plugin">
-    <img src="https://data.jsdelivr.com/v1/package/gh/azadeh=afzar/OpenMoji-Jekyll-Plugin/badge" alt="jsDelivr CDN">
+  
+  <br>
+  
+  <a title="Code Quality: Codefactor.io" href="https://www.codefactor.io/repository/github/azadeh-afzar/openMoji-jekyll-plugin" target="_blank">
+    <img src="https://www.codefactor.io/repository/github/azadeh-afzar/openMoji-jekyll-plugin/badge?style=flat-square" alt="CodeFactor"/>
+  </a>
+  <a title="Code Quality: CodeClimate.com" href="https://codeclimate.com/github/azadeh-afzar/OpenMoji-Jekyll-Plugin/maintainability" target="_blank">
+    <img src="https://img.shields.io/codeclimate/maintainability/azadeh-afzar/OpenMoji-Jekyll-Plugin?logo=code-climate&style=flat-square" alt="CodeClimate rating"/>
   </a>
+  <a title="Code Technical Debt: CodeClimate.com" href="https://codeclimate.com/github/azadeh-afzar/OpenMoji-Jekyll-Plugin/maintainability" target="_blank">
+    <img src="https://img.shields.io/codeclimate/tech-debt/azadeh-afzar/OpenMoji-Jekyll-Plugin?logo=code-climate&style=flat-square" alt="CodeClimate technical debt"/>
+  </a>
+  <a title="Code Issues: CodeClimate.com" href="https://codeclimate.com/github/azadeh-afzar/OpenMoji-Jekyll-Plugin/maintainability" target="_blank">
+    <img src="https://img.shields.io/codeclimate/issues/azadeh-afzar/OpenMoji-Jekyll-Plugin?logo=code-climate&style=flat-square" alt="CodeClimate issues"/>
+  </a>
+  
   <br>
+
+  <a title="GitLab: pipeline status" href="https://gitlab.com/Azadeh-Afzar/Web-Development/OpenMoji-Jekyll-Plugin/commits/master" target="_blank">
+    <img src="https://img.shields.io/gitlab/pipeline/Web-Development/OpenMoji-Jekyll-Plugin?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/OpenMoji-Jekyll-Plugin" target="_blank">
+    <img src="https://img.shields.io/codeclimate/coverage/azadeh-afzar/OpenMoji-Jekyll-Plugin?logo=code-climate&style=flat-square" alt="CodeClimate"/>
+  </a>
+  
   <br>
+
+  <a title="OpenMoji Version" href="https://github.com/hfg-gmuend/openmoji/releases">
+    <img src="https://img.shields.io/github/v/release/hfg-gmuend/openmoji?color=red&label=OpenMoji&logo=github&sort=semver&style=flat-square" alt="OpenMoji Version">
+  </a>
+  <a title="Gem Version" href="https://rubygems.org/gems/jekyll-openmoji">
+    <img src="https://img.shields.io/gem/v/jekyll-openmoji?color=red&label=Jekyll%20OpenMoji&logo=rubygems&style=flat-square" alt="Gem Version">
+  </a>
+  <a title="jsDelivr CDN" href="https://www.jsdelivr.com/package/gh/azadeh=afzar/OpenMoji-Jekyll-Plugin">
+    <img src="https://data.jsdelivr.com/v1/package/gh/azadeh=afzar/OpenMoji-Jekyll-Plugin/badge" alt="jsDelivr CDN">
+  </a>
 </p>
 
-> This project is a fork of <a href="https://github.com/jekyll/jeomi">Jemoji</a>. It's also independent from OpenMoji project.
+> If you are viewing this repository on GitHub, this GitHub repository is a mirror of the OpenMoji Jekyll Plugin,
+> the main repository is served on 
+><a href="https://gitlab.com/Azadeh-Afzar/Web-Development/OpenMoji-Jekyll-Plugin">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/jekyll/jeomi">Jemoji</a>. 
+> This project is currently independent from main OpenMoji project.
 
 ### Enjoy a free open source emoji package
-Use more than 3,000 emoji from OpenMoji package for free in your jekyll website.
+Use more than 3,000 emojis from OpenMoji package for free in your jekyll website.
+but remember to credit the OpenMoji project somewhere in your site to comply with
+their license.
 
 ### Connect to any other emoji source
-Use any available emoji package from a CDN or locally served emoji images by adding only 3 lines to your website's config file.
+Use any available emoji package from a CDN or locally served emoji images by adding
+roughly 5 lines to your website's config file.
 
 ## Quick start
 
@@ -69,27 +113,36 @@ you can specify so in your `_config.yml` file:
 
 ```yaml
 emoji:
-  # src key is required .
+  # for other emoji packs providing a src key is required.
   # images will be served from this base address
   # it must be a valid URL, if you don't provide a string to src key
-  # plugin will ignore this settings and uses default settings.
+  # plugin will ignore this settings and uses default settings which
+  # is OpenMoji emoji pack.
   src: "https://www.emojisource.com"
 
   # asset key is optional.
   # it will be appended to the end of src keyword to make a complete URL,
   # if you don't provide the asset value, it will be defaulted to "emoji".
-  asset: "/color/svg"
+  # you can also provide an empty string "" if your source doesn't have any asset path.
+  asset: "/color/png"
+
+  # final path will be  "https://www.emojisource.com/color/svg" and
+  # emoji images will serve from this address.
+  # in case of no asset value, final path would be  "https://www.emojisource.com/color/svg"emoji
 
-# final path will be  "https://www.emojisource.com/color/svg" and
-# emoji images will serve from this address.
-# in case of no asset value, final path would be  "https://www.emojisource.com/color/svg"emoji
+  # MORE CONFIGURATION OPTIONS
+  # all configs below are optional.
 
+  # default emoji image extension is svg (vector file), but if your emoji source
+  # images are in other formats, you can manually override default extension by using below key
+  # and specify your desired extension (png, jpg, jpeg, bmp, etc).
+  extension: png
 
 ```
 
 ## How it works
 
-For all sites emoji images are served from the GitHub.com CDN, with a
+For all sites emoji images are served from a GitHub.com CDN, with a
 base URL of `https://cdn.jsdelivr.net/gh/azadeh-afzar/OpenMoji-Jekyll-Plugin@latest` and
 asset path of `/images/color/svg`, which results in emoji image URLs like
 `https://cdn.jsdelivr.net/gh/azadeh-afzar/OpenMoji-Jekyll-Plugin@latest/images/color/svg/1f604.svg`.
@@ -98,7 +151,8 @@ However you can alter the default path in `_config.yml` to serve from external s
 
 ### Notes
 
-Emoji files names should be unicode strings, for example name of this emoji 😄 image file must be: 1f604
+Emoji files names should be lowercase unicode strings, for example name of this
+emoji 😄 image file must be: 1f604
 
 ## Contribution
 
@@ -110,12 +164,14 @@ 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.
+Visit the [Roadmap](ROADMAP.md) to keep track of which features we are currently
+working on.
 
 ## License
 
 Licensed under the [GPL v3](LICENSE).
 
 ## Attribution
-1. All default emojis designed by [OpenMoji](https://openmoji.org) - the open source emoji and icon project. License: CC BY-SA 4.0
-2. This project is a fork of [Jemoji](https://github.com/jekyll/jemoji).
+1. All default emojis designed by [OpenMoji](https://openmoji.org) - the open source
+emoji and icon project. License: CC BY-SA 4.0
+2. This project is a fork of [Jemoji](https://github.com/jekyll/jemoji). License: MIT

data/ROADMAP.md

@@ -0,0 +1,28 @@
+# OpenMoji Jekyll Plugin v1.0 Roadmap
+
+## Overview
+
+This document outlines our roadmap to delivering Azadeh Afzar - OpenMoji Jekyll Plugin
+v1.0 by Summer 2020.
+
+## Milestones
+
+The Azadeh Afzar - OpenMoji Jekyll Plugin
+v1.0 project is engineered and delivered as a set of 6-week milestones:
+
+Milestone name: Complete configuration set for emojis
+Start date of this Milestone: 2019-11-8
+
+| Feature | Duration |
+| --- | --- |
+| Add custom extension, custom inline css attributes | 3 weeks
+| Test and Bug fixed | 3 weeks |
+
+## Terminal Roadmap / Timeline
+
+Ultimately, we're aiming for OpenMoji Jekyll Plugin v1.0 to be feature-complete by Jan 2020,
+and to declare v1.0 by Jul 2020:
+
+| Milestone end date | Milestone Name | Key Deliverables |
+| --- | --- | --- |
+| 2019-09-9 | Start | Azadeh Afzar forked Jemoji package from GitHub

data/SUPPORT.md

@@ -1 +1,6 @@
-## OpenMoji Support
+## Support Azadeh Afzar
+
+If you liked this work and you want to help Azadeh Afzar, you can become a patron
+at https://www.patreon.com/AzadehAfzar
+
+Thank You!

data/jekyll-openmoji.gemspec

@@ -5,18 +5,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "jekyll-openmoji/version"
 
 Gem::Specification.new do |spec|
-  spec.name        = "jekyll-openmoji"
+  spec.name = "jekyll-openmoji"
   spec.version = Jekyll::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/OpenMoji-Jekyll-Plugin"
-  spec.description = "%q{OpenMoji emoji pack plugin for Jekyll with a powerful configuration options
-                     and support for various emoji image file sources and extensions}"
-  spec.summary     = "OpenMoji emoji plugin for Jekyll"
-  spec.licenses    = "GPL-3.0"
+  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/OpenMoji-Jekyll-Plugin"
+  spec.description = "OpenMoji emoji pack plugin for Jekyll with powerful
+                      configuration options and support for various emoji image file
+                      sources and extensions. in addition to OpenMoji emojis, you can
+                      also configure it to use any emoji source available."
+  spec.summary = "OpenMoji emoji plugin for Jekyll"
+  spec.licenses = "GPL-3.0"
 
-  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(images|script|spec)/!) }
+  spec.files = `git ls-files -z`.split("\x0").reject { |f|
+    f.match(%r!^(images|script|spec)/!)
+  }
   spec.executables = spec.files.grep(%r!^bin/!) { |f| File.basename(f) }
   spec.test_files = spec.files.grep(%r!^test/!)
   spec.require_paths = ["lib"]

data/lib/jekyll-openmoji/plugin.rb

@@ -7,6 +7,7 @@ require "html/pipeline/negarmoji-pipeline"
 
 module Jekyll
   class Emoji
+    # Extend negarmoji emoji class.
     OPENMOJI_ASSET_HOST_URL = "https://cdn.jsdelivr.net/gh/azadeh-afzar/OpenMoji-Jekyll-Plugin@latest"
     ASSET_PATH = "/images/color/svg"
     DEFAULT_DIR = "/emoji"
@@ -17,8 +18,9 @@ module Jekyll
 
     class << self
       def emojify(doc)
-        return unless doc.output =~ HTML::Pipeline::NegarMojiHtmlPipeline::NegarehEmojiFilter
-                                        .emoji_pattern
+        return unless
+            doc.output =~ HTML::Pipeline::NegarMojiHtmlPipeline::NegarehEmojiFilter
+                            .emoji_pattern
 
         doc.output = if doc.output.include? BODY_START_TAG
                        replace_document_body(doc)
@@ -27,14 +29,16 @@ module Jekyll
                        asset_path = emoji_asset_path(doc.site.config)
                        file_extension = emoji_extension(doc.site.config)
                        filter_with_emoji(src_root, asset_path, file_extension)
-                           .call(doc.output)[:output].to_s
+                         .call(doc.output)[:output].to_s
                      end
       end
 
       # Public: Create or fetch the filter for the given {{src_root}} asset root.
       #
       # src_root - the asset root URL (e.g. https://cdn.jsdelivr.net/gh/azadeh-afzar/OpenMoji-Jekyll-Plugin@latest)
-      # asset_path - the asset sub-path of src (e.g. "/images/color/svg") [default = "emoji"]
+      # asset_path - the asset sub-path of src (e.g. "/images/color/svg")
+      # [default = "emoji"]
+      #
       # extension - the extension of emoji image files, [default = svg ]
       #
       # examples of _config.yml:
@@ -58,8 +62,8 @@ module Jekyll
                 NegarMojiHtmlPipeline::NegarehEmojiFilter],
                                                  :asset_root => src_root,
                                                  :asset_path => asset_path,
-                                                 :extension => file_extension,
-                                                 :img_attrs => {:align => nil})
+                                                 :extension  => file_extension,
+                                                 :img_attrs  => { :align => nil })
       end
 
       # Public: Filters hash where the key is the asset root source.
@@ -131,7 +135,7 @@ module Jekyll
       # Returns true if the doc is written & is HTML.
       def emojiable?(doc)
         (doc.is_a?(Jekyll::Page) || doc.write?) &&
-            doc.output_ext == ".html" || (doc.permalink&.end_with?("/"))
+          doc.output_ext == ".html" || (doc.permalink&.end_with?("/"))
       end
 
       private
@@ -153,7 +157,7 @@ module Jekyll
         head, opener, tail = doc.output.partition(OPENING_BODY_TAG_REGEX)
         body_content, *rest = tail.partition("</body>")
         processed_markup = filter_with_emoji(src_root, asset_path, file_extension)
-                               .call(body_content)[:output].to_s
+                             .call(body_content)[:output].to_s
         String.new(head) << opener << processed_markup << rest.join
       end
     end

data/lib/jekyll-openmoji/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   class Emoji
-    VERSION = "0.0.3"
+    VERSION = "0.0.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-openmoji
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Mohammad Mahdi Baghbani Pourvahid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-01 00:00:00.000000000 Z
+date: 2019-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-pipeline
@@ -143,22 +143,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.17.0
 description: |-
-  %q{OpenMoji emoji pack plugin for Jekyll with a powerful configuration options
-                       and support for various emoji image file sources and extensions}
+  OpenMoji emoji pack plugin for Jekyll with powerful
+                        configuration options and support for various emoji image file
+                        sources and extensions. in addition to OpenMoji emojis, you can
+                        also configure it to use any emoji source available.
 email: MahdiBaghbani@protonmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".gitlab/issue_templates/Default.md"
+- ".gitlab/merge_request_templates/Default.md"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- CREDITS
 - Gemfile
 - LICENSE
 - README.md

data/.travis.yml

@@ -1,35 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - &latest_ruby 2.6
-  - 2.4
-  - 2.3
-env:
-  - JEKYLL_VERSION="~> 3.8"
-matrix:
-  include:
-    - # GitHub Pages
-      rvm: 2.5.3
-      env: GH_PAGES=true
-    - rvm: *latest_ruby
-      env: JEKYLL_VERSION=">= 4.0.0.pre.alpha1"
-
-before_install:
-  - gem update --system
-  - gem install bundler
-before_script: bundle update
-script: script/ci-test
-branches:
-  only:
-    - master
-notifications:
-  irc:
-    on_success: change
-    on_failure: change
-    channels:
-    - irc.freenode.org#jekyll
-    template:
-    - '%{repository}#%{build_number} (%{branch}) %{message} %{build_url}'
-  email:
-    on_success: never
-    on_failure: never