gemoji-parser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f5c233d77c332dabf52ca117a87ac008e0df2c2
+  data.tar.gz: 79876f028d01361d173c93de9ca527ee6ec71c7b
+SHA512:
+  metadata.gz: 20e96eb56067495de4b03295e5484853bf86162d0773203f8b67c7eff47bf1ffda05d8753c67c575fe4dd502e68ffbee231a40f75f2db94eb2908b95db1d52e6
+  data.tar.gz: d24710b9c58651f74749ff7fcf2efb00440b04102ffe511e8eaa1b54b066ed5169c9074d8b37eacfb3a6a33fce06117919fc50f77798a08203b2144272eab365

data/.gitignore

@@ -0,0 +1,15 @@
+.DS_Store
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Greg MacWilliam
+
+MIT License
+
+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,92 @@
+# gemoji-parser
+
+The missing helper methods for [GitHub's Gemoji](https://github.com/github/gemoji) gem. This utility provides a parsing API for the `Emoji` corelib (provided by Gemoji). The parser includes quick tokenizers for transforming unicode symbols (🐠) into token symbols (`:tropical_fish:`), and arbitrary block replacement methods for custom formatting of symbols.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gemoji-parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gemoji-parser
+
+To run tests:
+
+	$ be rake spec
+
+## Usage
+
+
+### Tokenizing
+
+These methods perform basic conversions of unicode symbols to token symbols, and vice versa.
+
+```ruby
+EmojiParser.tokenize("Test 🙈 🙊 🙉")
+# "Test :see_no_evil: :speak_no_evil: :hear_no_evil:"
+
+EmojiParser.detokenize("Test :see_no_evil: :speak_no_evil: :hear_no_evil:")
+# "Test 🙈 🙊 🙉"
+```
+
+### Block Parsing
+
+For custom symbol transformations, use the block parser methods. All parsers yeild Gemoji `Emoji::Character` instances into the parsing block for custom formatting.
+
+**Unicode symbols**
+
+```ruby
+EmojiParser.parse_unicode('Test 🐠') do |emoji|
+  %Q(<img src="#{emoji.image_filename}" alt=":#{emoji.name}:">).html_safe
+end
+
+# 'Test <img src="unicode/1F420.png" alt=":tropical_fish:">'
+```
+
+**Token symbols**
+
+```ruby
+EmojiParser.parse_tokens('Test :tropical_fish:') do |emoji|
+  %Q(<img src="#{emoji.image_filename}" alt=":#{emoji.name}:">).html_safe
+end
+
+# 'Test <img src="unicode/1F420.png" alt=":tropical_fish:">'
+```
+
+**All symbols**
+
+```ruby
+EmojiParser.parse_all('Test 🐠 :tropical_fish:') { |emoji| emoji.hex_inspect }
+
+# 'Test 1f420 1f420'
+```
+
+### File Paths
+
+A helper is provided for formatting custom filepaths beyond the Gemoji default. This may be useful if you'd like to upload your images to a CDN, and simply reference them from there:
+
+```ruby
+fish = Emoji.find_by_alias('tropical_fish')
+EmojiParser.filepath(fish, '//cdn.fu/emoji/')
+# "//cdn.fu/emoji/1F420.png"
+```
+
+## Shoutout
+
+Thanks to the GitHub team for the [Gemoji](https://github.com/github/gemoji) gem. They're handling all the heavy lifting.
+
+## Contributing
+
+1. Fork it ( https://github.com/gmac/gemoji-parser/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+
+# RSpec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/gemoji-parser.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gemoji-parser/version'
+
+Gem::Specification.new do |s|
+  s.name          = "gemoji-parser"
+  s.version       = EmojiParser::VERSION
+  s.authors       = ["Greg MacWilliam"]
+  s.email         = ["greg.macwilliam@voxmedia.com"]
+  s.summary       = %q{The missing helper methods for GitHub's Gemoji gem.}
+  s.description   = %q{Parses emoji unicode symbols and string tokens, allowing for customizable transformations.}
+  s.homepage      = "https://github.com/gmac/gemoji-parser"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '> 1.9'
+  
+  s.add_dependency "gemoji", ">= 2.1.0"
+  s.add_development_dependency "bundler", "~> 1.6"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency 'rspec'
+end

data/lib/gemoji-parser.rb

@@ -0,0 +1,63 @@
+require 'gemoji-parser/version'
+require 'gemoji'
+
+module EmojiParser
+  extend self
+
+  # Generates a regular expression for matching emoji unicodes.
+  # Call with "rehash: true" to regenerate the cached regex.
+  def emoji_regexp(opts = {})
+    return @emoji_regexp if defined?(@emoji_regexp) && !opts[:rehash]
+    patterns = []
+
+    Emoji.all.each do |emoji|
+      u = emoji.unicode_aliases.map do |str|
+        str.codepoints.map { |c| '\u{%s}' % c.to_s(16).rjust(4, '0') }.join('')
+      end
+      # Append unicode patterns longest first for broader match:
+      patterns.concat u.sort! { |a, b| b.length - a.length }
+    end
+
+    @emoji_regexp = Regexp.new("(#{patterns.join('|')})")
+  end
+
+  # Parses all unicode emoji characters within a string.
+  # Provide a block that performs the character transformation.
+  def parse_unicode(text)
+    text.gsub(emoji_regexp) do |match|
+      emoji = Emoji.find_by_unicode($1)
+      block_given? && emoji ? yield(emoji) : match
+    end
+  end
+
+  # Parses all emoji tokens within a string.
+  # Provide a block that performs the token transformation.
+  def parse_tokens(text)
+    text.gsub(/:([\w+-]+):/) do |match|
+      emoji = Emoji.find_by_alias($1.to_s)
+      block_given? && emoji ? yield(emoji) : match
+    end
+  end
+
+  # Parses all emoji unicodes and tokens within a string.
+  # Provide a block that performs all transformations.
+  def parse_all(text)
+    text = parse_unicode(text) { |emoji| yield(emoji) }
+    parse_tokens(text) { |emoji| yield(emoji) }
+  end
+
+  # Transforms all unicode emoji into token strings.
+  def tokenize(text)
+    parse_unicode(text) { |emoji| ":#{emoji.name}:" }
+  end
+
+  # Transforms all token strings into unicode emoji.
+  def detokenize(text)
+    parse_tokens(text) { |emoji| emoji.raw }
+  end
+
+  # Generates a custom emoji file path.
+  def filepath(emoji, path='/')
+    [path.sub(/\/$/, ''), emoji.image_filename.split('/').pop].join('/')
+  end
+end

data/lib/gemoji-parser/version.rb

@@ -0,0 +1,3 @@
+module EmojiParser
+  VERSION = "1.0.0"
+end

data/spec/emoji_helper_spec.rb

@@ -0,0 +1,88 @@
+# coding: utf-8
+require 'gemoji-parser'
+
+describe EmojiParser do
+  let(:test_unicode) { 'Test 🙈 🙊 🙉 😰 :invalid: 🐠.' }
+  let(:test_mixed) { 'Test 🙈 🙊 🙉 :cold_sweat: :invalid: :tropical_fish:.' }
+  let(:test_tokens) { 'Test :see_no_evil: :speak_no_evil: :hear_no_evil: :cold_sweat: :invalid: :tropical_fish:.' }
+
+  describe '#emoji_regexp' do
+    it 'generates once and remains cached.' do
+      first = EmojiParser.emoji_regexp
+      second = EmojiParser.emoji_regexp
+      expect(first).to be second
+    end
+
+    it 'regenerates when called with a :rehash option.' do
+      first = EmojiParser.emoji_regexp
+      second = EmojiParser.emoji_regexp(rehash: true)
+      expect(first).not_to be second
+    end
+  end
+
+  describe '#parse_unicode' do
+    it 'replaces all valid emoji unicode via block transformation.' do
+      parsed = EmojiParser.parse_unicode(test_mixed) { |emoji| 'X' }
+      expect(parsed).to eq "Test X X X :cold_sweat: :invalid: :tropical_fish:."
+    end
+  end
+
+  describe '#parse_tokens' do
+    it 'replaces all valid emoji tokens via block transformation.' do
+      parsed = EmojiParser.parse_tokens(test_tokens) { |emoji| 'X' }
+      expect(parsed).to eq "Test X X X X :invalid: X."
+    end
+  end
+
+  describe '#parse_all' do
+    it 'replaces all valid emoji unicode and tokens via block transformation.' do
+      parsed = EmojiParser.parse_all(test_mixed) { |emoji| 'X' }
+      expect(parsed).to eq "Test X X X X :invalid: X."
+    end
+  end
+
+  describe '#tokenize' do
+    it 'successfully tokenizes all Gemoji unicode aliases.' do
+      Emoji.all.each do |emoji|
+        emoji.unicode_aliases.each do |u|
+          tokenized = EmojiParser.tokenize("Test #{u}")
+          expect(tokenized).to eq "Test :#{emoji.name}:"
+        end
+      end
+    end
+
+    it 'replaces all valid emoji unicodes with their token equivalent.' do
+      tokenized = EmojiParser.tokenize(test_mixed)
+      expect(tokenized).to eq test_tokens
+    end
+  end
+
+  describe '#detokenize' do
+    it 'replaces all valid emoji tokens with their raw unicode equivalent.' do
+      tokenized = EmojiParser.detokenize(test_mixed)
+      expect(tokenized).to eq test_unicode
+    end
+  end
+
+  describe '#filepath' do
+    let (:test_emoji) { Emoji.find_by_alias('de') }
+    let (:test_file) { '1f1e9-1f1ea.png' }
+
+    it 'formats a Gemoji image path as a root location by default.' do
+      path = EmojiParser.filepath(test_emoji)
+      expect(path).to eq "/#{test_file}"
+    end
+
+    it 'formats a Gemoji image path as a custom location (with trailing slash).' do
+      images_path = '//fonts.test.com/emoji/'
+      path = EmojiParser.filepath(test_emoji, images_path)
+      expect(path).to eq "#{images_path}#{test_file}"
+    end
+
+    it 'formats a Gemoji image path to a custom location (no trailing slash).' do
+      images_path = '//fonts.test.com/emoji'
+      path = EmojiParser.filepath(test_emoji, images_path)
+      expect(path).to eq "#{images_path}/#{test_file}"
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: gemoji-parser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Greg MacWilliam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gemoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parses emoji unicode symbols and string tokens, allowing for customizable
+  transformations.
+email:
+- greg.macwilliam@voxmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemoji-parser.gemspec
+- lib/gemoji-parser.rb
+- lib/gemoji-parser/version.rb
+- spec/emoji_helper_spec.rb
+homepage: https://github.com/gmac/gemoji-parser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: The missing helper methods for GitHub's Gemoji gem.
+test_files:
+- spec/emoji_helper_spec.rb