Class: Jekyll::Emoji

Inherits:
Object
  • Object
show all
Defined in:
lib/jekyll-openmoji/plugin.rb,
lib/jekyll-openmoji/version.rb

Constant Summary collapse

DEFAULT_HOST_URL =

Default configuration.

"https://cdn.jsdelivr.net/gh/azadeh-afzar/OpenMoji-Jekyll-Plugin@latest"
DEFAULT_ASSET_PATH = 
"/images/color/svg"
DEFAULT_DIR = 
"/emoji"
DEFAULT_EXTENSION = 
"svg"
DEFAULT_IMG_ATTRS = 
{ "class"  => "emoji",
"height" => "20",
"width"  => "20",
"align"  => nil, }
FILE_NAME =

Regex values.

"/:file_name"
BODY_START_TAG = 
"<body"
OPENING_BODY_TAG_REGEX = 
%r!<body(.*?)>\s*!m.freeze
VERSION = 
"0.1.3"

Class Method Summary collapse

Class Method Details

.emoji_asset_path(config = {}) ⇒ Object

Public: Calculate the asset root source for the given config. 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”.

config - the hash-like configuration of the document’s site.

Returns a string to use as the asset path. Defaults to the ASSET_PATH.



112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/jekyll-openmoji/plugin.rb', line 112

def emoji_asset_path(config = {})
  if config.key?("emoji") && config["emoji"].key?("src")
    if config["emoji"].key?("asset")
      config["emoji"]["asset"].chomp("/") + FILE_NAME.to_s
    else
      "#{DEFAULT_DIR}#{FILE_NAME}"
    end
  else
    "#{DEFAULT_ASSET_PATH}#{FILE_NAME}"
  end
end

.emoji_attributes(config = {}) ⇒ Object

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.



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/jekyll-openmoji/plugin.rb', line 159

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

.emoji_extension(config = {}) ⇒ Object

Public: return extension for emoji files. 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”.

config - the hash-like configuration of the document’s site.

Returns a string to use as the extension. Defaults to the DEFAULT_EXTENSION.



133
134
135
136
137
138
139
 
# File 'lib/jekyll-openmoji/plugin.rb', line 133

def emoji_extension(config = {})
  if config.key?("emoji") && config["emoji"].key?("extension")
    config["emoji"]["extension"]
  else
    DEFAULT_EXTENSION.to_s
  end
end

.emoji_src_root(config = {}) ⇒ Object

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).

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, otherwise the root URL for emoji assets at cdn.jsdelivr.net/gh/azadeh-afzar/OpenMoji-Jekyll-Plugin@latest.



95
96
97
98
99
100
101
 
# File 'lib/jekyll-openmoji/plugin.rb', line 95

def emoji_src_root(config = {})
  if config.key?("emoji") && config["emoji"].key?("src")
    config["emoji"]["src"]
  else
    default_asset_root
  end
end

.emojiable?(doc) ⇒ Boolean

Public: Defines the conditions for a document to be emojiable.

doc - the Jekyll::Document or Jekyll::Page

Returns true if the doc is written & is HTML.

Returns:

  • (Boolean) 


176
177
178
179
 
# File 'lib/jekyll-openmoji/plugin.rb', line 176

def emojiable?(doc)
  (doc.is_a?(Jekyll::Page) || doc.write?) &&
    doc.output_ext == ".html" || (doc.permalink&.end_with?("/"))
end

.emojify(doc) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/jekyll-openmoji/plugin.rb', line 27

def emojify(doc)
  return unless
      doc.output =~ HTML::Pipeline::NegarMojiHtmlPipeline::NegarehEmojiFilter
                      .emoji_pattern

  doc.output = if doc.output.include? BODY_START_TAG
                 replace_document_body(doc)
               else
                 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)
                 filter_with_emoji(src_root, asset_path, file_extension,
                                   img_attrs).call(doc.output)[:output].to_s
               end
end

.filter_with_emoji(src_root, asset_path, file_extension, img_attrs) ⇒ Object

Public: Create or fetch the filter for the given {src_root} asset root.

:src_root - the asset root URL (e.g. 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 ].

:img_attrs - the custom css properties for emoji <img> tag.

examples of _config.yml:

1. user provided all URLs:
    emoji:
        src: https://example.com/asset
        asset: /images/png
emoji files will serve from https://example.com/asset/images/png

2. user provided just src:
    emoji:
        src: https://example.com/asset
emoji files will serve from https://example.com/emoji

3. user provided nothing:
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.



70
71
72
73
74
75
76
77
 
# File 'lib/jekyll-openmoji/plugin.rb', line 70

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  => img_attrs)
end

.filters ⇒ Object

Public: Filters hash where the key is the asset root source. Effectively a cache.



81
82
83
 
# File 'lib/jekyll-openmoji/plugin.rb', line 81

def filters
  @filters ||= {}
end