somemoji 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9226ef38d541403c6c1e567087fc02d100dde798
+  data.tar.gz: 94b439e4704fc2d98a3ae66de9bc2e7498b9562c
+SHA512:
+  metadata.gz: 37b854b7b285a50c60c8300497cb5126210ce31f57aa585b8033e0040ef5f728b455ce12af1381171c8e1a02c116dd3549c00a0be51a25d27f902381ad513115
+  data.tar.gz: a935436131de499d333c753f74cc9f8587d558c51fd51a4acbb9dc8d5d440f62a131a3764a962a72cfa5f4d412ba1189ed4227d1c42755e4e6c70d170a1a86a6

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ryo Nakamura
+
+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,152 @@
+# Somemoji
+
+A grand unified emoji mapper for some emoji providers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "somemoji"
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install somemoji
+```
+
+## Usage
+
+### Somemoji.emoji_collection
+
+Returns a `Somemoji::EmojiCollection` instance based on our emoji definitions.
+
+```ruby
+require "somemoji"
+
+Somemoji.emoji_collection.class #=> Somemoji::EmojiCollection
+Somemoji.emoji_collection.count #=> 1794
+Somemoji.emoji_collection.first.class #=> Somemoji::Emoji
+```
+
+### Somemoji::EmojiCollection#find_by_character(character)
+
+Finds a `Somemoji::Emoji` instance from an emoji character (unicode grapheme cluster).
+
+```ruby
+require "somemoji"
+
+Somemoji.emoji_collection.find_by_character("👍").class #=> Somemoji::Emoji
+Somemoji.emoji_collection.find_by_character("👎").class #=> Somemoji::Emoji
+```
+
+### Somemoji::EmojiCollection#find_by_code(code)
+
+Finds a `Somemoji::Emoji` instance from an emoji code.
+
+```ruby
+require "somemoji"
+
+Somemoji.emoji_collection.find_by_code("thumbsup").class #=> Somemoji::Emoji
+Somemoji.emoji_collection.find_by_code("+1").class #=> Somemoji::Emoji
+Somemoji.emoji_collection.find_by_code("undefined_code") #=> nil
+```
+
+### Somemoji::EmojiCollection#+(emoji_collection)
+
+Compounds two `Somemoji::EmojiCollection` into one `Somemoji::EmojiCollection`.
+
+```ruby
+require "somemoji"
+
+custom_emoji_collection = Somemoji.emoji_collection + Somemoji::EmojiCollection.new(
+  [
+    Somemoji::Emoji.new(code: "foo"),
+    Somemoji::Emoji.new(code: "bar"),
+  ]
+)
+custom_emoji_collection.find_by_code("foo").class #=> Somemoji::Emoji
+custom_emoji_collection.find_by_code("bar").class #=> Somemoji::Emoji
+custom_emoji_collection.find_by_code("100").class #=> Somemoji::Emoji
+```
+
+### Somemoji::EmojiCollection#replace_character(string, &block)
+
+Replace emoji characters in a given string with a given block.
+
+```ruby
+require "somemoji"
+
+Somemoji.emoji_collection.replace_code("I ❤ Emoji") do |emoji|
+  %(<img alt="#{emoji.character}" class="emoji" src="/assets/emoji/#{emoji.code_points.join('-').downcase}.png">)
+end
+#=> 'I <img alt="❤" class="emoji" src="/assets/emoji/2764.png"> Emoji'
+```
+
+### Somemoji::EmojiCollection#replace_code(string, &block)
+
+Replace emoji codes in a given string with a given block.
+
+```ruby
+require "somemoji"
+
+Somemoji.emoji_collection.replace_code("I :heart: Emoji") do |emoji|
+  %(<img alt="#{emoji.character}" class="emoji" src="/assets/emoji/#{emoji.code_points.join('-').downcase}.png">)
+end
+#=> 'I <img alt="❤" class="emoji" src="/assets/emoji/2764.png"> Emoji'
+```
+
+### Somemoji::Emoji.new
+
+Create a new `Somemoji::Emoji` instance from emoji definition data.
+
+```ruby
+require "somemoji"
+
+emoji = Somemoji::Emoji.new(
+  aliases: [],
+  ascii_arts: [],
+  category: "symbols",
+  code_points_alternates: [],
+  code_points: [
+    "1F4AF"
+  ],
+  code: "100",
+  keywords: [
+    "100",
+    "a",
+    "exam",
+    "numbers",
+    "parties",
+    "percent",
+    "perfect",
+    "plus",
+    "quiz",
+    "school",
+    "score",
+    "symbol",
+    "test",
+    "win",
+    "wow"
+  ],
+  name: "hundred points symbol"
+)
+emoji.character #=> "💯"
+```
+
+### Somemoji::Emoji#character
+
+Returns a String representation of an emoji if it has code points.
+
+```ruby
+require "somemoji"
+
+Somemoji.emojis.first.character #=> "💯"
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/data/100.json

@@ -0,0 +1,28 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "symbols",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F4AF"
+  ],
+  "code": "100",
+  "keywords": [
+    "100",
+    "a",
+    "exam",
+    "numbers",
+    "parties",
+    "percent",
+    "perfect",
+    "plus",
+    "quiz",
+    "school",
+    "score",
+    "symbol",
+    "test",
+    "win",
+    "wow"
+  ],
+  "name": "hundred points symbol"
+}

data/data/1234.json

@@ -0,0 +1,16 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "symbols",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F522"
+  ],
+  "code": "1234",
+  "keywords": [
+    "blue-square",
+    "numbers",
+    "symbol"
+  ],
+  "name": "input symbol for numbers"
+}

data/data/8ball.json

@@ -0,0 +1,23 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "activity",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F3B1"
+  ],
+  "code": "8ball",
+  "keywords": [
+    "ball",
+    "billiards",
+    "boys night",
+    "cue",
+    "eight ball",
+    "game",
+    "luck",
+    "pocket ball",
+    "pool",
+    "sport"
+  ],
+  "name": "billiards"
+}

data/data/a.json

@@ -0,0 +1,17 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "symbols",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F170"
+  ],
+  "code": "a",
+  "keywords": [
+    "alphabet",
+    "letter",
+    "red-square",
+    "symbol"
+  ],
+  "name": "negative squared latin capital letter a"
+}

data/data/ab.json

@@ -0,0 +1,16 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "symbols",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F18E"
+  ],
+  "code": "ab",
+  "keywords": [
+    "alphabet",
+    "red-square",
+    "symbol"
+  ],
+  "name": "negative squared ab"
+}

data/data/abc.json

@@ -0,0 +1,16 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "symbols",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F524"
+  ],
+  "code": "abc",
+  "keywords": [
+    "alphabet",
+    "blue-square",
+    "symbol"
+  ],
+  "name": "input symbol for latin letters"
+}

data/data/abcd.json

@@ -0,0 +1,16 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "symbols",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F521"
+  ],
+  "code": "abcd",
+  "keywords": [
+    "alphabet",
+    "blue-square",
+    "symbol"
+  ],
+  "name": "input symbol for latin small letters"
+}

data/data/accept.json

@@ -0,0 +1,20 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "symbols",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F251"
+  ],
+  "code": "accept",
+  "keywords": [
+    "agree",
+    "chinese",
+    "good",
+    "kanji",
+    "ok",
+    "symbol",
+    "yes"
+  ],
+  "name": "circled ideograph accept"
+}

data/data/aerial_tramway.json

@@ -0,0 +1,22 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "travel",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F6A1"
+  ],
+  "code": "aerial_tramway",
+  "keywords": [
+    "aerial",
+    "cable",
+    "train",
+    "tram",
+    "tramway",
+    "transport",
+    "transportation",
+    "travel",
+    "vehicle"
+  ],
+  "name": "aerial tramway"
+}

data/data/airplane.json

@@ -0,0 +1,32 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "travel",
+  "code_points_alternates": [
+    [
+      "2708",
+      "FE0F"
+    ]
+  ],
+  "code_points": [
+    "2708"
+  ],
+  "code": "airplane",
+  "keywords": [
+    "airbus",
+    "airlines",
+    "airplane",
+    "airport",
+    "boeing",
+    "flight",
+    "fly",
+    "jet",
+    "jumbo",
+    "plane",
+    "transportation",
+    "travel",
+    "vacation",
+    "vehicle"
+  ],
+  "name": "airplane"
+}

data/data/airplane_arriving.json

@@ -0,0 +1,26 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "travel",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F6EC"
+  ],
+  "code": "airplane_arriving",
+  "keywords": [
+    "airbus",
+    "airlines",
+    "airport",
+    "boeing",
+    "flight",
+    "fly",
+    "jet",
+    "jumbo",
+    "plane",
+    "transportation",
+    "travel",
+    "vacation",
+    "vehicle"
+  ],
+  "name": "airplane arriving"
+}

data/data/airplane_departure.json

@@ -0,0 +1,27 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "travel",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F6EB"
+  ],
+  "code": "airplane_departure",
+  "keywords": [
+    "airbus",
+    "airlines",
+    "airport",
+    "boeing",
+    "flight",
+    "fly",
+    "jet",
+    "jumbo",
+    "leaving",
+    "plane",
+    "transportation",
+    "travel",
+    "vacation",
+    "vehicle"
+  ],
+  "name": "airplane departure"
+}

data/data/airplane_small.json

@@ -0,0 +1,28 @@
+{
+  "aliases": [
+    "small_airplane"
+  ],
+  "ascii_arts": [],
+  "category": "travel",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F6E9"
+  ],
+  "code": "airplane_small",
+  "keywords": [
+    "airbus",
+    "airlines",
+    "airport",
+    "boeing",
+    "flight",
+    "fly",
+    "jet",
+    "jumbo",
+    "plane",
+    "transportation",
+    "travel",
+    "vacation",
+    "vehicle"
+  ],
+  "name": "small airplane"
+}

data/data/alarm_clock.json

@@ -0,0 +1,16 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "objects",
+  "code_points_alternates": [],
+  "code_points": [
+    "23F0"
+  ],
+  "code": "alarm_clock",
+  "keywords": [
+    "object",
+    "time",
+    "wake"
+  ],
+  "name": "alarm clock"
+}

data/data/alembic.json

@@ -0,0 +1,17 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "objects",
+  "code_points_alternates": [],
+  "code_points": [
+    "2697"
+  ],
+  "code": "alembic",
+  "keywords": [
+    "chemistry",
+    "object",
+    "science",
+    "tool"
+  ],
+  "name": "alembic"
+}

data/data/alien.json

@@ -0,0 +1,20 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "people",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F47D"
+  ],
+  "code": "alien",
+  "keywords": [
+    "UFO",
+    "alien",
+    "monster",
+    "paul",
+    "scientology",
+    "space",
+    "ufo"
+  ],
+  "name": "extraterrestrial alien"
+}

data/data/ambulance.json

@@ -0,0 +1,21 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "travel",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F691"
+  ],
+  "code": "ambulance",
+  "keywords": [
+    "911",
+    "ambulance",
+    "assistance",
+    "emergency",
+    "health",
+    "help",
+    "medical",
+    "transportation"
+  ],
+  "name": "ambulance"
+}

data/data/amphora.json

@@ -0,0 +1,14 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "objects",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F3FA"
+  ],
+  "code": "amphora",
+  "keywords": [
+    "object"
+  ],
+  "name": "amphora"
+}

data/data/anchor.json

@@ -0,0 +1,31 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "travel",
+  "code_points_alternates": [
+    [
+      "2693",
+      "FE0F"
+    ]
+  ],
+  "code_points": [
+    "2693"
+  ],
+  "code": "anchor",
+  "keywords": [
+    "anchor",
+    "boat",
+    "ferry",
+    "harbor",
+    "marina",
+    "object",
+    "ocean",
+    "sailor",
+    "ship",
+    "shipyard",
+    "tattoo",
+    "travel",
+    "vacation"
+  ],
+  "name": "anchor"
+}

data/data/angel.json

@@ -0,0 +1,23 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "people",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F47C"
+  ],
+  "code": "angel",
+  "keywords": [
+    "angel",
+    "baby",
+    "cupid",
+    "diversity",
+    "halo",
+    "heaven",
+    "jesus",
+    "omg",
+    "people",
+    "wings"
+  ],
+  "name": "baby angel"
+}

data/data/angel_tone1.json

@@ -0,0 +1,19 @@
+{
+  "aliases": [],
+  "ascii_arts": [],
+  "category": "people",
+  "code_points_alternates": [],
+  "code_points": [
+    "1F47C",
+    "1F3FB"
+  ],
+  "code": "angel_tone1",
+  "keywords": [
+    "cupid",
+    "halo",
+    "heaven",
+    "jesus",
+    "wings"
+  ],
+  "name": "baby angel tone 1"
+}