emoji 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a5314dfa9bd2b9fefb8db7cd2c5b52643a11615
-  data.tar.gz: ce8ef4dfdbf6044d5864f2ab5a4846d19bc3b36e
+  metadata.gz: 1a107032c52334744a9ea531dc52687ad3734542
+  data.tar.gz: 02a61e602aafe01ed88f7f536f35e06846463854
 SHA512:
-  metadata.gz: 9dea51512846eb336698457bd4a12f6898c8b9906261b913cc720303a24f03c5c67e7666053ad00f26be58626479f71ba93642911c1a2fb33d37a45a2344630f
-  data.tar.gz: 847d2edef664e9949e59c71112b369d0af4ab5cdd91277d9de02fd05a35908466f1e465372e0413d4aedd188ffdc4231e1122d5f7fdfe7fce06d9f8d9e8255a3
+  metadata.gz: 109658ab8eb1bf45b80cbbe27e3eed081bb702d68b16f6e2a05e95a4de14811556ad915ffbc6e23fc5e19d37d335d8b77ae2f47554329dd1f4e149077ab09a73
+  data.tar.gz: 1bdfd0c4687546ff3ba1a6676e93eab048471ac0e19220c576d5b1f9841db71279c97e4a078680938a5cccc6ac9c994c29737d4250c6689875e31b830603e902

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+sudo: false
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode
+  - rbx-2
+  - ruby-head
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Releases / Changes
 
+## 1.0.2
+
+* Improved Emoji.asset_host configuration/handling
+* Emoji::Index cleanup and find_by_unicode
+* Plaintext alt tags (optional)
+
 ## 1.0.1
 
 * Important html_safe security fix.

data/README.md

@@ -2,6 +2,8 @@
 
 A Ruby gem. For emoji. For everyone. :heart:
 
+[![Build Status](https://travis-ci.org/steveklabnik/emoji.svg?branch=master)](https://travis-ci.org/steveklabnik/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.
@@ -67,6 +69,7 @@ Default configuration integrates with Rails, but you can change it with an initi
 # config/initializers/emoji.rb
 Emoji.asset_host = "emoji.cdn.com"
 Emoji.asset_path = '/assets/emoji'
+Emoji.use_plaintext_alt_tags = true
 ```
 
 String Helper Methods:
@@ -109,6 +112,10 @@ gem 'escape_utils'
 * [@mikowitz](https://github.com/mikowitz): `String` ext helpers
 * [@semanticart](https://github.com/semanticart): Cleanup/Ruby 1.9.3 support
 * [@parndt](https://github.com/parndt): README doc fixes
+* [@neuegram](https://github.com/neuegram): XSS Security Audit
+* [@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
 
 ## Contributing
 

data/emoji.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "json"
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "debugger"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
 end

data/lib/emoji.rb

@@ -1,5 +1,6 @@
 require 'emoji/version'
 require 'json'
+require 'uri'
 
 # Optionally load EscapeUtils if it's available
 begin
@@ -15,14 +16,48 @@ require "emoji/railtie" if defined?(Rails)
 module Emoji
   @asset_host = nil
   @asset_path = nil
+  @use_plaintext_alt_tags = nil
   @escaper = defined?(EscapeUtils) ? EscapeUtils : CGI
 
   def self.asset_host
     @asset_host || 'http://localhost:3000'
   end
 
-  def self.asset_host=(host)
-    @asset_host = host
+  def self.asset_host=(asset_host)
+    @asset_host = parse_and_validate_asset_host(asset_host)
+  end
+
+  def self.parse_and_validate_asset_host(asset_host_spec)
+    begin
+      uri = URI.parse(asset_host_spec)
+      scheme_string = extract_uri_scheme_string(asset_host_spec, uri)
+      hostname = uri.hostname || uri.path
+      port_string = extract_port_string(uri)
+      
+      return "#{ scheme_string }#{ hostname }#{ port_string }"
+    rescue URI::InvalidURIError
+      raise 'Invalid Emoji.asset_host, should be a hostname or URL prefix'
+    end
+  end
+
+  def self.extract_uri_scheme_string(asset_host_spec, uri)
+    # Special Case for Protocol Relative Scheme: //hostname.com/
+    if asset_host_spec.size >= 2 && asset_host_spec[0..1] == '//'
+      return '//'
+    end
+
+    # Extract Protocol from asset_host_spec URI or default to HTTP
+    scheme = uri.scheme || 'http'
+
+    "#{ scheme }://"
+  end
+
+  def self.extract_port_string(uri)
+    return nil unless uri.port
+    return nil if uri.port == 80 && uri.scheme == 'http'
+    return nil if uri.port == 443 && uri.scheme == 'https'
+
+    return ":#{uri.port}"
   end
 
   def self.asset_path
@@ -33,6 +68,14 @@ module Emoji
     @asset_path = path
   end
 
+  def self.use_plaintext_alt_tags
+    @use_plaintext_alt_tags || false
+  end
+
+  def self.use_plaintext_alt_tags=(bool)
+    @use_plaintext_alt_tags = bool
+  end
+
   def self.image_url_for_name(name)
     "#{asset_host}#{ File.join(asset_path, name) }.png"
   end
@@ -42,6 +85,12 @@ module Emoji
     image_url_for_name(emoji['name'])
   end
 
+  def self.alt_tag_for_moji(moji)
+    return moji unless use_plaintext_alt_tags
+    emoji = index.find_by_moji(moji)
+    emoji['name']
+  end
+
   def self.replace_unicode_moji_with_images(string)
     return string unless string
     unless string.match(index.unicode_moji_regex)
@@ -50,7 +99,7 @@ module Emoji
 
     safe_string = safe_string(string.dup)
     safe_string.gsub!(index.unicode_moji_regex) do |moji|
-      %Q{<img alt="#{moji}" class="emoji" src="#{ image_url_for_unicode_moji(moji) }">}
+      %Q{<img alt="#{alt_tag_for_moji(moji)}" class="emoji" src="#{ image_url_for_unicode_moji(moji) }">}
     end
     safe_string = safe_string.html_safe if safe_string.respond_to?(:html_safe)
 

data/lib/emoji/index.rb

@@ -1,13 +1,24 @@
+require 'forwardable'
+
 module Emoji
   class Index
+    extend Forwardable
+
+    attr_reader :unicode_moji_regex
+
+    def_delegator :@emoji_by_moji, :[], :find_by_moji
+    def_delegator :@emoji_by_name, :[], :find_by_name
+    def_delegator :@emoji_by_unicode, :[], :find_by_unicode
+
     def initialize(emoji_list=nil)
       emoji_list ||= begin
         emoji_json = File.read(File.absolute_path(File.dirname(__FILE__) + '/../../config/index.json'))
         JSON.parse(emoji_json)
       end
-      
+
       @emoji_by_name = {}
       @emoji_by_moji = {}
+      @emoji_by_unicode = {}
 
       emoji_list.each do |emoji_hash|
         name = emoji_hash['name']
@@ -15,20 +26,12 @@ module Emoji
 
         moji = emoji_hash['moji']
         @emoji_by_moji[moji] = emoji_hash if moji
-      end
-      @emoji_moji_regex = /#{@emoji_by_moji.keys.join('|')}/
-    end
-
-    def find_by_moji(moji)
-      @emoji_by_moji[moji]
-    end
 
-    def find_by_name(name)
-      @emoji_by_name[name]
-    end
+        unicode = emoji_hash['unicode']
+        @emoji_by_unicode[unicode] = emoji_hash if unicode
+      end
 
-    def unicode_moji_regex
-      @emoji_moji_regex
+      @unicode_moji_regex = /#{@emoji_by_moji.keys.join('|')}/
     end
   end
 end

data/lib/emoji/railtie.rb

@@ -6,10 +6,11 @@ module Emoji
     initializer "emoji.defaults" do
       Emoji.asset_host = ActionController::Base.asset_host
       Emoji.asset_path = '/assets/emoji'
+      Emoji.use_plaintext_alt_tags = false
     end
 
     rake_tasks do
       load File.absolute_path(File.dirname(__FILE__) + '/tasks/install.rake')
     end
   end
-end
+end

data/lib/emoji/version.rb

@@ -1,3 +1,3 @@
 module Emoji
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/test/emoji_test.rb

@@ -20,9 +20,34 @@ describe Emoji do
       assert_equal 'http://localhost:3000', Emoji.asset_host
     end
 
-    it 'should be configurable' do
+    it 'should allow hostname only and default scheme to http' do
       with_emoji_config(:asset_host, 'emoji') do
-        assert_equal 'emoji', Emoji.asset_host
+        assert_equal 'http://emoji', Emoji.asset_host
+      end
+    end
+
+    it 'should allow protocol relative URL' do
+      with_emoji_config(:asset_host, '//emoji') do
+        assert_equal '//emoji', Emoji.asset_host
+      end
+    end
+
+    it 'should respect protocol scheme' do
+      with_emoji_config(:asset_host, 'https://emoji') do
+        assert_equal 'https://emoji', Emoji.asset_host
+      end
+    end
+
+    it 'should allow setting port' do
+      with_emoji_config(:asset_host, 'http://emoji:3000') do
+        assert_equal 'http://emoji:3000', Emoji.asset_host
+      end
+
+    end
+
+    it 'should validate hostname' do
+      assert_raises(RuntimeError) do
+        with_emoji_config(:asset_host, nil) {}
       end
     end
   end
@@ -39,6 +64,18 @@ describe Emoji do
     end
   end
 
+  describe "use_plaintext_alt_tags" do
+    it 'should default to false' do
+      refute Emoji.use_plaintext_alt_tags
+    end
+
+    it 'should be configurable' do
+      with_emoji_config(:use_plaintext_alt_tags, true) do
+        assert Emoji.use_plaintext_alt_tags
+      end
+    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')
@@ -55,6 +92,14 @@ describe Emoji do
       assert_equal "I <img alt=\"❤\" class=\"emoji\" src=\"http://localhost:3000/heart.png\"> Emoji", replaced_string
     end
 
+    it 'should use plaintext alt tags if configured to do so' do
+      with_emoji_config(:use_plaintext_alt_tags, true) do
+        base_string = "I ❤ Emoji"
+        replaced_string = Emoji.replace_unicode_moji_with_images(base_string)
+        assert_equal "I <img alt=\"heart\" class=\"emoji\" src=\"http://localhost:3000/heart.png\"> Emoji", replaced_string
+      end
+    end
+
     it 'should handle nil string' do
       assert_equal nil, Emoji.replace_unicode_moji_with_images(nil)
     end
@@ -126,5 +171,4 @@ describe Emoji do
       Emoji.send("#{name}=", original_value)
     end
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emoji
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Steve Klabnik
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-13 00:00:00.000000000 Z
+date: 2015-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -39,20 +39,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: debugger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +77,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rvmrc
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -618,7 +605,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: 'A Ruby gem. For emoji. For everyone. :heart:'