twemoji 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30d5595bf4c341a2f7b960d79941a08571184fb3
-  data.tar.gz: 1ba40ad4ea3c925acbca7a7cdd7e3ba1bf3fa9b0
+  metadata.gz: 23f6e3897cb5f1b31ad0c451f43db2b9aaa0cc66
+  data.tar.gz: ebd4be4bf5d973818ee506f13fc9c4ec79d8ad39
 SHA512:
-  metadata.gz: e3d2628da8e26b765f96944e8a93328cfebb747fae0c13fb88db09cf72c1fab1f0d36cb9e4a05c8e3c4f31ff56ee88bb05b0690f77a10da2b7c00ee8963b5e40
-  data.tar.gz: 9bd3620246f497178f7f6f13997ee83834ee90b005a130a1a787e25cf4726be049700976c1588789d3efe1378fb87412f227a68d5b72f48246d9b035c345dfa4
+  metadata.gz: 595e24e32a9371f00baca715dbf793b04327dfda9ef66aae9bba22a5b70b7737ed07fdf6b2e3c4bca8c9f33332bbef0d9a4768cac5ec8c183adcec00fee0f721
+  data.tar.gz: 2ba21f666a4831af30563d3d9dd8b494947cf6c7a6969e4c4f8b0e54d8535c066e658ad4ea73abb493f7de6a0196143991ff9f2e22b3d1cb732d8bcd9402a229

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+sudo: false
+bundler_args: --retry=3 --jobs=3
+
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - jruby
+  - jruby-19mode
+  - jruby-head
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: jruby
+    - rvm: jruby-19mode
+    - rvm: juby-head
+    - rvm: ruby-head
+  fast_finish: true

data/Gemfile

@@ -6,6 +6,7 @@ gemspec
 group :development do
   gem "rake"
   gem "bundler"
+  gem "pry"
 end
 
 group :test do

data/README.md

@@ -1,6 +1,12 @@
 # Twemoji
 
-Get imoji img by text.
+[![Gem Version](http://img.shields.io/gem/v/twemoji.svg)][gem]
+[![Build Status](https://travis-ci.org/jollygoodcode/twemoji.svg)][travis]
+
+[gem]: https://rubygems.org/gems/twemoji
+[travis]: https://travis-ci.org/jollygoodcode/twemoji
+
+Twitter Emoji has a official JavaScript implementation of [twemoji](https://github.com/twitter/twemoji). This RubyGem Twemoji is a minimum implementation in Ruby, does not implement all its features.
 
 ## Installation
 
@@ -33,24 +39,24 @@ Or install it yourself as:
 
 ```ruby
 > Twemoji.find_by_code("1f60d")
-=> "1f60d"
+=> ":heart_eyes:"
 ```
 
 #### `.find_by` text or code
 
 ```ruby
-> Twemoji.find_by(text: ':heart_eyes:')
+> Twemoji.find_by(text: ":heart_eyes:")
 => 1f60d
 
-> Twemoji.find_by(code: '1f60d')
+> Twemoji.find_by(code: "1f60d")
 => :heart_eyes:
 ```
 
 #### `.parse`
 
 ```ruby
-> Twemoji.parse 'I like chocolate :heart_eyes:!'
-=> 'I like chololate <img class="emoji" draggable="false" alt=":heart_eyes:" src="https://twemoji.maxcdn.com/36x36/1f60d.png">'
+> Twemoji.parse "I like chocolate :heart_eyes:!"
+=> 'I like chololate <img class="emoji" draggable="false" alt=":heart_eyes:" src="https://twemoji.maxcdn.com/16x16/1f60d.png">'
 ```
 
 ##### asset_root
@@ -58,42 +64,40 @@ Or install it yourself as:
 Default assets root url, by default will be `https://twemoji.maxcdn.com/`:
 
 ```ruby
-> Twemoji.parse 'I like chocolate :heart_eyes:!', base: 'foocdn.com'
-=> 'I like chololate <img class="emoji" draggable="false" alt=":heart_eyes:" src="https://foocdn.com/36x36/1f60d.png">'
+> Twemoji.parse 'I like chocolate :heart_eyes:!', asset_root: "foocdn.com"
+=> 'I like chololate <img class="emoji" draggable="false" alt=":heart_eyes:" src="https://foocdn.com/16x16/1f60d.png">'
 ```
 
 ##### file_ext
 
-Default assets file extensions, by default '.svg'.
+Default assets file extensions, by default `.png`.
 
 ```ruby
-> Twemoji.parse 'I like chocolate :heart_eyes:!', ext: '.png'
-=> 'I like chololate <img class="emoji" draggable="false" alt=":heart_eyes:" src="https://twemoji.maxcdn.com/16x16/1f60d.png">'
+> Twemoji.parse 'I like chocolate :heart_eyes:!', file_ext: ".svg"
+=> 'I like chololate <img class="emoji" draggable="false" alt=":heart_eyes:" src="https://twemoji.maxcdn.com/svg/1f60d.svg">'
 ```
 
 ##### image_size
 
-Default assets/folder size, by default "36x36". Available via Twitter CDN: 16, 36, 72
-
-Only applicable when file_ext is .png.
+Default assets/folder size, by default `"16x16"`. Available via Twitter CDN: `16`, `36`, `72`.
 
 ```ruby
-> Twemoji.parse 'I like chocolate :heart_eyes:!', size: "72x72"
-=> 'I like chololate <img class="emoji" draggable="false" alt=":heart_eyes:" src="https://foocdn.com/72x72/1f60d.png">'
+> Twemoji.parse 'I like chocolate :heart_eyes:!', image_size: "72x72"
+=> 'I like chololate <img class="emoji" draggable="false" alt=":heart_eyes:" src="https://twemoji.maxcdn.com/72x72/1f60d.png">'
 ```
 
 ##### class_name
 
-Default img css class name, by default "emoji".
+Default img css class name, by default `"emoji"`.
 
 ```ruby
-> Twemoji.parse 'I like chocolate :heart_eyes:!', class_name: 'superemoji'
-=> 'I like chololate <img class="superemoji" draggable="false" alt=":heart_eyes:" src="https://foocdn.com/72x72/1f60d.png">'
+> Twemoji.parse 'I like chocolate :heart_eyes:!', class_name: "superemoji"
+=> 'I like chololate <img class="superemoji" draggable="false" alt=":heart_eyes:" src="https://twemoji.maxcdn.com/16x16/1f60d.png">'
 ```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/twemoji/fork )
+1. Fork it ( https://github.com/jollygoodcode/twemoji/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`)

data/lib/twemoji.rb

@@ -3,20 +3,23 @@ require "nokogiri"
 require "twemoji/version"
 require "twemoji/map"
 
+# Twemoji is a Ruby implementation, parses your text, replace emoji text
+# with corresponding emoji image. Default emoji images are from Twiiter CDN.
 module Twemoji
   # Find code by text and find text by code.
   #
   # @example Usage
-  #
   #   Twemoji.find_by(text: :heart_eyes:) # => "1f60d"
-  #   Twemoji.find_by(code: :1f60d:)      # => "heart_eyes"
+  #   Twemoji.find_by(code: :1f60d:)      # => ":heart_eyes:"
   #
   # @option options [String] (optional) :text
   # @option options [String] (optional) :code
   #
-  # @return [String] Text or Code
+  # @return [String] Text or Code.
   def self.find_by(*args, text: nil, code: nil)
-    raise "Can only specify text or code one at a time" if text && code
+    if text && code
+      raise ArgumentError, "Can only specify text or code one at a time"
+    end
 
     if text
       find_by_text text
@@ -25,30 +28,26 @@ module Twemoji
     end
   end
 
-  # Find emoji code by text
+  # Find emoji code by emoji text
   #
   # @example Usage
-  #
   #   Twemoji.find_by_text ":heart_eyes:"
   #   => "1f60d"
   #
-  # @param text [String] Text to find emoji code
-  #
-  # @return [String] Emoji Code
+  # @param text [String] Text to find emoji code.
+  # @return [String] Emoji Code.
   def self.find_by_text(text)
     CODES[must_str(text)]
   end
 
-  # Find text by emoji code
+  # Find emoji text by emoji code.
   #
   # @example Usage
-  #
   #   Twemoji.find_by_code "1f60d"
   #   => ":heart_eyes:"
   #
-  # @param code [String] Emoji code to find text
-  #
-  # @return [String] Text
+  # @param code [String] Emoji code to find text.
+  # @return [String] Emoji Text.
   def self.find_by_code(code)
     ICODES[must_str(code)]
   end
@@ -56,63 +55,78 @@ module Twemoji
   # Parse text, replace emoji text with image.
   #
   # @example Usage
-  #
   #   Twemoji.parse("I like chocolate :heart_eyes:!")
   #   => => 'I like chololate <img class="emoji" draggable="false" alt=":heart_eyes:" src="https://twemoji.maxcdn.com/svg/1f60d.svg">'
   #
-  # @param text [String] source text to parse.
+  # @param text [String] Source text to parse.
   #
   # @option options [String] (optional) asset_root Asset root url to serve emoji.
-  # @option options [String] (optional) asset_path Folder where you store your emoji images.
   # @option options [String] (optional) file_ext   File extension.
   # @option options [String] (optional) image_size Emoji image's size 16, 36, 72 applicable if specify .png.
   # @option options [String] (optional) class_name Emoji image's css class name.
   #
-  # @return [String]
+  # @return [String] Original text with all occurrences of emoji text
+  # replaced by emoji image according to given options.
   def self.parse(text, asset_root: "https://twemoji.maxcdn.com/",
-                       asset_path: "",
-                       file_ext:   ".svg",
+                       file_ext:   ".png",
                        image_size: "16x16",
                        class_name: "emoji")
 
     options[:asset_root] = asset_root
-    options[:asset_path] = asset_path
     options[:file_ext]   = file_ext
     options[:image_size] = image_size
     options[:class_name] = class_name
 
-    if text.kind_of?(String)
-      parse_html(text)
-    else
+    if text.kind_of?(Nokogiri::HTML::DocumentFragment)
       parse_document(text)
+    else
+      parse_html(text)
     end
   end
 
-  # Return all emoji patterns' regexp
+  # Return all emoji patterns' regular expressions.
+  #
+  # @return [RegExp] A Regular expression consists of all emojis text.
   def self.emoji_pattern
     @emoji_pattern ||= /(#{CODES.keys.each { |name| Regexp.escape(name) }.join("|") })/
   end
 
   private
-    # Ensure text is string
-    #
-    # @param text [String]
+
+    # Ensure text is a string.
     #
-    # @return [String]
+    # @param text [String] Text to ensure to be a string.
+    # @return [String] A String.
+    # @private
     def self.must_str(text)
       text = text.respond_to?(:to_str) ? text.to_str : text.to_s
     end
 
+    # Options hash for Twemoji.
+    #
+    # @return [Hash] Hash of options.
+    # @private
     def self.options
       @options ||= {}
     end
 
+    # Parse a HTML String, replace emoji text with corresponding emoji image.
+    #
+    # @param text [String] Text string to be parse.
+    # @return [String] Text with emoji text replaced by emoji image.
+    # @private
     def self.parse_html(text)
       return text if !text.include?(":")
 
       filter_emojis(text)
     end
 
+    # Parse a Nokogiri::HTML::DocumentFragment document, replace emoji text
+    # with corresponding emoji image.
+    #
+    # @param doc [Nokogiri::HTML::DocumentFragment] Document to parse.
+    # @return [Nokogiri::HTML::DocumentFragment] Parsed document.
+    # @private
     def self.parse_document(doc)
       doc.search('text()').each do |node|
         content = node.to_html
@@ -125,25 +139,53 @@ module Twemoji
       doc
     end
 
+    # Find out if a node with given exclude tags has ancestors.
+    #
+    # @param node [Nokogiri::XML::Text] Text node to find ancestor.
+    # @param tags [Array] Array of String represents tags.
+    # @return [Boolean] If has ancestor returns true, otherwise falsy (nil).
+    # @private
+    def self.has_ancestor?(node, tags)
+      while node = node.parent
+        if tags.include?(node.name.downcase)
+          break true
+        end
+      end
+    end
+
+    # Filter emoji text in content, replaced by corresponding emoji image.
+    #
+    # @param content [String] Contetn to filter emoji text to image.
+    # @return [String] Returns a String just like content with all emoji text
+    #                  replaced by the corresponding emoji image.
+    # @private
     def self.filter_emojis(content)
       content.gsub(emoji_pattern) { |match| img_tag(match) }
     end
 
+    # Returns emoji image by given name and options from `Twemoji.parse`.
+    #
+    # @param name [String] Emoji name to generate image tag.
+    # @return [String] Emoji image tag generated by name and options.
+    # @private
     def self.img_tag(name)
       "<img class='#{options[:class_name]}' draggable='false' title='#{name}' alt='#{name}' src='#{emoji_url(name)}'>"
     end
 
+    # Returns emoji url by given name and options from `Twemoji.parse`.
+    #
+    # @param name [String] Emoji name to generate image url.
+    # @return [String] Emoji image tag generated by name and options.
+    # @private
     def self.emoji_url(name)
       code = find_by_text(name)
 
-      if options[:file_ext] == ".svg"
-        File.join(options[:asset_root], "svg", "#{code}.svg")
-      elsif !options[:asset_path].empty?
-        File.join(options[:asset_root], options[:asset_path], "#{code}.#{options[:file_ext]}")
-      elsif options[:file_ext] == ".png"
+      if options[:file_ext] == ".png"
         File.join(options[:asset_root], options[:image_size], "#{code}.png")
+      elsif options[:file_ext] == ".svg"
+        File.join(options[:asset_root], "svg", "#{code}.svg")
       else
-        File.join(options[:asset_root], options[:image_size], "#{code}.#{options[:file_ext]}")
+        raise RuntimeError, "Unspported file extension: #{options[:file_ext]}"
       end
     end
 end

data/lib/twemoji/map.rb

@@ -1,14 +1,11 @@
 module Twemoji
-  # String to hex map
-  #
-  # This hash is frozen.
+  # Emoji Text to Codepoint mappings. This hash is frozen.
   #
   # @example Usage
-  #
   #   CODES[:smile:] # => "1f604"
   #   CODES[:notebook_with_decorative_cover:] # => "1f4d4"
-  #
   # @return [Hash<String => String>]
+  # @private
   CODES = {
   ":smile:"                           => "1f604",
   ":laughing:"                        => "1f606",
@@ -839,15 +836,13 @@ module Twemoji
   ":zero:"                            => "30-20e3"
   }.each { | k, v| k.freeze; v.freeze }.freeze
 
-  # Hex to string map
-  #
-  # This hash is frozen.
+  # Emoji Codepoint to Text mappings. This hash is frozen.
   #
   # @example Usage
-  #
   #   ICODES["1f60d"] # => ":heart_eyes:"
   #   ICODES["1f4d4"] # => ":notebook_with_decorative_cover:"
   #
   # @return [Hash<String => String>]
+  # @private
   ICODES = CODES.invert.freeze
 end

data/lib/twemoji/version.rb

@@ -1,3 +1,3 @@
 module Twemoji
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/test/twemoji_test.rb

@@ -21,19 +21,60 @@ class TwemojiTest < Minitest::Test
     assert_equal ":heart_eyes:", Twemoji.find_by(code: "1f60d")
   end
 
-  def test_emoji_pattern
-    assert_kind_of Regexp, Twemoji.emoji_pattern
+  def test_finder_methods_cannot_find_by_both
+    exception = assert_raises ArgumentError do
+      Twemoji.find_by(text: ":heart_eyes:", code: "1f60d")
+    end
+
+    assert_equal "Can only specify text or code one at a time", exception.message
+  end
+
+  def test_parse_html_string
+    expected = "I like chocolate <img class='emoji' draggable='false' title=':heart_eyes:' alt=':heart_eyes:' src='https://twemoji.maxcdn.com/16x16/1f60d.png'>!"
+
+    assert_equal expected, Twemoji.parse("I like chocolate :heart_eyes:!")
+  end
+
+  def test_parse_document
+    doc  = Nokogiri::HTML::DocumentFragment.parse("<p>I like chocolate :heart_eyes:!</p>")
+    expected = '<p>I like chocolate <img class="emoji" draggable="false" title=":heart_eyes:" alt=":heart_eyes:" src="https://twemoji.maxcdn.com/16x16/1f60d.png">!</p>'
+
+    assert_equal expected, Twemoji.parse(doc).to_html
+  end
+
+  def test_parse_option_asset_root
+    expected = "I like chocolate <img class='emoji' draggable='false' title=':heart_eyes:' alt=':heart_eyes:' src='https://emoji.bestcdn.com/16x16/1f60d.png'>!"
+
+    assert_equal expected, Twemoji.parse("I like chocolate :heart_eyes:!", asset_root: 'https://emoji.bestcdn.com')
   end
 
-  def test_parse
+  def test_parse_option_file_ext_svg
     expected = "I like chocolate <img class='emoji' draggable='false' title=':heart_eyes:' alt=':heart_eyes:' src='https://twemoji.maxcdn.com/svg/1f60d.svg'>!"
 
-    assert_equal expected, Twemoji.parse('I like chocolate :heart_eyes:!')
+    assert_equal expected, Twemoji.parse("I like chocolate :heart_eyes:!", file_ext: '.svg')
+  end
+
+  def test_parse_option_unsupport_file_ext_gif
+    exception = assert_raises RuntimeError do
+      Twemoji.parse("I like chocolate :heart_eyes:!", file_ext: '.gif')
+    end
+
+    assert_equal "Unspported file extension: .gif", exception.message
   end
 
-  def test_parse_with_different_cdn
-    expected = "I like chocolate <img class='emoji' draggable='false' title=':heart_eyes:' alt=':heart_eyes:' src='https://emoji.bestcdn.com/svg/1f60d.svg'>!"
+  def test_parse_option_image_size
+    expected = "I like chocolate <img class='emoji' draggable='false' title=':heart_eyes:' alt=':heart_eyes:' src='https://twemoji.maxcdn.com/72x72/1f60d.png'>!"
+
+    assert_equal expected, Twemoji.parse("I like chocolate :heart_eyes:!", file_ext: ".png", image_size: "72x72")
+  end
 
-    assert_equal expected, Twemoji.parse('I like chocolate :heart_eyes:!', asset_root: 'https://emoji.bestcdn.com')
+  def test_parse_option_class_name
+    expected = "I like chocolate <img class='twemoji' draggable='false' title=':heart_eyes:' alt=':heart_eyes:' src='https://twemoji.maxcdn.com/16x16/1f60d.png'>!"
+
+    assert_equal expected, Twemoji.parse("I like chocolate :heart_eyes:!", class_name: 'twemoji')
+  end
+
+  def test_emoji_pattern
+    assert_kind_of Regexp, Twemoji.emoji_pattern
   end
 end

data/twemoji.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = %w(katehuang0320@gmail.com)
   spec.summary       = %q{A RubyGem to convert :heart: to Twitter cdn url}
   spec.description   = spec.summary
-  spec.homepage      = "https://github.com/JuanitoFatas/twemoji"
+  spec.homepage      = "https://github.com/jollygoodcode/twemoji"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twemoji
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Juanito
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-11 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -33,6 +33,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -43,7 +44,7 @@ files:
 - test/test_helper.rb
 - test/twemoji_test.rb
 - twemoji.gemspec
-homepage: https://github.com/JuanitoFatas/twemoji
+homepage: https://github.com/jollygoodcode/twemoji
 licenses:
 - MIT
 metadata: {}