jekyll-openmoji 0.1.0 → 0.1.1

data/jekyll-openmoji.gemspec

@@ -27,10 +27,10 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3.0"
 
-  spec.add_dependency "html-pipeline", "~> 2.2"
-  spec.add_dependency "html-pipeline-negarmoji", "~> 0.1.0"
+  spec.add_dependency "html-pipeline", "~> 2.12"
+  spec.add_dependency "html-pipeline-negarmoji", "~> 0.1.1"
   spec.add_dependency "jekyll", ">= 3.0", "< 5.0"
-  spec.add_dependency "negarmoji", "~> 0.1.3"
+  spec.add_dependency "negarmoji", "~> 0.1.4"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"

data/lib/jekyll-openmoji/plugin.rb

@@ -8,11 +8,18 @@ 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 configuration.
+    DEFAULT_HOST_URL = "https://cdn.jsdelivr.net/gh/azadeh-afzar/OpenMoji-Jekyll-Plugin@latest"
+    DEFAULT_ASSET_PATH = "/images/color/svg"
     DEFAULT_DIR = "/emoji"
-    FILE_NAME = "/:file_name"
     DEFAULT_EXTENSION = "svg"
+    DEFAULT_IMG_ATTRS = { "class"  => "emoji",
+                          "height" => "20",
+                          "width"  => "20",
+                          "align"  => nil, }
+    # Regex values.
+    FILE_NAME = "/:file_name"
     BODY_START_TAG = "<body"
     OPENING_BODY_TAG_REGEX = %r!<body(.*?)>\s*!m.freeze
 
@@ -28,18 +35,21 @@ module Jekyll
                        src_root = emoji_src_root(doc.site.config)
                        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
+                       img_attrs = emoji_attributes(doc.site.config)
+                       filter_with_emoji(src_root, asset_path, file_extension,
+                                         img_attrs).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"]
+      # :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"].
       #
-      # extension - the extension of emoji image files, [default = svg ]
+      # :extension - the extension of emoji image files, [default = svg ].
+      #
+      # :img_attrs - the custom css properties for emoji <img> tag.
       #
       # examples of _config.yml:
       #   1. user provided all URLs:
@@ -57,13 +67,13 @@ module Jekyll
       #   emoji files will serve from https://cdn.jsdelivr.net/gh/azadeh-afzar/OpenMoji-Jekyll-Plugin@latest/images/color/svg
       #
       # Returns an HTML::Pipeline instance for the given asset root.
-      def filter_with_emoji(src_root, asset_path, file_extension)
+      def filter_with_emoji(src_root, asset_path, file_extension, img_attrs)
         filters[src_root] ||= HTML::Pipeline.new([HTML::Pipeline::
                 NegarMojiHtmlPipeline::NegarehEmojiFilter],
                                                  :asset_root => src_root,
                                                  :asset_path => asset_path,
                                                  :extension  => file_extension,
-                                                 :img_attrs  => { :align => nil })
+                                                 :img_attrs  => img_attrs)
       end
 
       # Public: Filters hash where the key is the asset root source.
@@ -75,9 +85,9 @@ module Jekyll
       # Public: Calculate the asset root source for the given config.
       # The custom emoji asset root can be defined in the config as
       # emoji.src, and must be a valid URL (i.e. it must include a
-      # protocol and valid domain)
+      # protocol and valid domain).
       #
-      # config - the hash-like configuration of the document's site
+      # config - the hash-like configuration of the document's site.
       #
       # Returns a full URL to use as the asset root URL. Defaults to the root
       # URL for assets provided by an ASSET_HOST_URL environment variable,
@@ -94,9 +104,9 @@ module Jekyll
       # The custom emoji asset root can be defined in the config as
       # emoji.asset.
       #
-      # If emoji.asset isn't defined, its value will explicitly set to "emoji"
+      # If emoji.asset isn't defined, its value will explicitly set to "emoji".
       #
-      # config - the hash-like configuration of the document's site
+      # config - the hash-like configuration of the document's site.
       #
       # Returns a string to use as the asset path. Defaults to the ASSET_PATH.
       def emoji_asset_path(config = {})
@@ -107,7 +117,7 @@ module Jekyll
             "#{DEFAULT_DIR}#{FILE_NAME}"
           end
         else
-          "#{ASSET_PATH}#{FILE_NAME}"
+          "#{DEFAULT_ASSET_PATH}#{FILE_NAME}"
         end
       end
 
@@ -115,9 +125,9 @@ module Jekyll
       # The custom emoji extension can be defined in the config as
       # emoji.extension.
       #
-      # If emoji.extension isn't defined, its value will explicitly set to "svg"
+      # If emoji.extension isn't defined, its value will explicitly set to "svg".
       #
-      # config - the hash-like configuration of the document's site
+      # config - the hash-like configuration of the document's site.
       #
       # Returns a string to use as the extension. Defaults to the DEFAULT_EXTENSION.
       def emoji_extension(config = {})
@@ -128,6 +138,36 @@ module Jekyll
         end
       end
 
+      # Public: return emoji <img> tag attributes.
+      # The custom emoji css attributes can be defined with emoji.img_attrs.
+      #
+      # for example:
+      #
+      # emoji:
+      #   img_attrs:
+      #     class: "openmoji"
+      #     height: 30
+      #
+      # this will override default emoji css attributes.
+      #
+      # If emoji.img_attrs isn't defined, its value will explicitly set to
+      # DEFAULT_IMG_ATTRS.
+      #
+      # config - the hash-like configuration of the document's site
+      #
+      # Returns a hash to use as the attributes. Defaults to the DEFAULT_IMG_ATTRS.
+      def emoji_attributes(config = {})
+        if config.key?("emoji") && config["emoji"].key?("img_attrs")
+          # merge default values with custom values and then
+          # convert hash keys to symbols.
+          DEFAULT_IMG_ATTRS.merge!(config["emoji"]["img_attrs"])
+            .map { |key, value| [key.to_sym, value] }.to_h
+        else
+          # convert hash keys to symbols.
+          DEFAULT_IMG_ATTRS.map { |key, value| [key.to_sym, value] }.to_h
+        end
+      end
+
       # Public: Defines the conditions for a document to be emojiable.
       #
       # doc - the Jekyll::Document or Jekyll::Page
@@ -146,7 +186,7 @@ module Jekyll
           asset_host_url = ENV["ASSET_HOST_URL"].chomp("/")
           asset_host_url.to_s
         else
-          OPENMOJI_ASSET_HOST_URL.to_s
+          DEFAULT_HOST_URL.to_s
         end
       end
 
@@ -154,10 +194,12 @@ module Jekyll
         src_root = emoji_src_root(doc.site.config)
         asset_path = emoji_asset_path(doc.site.config)
         file_extension = emoji_extension(doc.site.config)
+        img_attrs = emoji_attributes(doc.site.config)
         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
+        processed_markup = filter_with_emoji(src_root, asset_path, file_extension,
+                                             img_attrs).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.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-openmoji
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mohammad Mahdi Baghbani Pourvahid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-17 00:00:00.000000000 Z
+date: 2019-12-27 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.2'
+        version: '2.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: html-pipeline-negarmoji
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -170,6 +170,32 @@ 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