jekyll-openmoji 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b5c797f4f403a5d3e24703b151007f2da0bf444004f99890c76b94592a0c7a6
-  data.tar.gz: 4241d030fca03cd2497c71cafb5aa17598907451f93670110d80f76b68d926ad
+  metadata.gz: ec6edaf2e003a2987d94f07283a7a01ece82639e566899068bdcff4d68b309a1
+  data.tar.gz: e8756ba6732fdc13dc3bc9563d53042c362e0f58b4f65ddd19c089fd529e7642
 SHA512:
-  metadata.gz: a22bc4b22eb6e6eaa24c10b1e0ed74a65ea206fd64d84c0aceaeccf1da02bc1efe78f38751c128c1b74d044ad7936d49e38ed9b831a3f5031d1b3c88989ecd2e
-  data.tar.gz: 5695c62086f521489c47e6bf3589e1a751cd4b8892571aab76d676775b6703a17b1522cc7e89fbd5803e394e3c6694736bf2eaf17bcca8690efb5d9c14b04f44
+  metadata.gz: b64b5cf5bc3d1d52a03e6fdd38844da95ebd22539b094bee5c2cfa889ddb21e3f2afee1c2687e496b30e9f4c65e0c9da4589d48da1c9d6fde0169a5a37a29a4f
+  data.tar.gz: 5ab34c9dfa9b46da6f799bd3769526a917a0aaf940b95aa3e5bdfc0c2d00f411580f507de6b72874bb3b165bf0fc12f438051dd592210a0b28b1d820098c9492

data/.codeclimate.yml

@@ -46,8 +46,6 @@ plugins:
   config:
     allow_affero_copyleft: true
     allow_strong_copyleft: true
- rubocop:
-   enabled: true
 
 exclude_patterns:
 - "config/"

data/.gitlab-ci.yml

@@ -11,134 +11,125 @@ default:
     paths:
       - vendor/
 
-# job for testing package against ruby version 2.6
+# job for testing package against default ruby version
 # on master branch and send test coverage result to
 # codeclimate.
-test main branch:
+test master branch defaut:
   stage: test
   before_script:
-    # setup rvm.
+    # setup rbenv.
     - source ~/.bash_profile
-    # use ruby version 2.6.
-    - rvm use 2.6
-    # upgrade bundler to latest version.
-    - gem install bundler
+    # use default ruby version.
+    - rbenv global 3.0.0
     # install dependency gems.
-    - bundle install --path vendor
+    - bundle config set path 'vendor'
+    - bundle install
     # run codeclimate test reporter agent.
     - cc-test-reporter before-build
   # run tests.
   script:
-    - script/test.sh
+    - cd script && ./test.sh
   # send test coverage result to codeclimate.
   after_script:
     - cc-test-reporter after-build --coverage-input-type simplecov
   only:
     - master
 
-# job for testing package on other branches than master
-# and merge requests against 2.6 version.
-test ruby 2.6:
+# job for testing package on mon master branch
+# and merge requests against other ruby versions.
+test master branch ruby 2.7.2:
   stage: test
   before_script:
-    # setup rvm.
+    # setup rbenv.
     - source ~/.bash_profile
-    # use ruby version 2.6.
-    - rvm use 2.6
-    # upgrade bundler to latest version.
-    - gem install bundler
+    # use custom ruby version.
+    - rbenv global 2.7.2
     # install dependency gems.
-    - bundle install --path vendor
+    - bundle config set path 'vendor'
+    - bundle install
   # run tests.
   script:
-    - script/test.sh
+    - cd script && ./test.sh
   only:
-    - branches
-    - merge_requests
-  except:
     - master
 
-test ruby 2.5:
-  stage: test
-  before_script:
-    # setup rvm.
-    - source ~/.bash_profile
-    # use ruby version 2.5.
-    - rvm use 2.5
-    # upgrade bundler to latest version.
-    - gem install bundler
-    # install dependency gems.
-    - bundle install --path vendor
-  # run tests.
-  script:
-    - script/test.sh
-  except:
-    - tags
-
-test ruby 2.4:
+# job for testing package on other branches than master
+# and merge requests against default version.
+test branch ruby default:
   stage: test
   before_script:
-    # setup rvm.
+    # setup rbenv.
     - source ~/.bash_profile
-    # use ruby version 2.4.
-    - rvm use 2.4
-    # upgrade bundler to latest version.
-    - gem install bundler
+    # use default ruby version.
+    - rbenv global 3.0.0
     # install dependency gems.
-    - bundle install --path vendor
+    - bundle config set path 'vendor'
+    - bundle install
   # run tests.
   script:
-    - script/test.sh
+    - cd script && ./test.sh
+  only:
+    - branches
+    - merge_requests
   except:
-    - tags
+    - master
 
-test ruby 2.3:
+# job for testing package on other branches than master
+# and merge requests against other ruby versions.
+test branch ruby 2.7.2:
   stage: test
   before_script:
-    # setup rvm.
+    # setup rbenv.
     - source ~/.bash_profile
-    # use ruby version 2.3.
-    - rvm use 2.3
-    # upgrade bundler to latest version.
-    - gem install bundler
+    # use custom ruby version.
+    - rbenv global 2.7.2
     # install dependency gems.
-    - bundle install --path vendor
+    - bundle config set path 'vendor'
+    - bundle install
   # run tests.
   script:
-    - script/test.sh
+    - cd script && ./test.sh
+  only:
+    - branches
+    - merge_requests
   except:
-    - tags
+    - master
 
 # release a preview blog for master branch with gitlab pages.
 pages:
   stage: deploy
-  script:
-    # setup rvm.
+  before_script:
+    # setup rbenv.
     - source ~/.bash_profile
-    # use ruby version 2.6.
-    - rvm use 2.6
+    # use ruby version 3.0.0 .
+    - rbenv global 3.0.0
+    # delete and recreate directory.
+    - rm --force --recursive public
+    - mkdir public
     # go to blog folder.
     - cd doc/blog
-    # upgrade bundler to latest version.
-    - gem install bundler
-    # install dependencies.
-    - bundle install --path vendor
+    # install dependency gems.
+    - bundle config set path 'vendor'
+    - bundle install
+  script:
     # generate site with jekyll.
-    - bundle exec jekyll build --trace --destination ../../public
+    - bundle exec jekyll build --trace --config ./_config.yml --destination ../../public
   artifacts:
     paths:
       - public
+    expire_in: 7 days
   only:
-    - master
+    - tags
+  when: manual
 
 # deploy gems to rubygems.org whenever a tag is released.
 release to rubygems:
   stage: release
   script:
-    # setup rvm.
+    # setup rbenv.
     - source ~/.bash_profile
-    # use ruby version 2.6.
-    - rvm use 2.6
+    # use default ruby version.
+    - rbenv global 3.0.0
     # create rubygems credential file for auto login.
     - script/ci_rubygems.sh
     # extract tag from git log and strip "v".

data/.rubocop.yml

@@ -1,32 +1,34 @@
 inherit_from: .rubocop_todo.yml
 
-require: rubocop-jekyll
-
-inherit_gem:
-  rubocop-jekyll: .rubocop.yml
-
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.7.2
+  NewCops: disable
+  SuggestExtensions: false
   Exclude:
     - vendor/**/*
-    - doc/**/*
+    - test/**/*
+    - db/**/*
+    - Rakefile
+    - ./*.gemspec
 
-Layout/AlignHash:
+Layout/HashAlignment:
   EnforcedHashRocketStyle: table
 
+Layout/LineLength:
+  Max: 85
+
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented_relative_to_receiver
   IndentationWidth: 2
 
 Metrics/AbcSize:
   Max: 30
+  Exclude:
+    - "lib/jekyll_openmoji/plugin.rb"
 
 Metrics/BlockLength:
   Max: 50
 
-Metrics/LineLength:
-  Max: 85
-
 Metrics/MethodLength:
   Max: 25
 

data/.rubocop_todo.yml

@@ -4,22 +4,4 @@
 # 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.
-
-# Offense count: 1
-# Configuration parameters: CountComments, Max, ExcludedMethods.
-# ExcludedMethods: refine
-Metrics/BlockLength:
-  Exclude:
-    - "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"
-
-Metrics/AbcSize:
-  Exclude:
-    - "lib/jekyll_openmoji/plugin.rb"
+# versions of RuboCop, may require this file to be generated again.

data/README.md

@@ -56,7 +56,7 @@
   <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">
+    <img src="https://img.shields.io/static/v1?label=OpenMoji&message=v13.1.0&logo=github&color=red&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">
@@ -72,11 +72,12 @@
 >discussions, issue tracking and merge requests take place in GitLab.  
 
 > This project is a fork of <a href="https://github.com/jekyll/jemoji">Jemoji</a>. 
-> This project is currently independent from main OpenMoji project.
+
+> This project is independent from <a href="https://openmoji.org">OpenMoji</a> project.
 
 ### Enjoy a free open source emoji package
 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
+but remember to ***credit the OpenMoji project*** somewhere in your site to comply with
 their license.
 
 ### Connect to any other emoji source
@@ -85,7 +86,9 @@ roughly 5 lines to your website's config file.
 
 ## Preview
 
-see a preview of how OpenMoji emojis looks like with this plugin at this [**page**][preview].
+[![screenshot of OpenMoji Emoji preview blog](/pages_preview.webp)](preview)
+
+see a preview of OpenMoji emojis with their aliases.
 
 ## Quick start
 
@@ -102,16 +105,22 @@ plugins:
   - jekyll-openmoji
 ```
 
-### 3. Next steps
+### 3. Open terminal and use bundler to install this new gem.
+
+```bash
+bundle install
+```
+
+### 4. Next steps
 
 In any page or post, use emoji as you would normally, e.g.
 
 ```markdown
-I give this plugin two :+1:!
+I give this plugin two :thumbs_up:!
 ```
 
-with this plugin, Jekyll will turn this markdown code `:+1:` into this image:
-<img class="emoji" title="+1" alt="👍" src="https://cdn.jsdelivr.net/gh/azadeh-afzar/OpenMoji-Jekyll-Plugin@latest/images/color/svg/1f44d.svg" width="30em" height="30em" margin="0.5em"> .
+with this plugin, Jekyll will turn this markdown code (aka emoji alias) `:thumbs_up:` into this image:
+<img class="emoji" title="thumbs_up" alt="👍️" src="https://cdn.jsdelivr.net/gh/azadeh-afzar/OpenMoji-Jekyll-Plugin@latest/images/color/svg/1f44d-fe0f.svg" width="30em" height="30em" margin="0.5em"> .
 
 to see all codes and their emoji images, see preview [**page**][preview].
 
@@ -168,8 +177,10 @@ However you can alter the default path in `_config.yml` to serve from external s
 
 ### Notes
 
-Emoji files names should be lowercase unicode strings, for example name of this
-emoji 😄 image file must be: 1f604
+* Your external image source must be compatible with this plugin in order to show emojis correctly, 
+for example: 
+  * emoji files names should be lowercase unicode strings, so that this
+emoji 😄 image file must be: 1f604 followed by its extension (here png), final file name would be 1f604.png
 
 ## Contribution
 

data/jekyll-openmoji.gemspec

@@ -19,22 +19,22 @@ Gem::Specification.new do |spec|
   spec.licenses = "GPL-3.0"
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f|
-    f.match(%r!^(images|script|spec)/!)
+    f.match(%r!^(doc|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"]
 
-  spec.required_ruby_version = ">= 2.3.0"
+  spec.required_ruby_version = ">= 2.7.2"
 
-  spec.add_dependency "html-pipeline", "~> 2.12"
-  spec.add_dependency "html-pipeline-negarmoji", "~> 0.1.1"
+  spec.add_dependency "html-pipeline", "~> 2.14"
+  spec.add_dependency "html-pipeline-negarmoji", "~> 0.1.6"
   spec.add_dependency "jekyll", ">= 3.0", "< 5.0"
-  spec.add_dependency "negarmoji", "~> 0.1.4"
+  spec.add_dependency "negarmoji", "~> 0.1.10"
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop-jekyll", "~> 0.10"
-  spec.add_development_dependency "simplecov", "~> 0.17.0"
+  spec.add_development_dependency "bundler", "~> 2.2.3"
+  spec.add_development_dependency "rake", "~> 13.0.6"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "rubocop", "~> 1.18.3"
+  spec.add_development_dependency "simplecov", "~> 0.21.2"
 end

data/lib/jekyll-openmoji/plugin.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "jekyll"
-require "negarmoji"
 require "html/pipeline"
 require "html/pipeline/negarmoji-pipeline"
 

data/lib/jekyll-openmoji/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   class Emoji
-    VERSION = "0.1.1"
+    VERSION = "0.1.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-openmoji
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Mohammad Mahdi Baghbani Pourvahid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-27 00:00:00.000000000 Z
+date: 2021-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-pipeline
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: html-pipeline-negarmoji
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.6
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -64,84 +64,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.10
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.2.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: rubocop-jekyll
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 1.18.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 1.18.3
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.21.2
 description: |-
   OpenMoji emoji pack plugin for Jekyll with powerful
                         configuration options and support for various emoji image file
@@ -170,37 +170,12 @@ files:
 - ROADMAP.md
 - Rakefile
 - SUPPORT.md
-- doc/blog/.bundle/config
-- doc/blog/404.html
-- doc/blog/Gemfile
-- doc/blog/_config.yml
-- doc/blog/_includes/disqus_comments.html
-- doc/blog/_includes/footer.html
-- doc/blog/_includes/google-analytics.html
-- doc/blog/_includes/head.html
-- doc/blog/_includes/header.html
-- doc/blog/_includes/social.html
-- doc/blog/_layouts/default.html
-- doc/blog/_layouts/home.html
-- doc/blog/_layouts/page.html
-- doc/blog/_layouts/post.html
-- doc/blog/_sass/minima-classic.scss
-- doc/blog/_sass/minima-solarized-dark.scss
-- doc/blog/_sass/minima-solarized.scss
-- doc/blog/_sass/minima/_base.scss
-- doc/blog/_sass/minima/_layout.scss
-- doc/blog/_sass/minima/custom-styles.scss
-- doc/blog/_sass/minima/custom-variables.scss
-- doc/blog/_sass/minima/initialize.scss
-- doc/blog/assets/css/style.scss
-- doc/blog/assets/minima-social-icons.svg
-- doc/blog/favicon.ico
-- doc/blog/index.md
 - jekyll-openmoji.gemspec
 - lib/jekyll-openmoji.rb
 - lib/jekyll-openmoji/plugin.rb
 - lib/jekyll-openmoji/version.rb
 - logo.svg
+- pages_preview.webp
 homepage: https://gitlab.com/Azadeh-Afzar/Web-Development/OpenMoji-Jekyll-Plugin
 licenses:
 - GPL-3.0
@@ -213,14 +188,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: OpenMoji emoji plugin for Jekyll