emoji 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3db53a871c5e23c6351a7f65f4a42d553cf9939
-  data.tar.gz: 887e181e6e54b5f55426c7a2ad0a338cf50660e7
+  metadata.gz: 85b117fc2248c58f4b7c1b271121cefcc58ecd7a
+  data.tar.gz: 1b78b3e8d1d096e644110f03d41fdaf64d6ddf50
 SHA512:
-  metadata.gz: 48be0c44cad71b861e291e96a47bed6f49e355e743b0c2b03feb63151471a7efeba82d9226a2749a97c9230bfeb592d9229c33241141011e901609d7121e689f
-  data.tar.gz: 9a6a4ec187f2d1afeb022627c5bb3abe462368b14f49a8762d0b050bcf504006fa0cf46ce50a1890be7c4ac8a6f021dd138bdf47e6ce9462eaa1928c6adf87d3
+  metadata.gz: 10e36d5aab8e0a94fc2f28cf9ab8b0b59786127089dd6c86f876a10821480a9be6f0103a9ecc1cc15357097cfaed232c0a945d3194099737b5f1258a3b092a5e
+  data.tar.gz: 0ae62138344caec64c023abfd93731e31202bfbc4ff0d3df241e04c6fc21fe02715403c2d657bd7262587667dc80e3173886a05577dad024c0c795b32a623211

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Releases / Changes
 
+## 1.0.6
+
+* Adds `Emoji.replace_unicode_moji_with_name()` for Markdown
+
 ## 1.0.5
 
 * Adds support for dynamic Emoji.asset_host as a proc (ala Rails.asset_host)

data/README.md

@@ -1,16 +1,27 @@
 # Emoji
+[![Build Status](https://travis-ci.org/wpeterson/emoji.svg?branch=master)](https://travis-ci.org/wpeterson/emoji)
 
 A Ruby gem. For emoji. For everyone. :heart:
 
-[![Build Status](https://travis-ci.org/wpeterson/emoji.svg?branch=master)](https://travis-ci.org/wpeterson/emoji)
-
 This gem exposes the [Phantom Open Emoji library](https://github.com/Genshin/PhantomOpenEmoji) unicode/image assets and APIs for working with them.
 
-Easily lookup emoji name, unicode character, or image assets and convert emoji representations.
+Easily look up emoji's name, unicode character, or image assets and convert it into emoji representations.
+
+## Table of Contents
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Image Replacement APIs](#image-replacement-apis)
+  - [Emoji Library Index APIs](#emoji-library-index-apis)
+  - [String Helper Methods](#string-helper-methods)
+- [Emoji Asset Host](#emoji-asset-host)
+- [HTML Safety and Performance](#html-safety-and-performance)
+- [Contributors :heart:](#contributors-heart)
+- [Contributing](#contributing)
+
 
 ## Installation
 
-Add this line to your application's Gemfile:
+First, add this line to your application's Gemfile:
 
 ```ruby
 gem 'emoji'
@@ -23,8 +34,8 @@ And then execute:
 Or install it yourself as:
 
     $ gem install emoji
-    
-Install emoji image library assets:
+
+Finally, install the emoji image library assets:
 
     $ rake emoji:install_assets
     ====================================================================
@@ -37,9 +48,9 @@ Install emoji image library assets:
 
 ## Usage
 
-You can use this gem to replace unicode emoji characters with img tags linking to the appropriate emoji image.
+You can use this gem to replace unicode emoji characters with `img` tags linking to the appropriate emoji image.
 
-Image Replacement APIs:
+### Image Replacement APIs:
 
 ```ruby
 > Emoji.replace_unicode_moji_with_images('I ❤ Emoji')
@@ -52,7 +63,7 @@ Image Replacement APIs:
 => "http://localhost:3000/assets/emoji/heart.png"
 ```
 
-Emoji Library Index APIs:
+### Emoji Library Index APIs:
 
 ```ruby
 > index = Emoji::Index.new
@@ -67,20 +78,20 @@ Emoji Library Index APIs:
 => {"moji"=>"❤", "name"=>"heart", "name-ja"=>"ハート", "category"=>"abstract", "unicode"=>"2764"}
 ```
 Default configuration integrates with Rails, but you can change it with an initializer:
-   
-```ruby 
+
+```ruby
 # config/initializers/emoji.rb
 Emoji.asset_host = "emoji.cdn.com"
 Emoji.asset_path = '/assets/emoji'
 Emoji.use_plaintext_alt_tags = true
 ```
 
-String Helper Methods:
+### String Helper Methods:
 
-You can also 
+You can also include the string helper module
 
 ```ruby
-include 'emoji/string_ext'
+require 'emoji/string_ext'
 ```
 
 and call methods directly on your string to return the same results:
@@ -98,8 +109,8 @@ and call methods directly on your string to return the same results:
 => {"moji"=>"❤", "name"=>"heart", "name-ja"=>"ハート", "category"=>"abstract", "unicode"=>"2764"}
 ```
 
-## Emoji Asset host
-By default, if used with Rails this gem will inherit Rails configured `Rails.asset_host`.  Otherwise, you will need to configure the `Emoji.asset_host` as a string URL or a lambda/proc.
+## Emoji Asset Host
+By default when used with Rails, this gem will inherit Rails configured `Rails.asset_host`.  Otherwise, you will need to manually configure the `Emoji.asset_host` as a string URL or a lambda/proc.
 
 ```ruby
 # String URL
@@ -111,9 +122,9 @@ Emoji.asset_host = lambda {|path| path.size % 2 == 0 ? 'http://even.com' : 'http
 
 ## HTML Safety and Performance
 
-This gem uses pure ruby code for compatibility with different Ruby virtual machines.  However, there can be significant performance gains to escaping incoming HTML strings using optimized, native code in the `escape_utils` gem.
+This gem uses pure Ruby code for compatibility with different Ruby virtual machines.  However, there can be significant performance gains to escaping incoming HTML strings using optimized, native code in the `escape_utils` gem.
 
-The emoji gem will try to use `escape_utils` if it's available, but does not require it.  [Benchmarks show a 10x-100x improvement](https://gist.github.com/wpeterson/c851be471bd91868716c) in HTML escaping performance, based on the size of the string being processed.
+The `emoji` gem will try to use `escape_utils` if it's available, but does not require it.  [Benchmarks show a 10x-100x improvement](https://gist.github.com/wpeterson/c851be471bd91868716c) in HTML escaping performance, based on the size of the string being processed.
 
 To enable native HTML escaping, add this line to your application's Gemfile:
 
@@ -122,7 +133,7 @@ gem 'escape_utils'
 ```
 ## Contributors: :heart:
 
-This project was spawned from conversation at the BurlingtonRB conference between Steve/Winfield.  Together they built the initial gem.  Huge thanks to everyone else who's submitted code and work to the project.
+This project was spawned from conversation at the [BurlingtonRB conference](http://www.burlingtonrubyconference.com/) between [Steve](https://github.com/steveklabnik)/[Winfield](https://github.com/wpeterson). Together, they built the the initial gem.  Huge thanks to everyone else who's submitted code and work to the project.
 
 * [@steveklabnik](https://github.com/steveklabnik): Created this project and made it all happen
 * [@wpeterson](https://github.com/wpeterson): gem implementation
@@ -134,10 +145,11 @@ This project was spawned from conversation at the BurlingtonRB conference betwee
 * [@tumes](https://github.com/tumes): Plaintext Emoji Alt Tags
 * [@poporul](https://github.com/poporul): Emoji::Index Refactoring
 * [@dilkhush](https://github.com/dilkhush): Emoji::Index Search by Unicode
+* [@cromulus](https://github.com/cromulus): Emoji.replace_unicode_moji_with_name() API
 
 ## Contributing
 
-1. Fork it
+1. Fork the repo
 2. Bundle Install (`bundle install`)
 3. Run the Tests (`rake test`)
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/lib/emoji.rb

@@ -47,8 +47,8 @@ module Emoji
       hostname = uri.hostname || uri.path
       port_string = extract_port_string(uri)
     end
-      
-     "#{ scheme_string }#{ hostname }#{ port_string }"
+
+    "#{ scheme_string }#{ hostname }#{ port_string }"
   end
 
   def self.parse_asset_host_uri(asset_host_spec)
@@ -132,6 +132,22 @@ module Emoji
     safe_string
   end
 
+  def self.replace_unicode_moji_with_name(string)
+    return string unless string
+    unless string.match(index.unicode_moji_regex)
+      return safe_string(string)
+    end
+
+    safe_string = safe_string(string.dup)
+    safe_string.gsub!(index.unicode_moji_regex) do |moji|
+      emoji = index.find_by_moji(moji)
+      %Q{:#{emoji['name']}:}
+    end
+    safe_string = safe_string.html_safe if safe_string.respond_to?(:html_safe)
+
+    safe_string
+  end
+
   def self.safe_string(string)
     if string.respond_to?(:html_safe?) && string.html_safe?
       string

data/lib/emoji/version.rb

@@ -1,3 +1,3 @@
 module Emoji
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

data/test/emoji_test.rb

@@ -104,6 +104,16 @@ describe Emoji do
     end
   end
 
+  describe 'replace_unicode_moji_with_name' do
+    it 'should return original string without emoji' do
+      assert_equal "foo", Emoji.replace_unicode_moji_with_name('foo')
+    end
+    it 'should replace an emoji with its ascii name' do
+      base_string = "I ❤ Emoji"
+      assert_equal "I :heart: Emoji", Emoji.replace_unicode_moji_with_name(base_string)
+    end
+  end
+
   describe "replace_unicode_moji_with_images" do
     it 'should return original string without emoji' do
       assert_equal "foo", Emoji.replace_unicode_moji_with_images('foo')
@@ -159,7 +169,7 @@ describe Emoji do
         replaced_string = string.stub(:html_safe?, true) do
           Emoji.replace_unicode_moji_with_images(string)
         end
-        
+
         assert_equal "<img alt=\"❤\" class=\"emoji\" src=\"http://localhost:3000/heart.png\"><a href=\"harmless\">", replaced_string
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emoji
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Steve Klabnik
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2016-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -605,7 +605,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: 'A Ruby gem. For emoji. For everyone. :heart:'