unicode-emoji 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8a2374f40fac31061e825e42b16bbed3ad4455c
-  data.tar.gz: 567004277315d4a7a05dd7a86e07056e968e78ef
+  metadata.gz: 8c4eb20ad652c14682be8230ae7d0055bbf20960
+  data.tar.gz: 74859c59a011fc5e6464fac81851ff1e1c0f14c8
 SHA512:
-  metadata.gz: 317e769c1426b946ff102670024dda19f8fbe0975af670a01ff79fc0e3c50571ccac503082dda8468b696dd9574ad206c39e20989f8b283993b7c3b48591c356
-  data.tar.gz: b2608a118f51a6c11d579696b4949ceef9827ee45c93609e3816c303199246942842150e240a9f33a013c2290ee1abd8e1b82960b2dcd93ffcc28c9c8debc4f8
+  metadata.gz: 42556f73e4623278ef522855822711fa133fbd7a0bd4c04b3a7c4aae8976e7678f5d8ea61408346517c768b3416f8808a37d0900ea7fdabd3a3bea96c0d3fe08
+  data.tar.gz: 9491eebda45d972a0a11df1ce9f688f1c7c66646b09d261a6aff91549ddc5c3eb881a0bb71a8551da1a5046e074a44c993fc7479df98f6c927eaf5774691a6cd

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 ## CHANGELOG
 
+### 0.9.1
+
+- Include a categorized list of recommended Emoji
+
 ### 0.9.0
 
-* Initial release (Emoji version 5.0)
+- Initial release (Emoji version 5.0)
 

data/README.md

@@ -2,6 +2,8 @@
 
 A small Ruby library which provides Unicode Emoji data and regexes.
 
+Also includes a categorized list of recommended Emoji.
+
 Emoji version: **5.0**
 
 Supported Rubies: **2.4**, **2.3**, **2.2**, **2.1**
@@ -54,12 +56,29 @@ Regex                         | Description | Example Matches | Example Non-Matc
 `Unicode::Emoji::REGEX_TEXT`  | Matches only textual singleton Emoji (except for singleton components, like digit 1) | `😴︎`, `▶` | `😴`, `▶️`, `🏻`, `🛌🏽`, `🇵🇹`, `🇵🇵`,`2️⃣`, `🏴󠁧󠁢󠁳󠁣󠁴󠁿`, `🏴󠁧󠁢󠁡󠁧󠁢󠁿`, `🤾🏽‍♀️`, `🤠‍🤢`
 `Unicode::Emoji::REGEX_ANY`   | Matches any Emoji-related codepoint (but no variation selectors or tags) | `😴`, `▶`, `🏻`, `🛌`, `🏽`, `🇵`, `🇹`, `2`, `🏴`, `🤾`, `♀`, `🤠`, `🤢` | -
 
+## List
+
+Use `Unicode::Emoji::LIST` or the list method to get a grouped (and ordered) list of Emoji:
+
+```ruby
+Unicode::Emoji.list.keys
+# => ["Smileys & People", "Animals & Nature", "Food & Drink", "Travel & Places", "Activities", "Objects", "Symbols", "Flags"]
+
+Unicode::Emoji.list("Food & Drink").keys
+# => ["food-fruit", "food-vegetable", "food-prepared", "food-asian", "food-sweet", "drink", "dishware"]
+
+Unicode::Emoji.list("Food & Drink", "food-asian")
+=> ["🍱", "🍘", "🍙", "🍚", "🍛", "🍜", "🍝", "🍠", "🍢", "🍣", "🍤", "🍥", "🍡", "\u{1F95F}", "\u{1F960}", "\u{1F961}"]
+```
+
+A markdown file with all recommended emoji can be found [in this gist](https://gist.github.com/janlelis/72f9be1f0ecca07372c64cf13894b801).
 
 ## Also See
 
 - [Unicode® Technical Standard #51](http://www.unicode.org/reports/tr51/proposed.html)
 - [Emoji data](http://unicode.org/Public/emoji/5.0/)
-- [Emoji sequence names](https://github.com/janlelis/unicode-sequence_name)
+- [Emoji categories](http://unicode.org/emoji/charts/emoji-ordering.html)
+- Ruby gem which displays [Emoji sequence names](https://github.com/janlelis/unicode-sequence_name)
 - Part of [unicode-x](https://github.com/janlelis/unicode-x)
 
 ## MIT

data/lib/unicode/emoji.rb

@@ -31,6 +31,8 @@ module Unicode
     RECOMMENDED_SUBDIVISION_FLAGS = INDEX[:TAGS].freeze
     RECOMMENDED_ZWJ_SEQUENCES     = INDEX[:ZWJ].freeze
 
+    LIST                          = INDEX[:LIST].freeze.each{ |_, sub_list| sub_list.freeze }
+
     pack = ->(ord){ Regexp.escape(Array(ord).pack("U*")) }
     join = -> (*strings){ "(?:" + strings.join("|") + ")" }
     pack_and_join = ->(ords){  join[*ords.map{ |ord| pack[ord] }] }
@@ -127,6 +129,18 @@ module Unicode
       end
     end
 
+    def self.list(key = nil, sub_key = nil)
+      if key
+        if sub_key
+          LIST[key][sub_key]
+        else
+          LIST[key]
+        end
+      else
+        LIST
+      end
+    end
+
     def self.get_codepoint_value(char)
       ord = nil
 

data/lib/unicode/emoji/constants.rb

@@ -2,7 +2,7 @@
 
 module Unicode
   module Emoji
-    VERSION = "0.9.0".freeze
+    VERSION = "0.9.1".freeze
     EMOJI_VERSION = "5.0".freeze
     DATA_DIRECTORY = File.expand_path(File.dirname(__FILE__) + '/../../../data/').freeze
     INDEX_FILENAME = (DATA_DIRECTORY + '/emoji.marshal.gz').freeze

data/spec/unicode_emoji_spec.rb

@@ -292,4 +292,18 @@ describe Unicode::Emoji do
       assert_equal ["1", "😴", "🇵", "🏾", "🏴"], matches
     end
   end
+
+  describe ".list" do
+    it "returns a grouped list of emoji" do
+      assert_includes Unicode::Emoji.list.keys, "Smileys & People"
+    end
+
+    it "sub-groups the list of emoji" do
+      assert_includes Unicode::Emoji.list("Smileys & People").keys, "face-positive"
+    end
+
+    it "has emoji in sub-groups" do
+      assert_includes Unicode::Emoji.list("Smileys & People", "face-positive"), "😎"
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unicode-emoji
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-08 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies: []
 description: "[Emoji 5.0] Retrieve emoji data about Unicode codepoints. Also contains
   a regex to match emoji."