emoji 0.1.1 → 1.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bbc7674db316aa4a28b51174ed31282117d504b
-  data.tar.gz: 857672fc8f921547666f9e231d1c3ef2da9a60c2
+  metadata.gz: a929fc9ff4526ff22891d4cd39db46596c47d252
+  data.tar.gz: 7c578285ac4c5f5935cf5efd02ae99887c4de8af
 SHA512:
-  metadata.gz: 7f41d7669dc0a0b2704113d19445ef9a698df0fe8ec8dc1597aa25bf8207c35c625b3da0a8734cddf3566c7168e7443be6689f030fb7e840b54f341c3d26fd49
-  data.tar.gz: 01d98f3dbd2b80ef12c683ecea50c61eb642e1737a13a215428117a61f52003a7933e79efc0f52475ceb3e9e4b1f14e6ee5cd245ac2256a7e6a59b28c288e697
+  metadata.gz: 38dfb77e033583b2840f8f03c45c2210a7838a3224d8fddd5c142a38e3acb28b39d4d2f17d85ca8df1a94d2791fc40ddd7b754cf488e1597d510fbd9ea2594fc
+  data.tar.gz: 301d8332f7a29209f9de3683ecb28eee97b60e7175f0238874caf6ba16cb77dd8690f22a437c3b238530fa84ce9ecd930c69b2b40aa0b6b2e68c9f23dec71d6d

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-2.0.0-p247@emoji --create

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steve Klabnik
+
+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,102 @@
+# Emoji
+
+A Ruby gem. For emoji. For everyone. :heart:
+
+This gem includes an image library of open-source emoji and APIs for working with them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'emoji'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install emoji
+    
+Install emoji image library assets:
+
+    $ rake emoji:install_assets
+    ====================================================================
+    = emoji image assets install
+    = Target: /Users/user/src/rails-app/app/assets/images/emoji
+    = Source: /Users/user/src/emoji/assets/images
+    ====================================================================
+    - Creating /Users/user/src/rails-app/app/assets/images/emoji...
+    - Installing assets...
+
+## Usage
+
+You can use this gem to replace unicode emoji characters with img tags linking to the appropriate emoji image.
+
+Image Replacement APIs:
+
+    > Emoji.replace_unicode_moji_with_images('I ❤ Emoji')
+    => "I <img class=\"emoji\" src=\"http://localhost:3000/assets/emoji/heart.png\"> Emoji"
+
+    > Emoji.image_url_for_unicode_moji('❤')
+    => "http://localhost:3000/assets/emoji/heart.png"
+    
+    > Emoji.image_url_for_name('heart')
+    => "http://localhost:3000/assets/emoji/heart.png"
+
+Emoji Library Index APIs:
+
+    > index = Emoji::Index.new
+    
+    > index.find_by_name('heart')
+    => {"moji"=>"❤", "name"=>"heart", "name-ja"=>"ハート", "category"=>"abstract", "unicode"=>"2764"}
+    
+    > index.find_by_moji('❤')
+    => {"moji"=>"❤", "name"=>"heart", "name-ja"=>"ハート", "category"=>"abstract", "unicode"=>"2764"}
+
+Default configuration integrates with Rails, but you can change it with an initializer:
+    
+    # config/initializers/emoji.rb
+    Emoji.asset_host = "emoji.cdn.com"
+    Emoji.asset_path = '/assets/emoji'
+
+String Helper Methods:
+
+You can also 
+
+    include 'emoji/string_ext'
+
+and call methods directly on your string to return the same results:
+
+    > 'I ❤ Emoji'.with_emoji_images
+    => "I <img class=\"emoji\" src=\"http://localhost:3000/assets/emoji/heart.png\"> Emoji"
+
+    > 'heart'.image_url
+    > '❤'.image_url
+    => "http://localhost:3000/assets/emoji.heart.png"
+    
+    > 'heart'.emoji_data
+    > '❤'.emoji_data
+    => {"moji"=>"❤", "name"=>"heart", "name-ja"=>"ハート", "category"=>"abstract", "unicode"=>"2764"}
+
+
+## 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.
+
+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:
+
+    gem 'escape_utils'
+
+
+## Contributing
+
+1. Fork it
+2. Bundle Install (`bundle install`)
+3. Run the Tests (`rake test`)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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