rumoji 0.1.0 → 0.2.0

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rack-emoji.gemspec
 gemspec
+
+gem 'rake'

data/README.md

@@ -1,6 +1,6 @@
 # Rumoji
 
-This is a tool to convert Emoji UTF-8 into the codes used by http://www.emoji-cheat-sheet.com/ and back again.
+This is a tool to convert Emoji Unicode codepoints into the human-friendly codes used by http://www.emoji-cheat-sheet.com/ and back again.
 
 Why would you want to do this? Read this blog post: http://mwunsch.tumblr.com/post/34721548842/we-need-to-talk-about-emoji
 
@@ -46,9 +46,11 @@ On the command line
     echo "But Rumoji makes encoding issues a :joy:" | ruby ./funfile.rb
     #=> But Rumoji makes encoding issues a 😂
 
-Implement the emoji codes from emoji-cheat-sheet.com using a tool like [gemoji](https://github.com/github/gemoji) along with Rumoji, and you'll easily be able to transform user input with raw emoji utf-8 into images you can show to all users.
+Implement the emoji codes from emoji-cheat-sheet.com using a tool like [gemoji](https://github.com/github/gemoji) along with Rumoji, and you'll easily be able to transform user input with raw emoji unicode into images you can show to all users.
 
-_Having trouble discerning what's happening in this README?_ You might be on a device with NO emoji support! All the more reason to use Rumoji. Transcode the raw utf-8 into something users can understand across devices!
+Currently, Rumoji only supports the _People_ and _Nature_ characters in emoji-cheat-sheet, but that will change!
+
+_Having trouble discerning what's happening in this README?_ You might be on a device with NO emoji support! All the more reason to use Rumoji. Transcode the raw unicode into something users can understand across devices!
 
 Thanks!
 

data/Rakefile

@@ -3,7 +3,7 @@ require "rake/testtask"
 
 Rake::TestTask.new do |t|
   t.libs.push "lib"
-  t.test_files = FileList['spec/*_spec.rb']
+  t.test_files = FileList['spec/**/*_spec.rb']
   t.verbose = true
 end
 

data/bin/rumoji

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+require 'rumoji'
+
+Rumoji.decode_io(STDIN, STDOUT)

data/lib/rumoji.rb

@@ -1,244 +1,39 @@
 # -*- encoding: utf-8 -*-
 require "rumoji/version"
+require "rumoji/emoji"
 require 'stringio'
 
 module Rumoji
   extend self
 
+  # Transform emoji into its cheat-sheet code
   def encode(str)
     remapped_codepoints = str.codepoints.flat_map do |codepoint|
-      emoji = EMOJI_NAME_TO_CODEPOINT.key(codepoint.to_s(16).upcase)
-      emoji ? ":#{emoji}:".codepoints.entries : codepoint
+      emoji = Emoji.find_by_codepoint(codepoint)
+      emoji ? emoji.code.codepoints.entries : codepoint
     end
     remapped_codepoints.pack("U*")
   end
 
+  # Transform a cheat-sheet code into an Emoji
   def decode(str)
-    duplicate = str.dup
-    EMOJI_NAME_TO_CODEPOINT.each_pair do |key, value|
-      duplicate.gsub! ":#{key}:", [value.to_i(16)].pack("U")
-    end
-    duplicate
+    str.gsub(/:(\S?\w+):/) {|sym| Emoji.find($1.intern).to_s }
   end
 
   def encode_io(readable, writeable=StringIO.new(""))
     readable.each_codepoint do |codepoint|
-      emoji = codepoint.to_s(16).upcase
-      emoji_or_character = EMOJI_NAME_TO_CODEPOINT.has_value?(emoji) ? ":#{EMOJI_NAME_TO_CODEPOINT.key(emoji)}:" : [codepoint].pack("U")
+      emoji = Emoji.find_by_codepoint(codepoint)
+      emoji_or_character = emoji ? emoji.code : [codepoint].pack("U")
       writeable.write emoji_or_character
     end
-    writeable.rewind
     writeable
   end
 
   def decode_io(readable, writeable=StringIO.new(""))
-    readable.each do |word|
-      EMOJI_NAME_TO_CODEPOINT.each_pair do |key,value|
-        word.gsub!(":#{key}:", [value.to_i(16)].pack("U"))
-      end
-      writeable.write(word)
+    readable.each_line do |line|
+      writeable.write decode(line)
     end
-    writeable.rewind
     writeable
   end
 
-  EMOJI_NAME_TO_CODEPOINT = {
-    # PEOPLE
-    smile:                        "1F604",
-    laughing:                     "1F606",
-    blush:                        "1F60A",
-    smiley:                       "1F603",
-    relaxed:                      "263A",
-    smirk:                        "1F60F",
-    heart_eyes:                   "1F60D",
-    kissing_heart:                "1F618",
-    kissing_closed_eyes:          "1F61A",
-    flushed:                      "1F633",
-    relieved:                     "1F625",
-    satisfied:                    "1F60C",
-    grin:                         "1F601",
-    wink:                         "1F609",
-    wink2:                        "1F61C",
-    stuck_out_tongue_winking_eye: "1F61C",
-    stuck_out_tongue_closed_eyes: "1F61D",
-    grinning:                     "1F600",
-    kissing:                      "1F617",
-    kissing_smiling_eyes:         "1F619",
-    stuck_out_tongue:             "1F61B",
-    sleeping:                     "1F634",
-    worried:                      "1F61F",
-    frowning:                     "1F626",
-    anguished:                    "1F627",
-    open_mouth:                   "1F62E",
-    grimacing:                    "1F62C",
-    confused:                     "1F615",
-    hushed:                       "1F62F",
-    expressionless:               "1F611",
-    unamused:                     "1F612",
-    sweat_smile:                  "1F605",
-    sweat:                        "1F613",
-    weary:                        "1F629",
-    pensive:                      "1F614",
-    dissapointed:                 "1F61E",
-    confounded:                   "1F616",
-    fearful:                      "1F628",
-    cold_sweat:                   "1F630",
-    persevere:                    "1F623",
-    cry:                          "1F622",
-    sob:                          "1F62D",
-    joy:                          "1F602",
-    astonished:                   "1F632",
-    scream:                       "1F631",
-    tired_face:                   "1F62B",
-    angry:                        "1F620",
-    rage:                         "1F621",
-    triumph:                      "1F624",
-    sleepy:                       "1F62A",
-    yum:                          "1F60B",
-    mask:                         "1F637",
-    sunglasses:                   "1F60E",
-    dizzy_face:                   "1F635",
-    imp:                          "1F47F",
-    smiling_imp:                  "1F608",
-    neutral_face:                 "1F610",
-    no_mouth:                     "1F636",
-    innocent:                     "1F607",
-
-    alien:                        "1F47D",
-
-    yellow_heart:                 "1F49B",
-    blue_heart:                   "1F499",
-    purple_heart:                 "1F49C",
-    heart:                        "2764",
-    green_heart:                  "1F49A",
-    broken_heart:                 "1F494",
-    heartbeat:                    "1F493",
-    heartpulse:                   "1F497",
-    two_hearts:                   "1F495",
-    revolving_hearts:             "1F49E",
-    cupid:                        "1F498",
-    sparkling_heart:              "1F496",
-
-    sparkles:                     "2728",
-    star:                         "2B50", # In "Nature" range
-    star2:                        "1F31F",
-    dizzy:                        "1F4AB",
-    boom:                         "1F4A5",
-    collision:                    "1F4A5",
-    anger:                        "1F4A2",
-
-    # In "Symbols" range
-    exclamation:                  "2757",
-    question:                     "2753",
-    grey_exclamation:             "2755",
-    grey_question:                "2754",
-
-    zzz:                          "1F4A4",
-    dash:                         "1F4A8",
-    sweat_drops:                  "1F4A6",
-
-    # In "Objects" range
-    notes:                        "1F3B6",
-    musical_note:                 "1F3B5",
-
-    fire:                         "1F525",
-
-    # So much poop
-    hankey:                       "1F4A9",
-    poop:                         "1F4A9",
-    shit:                         "1F4A9",
-
-    thumbsup:                     "1F44D",
-    thumbsdown:                   "1F44E",
-    ok_hand:                      "1F44C",
-    punch:                        "1F44A",
-    facepunch:                    "1F44A",
-    fist:                         "270A",
-    v:                            "270C",
-    wave:                         "1F44B",
-    hand:                         "270B",
-
-    open_hands:                   "1F450",
-    point_up:                     "261D",
-    point_down:                   "1F447",
-    point_left:                   "1F448",
-    point_right:                  "1F449",
-    raised_hands:                 "1F64C",
-    pray:                         "1F64F",
-    point_up_2:                   "1F446",
-    clap:                         "1F44F",
-    muscle:                       "1F4AA",
-
-    walking:                      "1F6B6",
-    runner:                       "1F3C3",
-    running:                      "1F3C3",
-    couple:                       "1F46B",
-    family:                       "1F46A",
-    two_men_holding_hands:        "1F46C",
-    two_women_holding_hands:      "1F46C",
-    dancer:                       "1F483",
-    dancers:                      "1F46F",
-    ok_woman:                     "1F646",
-    no_good:                      "1F645",
-    information_desk_person:      "1F481",
-    raised_hand:                  "1F64B",
-    bride_with_veil:              "1F470",
-    person_with_pouting_face:     "1F64E",
-    person_frowning:              "1F64D",
-    bow:                          "1F647",
-    couplekiss:                   "1F48F",
-    couple_with_heart:            "1F491",
-    massage:                      "1F486",
-    haircut:                      "1F487",
-    nail_care:                    "1F485",
-    boy:                          "1F466",
-    girl:                         "1F467",
-    woman:                        "1F469",
-    man:                          "1F468",
-    baby:                         "1F476",
-    older_woman:                  "1F475",
-    older_man:                    "1F474",
-    person_with_blond_hair:       "1F471",
-    man_with_gua_pi_mao:          "1F472",
-    man_with_turban:              "1F473",
-    construction_worker:          "1F477",
-    cop:                          "1F46E",
-    angel:                        "1F47C",
-    princess:                     "1F478",
-
-    smiley_cat:                   "1F63A",
-    smile_cat:                    "1F638",
-    heart_eyes_cat:               "1F63B",
-    kissing_cat:                  "1F63D",
-    smirk_cat:                    "1F63C",
-    scream_cat:                   "1F640",
-    crying_cat_face:              "1F63F",
-    joy_cat:                      "1F639",
-    pouting_cat:                  "1F63E",
-
-    japanese_ogre:                "1F479",
-    japanese_goblin:              "1F47A",
-
-    see_no_evil:                  "1F648",
-    hear_no_evil:                 "1F649",
-    speak_no_evil:                "1F649",
-
-    guardsman:                    "1F482",
-    skull:                        "1F480",
-
-    feet:                         "1F463",
-    lips:                         "1F444",
-    kiss:                         "1F48B",
-    droplet:                      "1F4A7",
-    ear:                          "1F442",
-    eyes:                         "1F440",
-    nose:                         "1F443",
-    tongue:                       "1F445",
-    love_letter:                  "1F48C",
-    bust_in_silhouette:           "1F464",
-    busts_in_silhouette:          "1F465",
-    speech_balloon:               "1F4AC",
-    thought_balloon:              "1F4AD"
-  }
-
 end

data/lib/rumoji/emoji.rb

@@ -0,0 +1,57 @@
+# -*- encoding: utf-8 -*-
+module Rumoji
+  class Emoji
+
+    attr_reader :name
+
+    def initialize(string, symbols, name = nil)
+      @codepoints = string.codepoints
+      @cheat_codes = [symbols].flatten
+      @name = name || @cheat_codes.first.to_s.upcase.gsub("_", " ")
+    end
+
+    def symbol
+      @cheat_codes.first
+    end
+
+    def code
+      ":#{symbol}:"
+    end
+
+    def include?(symbol)
+      @cheat_codes.include? symbol.to_sym
+    end
+
+    def to_s
+      @codepoints.to_a.pack("U*")
+    end
+
+    def hash
+      code.hash
+    end
+
+    def hex
+      @codepoints.map{|point| point.to_s(16).upcase }.join("-")
+    end
+
+    autoload :PEOPLE, 'rumoji/emoji/people'
+    autoload :NATURE, 'rumoji/emoji/nature'
+    autoload :OBJECTS, 'rumoji/emoji/objects'
+    autoload :PLACES, 'rumoji/emoji/places'
+    autoload :SYMBOLS, 'rumoji/emoji/symbols'
+
+    ALL = PEOPLE | NATURE | OBJECTS | PLACES | SYMBOLS
+
+    def self.find(symbol)
+      ALL.find {|emoji| emoji.include? symbol }
+    end
+
+    def self.find_by_string(string)
+      ALL.find {|emoji| emoji.to_s == string }
+    end
+
+    def self.find_by_codepoint(codepoint)
+      ALL.find {|emoji| emoji.hex == codepoint.to_s(16).upcase }
+    end
+  end
+end

data/lib/rumoji/emoji/nature.rb

@@ -0,0 +1,127 @@
+# -*- encoding: utf-8 -*-
+
+require 'rumoji/emoji'
+require 'set'
+
+module Rumoji
+  class Emoji
+    NATURE = Set[
+      self.new("\u{2600}" , [:sunny], "BLACK SUN WITH RAYS"),
+      self.new("\u{2614}" , [:umbrella], "UMBRELLA WITH RAIN DROPS"),
+      self.new("\u{2601}" , [:cloud]),
+      self.new("\u{2744}" , [:snowflake]),
+      self.new("\u{26C4}" , [:snowman], "SNOWMAN WITHOUT SNOW"),
+      self.new("\u{26A1}" , [:zap], "HIGH VOLTAGE SIGN"),
+      self.new("\u{1F300}", [:cyclone]), # "typhoon, hurricane
+      self.new("\u{1F301}", [:foggy]),
+      self.new("\u{1F30A}", [:ocean], "WATER WAVE"),
+      # Animals
+      self.new("\u{1F431}", [:cat], "CAT FACE"),
+      self.new("\u{1F436}", [:dog], "DOG FACE"),
+      self.new("\u{1F42D}", [:mouse], "MOUSE FACE"),
+      self.new("\u{1F439}", [:hamster], "HAMSTER FACE"),
+      self.new("\u{1F430}", [:rabbit], "RABBIT FACE"),
+      self.new("\u{1F43A}", [:wolf], "WOLF FACE"),
+      self.new("\u{1F438}", [:frog], "FROG FACE"),
+      self.new("\u{1F42F}", [:tiger], "TIGER FACE"),
+      self.new("\u{1F428}", [:koala]),
+      self.new("\u{1F43B}", [:bear], "BEAR FACE"),
+      self.new("\u{1F437}", [:pig], "PIG FACE"),
+      self.new("\u{1F43D}", [:pig_nose]),
+      self.new("\u{1F42E}", [:cow], "COW FACE"),
+      self.new("\u{1F417}", [:boar]),
+      self.new("\u{1F435}", [:monkey_face]),
+      self.new("\u{1F412}", [:monkey]),
+      self.new("\u{1F434}", [:horse], "HORSE FACE"),
+      self.new("\u{1F40E}", [:racehorse], "HORSE"),
+      self.new("\u{1F42B}", [:camel], "BACTRIAN CAMEL"), # "has two humps"
+      self.new("\u{1F411}", [:sheep]),
+      self.new("\u{1F418}", [:elephant]),
+      self.new("\u{1F43C}", [:panda_face]),
+      self.new("\u{1F40D}", [:snake]),
+      self.new("\u{1F426}", [:bird]),
+      self.new("\u{1F424}", [:baby_chick]),
+      self.new("\u{1F425}", [:hatched_chick], "FRONT-FACING BABY CHICK"),
+      self.new("\u{1F423}", [:hatching_chick]),
+      self.new("\u{1F414}", [:chicken]),
+      self.new("\u{1F427}", [:penguin]),
+      self.new("\u{1F422}", [:turtle]),
+      self.new("\u{1F41B}", [:bug]),
+      self.new("\u{1F41D}", [:honeybee]),
+      self.new("\u{1F41C}", [:ant]),
+      self.new("\u{1F41E}", [:beetle], "LADY BEETLE"), # "ladybird, ladybug, coccinellids"
+      self.new("\u{1F40C}", [:snail]),
+      self.new("\u{1F419}", [:octopus]),
+      self.new("\u{1F420}", [:tropical_fish]),
+      self.new("\u{1F41F}", [:fish]),
+      self.new("\u{1F433}", [:whale], "SPOUTING WHALE"),
+      self.new("\u{1F40B}", [:whale2], "WHALE"),
+      self.new("\u{1F42C}", [:dolphin]),
+      self.new("\u{1F404}", [:cow2], "COW"),
+      self.new("\u{1F40F}", [:ram]),
+      self.new("\u{1F400}", [:rat]),
+      self.new("\u{1F403}", [:water_buffalo]),
+      self.new("\u{1F405}", [:tiger2], "TIGER"),
+      self.new("\u{1F407}", [:rabbit2], "RABBIT"),
+      self.new("\u{1F409}", [:dragon]),
+      self.new("\u{1F410}", [:goat]),
+      self.new("\u{1F413}", [:rooster]),
+      self.new("\u{1F415}", [:dog2], "DOG"),
+      self.new("\u{1F416}", [:pig2], "PIG"),
+      self.new("\u{1F401}", [:mouse2], "MOUSE"),
+      self.new("\u{1F402}", [:ox]),
+      self.new("\u{1F432}", [:dragon_face]),
+      self.new("\u{1F421}", [:blowfish]),
+      self.new("\u{1F40A}", [:crocodile]),
+      self.new("\u{1F42A}", [:dromedary_camel]), # "has a single hump"
+      self.new("\u{1F406}", [:leopard]),
+      self.new("\u{1F408}", [:cat2], "CAT"),
+      self.new("\u{1F429}", [:poodle]),
+      self.new("\u{1F43E}", [:paw_prints]),
+      # Flowers
+      self.new("\u{1F490}", [:bouquet]),
+      self.new("\u{1F338}", [:cherry_blossom]),
+      self.new("\u{1F337}", [:tulip]),
+      self.new("\u{1F340}", [:four_leaf_clover]),
+      self.new("\u{1F339}", [:rose]),
+      self.new("\u{1F33B}", [:sunflower]),
+      self.new("\u{1F33A}", [:hibiscus]),
+      self.new("\u{1F341}", [:maple_leaf]),
+      self.new("\u{1F343}", [:leaves], "LEAF FLUTTERING IN WIND"),
+      self.new("\u{1F342}", [:fallen_leaf]),
+      self.new("\u{1F33F}", [:herb]),
+      self.new("\u{1F344}", [:mushroom]),
+      self.new("\u{1F335}", [:cactus]),
+      self.new("\u{1F334}", [:palm_tree]),
+      self.new("\u{1F332}", [:evergreen_tree]),
+      self.new("\u{1F333}", [:deciduous_tree]),
+      self.new("\u{1F330}", [:chestnut]),
+      self.new("\u{1F331}", [:seedling]),
+      self.new("\u{1F33C}", [:blossum]), # "daisy"
+      self.new("\u{1F33E}", [:ear_of_rice]),
+      self.new("\u{1F41A}", [:shell], "SPIRAL SHELL"),
+      self.new("\u{1F310}", [:globe_with_meridians]), # "used to indicate international input source, world clocks with time zones, etc."
+      # Moon
+      self.new("\u{1F31E}", [:sun_with_face]),
+      self.new("\u{1F31D}", [:full_moon_with_face]),
+      self.new("\u{1F31A}", [:new_moon_with_face]),
+      self.new("\u{1F311}", [:new_moon], "NEW MOON SYMBOL"),
+      self.new("\u{1F312}", [:waxing_crescent_moon], "WAXING CRESCENT MOON SYMBOL"),
+      self.new("\u{1F313}", [:first_quarter_moon], "FIRST QUARTER MOON SYMBOL"), # "half moon"
+      self.new("\u{1F314}", [:waxing_gibbous_moon], "WAXING GIBBOUS MOON SYMBOL"), # "waxing moon"
+      self.new("\u{1F315}", [:full_moon], "FULL MOON SYMBOL"),
+      self.new("\u{1F316}", [:waning_gibbous_moon], "WAINING GIBBOUS MOON SYMBOL"),
+      self.new("\u{1F317}", [:last_quarter_moon], "LAST QUARTER MOON SYMBOL"),
+      self.new("\u{1F318}", [:waning_crescent_moon], "WANING CRESCENT MOON SYMBOL"),
+      self.new("\u{1F31C}", [:last_quarter_moon_with_face]),
+      self.new("\u{1F31B}", [:first_quarter_moon_with_face]),
+      self.new("\u{1F319}", [:moon], "CRESCENT MOON"), # "may indicate either the first or last quarter moon"
+      self.new("\u{1F30D}", [:earth_africa], "EARTH GLOBE EUROPE-AFRICA"),
+      self.new("\u{1F30E}", [:earth_americas], "EARTH GLOBE AMERICAS"),
+      self.new("\u{1F30F}", [:earth_asia], "EARTH GLOBE ASIA-AUSTRALIA"),
+      self.new("\u{1F30B}", [:volcano]),
+      self.new("\u{1F30C}", [:milky_way]),
+      self.new("\u{26C5}" , [:partly_sunny], "SUN BEHIND CLOUD")
+    ]
+  end
+end