class Jekyll::Emoji
Constants
- ASSET_PATH
- BODY_START_TAG
- GITHUB_DOT_COM_ASSET_HOST_URL
- OPENING_BODY_TAG_REGEX
Public Class Methods
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 assets-cdn.github.com.
# File lib/jemoji.rb, line 52 def emoji_src(config = {}) if config.key?("emoji") && config["emoji"].key?("src") config["emoji"]["src"] else default_asset_root end end
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.
# File lib/jemoji.rb, line 65 def emojiable?(doc) (doc.is_a?(Jekyll::Page) || doc.write?) && doc.output_ext == ".html" || doc.permalink&.end_with?("/") end
# File lib/jemoji.rb, line 14 def emojify(doc) return unless doc.output&.match?(HTML::Pipeline::EmojiFilter.emoji_pattern) doc.output = if doc.output.include? BODY_START_TAG replace_document_body(doc) else src = emoji_src(doc.site.config) filter_with_emoji(src).call(doc.output)[:output].to_s end end
Public: Create or fetch the filter for the given {{src}} asset root.
src - the asset root URL (e.g. github.githubassets.com/images/icons/)
Returns an HTML::Pipeline instance for the given asset root.
# File lib/jemoji.rb, line 30 def filter_with_emoji(src) filters[src] ||= HTML::Pipeline.new([ HTML::Pipeline::EmojiFilter, ], :asset_root => src, :img_attrs => { :align => nil }) end
Public: Filters hash where the key is the asset root source. Effectively a cache.
# File lib/jemoji.rb, line 38 def filters @filters ||= {} end
Private Class Methods
# File lib/jemoji.rb, line 72 def default_asset_root if !ENV["ASSET_HOST_URL"].to_s.empty? # Ensure that any trailing "/" is trimmed asset_host_url = ENV["ASSET_HOST_URL"].chomp("/") "#{asset_host_url}#{ASSET_PATH}" else "#{GITHUB_DOT_COM_ASSET_HOST_URL}#{ASSET_PATH}" end end
# File lib/jemoji.rb, line 82 def replace_document_body(doc) src = emoji_src(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).call(body_content)[:output].to_s String.new(head) << opener << processed_markup << rest.join end