gemojione 3.1.0 → 3.2.0

data/gemojione.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "sprite-factory"
+  spec.add_development_dependency 'rmagick'
 end

data/lib/gemojione.rb

@@ -17,6 +17,7 @@ module Gemojione
   @asset_path = nil
   @default_size = nil
   @use_svg = false
+  @use_sprite = false
 
   @escaper = defined?(EscapeUtils) ? EscapeUtils : CGI
 
@@ -52,6 +53,14 @@ module Gemojione
     @use_svg = useit
   end
 
+  def self.use_sprite
+    @use_sprite
+  end
+
+  def self.use_sprite=(useit)
+    @use_sprite = useit
+  end
+
   def self.image_url_for_name(name)
     emoji = index.find_by_name(name)
     "#{asset_host}#{ File.join(asset_path, emoji['unicode']) }.#{ use_svg ? 'svg' : 'png' }"
@@ -63,7 +72,12 @@ module Gemojione
   end
 
   def self.image_tag_for_moji(moji)
-    %Q{<img alt="#{moji}" class="emoji" src="#{ image_url_for_unicode_moji(moji) }"#{ default_size ? ' style="width: '+default_size+';"' : '' }>}
+    if use_sprite
+      emoji = index.find_by_moji(moji)
+      %Q{<span class="emojione emojione-#{emoji['unicode'].to_s.downcase}" alt="#{ moji }" title="#{ moji }">#{ moji }</span>}
+    else
+      %Q{<img alt="#{moji}" class="emoji" src="#{ image_url_for_unicode_moji(moji) }"#{ default_size ? ' style="width: '+default_size+';"' : '' }>}
+    end
   end
 
   def self.replace_unicode_moji_with_images(string)
@@ -98,6 +112,25 @@ module Gemojione
     safe_string
   end
 
+  def self.replace_ascii_moji_with_images(string)
+    return string unless string
+    unless string.match(index.ascii_moji_regex)
+      return safe_string(string)
+    end
+
+    string.gsub!(index.ascii_moji_regex) do |code|
+      moji = index.find_by_ascii(code)['moji']
+      Gemojione.image_tag_for_moji(moji)
+    end
+
+    unless string.respond_to?(:html_safe?) && string.html_safe?
+      safe_string = CGI::unescapeElement(CGI.escape_html(string), %w[span img])
+    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
@@ -117,4 +150,8 @@ module Gemojione
   def self.images_path
     File.expand_path("../assets/#{ use_svg ? 'svg' : 'png' }", File.dirname(__FILE__))
   end
+
+  def self.sprites_path
+    File.expand_path("../assets/sprites", File.dirname(__FILE__))
+  end
 end

data/lib/gemojione/index.rb

@@ -41,6 +41,7 @@ module Gemojione
 
       @emoji_code_regex = /#{@emoji_by_code.keys.map{|ec| Regexp.escape(ec)}.join('|')}/
       @emoji_moji_regex = /#{@emoji_by_moji.keys.map{|ec| Regexp.escape(ec)}.join('|')}/
+      @emoji_ascii_regex = /#{@emoji_by_ascii.keys.map{|ec| Regexp.escape(ec)}.join('|')}/
     end
 
     def find_by_moji(moji)
@@ -66,5 +67,9 @@ module Gemojione
     def shortname_moji_regex
       @emoji_code_regex
     end
+
+    def ascii_moji_regex
+      @emoji_ascii_regex
+    end
   end
 end

data/lib/gemojione/tasks/install.rake

@@ -20,4 +20,5 @@ namespace :gemojione do
       FileUtils.cp_r(asset, target_dir, verbose: true, preserve: false)
     end
   end
+
 end

data/lib/gemojione/version.rb

@@ -1,3 +1,3 @@
 module Gemojione
-  VERSION = "3.1.0"
+  VERSION = "3.2.0"
 end

data/test/gemojione_test.rb

@@ -71,6 +71,12 @@ describe Gemojione do
       assert_equal '<img alt="🌀" class="emoji" src="http://localhost:3000/1F300.png" style="width: 42px;">', Gemojione.image_tag_for_moji('🌀')
       Gemojione.default_size=nil
     end
+
+    it 'should generate spritesheet tag' do
+      with_emoji_config(:use_sprite, true) do
+        assert_equal "<span class=\"emojione emojione-1f300\" alt=\"🌀\" title=\"🌀\">🌀</span>", Gemojione.image_tag_for_moji('🌀')
+      end
+    end
   end
 
   describe "replace_unicode_moji_with_images" do
@@ -89,6 +95,14 @@ describe Gemojione do
       assert_equal "I <img alt=\"❤\" class=\"emoji\" src=\"http://localhost:3000/2764.png\"> Emoji", replaced_string
     end
 
+    it 'should replace unicode moji with span tag for spritesheet' do
+      with_emoji_config(:use_sprite, true) do
+        base_string = "I ❤ Emoji"
+        replaced_string = Gemojione.replace_unicode_moji_with_images(base_string)
+        assert_equal "I <span class=\"emojione emojione-2764\" alt=\"❤\" title=\"❤\">❤</span> Emoji", replaced_string
+      end
+    end
+
     it 'should escape regex breaker mojis' do
       assert_equal "<img alt=\"*⃣\" class=\"emoji\" src=\"http://localhost:3000/002A-20E3.png\">", Gemojione.replace_unicode_moji_with_images('*⃣')
     end
@@ -149,6 +163,13 @@ describe Gemojione do
   end
 
   describe 'replace_named_moji_with_images' do
+    it 'should replace with span tag for spritesheet' do
+      with_emoji_config(:use_sprite, true) do
+        base_string = "I :heart: Emoji"
+        replaced_string = Gemojione.replace_named_moji_with_images(base_string)
+        assert_equal "I <span class=\"emojione emojione-2764\" alt=\"❤\" title=\"❤\">❤</span> Emoji", replaced_string
+      end
+    end
 
     it 'should return original string without emoji' do
       assert_equal 'foo', Gemojione.replace_named_moji_with_images('foo')
@@ -217,6 +238,30 @@ describe Gemojione do
 
         assert_equal "Content", replaced_string
       end
+
+      it 'should escape non html_safe? strings with ascii' do
+        string = HtmlSafeString.new('Moji is <3 XSS<script> attacks are not')
+
+        replaced_string = string.stub(:html_safe?, false) do
+          Gemojione.replace_ascii_moji_with_images(string)
+        end
+
+        assert_equal "Moji is <img alt=\"❤\" class=\"emoji\" src=\"http://localhost:3000/2764.png\"> XSS&lt;script&gt; attacks are not", replaced_string
+      end
+    end
+  end
+
+  describe "replace_ascii_moji_with_images" do
+    it 'should replace ascii moji with img tag' do
+      replaced_string = Gemojione.replace_ascii_moji_with_images("Emoji is :-)")
+      assert_equal "Emoji is <img alt=\"😄\" class=\"emoji\" src=\"http://localhost:3000/1F604.png\">", replaced_string
+    end
+
+    it 'should replace ascii moji with span tag for sprite' do
+      with_emoji_config(:use_sprite, true) do
+        replaced_string = Gemojione.replace_ascii_moji_with_images("Emoji is :-)")
+        assert_equal "Emoji is <span class=\"emojione emojione-1f604\" alt=\"😄\" title=\"😄\">😄</span>", replaced_string
+      end
     end
   end
 
@@ -239,6 +284,16 @@ describe Gemojione do
     end
   end
 
+  describe "sprites_path" do
+    it "should return sprite stylesheet" do
+      assert File.exist?("#{Gemojione.sprites_path}/emojione.sprites.scss")
+    end
+
+    it "should return PNG sprites" do
+      assert File.exist?("#{Gemojione.sprites_path}/emojione.sprites.png")
+    end
+  end
+
   class HtmlSafeString < String
     def initialize(*); super; end
     def html_safe; self; end
@@ -255,4 +310,4 @@ describe Gemojione do
       Gemojione.send("#{name}=", original_value)
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemojione
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Steve Klabnik
@@ -10,62 +10,90 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-30 00:00:00.000000000 Z
+date: 2016-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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: minitest
   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: sprite-factory
+  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: rmagick
+  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'
 description: A gem for EmojiOne
@@ -77,9 +105,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
-- .travis.yml
+- ".gitignore"
+- ".rvmrc"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -1879,6 +1907,8 @@ files:
 - assets/png/303D.png
 - assets/png/3297.png
 - assets/png/3299.png
+- assets/sprites/emojione.sprites.png
+- assets/sprites/emojione.sprites.scss
 - assets/svg/0023-20E3.svg
 - assets/svg/002A-20E3.svg
 - assets/svg/0030-20E3.svg
@@ -3695,17 +3725,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A gem for EmojiOne