gemoji 2.0.0

`shipit.png` is 75 px for some reason, though.

.gitignore

@@ -0,0 +1,2 @@
+.ruby-version
+db/NamesList.txt

.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.3
+  - 2.1.2
+notifications:
+  email: false

Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "rake"
+gem "minitest"
+
+gemspec

Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    gemoji (1.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.3.5)
+    rake (10.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gemoji!
+  minitest
+  rake

README.md

@@ -7,7 +7,7 @@ Emoji images and names. See the LICENSE for copyright information.
 Installation
 ------------
 
-Add `gemoji` to you Gemfile.
+Add `gemoji` to your Gemfile.
 
 ``` ruby
 gem 'gemoji'
@@ -39,7 +39,7 @@ Then have them compiled to public on deploy.
 
 ``` ruby
 # config/application.rb
-config.assets.precompile << "emoji/*.png"
+config.assets.precompile << "emoji/**/*.png"
 ```
 
 **WARNING** Since there are a ton of images, just adding the path may slow down other lookups if you aren't using it. Compiling all the emojis on deploy will add overhead to your deploy if even the images haven't changed. Theres just so many more superfluous files to iterate over. Also, the urls will be fingerprinted which may not be ideal for referencing from cached content.
@@ -48,16 +48,16 @@ config.assets.precompile << "emoji/*.png"
 Example Rails Helper
 --------------------
 
-This would allow emojifying content such as: `it's raining :cats: and :dogs:!`
+This would allow emojifying content such as: `it's raining :cat:s and :dog:s!`
 
 See the [Emoji cheat sheet](http://www.emoji-cheat-sheet.com) for more examples.
 
 ```ruby
 module EmojiHelper
- def emojify(content)
-    h(content).to_str.gsub(/:([a-z0-9\+\-_]+):/) do |match|
-      if Emoji.names.include?($1)
-        '<img alt="' + $1 + '" height="20" src="' + asset_path("emoji/#{$1}.png") + '" style="vertical-align:middle" width="20" />'
+  def emojify(content)
+    h(content).to_str.gsub(/:([\w+-]+):/) do |match|
+      if emoji = Emoji.find_by_alias($1) { nil }
+        %(<img alt="#$1" src="#{asset_path("emoji/#{emoji.image_filename}")}" style="vertical-align:middle" width="20" height="20" />)
       else
         match
       end
@@ -65,3 +65,59 @@ module EmojiHelper
   end
 end
 ```
+
+Unicode mapping
+---------------
+
+Translate emoji names to unicode and vice versa.
+
+```ruby
+>> Emoji.find_by_alias("cat").raw
+=> "🐱"  # Don't see a cat? That's U+1F431.
+
+>> Emoji.find_by_unicode("\u{1f431}").name
+=> "cat"
+```
+
+Adding new emoji
+----------------
+
+You can add new emoji characters to the `Emoji.all` list:
+
+```ruby
+emoji = Emoji.create("music") do |char|
+  char.add_alias "song"
+  char.add_unicode_alias "\u{266b}"
+  char.add_tag "notes"
+end
+
+emoji.name #=> "music"
+emoji.raw  #=> "♫"
+emoji.image_filename #=> "unicode/266b.png"
+
+# Creating custom emoji (no Unicode aliases):
+emoji = Emoji.create("music") do |char|
+  char.add_tag "notes"
+end
+
+emoji.custom? #=> true
+emoji.image_filename #=> "music.png"
+```
+
+As you create new emoji, you must ensure that you also create and put the images
+they reference by their `image_filename` to your assets directory.
+
+For existing emojis, you can edit the list of aliases or add new tags in an edit block:
+
+```ruby
+emoji = Emoji.find_by_alias "musical_note"
+
+Emoji.edit_emoji(emoji) do |char|
+  char.add_alias "music"
+  char.add_unicode_alias "\u{266b}"
+  char.add_tag "notes"
+end
+
+Emoji.find_by_alias "music"       #=> emoji
+Emoji.find_by_unicode "\u{266b}"  #=> emoji
+```

Rakefile

@@ -8,9 +8,22 @@ Rake::TestTask.new do |t|
 end
 
 namespace :db do
-  task :generate do
-    system "cp /System/Library/Input\\ Methods/CharacterPalette.app/Contents/Resources/Category-Emoji.plist db/"
-    system "plutil -convert json db/Category-Emoji.plist"
-    system "mv db/Category-Emoji.plist db/Category-Emoji.json"
+  desc %(Generate Emoji data files needed for development)
+  task :generate => ['db/Category-Emoji.json', 'db/NamesList.txt']
+
+  desc %(Dump a list of supported Emoji with Unicode descriptions and aliases)
+  task :dump => :generate do
+    system 'ruby', '-Ilib', 'db/dump.rb'
   end
 end
+
+emoji_plist = '/System/Library/Input Methods/CharacterPalette.app/Contents/Resources/Category-Emoji.plist'
+nameslist_url = 'http://www.unicode.org/Public/6.3.0/ucd/NamesList.txt'
+
+task 'db/Category-Emoji.json' do |t|
+  system "plutil -convert json -r '#{emoji_plist}' -o '#{t.name}'"
+end
+
+file 'db/NamesList.txt' do |t|
+  system "curl -fsSL '#{nameslist_url}' -o '#{t.name}'"
+end

db/dump.rb

@@ -0,0 +1,79 @@
+require 'emoji'
+require 'json'
+
+names_list = File.expand_path('../NamesList.txt', __FILE__)
+
+class UnicodeCharacter
+  attr_reader :code, :description, :aliases
+
+  @index = {}
+  class << self
+    attr_reader :index
+
+    def fetch(code, *args, &block)
+      code = code.to_s(16).rjust(4, '0') if code.is_a?(Integer)
+      index.fetch(code, *args, &block)
+    end
+  end
+
+  def initialize(code, description)
+    @code = code.downcase
+    @description = description.downcase
+    @aliases = []
+    @references = []
+
+    self.class.index[@code] = self
+  end
+
+  def add_alias(string)
+    @aliases.concat string.split(/\s*,\s*/)
+  end
+
+  def add_reference(code)
+    @references << code.downcase
+  end
+end
+
+char = nil
+
+File.foreach(names_list) do |line|
+  case line
+  when /^[A-F0-9]{4,5}\t/
+    code, desc = line.chomp.split("\t", 2)
+    codepoint = code.hex
+    char = UnicodeCharacter.new(code, desc)
+  when /^\t= /
+    char.add_alias($')
+  when /^\tx .+ - ([A-F0-9]{4,5})\)$/
+    char.add_reference($1)
+  end
+end
+
+trap(:PIPE) { abort }
+
+items = []
+variation = Emoji::VARIATION_SELECTOR_16
+
+for emoji in Emoji.all
+  unicodes = emoji.unicode_aliases.dup
+
+  item = {}
+
+  unless emoji.custom?
+    variation_codepoint = variation.codepoints[0]
+    chars = emoji.raw.codepoints.map { |code| UnicodeCharacter.fetch(code) unless code == variation_codepoint }.compact
+    unicodes.select { |u| u.index(variation) }.each { |u| unicodes.delete(u.sub(variation, '')) }
+    item[:emoji] = unicodes.shift
+    item[:unicodes] = unicodes if unicodes.any?
+    item[:description] = chars.map(&:description).join(' + ')
+  end
+
+  item[:aliases] = emoji.aliases
+  item[:tags] = emoji.tags
+
+  items << item
+end
+
+puts JSON.pretty_generate(items)
+  .gsub("\n\n", "\n")
+  .gsub(/,\n( +)/) { "\n%s, " % $1[2..-1] }

db/index.html

@@ -0,0 +1,113 @@
+<!doctype html>
+<title>Emoji preview</title>
+
+<style type="text/css">
+body {
+  font: 14px/18px Verdana, Arial, sans-serif;
+  padding: 2em;
+}
+ol {
+  list-style: none;
+  padding-left: 0;
+}
+li {
+  margin-left: 0;
+  margin-top: 5px;
+  clear: left;
+}
+li:first-child { display: none; }
+li > span {
+  display: block;
+}
+.emoji {
+  font-size: 50px;
+  line-height: 50px;
+  float: left;
+  margin-right: 20px;
+}
+.description {
+  font-style: italic;
+  color: gray;
+}
+.aliases span:before, .aliases span:after {
+  content: ":";
+  color: gray;
+}
+.tags {
+  font-size: 11px;
+}
+.tags span {
+  display: inline-block;
+  padding: 1px 5px 2px;
+  border-radius: 3px;
+  background: #dadada;
+  line-height: 11px;
+}
+</style>
+
+<p><input type=search placeholder="Search..."></p>
+
+<ol>
+  <li>
+    <span class="emoji"></span>
+    <span class="description"></span>
+    <span class="aliases"></span>
+    <span class="tags"></span>
+  </li>
+</ol>
+
+<script>
+  function renderEmoji(emojis) {
+    var item, els, template = document.querySelector('li')
+    for (var emoji, i=0; i < emojis.length; i++) {
+      emoji = emojis[i]
+      item = template.cloneNode(true)
+      els = item.querySelectorAll('span')
+      if (emoji.emoji) els[0].textContent = emoji.emoji
+      else {
+        var img = document.createElement('img')
+        img.src = "../images/emoji/" + emoji.aliases[0] + ".png"
+        els[0].appendChild(img)
+      }
+      els[1].textContent = emoji.description || ''
+      els[2].innerHTML = emoji.aliases.map(function(n){ return '<span>'+n+'</span>' }).join(' ')
+      els[3].innerHTML = emoji.tags.map(function(n){ return '<span>'+n+'</span>' }).join(' ')
+      template.parentNode.appendChild(item)
+
+      item._emojiText = (els[2].textContent + ' ' + els[3].textContent).replace(/_/g, '-')
+    }
+  }
+
+  xhr = new XMLHttpRequest
+  xhr.onreadystatechange = function() {
+    if (this.readyState == 4) {
+      json = JSON.parse(this.responseText)
+      renderEmoji(json)
+    }
+  }
+  xhr.open('GET', 'emoji.json', false)
+  xhr.send(null)
+
+  function searchEmoji(query) {
+    var el,
+        re = new RegExp('\\b' + query),
+        els = document.querySelectorAll('li')
+
+    for (var i=1; i < els.length; i++) {
+      el = els[i]
+      if ( !query || re.test(el._emojiText) ) {
+        el.style.display = 'list-item'
+      } else {
+        el.style.display = 'none'
+      }
+    }
+  }
+
+  var timeout, search = document.querySelector('input[type=search]')
+  search.addEventListener('input', function() {
+    var $this = this
+    if (timeout) clearTimeout(timeout)
+    timeout = setTimeout(function(){ searchEmoji($this.value) }, 200)
+  }, false)
+  search.focus()
+</script>

gemoji.gemspec

@@ -1,12 +1,21 @@
 Gem::Specification.new do |s|
   s.name    = "gemoji"
-  s.version = "1.5.0"
-  s.summary = "Emoji Assets"
-  s.description = "Emoji assets"
+  s.version = "2.0.0"
+  s.summary = "Emoji conversion and image assets"
+  s.description = "Image assets and character information for emoji."
+
+  s.required_ruby_version = '> 1.9'
 
   s.authors  = ["GitHub"]
   s.email    = "support@github.com"
   s.homepage = "https://github.com/github/gemoji"
+  s.licenses = ["MIT"]
 
-  s.files = Dir["README.md", "images/**/*.png", "lib/**/*.rb", "lib/tasks/*.rake"]
+  s.files = Dir[
+    "README.md",
+    "images/**/*.png",
+    "db/emoji.json",
+    "lib/**/*.rb",
+    "lib/tasks/*.rake"
+  ]
 end

images/emoji/+1.png

@@ -1 +0,0 @@
-unicode/1f44d.png

images/emoji/-1.png

@@ -1 +0,0 @@
-unicode/1f44e.png

images/emoji/100.png

@@ -1 +0,0 @@
-unicode/1f4af.png

images/emoji/1234.png

@@ -1 +0,0 @@
-unicode/1f522.png

images/emoji/8ball.png

@@ -1 +0,0 @@
-unicode/1f3b1.png

images/emoji/a.png

@@ -1 +0,0 @@
-unicode/1f170.png

images/emoji/ab.png

@@ -1 +0,0 @@
-unicode/1f18e.png

images/emoji/abc.png

@@ -1 +0,0 @@
-unicode/1f524.png

images/emoji/abcd.png

@@ -1 +0,0 @@
-unicode/1f521.png

images/emoji/accept.png

@@ -1 +0,0 @@
-unicode/1f251.png

images/emoji/aerial_tramway.png

@@ -1 +0,0 @@
-unicode/1f6a1.png

images/emoji/airplane.png

@@ -1 +0,0 @@
-unicode/2708.png

images/emoji/alarm_clock.png

@@ -1 +0,0 @@
-unicode/23f0.png

images/emoji/alien.png

@@ -1 +0,0 @@
-unicode/1f47d.png

images/emoji/ambulance.png

@@ -1 +0,0 @@
-unicode/1f691.png

images/emoji/anchor.png

@@ -1 +0,0 @@
-unicode/2693.png

images/emoji/angel.png

@@ -1 +0,0 @@
-unicode/1f47c.png

images/emoji/anger.png

@@ -1 +0,0 @@
-unicode/1f4a2.png

images/emoji/angry.png

@@ -1 +0,0 @@
-unicode/1f620.png

images/emoji/anguished.png

@@ -1 +0,0 @@
-unicode/1f627.png

images/emoji/ant.png

@@ -1 +0,0 @@
-unicode/1f41c.png

images/emoji/apple.png

@@ -1 +0,0 @@
-unicode/1f34e.png

images/emoji/aquarius.png

@@ -1 +0,0 @@
-unicode/2652.png

images/emoji/aries.png

@@ -1 +0,0 @@
-unicode/2648.png

images/emoji/arrow_backward.png

@@ -1 +0,0 @@
-unicode/25c0.png

images/emoji/arrow_double_down.png

@@ -1 +0,0 @@
-unicode/23ec.png

images/emoji/arrow_double_up.png

@@ -1 +0,0 @@
-unicode/23eb.png

images/emoji/arrow_down.png

@@ -1 +0,0 @@
-unicode/2b07.png

images/emoji/arrow_down_small.png

@@ -1 +0,0 @@
-unicode/1f53d.png

images/emoji/arrow_forward.png

@@ -1 +0,0 @@
-unicode/25b6.png

images/emoji/arrow_heading_down.png

@@ -1 +0,0 @@
-unicode/2935.png

images/emoji/arrow_heading_up.png

@@ -1 +0,0 @@
-unicode/2934.png

images/emoji/arrow_left.png

@@ -1 +0,0 @@
-unicode/2b05.png

images/emoji/arrow_lower_left.png

@@ -1 +0,0 @@
-unicode/2199.png

images/emoji/arrow_lower_right.png

@@ -1 +0,0 @@
-unicode/2198.png

images/emoji/arrow_right.png

@@ -1 +0,0 @@
-unicode/27a1.png

images/emoji/arrow_right_hook.png

@@ -1 +0,0 @@
-unicode/21aa.png

images/emoji/arrow_up.png

@@ -1 +0,0 @@
-unicode/2b06.png

images/emoji/arrow_up_down.png

@@ -1 +0,0 @@
-unicode/2195.png

images/emoji/arrow_up_small.png

@@ -1 +0,0 @@
-unicode/1f53c.png

images/emoji/arrow_upper_left.png

@@ -1 +0,0 @@
-unicode/2196.png

images/emoji/arrow_upper_right.png

@@ -1 +0,0 @@
-unicode/2197.png

images/emoji/arrows_clockwise.png

@@ -1 +0,0 @@
-unicode/1f503.png

images/emoji/arrows_counterclockwise.png

@@ -1 +0,0 @@
-unicode/1f504.png

images/emoji/art.png

@@ -1 +0,0 @@
-unicode/1f3a8.png

images/emoji/articulated_lorry.png

@@ -1 +0,0 @@
-unicode/1f69b.png

images/emoji/astonished.png

@@ -1 +0,0 @@
-unicode/1f632.png

images/emoji/athletic_shoe.png

@@ -1 +0,0 @@
-unicode/1f45f.png

images/emoji/atm.png

@@ -1 +0,0 @@
-unicode/1f3e7.png

images/emoji/b.png

@@ -1 +0,0 @@
-unicode/1f171.png

images/emoji/baby.png

@@ -1 +0,0 @@
-unicode/1f476.png

images/emoji/baby_bottle.png

@@ -1 +0,0 @@
-unicode/1f37c.png

images/emoji/baby_chick.png

@@ -1 +0,0 @@
-unicode/1f424.png

images/emoji/baby_symbol.png

@@ -1 +0,0 @@
-unicode/1f6bc.png

images/emoji/back.png

@@ -1 +0,0 @@
-unicode/1f519.png

images/emoji/baggage_claim.png

@@ -1 +0,0 @@
-unicode/1f6c4.png

images/emoji/balloon.png

@@ -1 +0,0 @@
-unicode/1f388.png

images/emoji/ballot_box_with_check.png

@@ -1 +0,0 @@
-unicode/2611.png

images/emoji/bamboo.png

@@ -1 +0,0 @@
-unicode/1f38d.png

images/emoji/banana.png

@@ -1 +0,0 @@
-unicode/1f34c.png

images/emoji/bangbang.png

@@ -1 +0,0 @@
-unicode/203c.png

images/emoji/bank.png

@@ -1 +0,0 @@
-unicode/1f3e6.png

images/emoji/bar_chart.png

@@ -1 +0,0 @@
-unicode/1f4ca.png

images/emoji/barber.png

@@ -1 +0,0 @@
-unicode/1f488.png

images/emoji/baseball.png

@@ -1 +0,0 @@
-unicode/26be.png

images/emoji/basketball.png

@@ -1 +0,0 @@
-unicode/1f3c0.png

images/emoji/bath.png

@@ -1 +0,0 @@
-unicode/1f6c0.png

images/emoji/bathtub.png

@@ -1 +0,0 @@
-unicode/1f6c1.png

images/emoji/battery.png

@@ -1 +0,0 @@
-unicode/1f50b.png

images/emoji/bear.png

@@ -1 +0,0 @@
-unicode/1f43b.png

images/emoji/bee.png

@@ -1 +0,0 @@
-unicode/1f41d.png

images/emoji/beer.png

@@ -1 +0,0 @@
-unicode/1f37a.png

images/emoji/beers.png

@@ -1 +0,0 @@
-unicode/1f37b.png

images/emoji/beetle.png

@@ -1 +0,0 @@
-unicode/1f41e.png

images/emoji/beginner.png

@@ -1 +0,0 @@
-unicode/1f530.png

images/emoji/bell.png

@@ -1 +0,0 @@
-unicode/1f514.png

images/emoji/bento.png

@@ -1 +0,0 @@
-unicode/1f371.png

images/emoji/bicyclist.png

@@ -1 +0,0 @@
-unicode/1f6b4.png

images/emoji/bike.png

@@ -1 +0,0 @@
-unicode/1f6b2.png

images/emoji/bikini.png

@@ -1 +0,0 @@
-unicode/1f459.png

images/emoji/bird.png

@@ -1 +0,0 @@
-unicode/1f426.png

images/emoji/birthday.png

@@ -1 +0,0 @@
-unicode/1f382.png

images/emoji/black_circle.png

@@ -1 +0,0 @@
-unicode/26ab.png

images/emoji/black_joker.png

@@ -1 +0,0 @@
-unicode/1f0cf.png

images/emoji/black_large_square.png

@@ -1 +0,0 @@
-unicode/2b1b.png

images/emoji/black_medium_small_square.png

@@ -1 +0,0 @@
-unicode/25fe.png

images/emoji/black_medium_square.png

@@ -1 +0,0 @@
-unicode/25fc.png

images/emoji/black_nib.png

@@ -1 +0,0 @@
-unicode/2712.png

images/emoji/black_small_square.png

@@ -1 +0,0 @@
-unicode/25aa.png