middleman-emojifire 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0349e3910318e00736e605cae6c79aa470aefc7
+  data.tar.gz: 8e44d94bf476e062406d73aa9cac6d03d0d164be
+SHA512:
+  metadata.gz: b5c0f19925ae34acf8fcabc2b41b611b83b890abf8d4237b353cc994c44658d53ef3a51ebce44fb42620f326ec6dc31b55d1f333ea3e2fa8a9ffc70a85ba6a4f
+  data.tar.gz: b15bed382e54ac7e1a53da68e3de339c48383cc39058b6b615061ca80d23ac2367eecf03af5bad1281aa2ab33692ecaa974f6fdcb19ba26389258771fd2e8c1d

data/.gitignore

@@ -0,0 +1,5 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg

data/Gemfile

@@ -0,0 +1,18 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-emojifire.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,101 @@
+# middleman-emojifire 🔥
+
+middleman-emojifire is a quite easy-to-use emoji extension for Middleman.
+
+Given the below HTML source:
+
+```html
+<h3>The love :cat:</h3>
+<p>I move like cagey :tiger:</p>
+```
+
+middleman-emojifire will convert it into like the following:
+
+```html
+<h3>The love 🐱</h3>
+<p>I move like cagey 🐯</p>
+```
+
+In fact, emojifire wraps emojis with `<span>` tags for future use (as be described later):
+
+```html
+<h3>The love <span class="emoji" data-alias="cat" data-fallback="https://assets-cdn.github.com/images/icons/emoji/unicode/1f431.png">🐱</span></h3>
+```
+
+
+Note that these emojis are characters respresented by unicode.
+Unlike the ways of most extensions to display emoji, they are not replaced by images.
+This means that modern OS/browsers can display them without extra downloads.
+
+However, what if you want to put popular emoji which does not have unicode representation like :shipit:?
+
+When a unicode repsentation for an emoji is not found, emojifire fallbacks it to an image with inline styles:
+
+```html
+<span class="emoji" data-alias="shipit" style="overflow: hidden; display: inline-block; width: 1em; height: 1em; margin: 0 0.1em; background-size: 100% 100%; background-image: url('https://assets-cdn.github.com/images/icons/emoji/shipit.png');"></span>
+```
+
+## Usage
+
+Add the following to Gemfile:
+
+```ruby
+gem "middleman-emojifire"
+```
+
+And add the following to your `config.rb`:
+
+```ruby
+activate :emojifire
+```
+
+That's all.
+
+## Fallback on platforms which do not natively support emoji
+
+Since middleman-emojifire set some data-attributes including an image source URL in tag, you can easily write a fallback script to display images instead of characters.
+
+Simply adding the below snippet into your JavaScript assets will work:
+
+```javascript
+document.addEventListener('DOMContentLoaded', function() {
+  var emojiSupported = (function() {
+    var node = document.createElement('canvas');
+    if (!node.getContext || !node.getContext('2d') ||
+      typeof node.getContext('2d').fillText !== 'function')
+      return false;
+    var ctx = node.getContext('2d');
+    ctx.textBaseline = 'top';
+    ctx.font = '32px Arial';
+    ctx.fillText('\ud83d\ude03', 0, 0);
+    return ctx.getImageData(16, 16, 1, 1).data[0] !== 0;
+  })();
+
+  if (emojiSupported) { return; }
+
+  var emojiElements = document.getElementsByClassName('emoji');
+
+  for (var i = 0; i < emojiElements.length; i++) {
+    var element = emojiElements[i];
+    var srcPath = element.dataset.fallback;
+    if (typeof srcPath !== 'undefined') {
+      element.innerHTML = '';
+      element.style.overflow = 'hidden';
+      element.style.display = 'inline-block';
+      element.style.width = '1em';
+      element.style.height = '1em';
+      element.style.margin = '0 0.1em';
+      element.style.backgroundSize =  '100% 100%';
+      element.style.backgroundImage = "url('" + srcPath + "')";
+      delete element.dataset.fallback;
+    }
+  }
+});
+```
+
+It will detect if a platform supports emoji, and fallback to images if it does not.
+
+## Thanks
+
+- [middleman-gemoji](https://github.com/yterajima/middleman-gemoji) as reference for both concept and implementation
+- http://crocodillon.com/blog/parsing-emoji-unicode-in-javascript for native emoji support detection snippet in JS

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-emojifire')

data/lib/middleman-emojifire.rb

@@ -0,0 +1,7 @@
+require "middleman-core"
+require "middleman-emojifire/version"
+
+::Middleman::Extensions.register :emojifire do
+  require "middleman-emojifire/extension"
+  ::Middleman::Emojifire::Extension
+end

data/lib/middleman-emojifire/content.rb

@@ -0,0 +1,25 @@
+module Middleman
+  module Emojifire
+    class Content
+      attr_reader :source
+
+      def initialize(source)
+        @source = source.to_s
+      end
+
+      def include_body?
+        source =~ %r{<body.*?>.*?</body>}m ? true : false
+      end
+
+      def body_only
+        source.gsub(%r{<body.*?>(.*?)</body>}m) do |match|
+          yield match
+        end
+      end
+
+      def to_s
+        source
+      end
+    end
+  end
+end

data/lib/middleman-emojifire/converter.rb

@@ -0,0 +1,36 @@
+require "middleman-emojifire/content"
+require "middleman-emojifire/ext/emoji_extension"
+
+module Middleman
+  module Emojifire
+    class Converter
+      attr_reader :content
+
+      using Middleman::Emojifire::EmojiExtension
+
+      def initialize(content)
+        @content = ::Middleman::Emojifire::Content.new(content)
+      end
+
+      def convert
+        if content.include_body?
+          content.body_only { |body| emojify(body) }
+        else
+          emojify(content.to_s)
+        end
+      end
+
+      private
+
+      def emojify(source)
+        source.gsub(/:([\w+-]+):/) do |match|
+          if (emoji = Emoji.find_by_alias(Regexp.last_match[1]))
+            emoji.raw ? emoji.raw_unicode_character_html : emoji.fallback_image_html
+          else
+            match
+          end
+        end
+      end
+    end
+  end
+end

data/lib/middleman-emojifire/ext/emoji_extension.rb

@@ -0,0 +1,28 @@
+require "gemoji"
+
+module Middleman
+  module Emojifire
+    module EmojiExtension
+      refine ::Emoji::Character do
+        GITHUB_DOT_COM_ASSET_HOST_URL = "https://assets-cdn.github.com".freeze
+        ASSET_PATH = "/images/icons/emoji".freeze
+
+        def raw_unicode_character_html
+          "<span class=\"emoji\" data-alias=\"#{name}\" " \
+            "data-fallback=\"#{fallback_source}\">" \
+            "#{raw}</span>"
+        end
+
+        def fallback_image_html
+          "<span class=\"emoji\" data-alias=\"#{name}\" " \
+            "style=\"overflow: hidden; display: inline-block; width: 1em; height: 1em; margin: 0 0.1em; background-size: 100% 100%; " \
+            "background-image: url('#{fallback_source}');\"></span>"
+        end
+
+        def fallback_source
+          File.join(GITHUB_DOT_COM_ASSET_HOST_URL, ASSET_PATH, image_filename)
+        end
+      end
+    end
+  end
+end

data/lib/middleman-emojifire/extension.rb

@@ -0,0 +1,17 @@
+require "middleman-core"
+require "middleman-emojifire/converter"
+
+module Middleman
+  module Emojifire
+    class Extension < ::Middleman::Extension
+      def initialize(app, options_hash={}, &block)
+        super
+        require "gemoji"
+
+        app.after_render do |content|
+          ::Middleman::Emojifire::Converter.new(content).convert
+        end
+      end
+    end
+  end
+end

data/lib/middleman-emojifire/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Emojifire
+    VERSION = "1.1.0"
+  end
+end

data/middleman-emojifire.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "middleman-emojifire/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "middleman-emojifire"
+  spec.version     = Middleman::Emojifire::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ["Hirofumi Wakasugi"]
+  spec.email       = ["baenej@gmail.com"]
+  spec.homepage    = "https://github.com/5t111111/middleman-emojifire"
+  spec.summary     = %q{Middleman emoji extension}
+  spec.description = %q{middleman-emojifire is a quite easy-to-use emoji extension for Middleman.}
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "middleman-core", ">= 4.2.1"
+  spec.add_runtime_dependency "gemoji", ">= 3.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", ">= 5.10"
+end

data/test/content_test.rb

@@ -0,0 +1,89 @@
+require "test_helper"
+require "middleman-emojifire/content"
+
+describe Middleman::Emojifire::Content do
+  describe "initialize" do
+    it "saves stringified content" do
+      content = Middleman::Emojifire::Content.new(123)
+      expect(content.source).must_be_instance_of String
+    end
+  end
+
+  describe "include_body?" do
+    it "returns true if including body tag" do
+      content = Middleman::Emojifire::Content.new(
+        <<~EOS
+          <head>
+            <title>Test</title>
+          </head>
+          <body>
+            Test
+          </body>
+        EOS
+      )
+      expect(content.include_body?).must_equal true
+    end
+
+    it "returns true if including body tag with attributes" do
+      content = Middleman::Emojifire::Content.new(
+        <<~EOS
+          <body class="main">
+            Test
+          </body>
+        EOS
+      )
+      expect(content.include_body?).must_equal true
+    end
+
+    it "returns false if not including body tag" do
+      content = Middleman::Emojifire::Content.new(
+        <<~EOS
+          <head>
+            <title>Test</title>
+          </head>
+        EOS
+      )
+      expect(content.include_body?).must_equal false
+    end
+
+    it "returns false if including body but not tag" do
+      content = Middleman::Emojifire::Content.new(
+        <<~EOS
+          body
+          /body
+        EOS
+      )
+      expect(content.include_body?).must_equal false
+    end
+  end
+
+  describe "body_only" do
+    it "yields body of content only" do
+      content = Middleman::Emojifire::Content.new(
+        <<~EOS
+          <head>
+            <title>Test</title>
+          </head>
+          <body>Expect this to be yielded</body>
+        EOS
+      )
+
+      content.body_only do |body|
+        expect(body).must_equal "<body>Expect this to be yielded</body>"
+      end
+    end
+
+    it "returns substituted content" do
+      content = Middleman::Emojifire::Content.new("<head></head><body>Expect this to be substituted</body>")
+      substituted_content = content.body_only { |body| "<body>substituted!</body>" }
+      expect(substituted_content).must_equal "<head></head><body>substituted!</body>"
+    end
+  end
+
+  describe "to_s" do
+    it "returns source" do
+      content = Middleman::Emojifire::Content.new("pewpewpew")
+      expect(content.to_s).must_equal "pewpewpew"
+    end
+  end
+end

data/test/converter_test.rb

@@ -0,0 +1,48 @@
+require "test_helper"
+require "middleman-emojifire/converter"
+
+describe Middleman::Emojifire::Converter do
+  describe "convert" do
+    it "converted emoji aliases in content with body" do
+      converter = Middleman::Emojifire::Converter.new(
+        <<~EOS
+          <head>
+            <title>:cat:</title>
+          </head>
+          <body>
+            :cat:
+            :shipit:
+          </body>
+        EOS
+      )
+
+      html = <<~EOS
+        <head>
+          <title>:cat:</title>
+        </head>
+        <body>
+          <span class="emoji" data-alias="cat" data-fallback="https://assets-cdn.github.com/images/icons/emoji/unicode/1f431.png">🐱</span>
+          <span class="emoji" data-alias="shipit" style="overflow: hidden; display: inline-block; width: 1em; height: 1em; margin: 0 0.1em; background-size: 100% 100%; background-image: url('https://assets-cdn.github.com/images/icons/emoji/shipit.png');"></span>
+        </body>
+       EOS
+
+      expect(converter.convert).must_equal html
+    end
+
+    it "converted emoji aliases in content without body" do
+      converter = Middleman::Emojifire::Converter.new(
+        <<~EOS
+          :cat:
+          :shipit:
+        EOS
+      )
+
+      html = <<~EOS
+        <span class="emoji" data-alias="cat" data-fallback="https://assets-cdn.github.com/images/icons/emoji/unicode/1f431.png">🐱</span>
+        <span class="emoji" data-alias="shipit" style="overflow: hidden; display: inline-block; width: 1em; height: 1em; margin: 0 0.1em; background-size: 100% 100%; background-image: url('https://assets-cdn.github.com/images/icons/emoji/shipit.png');"></span>
+       EOS
+
+      expect(converter.convert).must_equal html
+    end
+  end
+end

data/test/emoji_extension_test.rb

@@ -0,0 +1,39 @@
+require "test_helper"
+require "middleman-emojifire/ext/emoji_extension"
+
+class Dummy
+  using Middleman::Emojifire::EmojiExtension
+
+  def initialize
+    @emoji = Emoji::Character.new("cat")
+  end
+
+  def raw_unicode_character_html_test
+    @emoji.raw_unicode_character_html
+  end
+
+  def fallback_image_html_test
+    @emoji.fallback_image_html
+  end
+end
+
+describe Middleman::Emojifire::EmojiExtension do
+  describe "raw_unicode_character_html" do
+    it "returns html for displaying raw unicode emoji character" do
+      dummy_class = Dummy.new
+      html = '<span class="emoji" data-alias="cat" ' \
+        'data-fallback="https://assets-cdn.github.com/images/icons/emoji/cat.png"></span>'
+      expect(dummy_class.raw_unicode_character_html_test).must_equal html
+    end
+  end
+
+  describe "fallback_image_html" do
+    it "returns html for displaying fallback image instead of raw unicode emoji character" do
+      dummy_class = Dummy.new
+      html = '<span class="emoji" data-alias="cat" style="overflow: hidden; display: ' \
+        'inline-block; width: 1em; height: 1em; margin: 0 0.1em; background-size: 100% 100%; ' \
+        'background-image: url(\'https://assets-cdn.github.com/images/icons/emoji/cat.png\');"></span>'
+      expect(dummy_class.fallback_image_html_test).must_equal html
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1 @@
+require "minitest/autorun"

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: middleman-emojifire
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Hirofumi Wakasugi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: gemoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.10'
+description: middleman-emojifire is a quite easy-to-use emoji extension for Middleman.
+email:
+- baenej@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- features/support/env.rb
+- lib/middleman-emojifire.rb
+- lib/middleman-emojifire/content.rb
+- lib/middleman-emojifire/converter.rb
+- lib/middleman-emojifire/ext/emoji_extension.rb
+- lib/middleman-emojifire/extension.rb
+- lib/middleman-emojifire/version.rb
+- middleman-emojifire.gemspec
+- test/content_test.rb
+- test/converter_test.rb
+- test/emoji_extension_test.rb
+- test/test_helper.rb
+homepage: https://github.com/5t111111/middleman-emojifire
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Middleman emoji extension
+test_files:
+- features/support/env.rb
+- test/content_test.rb
+- test/converter_test.rb
+- test/emoji_extension_test.rb
+- test/test_helper.rb