Class: HTML::Pipeline::EmojiFilter

Inherits:
Filter
  • Object
show all
Defined in:
lib/html/pipeline/emoji_filter.rb

Overview

HTML filter that replaces :emoji: with images.

Context:

:asset_root (required) - base url to link to emoji sprite
:asset_path (optional) - url path to link to emoji sprite. :file_name can be used as a placeholder for the sprite file name. If no asset_path is set "emoji/:file_name" is used.
:ignored_ancestor_tags (optional) - Tags to stop the emojification. Node has matched ancestor HTML tags will not be emojified. Default to pre, code, and tt tags. Extra tags please pass in the form of array, e.g., %w(blockquote summary).
:img_attrs (optional) - Attributes for generated img tag. E.g. Pass { "draggble" => true, "height" => nil } to set draggable attribute to "true" and clear height attribute of generated img tag.

Constant Summary collapse

DEFAULT_IGNORED_ANCESTOR_TAGS = 
%w[pre code tt].freeze

Instance Attribute Summary

Attributes inherited from Filter

#context, #result

Instance Method Summary collapse

Methods inherited from Filter

#base_url, call, #current_user, #doc, #has_ancestor?, #html, #initialize, #needs, #parse_html, #repository, to_document, to_html

Constructor Details

This class inherits a constructor from HTML::Pipeline::Filter

Instance Method Details

#asset_path(name) ⇒ Object

The url path to link emoji sprites

:file_name can be used in the asset_path as a placeholder for the sprite file name. If no asset_path is set in the context “emoji/:file_name” is used. Returns the context’s asset_path or the default path if no context asset_path is given.



59
60
61
62
63
64
65
 
# File 'lib/html/pipeline/emoji_filter.rb', line 59

def asset_path(name)
  if context[:asset_path]
    context[:asset_path].gsub(':file_name', emoji_filename(name))
  else
    File.join('emoji', emoji_filename(name))
  end
end

#asset_root ⇒ Object

The base url to link emoji sprites

Raises ArgumentError if context option has not been provided. Returns the context’s asset_root.



51
52
53
 
# File 'lib/html/pipeline/emoji_filter.rb', line 51

def asset_root
  context[:asset_root]
end

#call ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/html/pipeline/emoji_filter.rb', line 18

def call
  doc.search('.//text()').each do |node|
    content = node.text
    next unless content.include?(':')
    next if has_ancestor?(node, ignored_ancestor_tags)
    html = emoji_image_filter(content)
    next if html == content
    node.replace(html)
  end
  doc
end

#emoji_image_filter(text) ⇒ Object

Replace :emoji: with corresponding images.

text - String text to replace :emoji: in.

Returns a String with :emoji: replaced with images.



41
42
43
44
45
 
# File 'lib/html/pipeline/emoji_filter.rb', line 41

def emoji_image_filter(text)
  text.gsub(emoji_pattern) do |_match|
    emoji_image_tag(Regexp.last_match(1))
  end
end

#validate ⇒ Object

Implementation of validate hook. Errors should raise exceptions or use an existing validator.



32
33
34
 
# File 'lib/html/pipeline/emoji_filter.rb', line 32

def validate
  needs :asset_root
end