twemoji 2.2.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bfc436e640e850f7fdc7824e7826b16f56edf66
-  data.tar.gz: 11b979a61a808f37fa9de4da1e2f60cf99ac4cd5
+  metadata.gz: ca77ba3081ece95f9a99dd12cea08feb0d46dd52
+  data.tar.gz: f9062643a1cd0b4c95ecc7a7049f15c940b3de18
 SHA512:
-  metadata.gz: 913f9e546e2c208bbdd97de077cd321d07d77e0df4f3734b1d730efbdf54a9afc1060a3ca74f614c422524c53bf4f5dfb3ee5e56552274a2b054702e017a3a91
-  data.tar.gz: 3c59d86cbbd347618a05c5f450a224ef9ce6c6e7f60f8de811d78cb872c4c20d94f28fe21d989f7a454e397094e590a89f3dac216d5ab5351f6c456363d09b57
+  metadata.gz: a7ee8617d645cae1cc5af9e2a7e623c3acd2e770e6162ddcb82c91fa7f38da08831aeab500441d6960a9751d3a90e72ea61b90a02705e6057b2d4335d7e20b17
+  data.tar.gz: fbc093472b082ba45a89fc3cd6fc9a5562c4ece473ed4fb74b6ff1ff0bce21d77dbffb7597ce54e2ebf0e30fff77f50927bc502fb4094b968bf57b5b934cbcae

data/.travis.yml

@@ -1,13 +1,17 @@
 language: ruby
-sudo: false
 bundler_args: "--retry=3 --jobs=3"
+cache: bundler
+sudo: false
 rvm:
-  - 2.0
-  - 2.1
+  - 2.3.1
+  - 2.3.0
   - 2.2
+  - 2.1
+  - 2.0
   - ruby-head
 matrix:
   allow_failures:
+    - rvm: 2.0
     - rvm: ruby-head
   fast_finish: true
 notifications:

data/CHANGELOG.md

@@ -2,9 +2,40 @@
 
 ## Unreleased
 
-## 2.2.2 - 2016.06.09
+## 3.0.0 - 2016.06.08
 
-- Backport [051f5a5](https://github.com/jollygoodcode/twemoji/commit/051f5a57c40f24d8d5caa65b462a9bee01545412) (find by multiple unicodes fix)
+### Features
+
+- Add support to twemoji.js V2
+- Add `Twemoji.svg` (not loaded by default), looks like:
+
+  ```ruby
+  {
+    ...
+    ":heart_eyes:" => "https://twemoji.maxcdn.com/2/svg/1f60d.svg",
+    ...
+  }
+  ```
+
+- Add `Twemoji.png` (not loaded by default), looks like:
+
+  ```ruby
+  {
+    ...
+    ":heart_eyes:" => "https://twemoji.maxcdn.com/2/72x72/1f60d.png",
+    ...
+  }
+  ```
+
+### Breaking Changes
+
+- Require Ruby 2.0+
+- `Twemoji::CODES` changes to `Twemoji.codes`
+- `Twemoji::ICODES` changes to `Twemoji.invert_codes`
+- `asset_root` config default value changed to `https://twemoji.maxcdn.com/2`
+- `file_ext` config default value changed to `svg`, available values are `"svg"` and `"png"`
+- PNG now only has one size `72x72`
+- Remove `Twemoji.to_json` method
 
 ## 2.2.1 - 2016.06.07
 

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in twemoji.gemspec
 gemspec

data/README.md

@@ -14,6 +14,11 @@ This RubyGem `twemoji` is a minimum implementation of Twitter Emoji in Ruby so t
 
 __Note:__ This gem might not implement all the features available in the JavaScript implementation.
 
+## Twemoji Gem and twemoji.js versions
+
+- Twemoji Gem 3.x supports twemoji.js V2 (1661 emojis)
+- Twemoji Gem 2.x supports twemoji.js V1 (874 emojis)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -30,14 +35,6 @@ Or install it yourself as:
 
     $ gem install twemoji
 
-### Ruby 1.9.3 Support
-
-@bramswenson has put in effort to support Ruby 1.9.3, please use [his forked branch](https://github.com/bramswenson/twemoji/tree/ruby-1.9.3):
-
-```ruby
-gem "twemoji", github: "bramswenson/twemoji", branch: "ruby-1.9.3"
-```
-
 ## Integration
 
 - [Integration with `HTML::Pipeline`](https://github.com/jollygoodcode/twemoji/wiki/Integrate-with-HTML%3A%3APipeline)
@@ -57,13 +54,13 @@ end
 In your ERb view:
 
 ```erb
-<%= emojify "I like chocolate :heart_eyes:!", image_size: "36x36" %>
+<%= emojify "I like chocolate :heart_eyes:!" %>
 ```
 
 will render
 
 ```
-I like chocolate <img class="emoji" draggable="false" title=":heart_eyes:" alt="😍" src="https://twemoji.maxcdn.com/36x36/1f60d.png">!
+I like chocolate <img class="emoji" draggable="false" title=":heart_eyes:" alt="😍" src="https://twemoji.maxcdn.com/2/72x72/1f60d.png">!
 ```
 
 More options could be passed in, please see [Twemoji.parse options](https://github.com/jollygoodcode/twemoji#twemojiparse-options) for more details.
@@ -123,38 +120,29 @@ More options could be passed in, please see [Twemoji.parse options](https://gith
 
 ```ruby
 > Twemoji.parse "I like chocolate :heart_eyes:!"
-=> "I like chocolate <img class='emoji' draggable='false' title=':heart_eyes:' alt='😍' src='https://twemoji.maxcdn.com/16x16/1f60d.png'>!"
+=> 'I like chocolate <img draggable="false" title=":heart_eyes:" alt="😍" src="https://twemoji.maxcdn.com/2/svg/1f60d.svg" class="emoji">!'
 ```
 
 ##### `Twemoji.parse` options
 
 ##### `asset_root`
 
-Default assets root url. Defaults to `https://twemoji.maxcdn.com/`:
+Default assets root url. Defaults to `https://twemoji.maxcdn.com/2/`:
 
 ```ruby
-> Twemoji.parse 'I like chocolate :heart_eyes:!', asset_root: "foocdn.com"
-=> "I like chocolate <img class='emoji' draggable='false' title=':heart_eyes:' alt='😍' src='foocdn.com/16x16/1f60d.png'>!"
+> Twemoji.parse "I like chocolate :heart_eyes:!", asset_root: "foocdn.com"
+=> 'I like chocolate <img draggable="false" title=":heart_eyes:" alt="😍" src="foocdn.com/svg/1f60d.svg" class="emoji">!'
 ```
 
 ##### `file_ext`
 
-Default assets file extensions. Defaults to `.png`.
+Default assets file extensions. Defaults to `svg`.
 
-```ruby
-> Twemoji.parse 'I like chocolate :heart_eyes:!', file_ext: ".svg"
-=> "I like chocolate <img class='emoji' draggable='false' title=':heart_eyes:' alt='😍' src='https://twemoji.maxcdn.com/svg/1f60d.svg'>!"
-```
-
-##### `image_size`
-
-Default assets/folder size. Defaults to `"16x16"`.
-
-Sizes available via Twitter CDN: `16`, `36`, `72`.
+Can change to `"png"`:
 
 ```ruby
-> Twemoji.parse 'I like chocolate :heart_eyes:!', image_size: "72x72"
-=> "I like chocolate <img class='emoji' draggable='false' title=':heart_eyes:' alt='😍' src='https://twemoji.maxcdn.com/72x72/1f60d.png'>!"
+> Twemoji.parse 'I like chocolate :heart_eyes:!', file_ext: "png"
+=> 'I like chocolate <img draggable="false" title=":heart_eyes:" alt="😍" src="https://twemoji.maxcdn.com/2/72x72/1f60d.png" class="emoji">!'
 ```
 
 ##### `class_name`
@@ -162,8 +150,8 @@ Sizes available via Twitter CDN: `16`, `36`, `72`.
 Default image CSS class name. Defaults to `"emoji"`.
 
 ```ruby
-> Twemoji.parse 'I like chocolate :heart_eyes:!', class_name: "superemoji"
-=> "I like chocolate <img class='superemoji' draggable='false' title=':heart_eyes:' alt='😍' src='https://twemoji.maxcdn.com/16x16/1f60d.png'>!"
+> Twemoji.parse "I like chocolate :heart_eyes:!", class_name: "superemoji"
+=> 'I like chocolate <img draggable="false" title=":heart_eyes:" alt="😍" src="https://twemoji.maxcdn.com/2/svg/1f60d.svg" class="superemoji">!'
 ```
 
 ##### `img_attrs`
@@ -171,8 +159,8 @@ Default image CSS class name. Defaults to `"emoji"`.
 List of image attributes for the `img` tag. Optional.
 
 ```ruby
-> Twemoji.parse("I like chocolate :heart_eyes:!", class_name: 'twemoji', img_attrs: { style: "height: 1.3em;" })
-=> "I like chocolate <img class='twemoji' draggable='false' title=':heart_eyes:' alt='😍' style='height: 1.3em;' src='https://twemoji.maxcdn.com/16x16/1f60d.png'>!"
+> Twemoji.parse "I like chocolate :heart_eyes:!", class_name: "twemoji", img_attrs: { style: "height: 1.3em;" }
+=> 'I like chocolate <img draggable="false" title=":heart_eyes:" alt="😍" src="https://twemoji.maxcdn.com/2/svg/1f60d.svg" class="twemoji" style="height: 1.3em;">!'
 ```
 
 attribute value can apply proc-like object, remove `:` from title attribute:
@@ -180,58 +168,100 @@ attribute value can apply proc-like object, remove `:` from title attribute:
 ```ruby
 > no_colons = ->(name) { name.gsub(":", "") }
 
-> Twemoji.parse("I like chocolate :heart_eyes:!", class_name: 'twemoji', img_attrs: { title: no_colons })
-=> "I like chocolate <img class='twemoji' draggable='false' title='heart_eyes' alt='😍' src='https://twemoji.maxcdn.com/16x16/1f60d.png'>!"
+> Twemoji.parse "I like chocolate :heart_eyes:!", class_name: "twemoji", img_attrs: { title: no_colons }
+=> 'I like chocolate <img draggable="false" title="heart_eyes" alt="😍" src="https://twemoji.maxcdn.com/2/svg/1f60d.svg" class="twemoji">!'
 ```
 
 #### `Twemoji.emoji_pattern`
 
 ```ruby
 > Twemoji.emoji_pattern
-=> /(:smile:|:laughing:| ... |:womens:|:x:|:zero:)/
+=> /(:mahjong:|:black_joker:| ... |:registered_sign:|:shibuya:)/
 ```
 
-#### `Twemoji.to_json`
+#### JSON for your front-end
 
-Returns emoji json, example of output:
+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:
 
-```json
-{
-  ...
-  ":heart_eyes:": "https://twemoji.maxcdn.com/svg/1f60d.svg"
-  ...
-}
+```ruby
+require "twemoji/png" # If you want to use Twemoji::PNG
+require "twemoji/svg" # If you want to use Twemoji::SVG
 ```
 
-Support `svg` or `png`, `png` can specify size from `16x16`, `36x36` or `72x72`.
+Or require at `Gemfile`:
 
 ```ruby
-> Twemoji.to_json(file_ext: "svg")
+# Require the one you need, require Twemoji::PNG
+gem "twemoji", require: "twemoji/png"
+
+# Or Twemoji::SVG
+gem "twemoji", require: "twemoji/svg"
+
+# Or both
+gem "twemoji", require: ["twemoji/png", "twemoji/svg"]
+```
 
-> Twemoji.to_json(file_ext: "png", image_size: "16x16")
+Then you can do `to_json` to feed your front-end.
 
-> Twemoji.to_json(file_ext: "png", image_size: "36x36")
+You can also make custom format by leverage `Twemoji.codes`:
 
-> Twemoji.to_json(file_ext: "png", image_size: "72x72")
+```html+erb
+# emojis.json.erb
+<%= Twemoji.codes.collect do |code, _|
+  Hash(
+    value: code,
+    html: content_tag(:span, Twemoji.parse(code).html_safe + " #{code}" )
+  )
+end.to_json.html_safe %>
 ```
 
 ## Configuration
 
-`Twemoji.parse` options can be given in configure block:
+`Twemoji.parse` options can be given in configure block, default values are:
 
 ```ruby
 Twemoji.configure do |config|
-  config.asset_root = "https://twemoji.awesomecdn.com/"
-  config.file_ext   = ".svg"
-  config.image_size = nil # only png need to set size
-  config.class_name = "twemoji"
-  config.img_attrs  = { style: "height: 1.3em;" }
+  config.asset_root = "https://twemoji.maxcdn.com/2"
+  config.file_ext   = "svg"
+  config.class_name = "emoji"
+  config.img_attrs  = {}
 end
 ```
 
+Specify additional img attributes like so:
+
+```ruby
+config.img_attrs  = { style: "height: 1.3em;" }
+```
+
+## Tips (from twitter/twemoji)
+
+### Inline Styles
+
+If you'd like to size the emoji according to the surrounding text, you can add the following CSS to your stylesheet:
+
+```css
+img.emoji {
+  height: 1em;
+  width: 1em;
+  margin: 0 .05em 0 .1em;
+  vertical-align: -0.1em;
+}
+```
+
+This will make sure emoji derive their width and height from the font-size of the text they're shown with. It also adds just a little bit of space before and after each emoji, and pulls them upwards a little bit for better optical alignment.
+
+### UTF-8 Character Set
+
+To properly support emoji, the document character must be set to UTF-8. This can done by including the following meta tag in the document <head>
+
+```html
+<meta charset="utf-8">
+```
+
 ## Attribution Requirements
 
-Please follow the [Attribution Requirements](https://github.com/twitter/twemoji#attribution-requirements) as stated on the official Twemoji (JS) repo.
+**IMPORTANT:** Please follow the [Attribution Requirements](https://github.com/twitter/twemoji#attribution-requirements) as stated on the official Twemoji (JS) repo.
 
 ## Contributing
 
@@ -241,6 +271,8 @@ Please see the [CONTRIBUTING.md](/CONTRIBUTING.md) file.
 
 A huge THANK YOU to all our [contributors](https://github.com/jollygoodcode/twemoji/graphs/contributors)! :heart:
 
+The emoji keywords are from [jollygoodcode/emoji-keywords](https://github.com/jollygoodcode/emoji-keywords).
+
 ## License
 
 Please see the [LICENSE.md](/LICENSE.md) file.

data/Rakefile

@@ -4,7 +4,7 @@ require "rake/testtask"
 
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
   t.verbose = true
 end
 

data/lib/twemoji.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require "nokogiri"
 require "json"
 require "twemoji/version"
 require "twemoji/map"
-require "twemoji/json"
 require "twemoji/configuration"
 
 # Twemoji is a Ruby implementation, parses your text, replace emoji text
@@ -12,7 +13,7 @@ module Twemoji
   #
   # @example Usage
   #   Twemoji.find_by(text: ":heart_eyes:") # => "1f60d"
-  #   Twemoji.find_by(code: ":1f60d:")      # => ":heart_eyes:"
+  #   Twemoji.find_by(code: "1f60d")      # => ":heart_eyes:"
   #   Twemoji.find_by(unicode: "😍")        # => ":heart_eyes:"
   #   Twemoji.find_by(unicode: "\u{1f60d}") # => ":heart_eyes:"
   #
@@ -45,7 +46,7 @@ module Twemoji
   # @param text [String] Text to find emoji code.
   # @return [String] Emoji Code.
   def self.find_by_text(text)
-    CODES[must_str(text)]
+    codes[must_str(text)]
   end
 
   # Find emoji text by emoji code.
@@ -57,7 +58,7 @@ module Twemoji
   # @param code [String] Emoji code to find text.
   # @return [String] Emoji Text.
   def self.find_by_code(code)
-    ICODES[must_str(code)]
+    invert_codes[must_str(code)]
   end
 
   # Find emoji text by raw emoji unicode.
@@ -69,7 +70,7 @@ module Twemoji
   # @param raw [String] Emoji raw unicode to find text.
   # @return [String] Emoji Text.
   def self.find_by_unicode(raw)
-    ICODES[must_str(raw.split("").map { |r| "%4.4x" % r.ord }.join("-"))]
+    invert_codes[raw.split("").map { |r| "%4.4x" % r.ord }.join("-")]
   end
 
   # Render raw emoji unicode from emoji text or emoji code.
@@ -92,26 +93,24 @@ module Twemoji
   #
   # @example Usage
   #   Twemoji.parse("I like chocolate :heart_eyes:!")
-  #   => "I like chocolate <img class='emoji' draggable='false' title=':heart_eyes:' alt='😍' src='https://twemoji.maxcdn.com/16x16/1f60d.png'>!"
+  #   => 'I like chocolate <img draggable="false" title=":heart_eyes:" alt="😍" src="https://twemoji.maxcdn.com/2/svg/1f60d.svg" class="emoji">!'
   #
   # @param text [String] Source text to parse.
   #
   # @option options [String] (optional) asset_root Asset root url to serve emoji.
   # @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) img_attrs Emoji image's img tag attributes.
+  # @option options [String] (optional) class_name Emoji image's tag class attribute.
+  # @option options [String] (optional) img_attrs  Emoji image's img tag attributes.
   #
   # @return [String] Original text with all occurrences of emoji text
   # replaced by emoji image according to given options.
   def self.parse(text, asset_root: Twemoji.configuration.asset_root,
                        file_ext:   Twemoji.configuration.file_ext,
-                       image_size: Twemoji.configuration.image_size,
                        class_name: Twemoji.configuration.class_name,
                        img_attrs:  Twemoji.configuration.img_attrs)
 
     options[:asset_root] = asset_root
     options[:file_ext]   = file_ext
-    options[:image_size] = image_size
     options[:img_attrs]  = { class: class_name }.merge! img_attrs
 
     if text.is_a?(Nokogiri::HTML::DocumentFragment)
@@ -125,36 +124,7 @@ module Twemoji
   #
   # @return [RegExp] A Regular expression consists of all emojis text.
   def self.emoji_pattern
-    @emoji_pattern ||= /(#{CODES.keys.map { |name| Regexp.quote(name) }.join("|") })/
-  end
-
-  # Return Twemoji json string, unicode => twemoji CDN url
-  #
-  # @example Output
-  # {
-  #   ":heart_eyes:": "https://twemoji.maxcdn.com/svg/1f60d.svg"
-  # }
-  #
-  # option [String] (optional) :file_ext - image extension: svg or png
-  # option [String] (optional) :image_size - if file_ext is png, can choose size of png from
-  #                                          "16x16", "32x32", "72x72"
-  # @return [String] Twemoji json string
-  def self.to_json(file_ext: "png", image_size: "16x16")
-    output = if file_ext == "svg"
-      Twemoji::SVG
-    elsif file_ext == "png"
-      case image_size
-      when "16x16" then Twemoji::PNG_16x16
-      when "36x36" then Twemoji::PNG_36x36
-      when "72x72" then Twemoji::PNG_72x72
-      else
-        fail %(Unsupported png image size: `#{image_size}', supported: "16x16", "36x36", "72x72".)
-      end
-    else
-      fail %(Unsupported file extension: `#{file_ext}', supported: "png" and "svg".)
-    end
-
-    output.to_json
+    @emoji_pattern ||= /(#{codes.keys.map { |name| Regexp.quote(name) }.join("|") })/
   end
 
   private
@@ -194,7 +164,7 @@ module Twemoji
     # @return [Nokogiri::HTML::DocumentFragment] Parsed document.
     # @private
     def self.parse_document(doc)
-      doc.xpath('.//text() | text()').each do |node|
+      doc.xpath(".//text() | text()").each do |node|
         content = node.to_html
         next if !content.include?(":")
         next if has_ancestor?(node, %w(pre code tt))
@@ -240,6 +210,9 @@ module Twemoji
       %(<img #{hash_to_html_attrs(img_attrs_hash)}>)
     end
 
+    PNG_IMAGE_SIZE = "72x72"
+    private_constant :PNG_IMAGE_SIZE
+
     # Returns emoji url by given name and options from `Twemoji.parse`.
     #
     # @param name [String] Emoji name to generate image url.
@@ -248,9 +221,9 @@ module Twemoji
     def self.emoji_url(name)
       code = find_by_text(name)
 
-      if options[:file_ext] == ".png"
-        File.join(options[:asset_root], options[:image_size], "#{code}.png")
-      elsif options[:file_ext] == ".svg"
+      if options[:file_ext] == "png"
+        File.join(options[:asset_root], PNG_IMAGE_SIZE, "#{code}.png")
+      elsif options[:file_ext] == "svg"
         File.join(options[:asset_root], "svg", "#{code}.svg")
       else
         fail "Unsupported file extension: #{options[:file_ext]}"