gemojione 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5c5ad07b1134af205ee5e8717c3303251dd5c1e
-  data.tar.gz: 911e76bbedddf4e8871b762ee33d3b5acb05e35b
+  metadata.gz: 5dd7d95071886d3fbb74ea8bc4d239ece9111d01
+  data.tar.gz: 7bbd1128a1b3ec633a3c69fba5332ae2e6a1f44b
 SHA512:
-  metadata.gz: ec865da778966185912b434cd925c702f23769e4a8234148f758188c081a1d2642f6267ddb8ba41cf3fe3251780899d121081c319ee083aa4cf8c68d2b3da264
-  data.tar.gz: ebbee9925229ebaa42a4ec0ef44cd255da2a6c7665392c104f3bc13ecd171d52ecf2b65fa1a2a51832e87e27f44108ecaad096769dd331bba8ebe7a1d10d0aee
+  metadata.gz: afc4cbd9eceac9b0c6f4255a4f515f15fea5a54a5bc6d770caa58d0745a9c21b1e73bd78ce32a4427a7b920d07f211a8fb2135f75a56f07103cffa6d389d2467
+  data.tar.gz: 3ecf09d1f4f53f41b185b752735ed5ae2c788be3911cfe8144b5de542b4c25bd08bd87854335f69e9ae8aaf6d1ae99f3569760ed1d8a2077a9c32973ece2d473

data/README.md

@@ -45,6 +45,9 @@ Image Replacement APIs:
 > Gemojione.replace_unicode_moji_with_images('I ❤ Emoji')
 => "I <img alt=\"❤\" class=\"emoji\" src=\"http://localhost:3000/assets/emoji/2764.png\"> Emoji"
 
+> Gemojione.replace_named_moji_with_images('I :heart: Emoji')
+=> "I <img alt=\"❤\" class=\"emoji\" src=\"http://localhost:3000/assets/emoji/2764.png\"> Emoji"
+
 > Gemojione.image_url_for_unicode_moji('❤')
 => "http://localhost:3000/assets/emoji/2764.png"
 

data/lib/gemojione.rb

@@ -58,6 +58,23 @@ module Gemojione
     safe_string
   end
 
+  def self.replace_named_moji_with_images(string)
+    return string unless string
+    unless string.match(index.shortname_moji_regex)
+      return safe_string(string)
+    end
+
+    safe_string = safe_string(string.dup)
+    safe_string.gsub!(index.shortname_moji_regex) do |code|
+      name = code.tr(':','')
+      moji = index.find_by_name(name)['moji']
+      %Q{<img alt="#{moji}" class="emoji" src="#{ image_url_for_name(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/gemojione/index.rb

@@ -9,6 +9,7 @@ module Gemojione
       @emoji_by_name = {}
       @emoji_by_moji = {}
       @emoji_by_ascii = {}
+      @emoji_by_code = {}
 
       emoji_list.each do |key, emoji_hash|
 
@@ -25,9 +26,14 @@ module Gemojione
           @emoji_by_ascii[emoji_ascii] = emoji_hash if emoji_ascii
         end
 
+        code = emoji_hash['shortname']
+        @emoji_by_code[code] = emoji_hash if code
+
         moji = emoji_hash['moji']
         @emoji_by_moji[moji] = emoji_hash if moji
       end
+
+      @emoji_code_regex = /#{@emoji_by_code.keys.join('|')}/
       @emoji_moji_regex = /#{@emoji_by_moji.keys.join('|')}/
     end
 
@@ -47,6 +53,10 @@ module Gemojione
       @emoji_moji_regex
     end
 
+    def shortname_moji_regex
+      @emoji_code_regex
+    end
+
     def images_path
       File.expand_path("../../assets/images", File.dirname(__FILE__))
     end

data/lib/gemojione/version.rb

@@ -1,3 +1,3 @@
 module Gemojione
-  VERSION = "2.4.0"
+  VERSION = "2.5.0"
 end

data/test/gemojione_test.rb

@@ -114,6 +114,78 @@ describe Gemojione do
     end
   end
 
+  describe 'replace_named_moji_with_images' do
+
+    it 'should return original string without emoji' do
+      assert_equal 'foo', Gemojione.replace_named_moji_with_images('foo')
+    end
+
+    it 'should escape html in non html_safe aware strings' do
+      replaced_string = Gemojione.replace_named_moji_with_images(':heart:<script>')
+      assert_equal "<img alt=\"❤\" class=\"emoji\" src=\"http://localhost:3000/2764.png\">&lt;script&gt;", replaced_string
+    end
+
+    it 'should replace coded moji with img tag' do
+      base_string = "I :heart: Emoji"
+      replaced_string = Gemojione.replace_named_moji_with_images(base_string)
+      assert_equal "I <img alt=\"❤\" class=\"emoji\" src=\"http://localhost:3000/2764.png\"> Emoji", replaced_string
+    end
+
+    it 'should handle nil string' do
+      assert_equal nil, Gemojione.replace_named_moji_with_images(nil)
+    end
+
+    describe 'with html_safe buffer' do
+      it 'should escape non html_safe? strings in emoji' do
+        string = HtmlSafeString.new(':heart:<script>')
+
+        replaced_string = string.stub(:html_safe?, false) do
+          Gemojione.replace_named_moji_with_images(string)
+        end
+
+        assert_equal "<img alt=\"❤\" class=\"emoji\" src=\"http://localhost:3000/2764.png\">&lt;script&gt;", replaced_string
+      end
+
+      it 'should escape non html_safe? strings in all strings' do
+        string = HtmlSafeString.new('XSS<script>')
+
+        replaced_string = string.stub(:html_safe?, false) do
+          Gemojione.replace_named_moji_with_images(string)
+        end
+
+        assert_equal "XSS&lt;script&gt;", replaced_string
+      end
+
+      it 'should not escape html_safe strings' do
+        string = HtmlSafeString.new(':heart:<a href="harmless">')
+
+        replaced_string = string.stub(:html_safe?, true) do
+          Gemojione.replace_named_moji_with_images(string)
+        end
+
+        assert_equal "<img alt=\"❤\" class=\"emoji\" src=\"http://localhost:3000/2764.png\"><a href=\"harmless\">", replaced_string
+      end
+
+      it 'should always return an html_safe string for emoji' do
+        string = HtmlSafeString.new(':heart:')
+        replaced_string = string.stub(:html_safe, 'safe_buffer') do
+          Gemojione.replace_named_moji_with_images(string)
+        end
+
+        assert_equal "safe_buffer", replaced_string
+      end
+
+      it 'should always return an html_safe string for any string' do
+        string = HtmlSafeString.new('Content')
+        replaced_string = string.stub(:html_safe, 'safe_buffer') do
+          Gemojione.replace_named_moji_with_images(string)
+        end
+
+        assert_equal "Content", replaced_string
+      end
+    end
+  end
+
   class HtmlSafeString < String
     def initialize(*); super; end
     def html_safe; self; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemojione
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Steve Klabnik
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-02 00:00:00.000000000 Z
+date: 2016-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json