emoji_data 0.0.1pre1 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f191eca7f7de6e6588fd01310ef0b1c9778d811e
-  data.tar.gz: cabdf97b59c4af32b28f7a20703ae31b1f119d8b
+  metadata.gz: dab837b7cd073e03b87f156cc2472c78cfa1a5a5
+  data.tar.gz: f6f8aa09037e39585efdfbb9aee1be99eb70973a
 SHA512:
-  metadata.gz: 4e54371b53461386c44530d18feb79c1df3821770852da849e5aed3281d4245a5a7eab868aa02edc8e7ab6f3d4a75031c06955e2ec1bc7e4649c0c3e18007ce5
-  data.tar.gz: 1bebd21c73fe98c48face452a755e6b539c198c7192161125649f9f9f6752e2d5f7e9496b4a08714daa3c90bfe78a1fcccf9dd5a2030809750b8dd77e6561a3c
+  metadata.gz: 29bb1371373e4c4b8525f7b32b5b6b44defa1b655505eb263abf1d8656fab671aa11b3084807b2d9a92e71295c612a31b7f5c1b04d6adf106b8c173e0a38b0e5
+  data.tar.gz: 2c04729c219a862f94464cb89a16fa220250989cd822fd0618929e64733fae8fafb0a810375943a1a6757affefb72f9df1c85eb946a4f58b82e1cec83505f99a

data/.travis.yml

@@ -1,5 +1,10 @@
 language: ruby
 rvm:
  - 1.8.7
+ - 1.9.2
  - 1.9.3
  - 2.0.0
+
+matrix:
+  allow_failures:
+    - rvm: 1.8.7

data/README.md

@@ -1,10 +1,13 @@
 # emoji_data.rb
 
-Provides classes and methods for dealing with emoji character data as unicode.
+[![Gem Version](https://badge.fury.io/rb/emoji_data.png)](http://badge.fury.io/rb/emoji_data)
+[![Build Status](https://travis-ci.org/mroth/emoji_data.rb.png?branch=master)](https://travis-ci.org/mroth/emoji_data.rb)
 
-Note, this is more useful for low-level operations.  If you can avoid having to deal with unicode character data extensively and just want to encode/decode stuff, [rumoji](https://github.com/mwunsch/rumoji) is probably a better bet for you.
+Provides classes and helpers for dealing with emoji character data as unicode.  Wraps a library of all known emoji characters and provides convenience methods.
 
-This library currently considers `iamcal/emoji-data` to be the "source of truth" regarding certain things, such as how to represent doublebyte unified codepoints as strings.
+Note, this is mostly useful for low-level operations.  If you can avoid having to deal with unicode character data extensively and just want to encode/decode stuff, [rumoji](https://github.com/mwunsch/rumoji) might be a better bet for you.
+
+This library currently uses `iamcal/emoji-data` as it's library dataset, and thus considers it to be the "source of truth" regarding certain things, such as how to represent doublebyte unified codepoint IDs as strings (seperated by a dash).
 
 This is basically a helper library for [emojitrack](https://github.com/mroth/emojitrack) and [emojistatic](https://github.com/mroth/emojistatic), but may be useful for other people.
 
@@ -22,10 +25,44 @@ Or install it yourself as:
 
     $ gem install emoji_data
 
-## Usage
+Currently requires Ruby 1.9 or more recent.
+
+## Library Usage
+
+Pretty straightforward, read the source.  But here are some things you might care about:
+
+### EmojiData
+
+  The `EmojiData` module provides some convenience methods for dealing with the library of known emoji characters.  Check out the source to see what's up.
+
+Some notable methods to call out:
+
+ - `EmojiData.find_by_unified(id)` gives you a quick way to grab a specific EmojiChar.
+
+		>> EmojiData.find_by_unified('1f680')
+	 	=> #<EmojiData::EmojiChar:0x007fd455ab2ff8 @name="ROCKET", @unified="1F680", @docomo="", @au="E5C8", @softbank="E10D", @google="FE7ED", @image="1f680.png", @sheet_x=21, @sheet_y=28, @short_name="rocket", @short_names=["rocket"], @text=nil>
+
+ - `EmojiData.find_by_name(name)` and `.find_by_short_name(name)` do pretty much what you'd expect:
+
+		>> EmojiData.find_by_name('thumb')
+		=> [#<EmojiData::EmojiChar:0x007f9db214a558 @name="THUMBS UP SIGN", @unified="1F44D", @docomo="E727", @au="E4F9", @softbank="E00E", @google="FEB97", @image="1f44d.png", @sheet_x=10, @sheet_y=17, @short_name="+1", @short_names=["+1", "thumbsup"], @text=nil>, #<EmojiData::EmojiChar:0x007f9db2149720 @name="THUMBS DOWN SIGN", @unified="1F44E", @docomo="E700", @au="EAD5", @softbank="E421", @google="FEBA0", @image="1f44e.png", @sheet_x=10, @sheet_y=18, @short_name="-1", @short_names=["-1", "thumbsdown"], @text=nil>]
+
+ - `EmojiData.char_to_unified(char)` takes a string containing a unified unicode representation of an emoji character and gives you the unicode ID.
+
+		>> EmojiData.char_to_unified(:rocket:)
+		=> "1F680"
+
+ - `EmojiData.all` will return an array of all known EmojiChars, so you can map or do whatever funky Enumerable stuff you want to do across the entire character set.
+
+ 		#gimmie the shortname of all doublebyte chars
+ 		>> EmojiData.all.select(&:doublebyte?).map(&:short_name)
+		=> ["hash", "zero", "one", "two", "three", "four", "five", "six", "seven", "eight", "nine", "cn", "de", "es", "fr", "gb", "it", "jp", "kr", "ru", "us"]
+
+
+### EmojiData::EmojiChar
+
+  `EmojiData::EmojiChar` is a class representing a single emoji character.  All the variables from the `iamcal/emoji-data` dataset have dynamically generated getter methods.
 
-Things you might care about:
+There are some additional convenience methods, such as `#doublebyte?` etc. Most important addition is the `#char` method which will output a properly unicode encoded string containing the character.
 
-  `EmojiData::EmojiChar`: is a class representing a single emoji character.  All the variables from `emoji-data` have dynamically generated getter methods.  There are some additional convenience methods, such as `#doublebyte?` etc. Most important addition is the `#char` method which will output a properly unicode encoded string containing the character.
 
-  The `EmojiData` module itself has some convenience methods.  Check out the source to see what's up. Probably most useful is `.all` which gives you an array of all known EmojiChars, so you can map or do whatever funky Enumerable stuff you need to do across the entire character set.

data/emoji_data.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = EmojiData::VERSION
   spec.authors       = ["Matthew Rothenberg"]
   spec.email         = ["mrothenberg@gmail.com"]
-  spec.description   = %q{Provides classes and methods for dealing with emoji character data as unicode.}
+  spec.description   = %q{Provides classes and helpers for dealing with emoji character data as unicode.  Wraps a library of all known emoji characters and provides convenience methods.}
   spec.summary       = %q{Provides classes and methods for dealing with emoji character data as unicode.}
   spec.homepage      = "https://github.com/mroth/emoji_data.rb"
   spec.license       = "MIT"
@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
 
   spec.add_dependency "json"
+
+  spec.required_ruby_version = '>= 1.9.2'
 end

data/lib/emoji_data.rb

@@ -29,13 +29,22 @@ module EmojiData
   end
 
   def self.find_by_unified(cp)
-    EMOJI_CHARS.detect { |ec| ec.unified == cp }
+    EMOJI_CHARS.detect { |ec| ec.unified == cp.upcase }
+  end
+
+  def self.find_by_name(name)
+    # self.all.select { |char| char.name.include? name.upcase }
+    self.find_by_value(:name, name.upcase)
+  end
+
+  def self.find_by_short_name(short_name)
+    # self.all.select { |char| char.short_name.include? name.downcase }
+    self.find_by_value(:short_name, short_name.downcase)
+  end
+
+  protected
+  def self.find_by_value(field,value)
+    self.all.select { |char| char.send(field).include? value }
   end
 
-  # not sure why the below doesnt work... but maybe fuck reverse compatibility for MYSELF
-  # self.module_eval do
-  #   alias_method :find_by_codepoint, :find_by_unified
-  #   alias_method :char_to_codepoint, :char_to_unified
-  #   alias_method :codepoint_to_char, :unified_to_char
-  # end
 end

data/lib/emoji_data/version.rb

@@ -1,3 +1,3 @@
 module EmojiData
-  VERSION = "0.0.1pre1"
+  VERSION = "0.0.1"
 end

data/spec/emoji_char_spec.rb

@@ -1,3 +1,4 @@
+#encoding: UTF-8
 require 'spec_helper'
 
 describe EmojiChar do

data/spec/emoji_data_spec.rb

@@ -11,6 +11,41 @@ describe EmojiData do
     end
   end
 
+  describe ".find_by_unified" do
+    it "should find the proper EmojiChar object" do
+      results = EmojiData.find_by_unified('1f680')
+      results.should be_kind_of(EmojiChar)
+      results.name.should eq('ROCKET')
+    end
+    it "should normallise capitalization for hex values" do
+      EmojiData.find_by_unified('1f680').should_not be_nil
+    end
+  end
+
+  describe ".find_by_name" do
+    it "returns an array of results" do
+      EmojiData.find_by_name('tree').should be_kind_of(Array)
+      EmojiData.find_by_name('tree').count.should eq(5)
+    end
+    it "returns [] if nothing is found" do
+      EmojiData.find_by_name('sdlkfjlskdfj').should_not be_nil
+      EmojiData.find_by_name('sdlkfjlskdfj').should be_kind_of(Array)
+      EmojiData.find_by_name('sdlkfjlskdfj').count.should eq(0)
+    end
+  end
+
+  describe ".find_by_short_name" do
+    it "returns an array of results, downcasing if needed" do
+      EmojiData.find_by_short_name('MOON').should be_kind_of(Array)
+      EmojiData.find_by_short_name('MOON').count.should eq(13)
+    end
+    it "returns [] if nothing is found" do
+      EmojiData.find_by_short_name('sdlkfjlskdfj').should_not be_nil
+      EmojiData.find_by_short_name('sdlkfjlskdfj').should be_kind_of(Array)
+      EmojiData.find_by_short_name('sdlkfjlskdfj').count.should eq(0)
+    end
+  end
+
   describe ".char_to_unified" do
     it "converts normal emoji to unified codepoint" do
       EmojiData.char_to_unified("👾").should eq('1F47E')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emoji_data
 version: !ruby/object:Gem::Version
-  version: 0.0.1pre1
+  version: 0.0.1
 platform: ruby
 authors:
 - Matthew Rothenberg
@@ -66,8 +66,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Provides classes and methods for dealing with emoji character data as
-  unicode.
+description: Provides classes and helpers for dealing with emoji character data as
+  unicode.  Wraps a library of all known emoji characters and provides convenience
+  methods.
 email:
 - mrothenberg@gmail.com
 executables: []
@@ -100,12 +101,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.2