emoji_for_jekyll 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbbdbe32efad1804a61ace9d8424f7bb05f2bf51
-  data.tar.gz: 00b6ac6894383459710ec55c5f579ae66799d63f
+  metadata.gz: 003ce4864712b5e090e7cfda26bfe8d66d4f3235
+  data.tar.gz: 2cb9c8cfe8d85981a8a2176260ce94da78fe48b5
 SHA512:
-  metadata.gz: 5dcf80b3e41e0a52a9dc52d8ea6d80624e5385497d9808e11f2f1395e7d3483fb32bc6fab82c9d894d17950cac291a0955899139f1ad0a0fca1fd860d05f3be8
-  data.tar.gz: b02a149651fd599d9074519a50a5ca6f0721d57f7aa1a29af896589d86dc94c0bcc38c5cb1525e84dff54c0b3fe443a660a09de787ba90873eec3d96e46aacc2
+  metadata.gz: 23a962166010f4ccbeeb4bac7959c0a1ebbf5f1544fb096c1a3e7614fa1036b42bcc808b6d437c09e831cfed8692646c1e17738a7e1b20ca2f3edf96db97c90b
+  data.tar.gz: 7b603b03cb8e70240180a7e4a7aaf4039978e85a0448c9eab88116cecdbee0e687bb8fd24bf170e8e74ead9484cd7335af9df92a4dd057141f2448a7f22cc0bd

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Yihang Ho
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Emoji for Jekyll
+Seamlessly enable emoji for Jekyll.
+
+## Installation
+1. Install the `emoji_for_jekyll` gem:
+
+        gem install emoji_for_jekyll
+2. Add `emoji_for_jekyll` to the list of gems in `config.yml`:
+
+  ```yaml
+  gems: ["emoji_for_jekyll"]
+  ```
+3. See beautiful emoji!
+
+_or_
+
+1. Copy `emoji_for_jekll.rb` and `emoji.json` into the `_plugins` directory
+
+
+## Options
+### Whitelist and blacklist
+You can also whitelist or blacklist certain emojis. On the posts or pages that you want to whitelist or blacklist certain emojis, add `emoji-whitelist` or `emoji-blacklist` follow by a list of emojis __without__ the colons to the front matter. For example:
+
+```yaml
+emoji-whitelist:
+  - bowtie
+  - blush
+ ```
+
+ or
+
+```yaml
+emoji-blacklist:
+  - smile
+```
+
+When both `emoji-whitelist` and `emoji-blacklist` are declared, the effect will be the same as when only the whitelist is declared.
+
+### Disabling
+You may choose to disable this plugin for certain posts or pages by adding `emoji: false` to the front matter of these posts and pages.
+
+If, for some reason, you want to disable this plugin for the entire site, you can either remove `emoji-for-jekyll.rb` from `_plugins`, or just add `emoji: false` to `_config.yml`.
+
+### Emojify front-matter items
+If you need to emojify certain items in your front-matter, like `title` or `caption` that is needed for some templates, you can do so by setting `emoji-additional-keys` in `_config.yml`. This setting is optional and expects an array:
+
+```yaml
+emoji-additional-keys: ["title", "caption"]
+```
+
+### Custom images
+By default the images are sourced from GitHub CDN but should you want to use other images you can by choosing a directory with the setting `emoji-images-path` in `_config.yml`. For example: `emoji-images-path: 'img/emoji'`
+
+Images copied into this directory will be added the whitelist. E.g.: `custom.png` would whitelist `:custom:`. Any images with the same name as the emoji list will overwrite the default GitHub emoji image.
+
+## Updating Emoji for Jekyll
+Updating Emoji for Jekyll is very easy:
+
+```
+gem update emoji_for_jekyll
+```

data/lib/emoji_for_jekyll.rb

@@ -1,65 +1,101 @@
 require 'json'
 
 module EmojiForJekyll
-	class EmojiGenerator < Jekyll::Generator
-		def generate(site)
-			if site.config.has_key?("emoji") and !site.config["emoji"]
-				return
-			end
-
-			if site.config.has_key?("emoji-additional-keys")
-				additional_keys = site.config["emoji-additional-keys"]
-			else
-				additional_keys = []
-			end
-
-			get_master_whitelist
-
-			site.pages.each { |p| substitute(p, additional_keys) }
-
-			site.posts.each { |p| substitute(p, additional_keys) }
-		end
-
-		private
-		def get_master_whitelist
-			# @master_whitelist is an array of all supported emojis
-			@master_whitelist = JSON.parse(IO.readlines(File.expand_path("emojis.json", File.dirname(__FILE__))).join)
-		end
-
-		def substitute(obj, additional_keys)
-			if obj.data.has_key?("emoji") and !obj.data["emoji"]
-				return
-			end
-
-			whitelist = obj.data.has_key?("emoji-whitelist") ? obj.data["emoji-whitelist"] : false
-			blacklist = obj.data.has_key?("emoji-blacklist") ? obj.data["emoji-blacklist"] : false
-
-			# When both the whitelist and blacklist are defined, whitelist will be prioritized
-			blacklist = whitelist ? false : blacklist
-
-			obj.content.gsub!(/:([\w\+\-]+):/) do |s|
-				if (whitelist and whitelist.include?($1)) or (blacklist and !blacklist.include?($1)) or (!whitelist and !blacklist) and @master_whitelist.bsearch { |i| i >= $1 } == $1
-					img_tag $1
-				else
-					s
-				end
-			end
-
-			additional_keys.each do |key|
-				if obj.data.has_key?(key)
-					obj.data[key].gsub!(/:([\w\+\-]+):/) do |s|
-						if (whitelist and whitelist.include?($1)) or (blacklist and !blacklist.include?($1)) or (!whitelist and !blacklist) and @master_whitelist.bsearch { |i| i >= $1 } == $1
-							img_tag $1
-						else
-							s
-						end
-					end
-				end
-			end
-		end
-
-		def img_tag(name)
-			"<img class=\"emoji\" title=\"#{name}\" alt=\"#{name}\" src=\"https://github.global.ssl.fastly.net/images/icons/emoji/#{name}.png\" height=\"20\" width=\"20\" align=\"absmiddle\">"
-		end
-	end
+
+  class EmojiGenerator < Jekyll::Generator
+    def generate(site)
+      if site.config.has_key?("emoji") and !site.config["emoji"]
+        return
+      end
+
+      if site.config.has_key?("emoji-additional-keys")
+        additional_keys = site.config["emoji-additional-keys"]
+      else
+        additional_keys = []
+      end
+
+      get_master_whitelist
+
+      get_images_path(site)
+
+      site.pages.each { |p| substitute(p, additional_keys) }
+
+      site.posts.each { |p| substitute(p, additional_keys) }
+    end
+
+    private
+    def get_master_whitelist
+      # @master_whitelist is an array of all supported emojis
+      @master_whitelist = JSON.parse(IO.readlines(File.expand_path("emoji.json", File.dirname(__FILE__))).join)
+    end
+
+    def get_images_path(site)
+      @images_path = {}
+      if site.config["emoji-images-path"]
+
+        images_path = site.config["emoji-images-path"]
+        images_dir  = File.join(site.source, images_path)
+        Dir.foreach(images_dir) do |image_filename|
+          if /^(?<tag>.*)\.(?:png|jpg|jpeg|gif)/ =~ image_filename
+            @master_whitelist << tag
+            @images_path[tag] = File.join("/", images_path, image_filename)
+          end
+        end
+
+      end
+      @master_whitelist.sort!
+    end
+
+    def substitute(obj, additional_keys)
+      if obj.data.has_key?("emoji") and !obj.data["emoji"]
+        return
+      end
+
+      whitelist = obj.data.has_key?("emoji-whitelist") ? obj.data["emoji-whitelist"] : false
+      blacklist = obj.data.has_key?("emoji-blacklist") ? obj.data["emoji-blacklist"] : false
+
+      # When both the whitelist and blacklist are defined, whitelist will be prioritized
+      blacklist = whitelist ? false : blacklist
+
+      filter = Proc.new do |key|
+        (whitelist and whitelist.include?($1)) or
+        (blacklist and !blacklist.include?($1)) or
+        (!whitelist and !blacklist) and
+        @master_whitelist.bsearch { |i| i >= key } == key
+      end
+
+      obj.content.gsub!(/:([\w\+\-]+):/) do |s|
+        convert($1, filter)
+      end
+
+      additional_keys.each do |key|
+        if obj.data.has_key?(key)
+          obj.data[key].gsub!(/:([\w\+\-]+):/) do |s|
+            convert($1, filter)
+          end
+        end
+      end
+    end
+
+    # convert takes in the key to the emoji to be converted and an optional block
+    # If block is provided, conversion will be done only if this block evaluates to true.
+    def convert(key, block = nil)
+      if block.nil? or block.call(key)
+        img_tag(key)
+      else
+        ":#{key}:"
+      end
+    end
+
+    def img_tag(name)
+      # if there is an image in the custom images path
+      if @images_path[name]
+        img_src = @images_path[name]
+      else # otherwise use fallback CDN
+        img_src = "https://github.global.ssl.fastly.net/images/icons/emoji/#{name}.png"
+      end
+
+      "<img class='emoji' title='#{name}' alt='#{name}' src='#{img_src}' height='20' width='20' align='absmiddle' >"
+    end
+  end
 end

metadata

@@ -1,23 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: emoji_for_jekyll
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Yihang Ho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-22 00:00:00.000000000 Z
+date: 2014-05-08 00:00:00.000000000 Z
 dependencies: []
 description: A plugin for Jekyll that seamlessly enable emoji.
 email: me@yihangho.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE
 files:
+- LICENSE
+- README.md
+- lib/emoji.json
 - lib/emoji_for_jekyll.rb
-- lib/emojis.json
 homepage: https://github.com/yihangho/emoji-for-jekyll
 licenses:
 - MIT
@@ -39,7 +43,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0.rc.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Seamlessly enable emoji in Jekyll.