twemoji 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c06920bca31cca0d6695bd1a6cb0ead8419278c
-  data.tar.gz: 905c191024265cf8b5727d6622b008396b705331
+  metadata.gz: 90100c2eb50b5ac0db62f5637bc68b75047f06b6
+  data.tar.gz: ef47c39ac68d556a1fe59fd0c9ceb64a42d81087
 SHA512:
-  metadata.gz: 89a774a07e59e3f5ac582123c673b9a32e6a97d2b520e5c8b629902ee108c888076379c31ef7813a1a06b97a48dc44bf376334da7ce391e25fca9004346219b5
-  data.tar.gz: eb9926492d5dc315d668dde24a6319db337f1d0ce89617315f0d792d83d74c06e4e95bf24f06247910d9d1e6462b18ddf87cf97fef670643e1d0c4d48384a1c4
+  metadata.gz: 54e064e15efb4e9ec6eec5aba88d591f89ed32c314f033f2583a64d0ec985cc02e575a328191ab5b4975f18d463b159ca3e4347b1ad3f2f943786cded3f81dd2
+  data.tar.gz: c295e141f0f963a00bfd3fd3af5db56c05b44514522815884410fc641410653a3640ed919cf038454d6667d894c3eacb157d479bd85a836e8eda9390b748ee27

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 3.1.0 - 2016.12.13
+
+- `Twemoji.parse` can now parse unicode values, too [#35](https://github.com/jollygoodcode/twemoji/pull/35)
+  * [New API] `Twemoji.emoji_pattern_unicode` - List all emoji unicodes in a regex
+  * [New API] `Twemoji.emoji_pattern_all` - List all emoji names and unicodes in a regex
+
 ## 3.0.2 - 2016.11.15
 
 - Fix handling codepoint less than 0x1000 [#33](https://github.com/jollygoodcode/twemoji/pull/33)

data/README.md

@@ -124,11 +124,29 @@ More options could be passed in, please see [Twemoji.parse options](https://gith
 
 #### `Twemoji.parse`
 
+Parses for both name tokens (e.g. :heart_eyes:) or unicode values (e.g. `\u1f60d`).
+
+Parsing by name token:
+
 ```ruby
 > Twemoji.parse "I like chocolate :heart_eyes:!"
 => 'I like chocolate <img draggable="false" title=":heart_eyes:" alt="😍" src="https://twemoji.maxcdn.com/2/svg/1f60d.svg" class="emoji">!'
 ```
 
+Parsing by name unicode values:
+
+```ruby
+> Twemoji.parse "I like chocolate 😍!"
+=> 'I like chocolate <img draggable="false" title=":heart_eyes:" alt="😍" src="https://twemoji.maxcdn.com/2/svg/1f60d.svg" class="emoji">!'
+```
+
+Parsing by both name and unicode:
+
+```ruby
+> Twemoji.parse ":cookie: 🎂"
+=> '<img draggable="false" title=":cookie:" alt="🍪" src="https://twemoji.maxcdn.com/2/svg/1f36a.svg" class="emoji"> <img draggable="false" title=":birthday:" alt="🎂" src="https://twemoji.maxcdn.com/2/svg/1f382.svg" class="emoji">'
+```
+
 ##### `Twemoji.parse` options
 
 ##### `asset_root`
@@ -185,6 +203,18 @@ attribute value can apply proc-like object, remove `:` from title attribute:
 => /(:mahjong:|:black_joker:| ... |:registered_sign:|:shibuya:)/
 ```
 
+#### `Twemoji.emoji_pattern_unicode`
+
+```ruby
+> Twemoji.emoji_pattern_unicode
+```
+
+#### `Twemoji.emoji_pattern_all` = `emoji_pattern` + `emoji_pattern_unicode`
+
+```ruby
+> Twemoji.emoji_pattern_all
+```
+
 #### JSON for your front-end
 
 We prepare two constants: [Twemoji::PNG](lib/twemoji/png.rb) and [Twemoji::SVG](lib/twemoji/svg.rb) (**not loaded by default**), you need to require them to use:
@@ -279,6 +309,11 @@ A huge THANK YOU to all our [contributors](https://github.com/jollygoodcode/twem
 
 The emoji keywords are from [jollygoodcode/emoji-keywords](https://github.com/jollygoodcode/emoji-keywords).
 
+## Guidelines
+
+This project subscribes to the [Moya Contributors Guidelines](https://github.com/Moya/contributors)
+which TLDR: means we give out push access easily and often.
+
 ## License
 
 Please see the [LICENSE.md](/LICENSE.md) file.

data/lib/twemoji.rb

@@ -70,7 +70,7 @@ module Twemoji
   # @param raw [String] Emoji raw unicode to find text.
   # @return [String] Emoji Text.
   def self.find_by_unicode(raw)
-    invert_codes[raw.split("").map { |r| "%x" % r.ord }.join("-")]
+    invert_codes[unicode_to_str(raw)]
   end
 
   # Render raw emoji unicode from emoji text or emoji code.
@@ -128,6 +128,24 @@ module Twemoji
     @emoji_pattern ||= /(#{codes.keys.map { |name| Regexp.quote(name) }.join("|") })/
   end
 
+  # Return all emoji patterns' regular expressions in unicode.
+  # e.g '1f1f2-1f1fe' will be converted to \u{1f1f2}\u{1f1fe} for RegExp matching.
+  #
+  # @return [RegExp] A Regular expression consists of all emojis unicode.
+  def self.emoji_pattern_unicode
+    @emoji_pattern_unicode ||= /(#{sorted_codepoint_values.map { |name| Regexp.quote(name.split('-').collect {|n| n.hex}.pack("U*")) }.join("|") })/
+  end
+
+  # Return all emoji patterns' regular expressions in unicode and name.
+  #
+  # @return [RegExp] A Regular expression consists of all emojis unicode codepoint and names.
+  def self.emoji_pattern_all
+    names = codes.keys.map { |name| Regexp.quote(name) }.join("|")
+    codepoints = sorted_codepoint_values.map { |name| Regexp.quote(name.split('-').collect {|n| n.hex}.pack("U*")) }.join("|")
+
+    @emoji_pattern_all ||= /(#{names}|#{codepoints})/
+  end
+
   private
 
     # Ensure text is a string.
@@ -150,26 +168,27 @@ module Twemoji
     # Parse a HTML String, replace emoji text with corresponding emoji image.
     #
     # @param text [String] Text string to be parse.
+    # @param filter [Symbol] Symbol of filter function to use. Available filters
+    #                        are :filter_emoji and :filter_emoji_unicode.
     # @return [String] Text with emoji text replaced by emoji image.
     # @private
-    def self.parse_html(text)
-      return text if !text.include?(":")
-
-      filter_emojis(text)
+    def self.parse_html(text, filter = :filter_emojis)
+      self.send(filter, text)
     end
 
     # Parse a Nokogiri::HTML::DocumentFragment document, replace emoji text
     # with corresponding emoji image.
     #
     # @param doc [Nokogiri::HTML::DocumentFragment] Document to parse.
+    # @param filter [Symbol] Symbol of filter function to use. Available filters
+    #                        are :filter_emoji and :filter_emoji_unicode.
     # @return [Nokogiri::HTML::DocumentFragment] Parsed document.
     # @private
-    def self.parse_document(doc)
+    def self.parse_document(doc, filter = :filter_emojis)
       doc.xpath(".//text() | text()").each do |node|
         content = node.to_html
-        next if !content.include?(":")
         next if has_ancestor?(node, %w(pre code tt))
-        html = filter_emojis(content)
+        html = self.send(filter, content)
         next if html == content
         node.replace(html)
       end
@@ -192,12 +211,12 @@ module Twemoji
 
     # Filter emoji text in content, replaced by corresponding emoji image.
     #
-    # @param content [String] Contetn to filter emoji text to image.
+    # @param content [String] Content 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) }
+    def self.filter_emojis(content, pattern = emoji_pattern_all)
+      content.gsub(pattern) { |match| img_tag(match) }
     end
 
     # Returns emoji image tag by given name and options from `Twemoji.parse`.
@@ -206,7 +225,10 @@ module Twemoji
     # @return [String] Emoji image tag generated by name and options.
     # @private
     def self.img_tag(name)
-      img_attrs_hash = default_attrs(name).merge! customized_attrs(name)
+      # choose default attributes based on name or unicode codepoint
+      default_attrs = name.include?(":") ? default_attrs(name) : default_attrs_unicode(name)
+      text_name = name.include?(":") ? name : find_by_unicode(name)
+      img_attrs_hash = default_attrs.merge! customized_attrs(text_name)
 
       %(<img #{hash_to_html_attrs(img_attrs_hash)}>)
     end
@@ -219,8 +241,8 @@ module Twemoji
     # @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)
+    def self.emoji_url(name, finder = :find_by_text)
+      code = self.send(finder, name)
 
       if options[:file_ext] == "png"
         File.join(options[:asset_root], PNG_IMAGE_SIZE, "#{code}.png")
@@ -238,12 +260,18 @@ module Twemoji
     # @return Hash of customized attributes
     # @private
     def self.customized_attrs(name)
-      custom_img_attributes = options[:img_attrs]
+      custom_img_attributes = {}
 
-      # run value filters where given
-      custom_img_attributes.each do |key, value|
-        custom_img_attributes[key] = value.call(name) if value.respond_to?(:call)
+      options[:img_attrs].each do |key, value|
+        # run value filters where given
+        if value.respond_to?(:call)
+          custom_img_attributes[key] = value.call(name)
+        else
+          custom_img_attributes[key] = value
+        end
       end
+
+      custom_img_attributes
     end
 
     # Default img attributes: draggable, title, alt, src.
@@ -260,6 +288,30 @@ module Twemoji
       }
     end
 
+    # Default img attributes for unicode: draggable, title, alt, src.
+    #
+    # @param unicode [String] Emoji unicode codepoint.
+    # @return Hash of default attributes
+    # @private
+    def self.default_attrs_unicode(unicode)
+      {
+        draggable: "false".freeze,
+        title:     find_by_unicode(unicode),
+        alt:       unicode,
+        src:       emoji_url(unicode, :unicode_to_str)
+      }
+    end
+
+    # Convert raw unicode to string key version.
+    #
+    # e.g. 🇲🇾 converts to "1f1f2-1f1fe"
+    # @param unicode [String] Unicode codepoint.
+    # @return String representation of unicode codepoint
+    # @private
+    def self.unicode_to_str(unicode)
+      unicode.split("").map { |r| "%x" % r.ord }.join("-")
+    end
+
     # Coverts hash of attributes into HTML attributes.
     #
     # @param hash [Hash] Hash of attributes.
@@ -268,4 +320,12 @@ module Twemoji
     def self.hash_to_html_attrs(hash)
       hash.map { |attr, value| %(#{attr}="#{value}") }.join(" ")
     end
+
+    # Return sorted codepoint values by descending length.
+    #
+    # @return [Array] An array of emoji codepoint values sorted by descending length
+    def self.sorted_codepoint_values
+      # has to be sorted to match the combined codepoint (2-3 char emojis) before single char emojis
+      @sorted_codepoint_values ||= invert_codes.keys.sort_by {|key| key.length }.reverse
+    end
 end

data/lib/twemoji/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Twemoji
-  VERSION = "3.0.2"
+  VERSION = "3.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twemoji
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Juanito
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-15 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: 'A RubyGem to convert :heart: to Twitter cdn url'