jekyll-emoji 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa05cb9d3d721a154defea59300d2091a943aace
-  data.tar.gz: 5cdfae6341a486064fa2ab6abcdb05d3a6501d1d
+  metadata.gz: 8fe913ad1a9849a6e354d27643eec013aef80fac
+  data.tar.gz: c47e5653f01a0b650726fc6484354e60125b8782
 SHA512:
-  metadata.gz: 5279d5dd2b413b01fda17517d0b5a2402d29b99a2b444487d888bddb4fb1c9fa01b2689dfa00c8363283442d1096cd9ba41e22c7b7703b54835106444dcc58b2
-  data.tar.gz: 680a167683ebec39347fc7fe10d50f936ecff530b9caf00bb55a39538b0d7577f1d26fd24898e8c83243135766ebb0bf0bfbe225dc6caa0592c7e3043e21aa56
+  metadata.gz: 9b0b278e3279d9e0177ea0a1c3cf41246203128e73c72a924df4653b96afe1f55a3bc3f5f3738848ecf823398298031eead44406a1180e9af8a378181b144fc1
+  data.tar.gz: 4b70b621ae16fc7c56b8759c793f75e1e3fabc1904be9314f77fd7d156d76ff57c69003fb245c9d185a0dfb0b55e2689454478a099310190d15eaa366574cbdb

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
   - 2.2.2
+  - 1.9.3
 before_install: gem install bundler -v 1.10.5

data/README.md

@@ -1,5 +1,11 @@
 # Jekyll::Emoji
 
+[![Build Status](https://travis-ci.org/omninonsense/jekyll-emoji.svg?branch=master)](https://travis-ci.org/omninonsense/jekyll-emoji)
+[![Gem Version](https://badge.fury.io/rb/jekyll-emoji.svg)](http://badge.fury.io/rb/jekyll-emoji)
+[![Code Climate](https://codeclimate.com/github/omninonsense/jekyll-emoji/badges/gpa.svg)](https://codeclimate.com/github/omninonsense/jekyll-emoji)
+[![Inline docs](http://inch-ci.org/github/omninonsense/jekyll-emoji.svg?branch=master)](http://inch-ci.org/github/omninonsense/jekyll-emoji)
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -30,7 +36,9 @@ emoji:
 
 The following formats are supported: `html`, `unicode`, `emojione-png`, and ` emojione-svg`.
 
-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.
+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/jekyll-emoji.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   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.
+    See documentation for more information on how to use it.
   }
   spec.homepage      = "https://github.com/omninonsense/jekyll-emoji"
   spec.license       = "MIT"

data/lib/jekyll/emoji/converter.rb

@@ -58,8 +58,8 @@ module Jekyll
       # @param [Hash] conf
       #
       def initialize(conf = {'emoji' => DEFAULTS})
-        @@site_conf = conf
-        configure(@@site_conf)
+        @initialized = false
+        configure(@initial_conf = conf)
 
         validate_format
 
@@ -71,8 +71,8 @@ module Jekyll
 
         load_emoji_data
         build_emoji_regexp
-
-        @encoding_regexp = Regexp.new (@encoding_map.keys.map{|k| Regexp.quote(k) }).join('|')
+        build_encoding_regexp
+        @initialized = true
       end
 
       ##
@@ -106,29 +106,121 @@ module Jekyll
         data = load_emoji_json(path)
 
         data.each do |v|
-          codepoints = v['unicode'].split('-')
+          codepoints = v['unicode']
           unicode = codepoints_to_unicode(codepoints)
 
-          @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
+          add_shortname_alias(v['shortname'], codepoints)
+          v['aliases'].each {|a| add_shortname_alias(a, codepoints) }
+          v['aliases_ascii'].each {|a| add_ascii_alias(a, codepoints) }
 
-          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']
+          map_emoji(unicode, codepoints)
+          map_encoding(unicode, codepoints)
         end
 
         return nil
       end
 
+      ##
+      # Map an key to an HTML Entity string for faster encoding.
+      # The keys also serve as an array of strings used in the emoji regexp.
+      #
+      # - `k` is the unicode string
+      # - `v` is a dash(`-`)-delimited string of hex-formated codepoints
+      #
+      # @param [String] k
+      # @param [String] v
+      #
+      def map_encoding(k, v)
+        @encoding_map[k] = v.split('-').map{|cp| "&#x#{cp};" }.join
+
+        build_encoding_regexp if @initialized
+      end
+
+      ##
+      # Add an emoji to the map of all supported emojis.
+      # - `k` is an string corresponding to the emoji.
+      # - `v` is a dash(`-`)-delimited string of hex-formated codepoints.
+      #
+      # Returns true if the key was added, false if it already existed.
+      #
+      # @example
+      #   conv = Converter.new()
+      #   conv.map_emoji("\u{1F609}", '1F609')
+      #
+      #
+      # **NOTE**: Keys added through `map_encoding`, `map_emoji`,
+      # `add_shortname_alias`, and `add_ascii_alias` are all used in the same
+      # fashion during the lookup of the emoji. So, the code below would work,
+      # but the `:wink:` key would be added to the wrong lookup table, which
+      # would mean this key wouldn't be converted to an emoji if ASCII keys
+      # were disabled.
+      #
+      # This is a design choice added on purpose to allow addition of different
+      # types of emoji aliases, which aren't limited to `:shortcode` or the
+      # traditional smiley faces (`:)`, or `:P`), but also allowing the ability
+      # to toggle them off if needed.
+      #
+      # @example
+      #   conv = Converter.new()
+      #   conv.add_ascii_alias(":wink:", '1F609')
+      #
+      #
+      # @param [String] k
+      # @param [String] v
+      # @return [FalseClass|TrueClass]
+      #
+      def map_emoji(k, v)
+        return false if @emoji_map.has_key? k
+        @emoji_map[k] = v
+
+        build_emoji_regexp if @initialized
+        return true
+      end
+
+      ##
+      # Add a shortname alias for an emoji
+      # Used similarly to `map_emoji`, except that `k` is a string alias:
+      #
+      # Returns true if the key was added, false if it already existed.
+      #
+      # @example
+      #   conv = Converter.new()
+      #   conv.add_shortname_alias(":wink:", '1F609')
+      #
+      # @param [String] k
+      # @param [String] v
+      # @return [FalseClass|TrueClass]
+      #
+      def add_shortname_alias(emoji_alias, codepoints)
+        return false unless map_emoji(emoji_alias, codepoints)
+        @shortname_aliases << emoji_alias
+
+        build_emoji_regexp if @initialized
+        return true
+      end
+
+      ##
+      # Add an ASCII alias for an emoji
+      # Used similarly to `add_shortname_alias`.
+      #
+      # Returns true if the key was added, false if it already existed.
+      #
+      # @example
+      #   conv = Converter.new()
+      #   conv.add_shortname_alias(";-)", '1F609')
+      #
+      # @param [String] k
+      # @param [String] v
+      # @return [FalseClass|TrueClass]
+      #
+      def add_ascii_alias(emoji_alias, codepoints)
+        return false unless map_emoji(emoji_alias, codepoints)
+        @ascii_aliases << emoji_alias
+
+        build_emoji_regexp if @initialized
+        return true
+      end
+
       ##
       # Validates if desired format is supported. If it isn't supported
       # an exception is raised.
@@ -151,8 +243,8 @@ module Jekyll
       # @param [Hash|NilClass]
       # @return [Regexp]
       #
-      def build_emoji_regexp(previous_conf = nil)
-        return if previous_conf == @conf
+      def build_emoji_regexp(oc = nil)
+        return if oc['ascii'] == @conf['ascii'] && oc['shortname'] == @conf['shortname'] unless oc.nil?
 
         valid = @encoding_map.keys
         valid += @shortname_aliases if @conf['shortname']
@@ -161,6 +253,10 @@ module Jekyll
         @emoji_regexp = Regexp.union(valid)
       end
 
+      def build_encoding_regexp
+        @encoding_regexp = Regexp.new (@encoding_map.keys.map{|k| Regexp.quote(k) }).join('|')
+      end
+
       ##
       # Configure the internal state.
       #
@@ -183,7 +279,7 @@ module Jekyll
       #
       def reconfigure(h)
         previous_conf = @conf
-        @conf = configure(@@site_conf).merge(h){|k, o, n| n.nil? ? o : n }
+        @conf = configure(@initial_conf).merge(h){|k, o, n| n.nil? ? o : n }
         validate_format
         build_emoji_regexp(previous_conf)
 
@@ -320,20 +416,6 @@ module Jekyll
         return [node_before, node_after ]
       end
 
-      ##
-      # Convert `unicode` string into a `"HHHH-HHHH"` string, which represents
-      # the codepoints of the unicode string, but only if `unicode`
-      # is a valid emoji.
-      #
-      #
-      # @param [String] unicode
-      # @return [String]
-      #
-      def unicode_to_codepoints(unicode)
-        return unicode unless @encoding_map.key? unicode
-        unicode.codepoints.map {|cp| cp.to_s 16}.join('-')
-      end
-
       ##
       # Convert `codepoints` into an unicode string.
       #
@@ -355,7 +437,7 @@ module Jekyll
       # won't be emojified. Check the `BLACKLIST_*`` constants, or the docs for
       # more information.
       #
-      # @param [String] convert
+      # @param [String] content
       # @return [String]
       #
       def convert(content)
@@ -371,16 +453,16 @@ module Jekyll
         return docstr
       end # convert
 
-      def self.site_conf
-        @@site_conf
+      def initial_conf
+        @initial_conf
       end
 
       private :load_emoji_json, :load_emoji_data
       private :validate_format
-      private :build_emoji_regexp
+      private :build_emoji_regexp, :build_encoding_regexp
       private :process_node
       private :emojione_img_node, :split_to_nodes
-      private :unicode_to_codepoints, :codepoints_to_unicode
+      private :codepoints_to_unicode
     end #Converter
   end #Emoji
 end

data/lib/jekyll/emoji/filter.rb

@@ -13,13 +13,15 @@ module Jekyll
       # @return [String]
       #
       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)
+        # Liquid/Jekyll seem to re-create the class where filters are included
+        @@__emoji_converter__ ||= Converter.new(@context.registers[:site].config)
+        @@__emoji_converter__.reconfigure('format' => output_format, 'ascii' => ascii, 'shortname' => shortname)
 
-        output = @@emoji_converter.convert(input)
+        output = @@__emoji_converter__.convert(input)
 
+        # Revert back to old configuration
         # NOTE: This impacts performance in certain cases
-        @@emoji_converter.reconfigure(Converter.site_conf)
+        @@__emoji_converter__.reconfigure(@@__emoji_converter__.initial_conf)
 
         return output
       end

data/lib/jekyll/emoji/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Emoji
-    VERSION = "0.1.5"
+    VERSION = "0.1.6"
   end
 end

data/tests/conversion_test.rb

@@ -5,7 +5,7 @@ require_relative '../lib/jekyll-emoji'
 class TestConversion < MiniTest::Test
   def setup
     @converter = Jekyll::Emoji::Converter.new('emoji' => {
-      'format': 'html',
+      'format' => 'html',
       'ascii' => true,
       'shortname' => true
     })
@@ -26,7 +26,7 @@ class TestConversion < MiniTest::Test
 
   def test_svg
     @converter.reconfigure 'format' => 'emojione-svg'
-    img = %q{the number <img class="emojione" alt="3⃣" src="https://cdn.jsdelivr.net/emojione/assets/svg/0033-20E3.svg" /> is smaller than 4}
+    img = %Q{the number <img class="emojione" alt="3\u{20E3}" src="https://cdn.jsdelivr.net/emojione/assets/svg/0033-20E3.svg" /> is smaller than 4}
     assert_equal img, @converter.convert("the number \u{0033}\u{20E3} is smaller than 4")
     assert_equal img, @converter.convert("the number :three: is smaller than 4")
     assert_equal "the number 3 is smaller than 4", @converter.convert("the number 3 is smaller than 4")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-emoji
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Nino Miletich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-11 00:00:00.000000000 Z
+date: 2015-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,7 +107,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.2.0
 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  "
+  \   See documentation for more information on how to use it.\n  "
 email:
 - nino@miletich.me
 executables: []