rumoji 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Wunsch
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Rumoji
+
+This is a tool to convert Emoji UTF-8 into the 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
+
+## tl;dr
+
+>**Do not store emoji unicodes in your database. Store the human-friendly code and support the emoji-cheat-sheet.**
+
+>By doing this, you can ensure that users across devices can see the author’s intention. You can always show users an image, but you can’t show them a range of characters their system does not support.
+
+## Usage
+
+    Rumoji.encode(str)
+    # Takes a String, transforms Emoji into cheat-sheet codes
+
+    Rumoji.decode(str)
+    # Does the reverse
+
+    Rumoji.encode_io(read, write)
+    # For an IO pipe (a read stream, and a write stream), transform Emoji from the
+    # read end, and write the cheat-sheet codes on the write end.
+
+    Rumoji.decode_io(read, write)
+    # Same thing but in reverse!
+
+## Installation
+
+    gem install rumoji
+
+Note that rumoji has only been tested in Ruby 1.9!!!
+
+### Some examples:
+
+    puts Rumoji.encode("Lack of cross-device emoji support makes me 😭")
+
+    #=> Lack of cross-device emoji support makes me :sob:
+
+Here's a fun file:
+
+    Rumoji.decode_io($stdin, $stdout)
+
+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.
+
+_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!
+
+Thanks!
+
+## Copyright
+Copyright (c) 2009 - 2012 Mark Wunsch. Licensed under the [MIT License](http://opensource.org/licenses/mit-license.php).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['spec/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => [:test]

data/lib/rumoji.rb

@@ -0,0 +1,244 @@
+# -*- encoding: utf-8 -*-
+require "rumoji/version"
+require 'stringio'
+
+module Rumoji
+  extend self
+
+  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
+    end
+    remapped_codepoints.pack("U*")
+  end
+
+  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
+  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")
+      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)
+    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/version.rb

@@ -0,0 +1,3 @@
+module Rumoji
+  VERSION = "0.1.0"
+end

data/rumoji.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rumoji/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rumoji"
+  gem.version       = Rumoji::VERSION
+  gem.authors       = ["Mark Wunsch"]
+  gem.email         = ["mark@markwunsch.com"]
+  gem.description   = %q{Transcode emoji utf-8 characters into emoji-cheat-sheet form}
+  gem.summary       = %q{Transcode emoji utf-8 characters into emoji-cheat-sheet form}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/rumoji_spec.rb

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+require 'rumoji'
+require 'minitest/spec'
+require 'minitest/autorun'
+
+describe Rumoji do
+  before do
+    @poop = "💩"
+    @smile = "😄"
+  end
+
+  describe "#encode" do
+    it "transforms emoji into cheat-sheet form" do
+      key = :smile
+      Rumoji.encode(@smile).must_equal ":smile:"
+    end
+  end
+
+  describe "#decode" do
+    it "transforms a cheat-sheet code into an emoji" do
+      Rumoji.decode(":poop:").must_equal @poop
+    end
+  end
+
+  describe "#encode_io" do
+    it "reads emoji from one stream and outputs a stream of cheat-sheet codes" do
+      io = StringIO.new("#{@smile}")
+      Rumoji.encode_io(io).read.must_equal ":smile:"
+    end
+  end
+
+  describe "#decode_io" do
+    it "reads a cheat-sheet code from one stream and outputs a stream of emoji" do
+      io = StringIO.new(":poop:")
+      Rumoji.decode_io(io).read.must_equal @poop
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: rumoji
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mark Wunsch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-31 00:00:00.000000000 Z
+dependencies: []
+description: Transcode emoji utf-8 characters into emoji-cheat-sheet form
+email:
+- mark@markwunsch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rumoji.rb
+- lib/rumoji/version.rb
+- rumoji.gemspec
+- spec/rumoji_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2529029853417925007
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2529029853417925007
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Transcode emoji utf-8 characters into emoji-cheat-sheet form
+test_files:
+- spec/rumoji_spec.rb