jekyll-emoji 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f8360f82a349bbefc1fbdced38dcd5119b5fa6d
-  data.tar.gz: 7f90d282ef03e5271f06af0dbeadb278bb401119
+  metadata.gz: 0de12d4ecb105bcf26e774bde5c75687cbee55a1
+  data.tar.gz: 23ea050f1423dedf1507d81750835f0203d274d1
 SHA512:
-  metadata.gz: 661bf10d3f3e0674f555a1dada7b5bee5bbe6a9acaeb5f9ff8d5326835654971c12fa314e56b35998732ed0ab26e1cadd26ab9b536672fb43b4f44b81f4178ee
-  data.tar.gz: a97db0b2cb09e777fca636f76bc43e8158e1596937f35cb95a36153fbced2497ca40e624da815ff262756084b7350789c742cd31e269e7e63651252b0788b143
+  metadata.gz: c890340261e610a52aa13b0fb8bbc9aa0a8c1718e0596ffc4baa301c25676027f67f7f9bbb3d576bbc33480cedd39da6663ba3ded9a43257c229e2d347344284
+  data.tar.gz: 03a6b8eecb4329048c01ecd4d749924aaeca19230963ca923c83185a6e2600bb29ebac0f77524796f125a448bc71d8e8d04b7868821640a9f17f990ef91dc771

data/README.md

@@ -21,7 +21,6 @@ Or install it yourself as:
 Add the following configuration to your `_config.yml`:
 
 ~~~yaml
-
 gems: ['jekyll-emoji']
 emoji:
   format: emojione-svg # default html
@@ -31,13 +30,21 @@ emoji:
 
 The following formats are supported: `html`, `unicode`, `emojione-png`, and ` emojione-svg`.
 
-For a lit of all available shortnames and asciimojis (I hope I coined this so I can be cool) you can consult [emoji.codes](http://emoji.codes) and [Emoji One](http://emojione.com) websites.
+For a list of all available shortnames and asciimojis (I hope I coined this, so I can be cool) you can consult the [emoji.codes](http://emoji.codes), [Emoji One](http://emojione.com), and [Emoji Cheat Sheet](http://www.emoji-cheat-sheet.com/) websites.
+
+Elements matching the following (CSS selector) will be excluded from the emojification:
+
+~~~
+[data-no-emoji], [data-no-emojis],
+.no-emoji, .no-emojis, .no_emoji, .no_emojis,
+code, pre
+~~~
 
 ### Liquid filter
 
-There's also a Liquid filter called `emojify` (not very original). It acceps three parameters: `format`, `ascii` and `shortname`. I'd just like to add a note that the plugin was designed to be fast, *but* the `emojify` filter does deteriorate performance *a little* under very *specific* conditions; it shouldn't be an issue, but you've been warned.
+There's also a Liquid filter called `emojify`. It accepts three parameters: `format`, `ascii` and `shortname`. The former is a `String` (see above) while the latter two are `Boolean`.
 
-```liquid
+```
 {{ ":kissing_heart: :heart: :stuck_out_tongue:" | emojify  }}
 ```
 
@@ -45,6 +52,28 @@ There's also a Liquid filter called `emojify` (not very original). It acceps thr
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Known Issues
+
+### `emojify` filter performance
+
+The `emojify` filter deteriorates performance *a little* under very *specific* conditions; it shouldn't be an issue, but in case you see performance degradation when generating the site—start with this.
+
+### `emojify` filter unawareness
+
+The `emojify` filter isn't aware of the context it's being called within.
+
+~~~html
+<span class=".no-emoji">{{ string_with_emoji | emojify }}</span>
+~~~
+
+The content of `string_with_emoji` would be emojified, provided that there's no HTML inside `string_with_emoji` which would match the above CSS path.
+
+### HTML Entites inside blacklisted elements
+
+When the `emojify` filter is used inside a markdown file (say, a blog post), and if `format: 'html'` is set, then the will convert all emoji-matching unicode codepoints&mdash;regardless of whether they're inside an element matching aforementioned blacklisting CSS selector&mdash;into HTML entities (using hex format `&#xhhhh;`).
+
+This is due to the fact that HTML encoding is done in a post-processing step to simplify and speed up the implementation.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/omninonsense/jekyll-emoji. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
@@ -53,4 +82,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/omnino
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/jekyll-emoji.gemspec

@@ -9,16 +9,25 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Nino Miletich"]
   spec.email         = ["nino@miletich.me"]
 
+  spec.required_ruby_version = '>= 1.9', '~> 2.2'
+
   spec.summary       = %q{Adds support for emojis to Jekyll}
+  spec.description   = %q{
+    A plug-n-play Jekyll plugin to enable emoji support in your site.
+
+    See documentation for more inforamtion on how to use it.
+  }
   spec.homepage      = "https://github.com/omninonsense/jekyll-emoji"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "bundler", "~> 1.10"
-  spec.add_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8"
+
   spec.add_dependency "jekyll", "~> 2.0"
-  spec.add_dependency "yajl-ruby"
-  spec.add_dependency "oga", "~> 1.2.0"
+  spec.add_dependency "yajl-ruby", "~> 1.2", '>= 1.2.0'
+  spec.add_dependency "oga", "~> 1.2", '>= 1.2.0'
 end

data/lib/jekyll/emoji.rb

@@ -3,210 +3,243 @@ require 'oga'
 require 'yajl'
 
 module Jekyll
-  class EmojiConverter < Converter
-    safe true
-    priority :lowest
-
-    Defaults = {
-      'format' => 'html',
-      'ascii' => false,
-      'shortname' => true
-    }
-
-    def initialize(conf)
-      parser = Yajl::Parser.new
-      @@site_conf = conf
-      @conf ||= Defaults.merge(@@site_conf['emoji'])
-
-      formats = %w{
-        html
-        unicode
-        emojione-png
-        emojione-svg
+  module Emoji
+    class Converter < Converter
+      safe true
+      priority :lowest
+
+      Defaults = {
+        'format' => 'html',
+        'ascii' => false,
+        'shortname' => true
+      }.freeze
+
+      Attribute_blacklist = %w{
+        data-no-emoji
+        data-no-emojis
       }
 
-      if !formats.include? @conf['format']
-        raise(ArgumentError, "Unknown emoji format: '#{@conf['format']}'; Supported formats are: #{formats}")
-      end
-
-      @emoji_map    = {}
-      @encoding_map = {}
+      Class_blacklist = %w{
+        no-emoji
+        no-emojis
 
-      @shortname_aliases = []
-      @ascii_aliases = []
+        no_emoji
+        no_emojis
+      }
 
-      # This JSON file is nicked from the Emoji One project
-      # Go shower them in love (not that kinda love :smirk:).
-      emojione_json = nil
-      File.open(File.expand_path('../../../emoji.json', __FILE__), 'r') do |f|
-        emojione_json ||= parser.parse(f)
-      end
+      Element_blacklist = %w{
+        code
+        pre
+      }
 
-      emojione_json.each_pair do |k, v|
-        codepoints = v['unicode'].split('-')
-        unicode = codepoints.map(&:hex).pack("U*")
+      def initialize(conf = nil)
+        parser = Yajl::Parser.new
 
-        @shortname_aliases << v['shortname']
-        @emoji_map[v['shortname']] = v['unicode']
+        @@site_conf = conf
+        configure(@@site_conf)
 
-        v['aliases'].each {|emoji_alias|
-          @shortname_aliases << emoji_alias
-          @emoji_map[emoji_alias] = v['unicode']
+        formats = %w{
+          html
+          unicode
+          emojione-png
+          emojione-svg
         }
 
-        v['aliases_ascii'].each {|emoji_alias|
-          @ascii_aliases << emoji_alias
-          @emoji_map[emoji_alias] = v['unicode']
-        }
+        if !formats.include? @conf['format']
+          raise(ArgumentError, "Unknown emoji format: '#{@conf['format']}'; Supported formats are: #{formats}")
+        end
+
+        @emoji_map    = {}
+        @encoding_map = {}
+
+        @shortname_aliases = []
+        @ascii_aliases     = []
+
+        # This JSON file is nicked from the Emoji One project
+        # Go shower them in love (not that kinda love :smirk:).
+        emojione_json = nil
+        File.open(File.expand_path('../../../emoji.json', __FILE__), 'r') do |f|
+          emojione_json ||= parser.parse(f)
+        end
+
+        emojione_json.each_value do |v|
+          codepoints = v['unicode'].split('-')
+          unicode = codepoints.map(&:hex).pack("U*")
 
-        @encoding_map[unicode] = codepoints.map{|cp| "&#x#{cp};" }.join
-        @emoji_map[unicode] = v['unicode']
+          @shortname_aliases << v['shortname']
+          @emoji_map[v['shortname']] = v['unicode']
+
+          v['aliases'].each do |emoji_alias|
+            @shortname_aliases << emoji_alias
+            @emoji_map[emoji_alias] = v['unicode']
+          end
+
+          v['aliases_ascii'].each do |emoji_alias|
+            @ascii_aliases << emoji_alias
+            @emoji_map[emoji_alias] = v['unicode']
+          end
+
+          @encoding_map[unicode] = codepoints.map{|cp| "&#x#{cp};" }.join
+          @emoji_map[unicode] = v['unicode']
+        end
+
+        build_emoji_regexp
+
+        # @emoji_regexp = Regexp.new (@emoji_map.keys.map{|k| Regexp.quote(k) }).join('|')
+        @encoding_regexp = Regexp.new (@encoding_map.keys.map{|k| Regexp.quote(k) }).join('|')
       end
 
-      build_emoji_regexp
-
-      # @emoji_regexp = Regexp.new (@emoji_map.keys.map{|k| Regexp.quote(k) }).join('|')
-      @encoding_regexp = Regexp.new (@encoding_map.keys.map{|k| Regexp.quote(k) }).join('|')
-    end
-
-    def build_emoji_regexp
-      return if @old_conf == @conf
-
-      valid = @encoding_map.keys
-      valid += @shortname_aliases if @conf['shortname']
-      valid += @ascii_aliases if @conf['ascii']
-
-      @emoji_regexp = Regexp.union(valid)
-    end
-
-    def reconfigure(h)
-      @old_conf = @conf
-      @conf = @@site_conf['emoji'].merge(h){|k, o, n| n.nil? ? o : n }
-      build_emoji_regexp
-    end
-
-    def matches(ext)
-      ext =~ /^\.(md|markdown)$/i
-    end
-
-    def output_ext(ext)
-      ".html"
-    end
-
-    ##
-    # Return whether whether `node` should contain emojis or not
-    #
-    # @param [Oga::XML::Node] node
-    #
-    # @return [Boolean]
-    #
-    def emoji_enabled?(node)
-
-      return true if node.is_a? Oga::XML::Document
-
-      if node.is_a? Oga::XML::Element
-        classes = node.get('class')
-        return false if node.name == 'code'
-        return false if node.name == 'pre'
-        return false if node.get('data-no-emoji')
-        return false if !classes.nil? && classes[/no[-_]emoji/]
+      def build_emoji_regexp(previous_conf = nil)
+        return if previous_conf == @conf
+
+        valid = @encoding_map.keys
+        valid += @shortname_aliases if @conf['shortname']
+        valid += @ascii_aliases if @conf['ascii']
+
+        @emoji_regexp = Regexp.union(valid)
       end
 
-      return true
-    end
-
-    ##
-    # Recursively add emojis to all child nodes
-    #
-    # @param [Oga::XML::Document|Oga::XML::Node|Oga::XML::Element] node
-    #
-    # @return [NilClass]
-    #
-    def add_emojis(node)
-      return unless emoji_enabled?(node)
-
-      node.children.each do |child|
-        if child.is_a?(Oga::XML::Text)
-          process_node(child)
+      def configure(h)
+        if h['emoji']
+          @conf = Defaults.merge(h['emoji'])
         else
-          add_emojis(child)
+          @conf = Defaults
         end
       end
 
-      return nil
-    end
-
-    ##
-    # Add emojis to {Oga::XML::Text} node
-    #
-    # @param [Oga::XML::Text] node
-    #
-    # @return [NilClass]
-    #
-    def process_node(node)
-      str = node.text
-      str.gsub!(@emoji_regexp) do |m|
-        codepoints = @emoji_map[m]
-
-        unicode_emoji = codepoints.split('-').map(&:hex).pack("U*")
-
-        case @conf['format']
-        when 'unicode', 'html'
-          unicode_emoji
-        when 'emojione-png', 'emojione-svg'
-          vendor, ext = @conf['format'].split('-')
-          loc = str.index(m)
-
-          before = Oga::XML::Text.new
-          after = Oga::XML::Text.new
-
-          before.text = str[0...loc]
-          after.text = str[loc + m.length..-1]
-          img = Oga::XML::Element.new name: 'img'
-          img.set('class', vendor)
-          img.set('alt', unicode_emoji)
-          img.set('src', "https://cdn.jsdelivr.net/#{vendor}/assets/#{ext}/#{codepoints}.#{ext}")
-
-          if node.node_set
-            node.before(before)
-            node.after(after)
-            node.replace img
-          end
+      def reconfigure(h)
+        previous_conf = @conf
+        @conf = configure(@@site_conf).merge(h){|k, o, n| n.nil? ? o : n }
+        build_emoji_regexp(previous_conf)
+      end
+
+      def matches(ext)
+        ext =~ /^\.(md|markdown)$/i
+      end
+
+      def output_ext(ext)
+        ".html"
+      end
+
+      ##
+      # Return whether whether `node` should contain emojis or not
+      #
+      # @param [Oga::XML::Node] node
+      #
+      # @return [Boolean]
+      #
+      def emoji_enabled?(node)
+
+        return true if node.is_a? Oga::XML::Document
+
+        if node.is_a? Oga::XML::Element
+          classes = node.get('class')
+
+          return false if Element_blacklist.any? {|e| e == node.name }
+          return false if Attribute_blacklist.any? {|a| node.attr(a) }
+          return false unless (Class_blacklist & classes.split).empty? unless classes.nil?
 
         end
+
+        return true
       end
 
-      return nil
-    end
+      ##
+      # Recursively add emojis to all child nodes
+      #
+      # @param [Oga::XML::Document|Oga::XML::Node|Oga::XML::Element] node
+      #
+      # @return [NilClass]
+      #
+      def add_emojis(node)
+        return unless emoji_enabled?(node)
+
+        node.children.each do |child|
+          if child.is_a?(Oga::XML::Text)
+            process_node(child)
+          else
+            add_emojis(child)
+          end
+        end
 
-    def convert(content)
-      document = Oga.parse_html(content)
-      add_emojis(document)
-      docstr = document.to_xml
+        return nil
+      end
+
+      ##
+      # Add emojis to {Oga::XML::Text} node
+      #
+      # @param [Oga::XML::Text] node
+      #
+      # @return [NilClass]
+      #
+      def process_node(node)
+        str = node.text
+        str.gsub!(@emoji_regexp) do |m|
+          codepoints = @emoji_map[m]
+
+          unicode_emoji = codepoints.split('-').map(&:hex).pack("U*")
+
+          case @conf['format']
+          when 'unicode', 'html'
+            unicode_emoji
+          when 'emojione-png', 'emojione-svg'
+            vendor, ext = @conf['format'].split('-')
+            loc = str.index(m)
+
+            before = Oga::XML::Text.new
+            after = Oga::XML::Text.new
+
+            before.text = str[0...loc]
+            after.text = str[loc + m.length..-1]
+            img = Oga::XML::Element.new name: 'img'
+            img.set('class', vendor)
+            img.set('alt', unicode_emoji)
+            img.set('src', "https://cdn.jsdelivr.net/#{vendor}/assets/#{ext}/#{codepoints}.#{ext}")
+
+            if node.node_set
+              node.before(before)
+              node.after(after)
+              node.replace img
+            end
+
+          end
+        end
 
-      # Now we only need to encode the Emojis into HTML Entities
-      if @conf['format'] == 'html'
-        docstr.gsub!(@encoding_regexp, @encoding_map)
+        return nil
       end
 
-      return docstr
-    end # convert
+      def convert(content)
+        document = Oga.parse_html(content)
+        add_emojis(document)
+        docstr = document.to_xml
 
-    def self.site_conf
-      @@site_conf
-    end
-  end
+        # Now we only need to encode the Emojis into HTML Entities
+        if @conf['format'] == 'html'
+          docstr.gsub!(@encoding_regexp, @encoding_map)
+        end
 
-  module EmojiFilter
-    def emojify(input, format = nil, ascii = nil, shortname = nil)
-      @@emoji_converter ||= EmojiConverter.new('emoji' => EmojiConverter.site_conf['emoji'])
+        return docstr
+      end # convert
 
-      @@emoji_converter.reconfigure('format' => format, 'ascii' => ascii, 'shortname' => shortname)
+      def self.site_conf
+        @@site_conf
+      end
+    end #Converter
+
+    module Filter
+      def emojify(input, output_format = nil, ascii = nil, shortname = nil)
+        @@emoji_converter ||= Converter.new(Converter.site_conf)
+        @@emoji_converter.reconfigure('format' => output_format, 'ascii' => ascii, 'shortname' => shortname)
+
+        output = @@emoji_converter.convert(input)
 
-      output = @@emoji_converter.convert(input)
-      return output
-    end
-  end
+        # NOTE: This impacts performance in certain cases
+        @@emoji_converter.reconfigure(Converter.site_conf)
+
+        return output
+      end
+    end #Filter
+  end #Emoji
 end
 
-Liquid::Template.register_filter(Jekyll::EmojiFilter)
+Liquid::Template.register_filter(Jekyll::Emoji::Filter)

data/lib/jekyll/emoji/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Emoji
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

data/tests/conversion_test.rb

@@ -4,7 +4,7 @@ require_relative '../lib/jekyll-emoji'
 
 class TestConversion < MiniTest::Test
   def setup
-    @converter = Jekyll::EmojiConverter.new('emoji' => {
+    @converter = Jekyll::Emoji::Converter.new('emoji' => {
       'format': 'html',
       'ascii' => true,
       'shortname' => true
@@ -31,4 +31,45 @@ class TestConversion < MiniTest::Test
     assert_equal img, @converter.convert(":three:")
     assert_equal "3", @converter.convert("3")
   end
+
+  def test_reconfiguring_aliases
+    @converter.reconfigure 'ascii' => false
+    assert_equal ":)", @converter.convert(":)")
+
+    # Return to default state
+    @converter.reconfigure 'ascii' => true
+  end
+
+  def test_class_blacklists
+    test1 = %q{<span class="very-serious-text no-emojis">:)</span>}
+    result1 = %q{<span class="very-serious-text no-emojis">:)</span>}
+
+    test2 = %q{<span class="very-serious-text no-emojiz">:)</span>}
+    result2 = %q{<span class="very-serious-text no-emojiz">&#x1F604;</span>}
+
+    assert_equal result1, @converter.convert(test1)
+    assert_equal result2, @converter.convert(test2)
+  end
+
+  def test_attr_blacklists
+    test1 = %q{<span data-no-emojis>:)</span>}
+    result1 = %q{<span data-no-emojis="">:)</span>}
+
+    test2 = %q{<span data-no-emojiz>:)</span>}
+    result2 = %q{<span data-no-emojiz="">&#x1F604;</span>}
+
+    assert_equal result1, @converter.convert(test1)
+    assert_equal result2, @converter.convert(test2)
+  end
+
+  def test_attr_blacklists
+    test1 = %q{<code>:)</code>}
+    result1 = %q{<code>:)</code>}
+
+    test2 = %q{<span>:)</span>}
+    result2 = %q{<span>&#x1F604;</span>}
+
+    assert_equal result1, @converter.convert(test1)
+    assert_equal result2, @converter.convert(test2)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-emoji
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Nino Miletich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-09 00:00:00.000000000 Z
+date: 2015-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,7 +17,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -31,13 +31,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -56,21 +70,30 @@ dependencies:
   name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: oga
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :runtime
@@ -78,9 +101,13 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
-description: 
+description: "\n    A plug-n-play Jekyll plugin to enable emoji support in your site.\n\n
+  \   See documentation for more inforamtion on how to use it.\n  "
 email:
 - nino@miletich.me
 executables: []
@@ -112,7 +139,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="