prawn-emoji 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26bd2353da780fc31e8ebd11751a1156916d7cea
-  data.tar.gz: 359e3538740e6c1e14a90ad6a399bb5be5c94624
+  metadata.gz: 30464f704625995fdd24c34529781eb09f5cc988
+  data.tar.gz: 730b6f231a9db3d31f560372bbffcc1e45da50cf
 SHA512:
-  metadata.gz: e408960124f71a8c5151ac0ac12a767a47a992e9b819d35a932d7201f21887556f5a17ede3551dc5823900cdff03faf67601b884987f5d1242ef6d32299be72d
-  data.tar.gz: f21a974d7dcdf8e954b64639f9c33b7320d829e1467654e3f7ac0b0190d9b79b32587c57a336a8cd37a1a984e2dbaa12c6f8da868f6d41e7ed01eaae22a7b78d
+  metadata.gz: 00c4a04c30c7c42b529a16a0368e2f9d689dcfece6adb14c2b8d2eb339de921175e8ed469f0415fe0a21f77624ff35de9401293c9e64959002d1726c7263e02f
+  data.tar.gz: 871b4cdf8e5af80ac414160bd2603884900438746f08b9a43da551e90c04d25b465c54f1a5dba4f6f939219e0e96b14680e181e6354959decfce767cf30d6c21

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 2.1.0
+
+### Breaking Changes
+
+ * Support variation selector
+   * An emoji with text presentation selector such as ☀︎ (U+2600 U+FE0E) will be drawn as text
+   * See also http://www.unicode.org/reports/tr51/tr51-12.html#def_text_presentation_selector
+
 ## 2.0.1
 
 ### Bug Fixes:

data/lib/prawn/emoji/drawer.rb

@@ -3,6 +3,7 @@
 require_relative 'substitution'
 require_relative 'index'
 require_relative 'image'
+require_relative 'unicode'
 
 module Prawn
   module Emoji
@@ -22,25 +23,54 @@ module Prawn
       private
 
       def draw_emoji(text, text_options)
-        left_text, emoji_unicode, remaining_text = text.partition(@emoji_index.to_regexp)
+        return text unless @emoji_index.to_regexp =~ text
+
+        result = []
+        target = text
+
+        while target do
+          left_text, emoji_unicode, remaining_text = partition_emoji(target)
 
-        return text if emoji_unicode.empty?
+          if emoji_unicode.nil?
+            result << target
+            break
+          end
 
-        emoji_image = Emoji::Image.new(emoji_unicode)
+          result << left_text
+          result << if emoji_unicode.text?
+            emoji_unicode.to_s
+          else
+            emoji_image = Emoji::Image.new(emoji_unicode)
 
-        emoji_x, emoji_y = text_options[:at]
-        emoji_x += @document.width_of(left_text, text_options)
-        emoji_y += @document.font_size
+            emoji_x, emoji_y = text_options[:at]
+            emoji_x += @document.width_of(left_text, text_options)
+            emoji_y += @document.font_size
 
-        draw_emoji_image emoji_image, at: [emoji_x, emoji_y], width: @document.font_size
+            draw_emoji_image emoji_image, at: [emoji_x, emoji_y], width: @document.font_size
 
-        substitution_of_emoji = Substitution.new(@document)
-        draw_emoji "#{left_text}#{substitution_of_emoji}#{remaining_text}", text_options
+            Emoji::Substitution.new(@document).to_s
+          end
+          target = remaining_text
+        end
+
+        result.join
       end
 
       def draw_emoji_image(emoji_image, at:, width:)
         @document.image emoji_image.path, at: at, width: width
       end
+
+      def partition_emoji(text)
+        left_text, emoji_unicode, remaining_text = text.partition(@emoji_index.to_regexp)
+
+        return nil if emoji_unicode.empty?
+
+        [
+          left_text,
+          Emoji::Unicode.new(emoji_unicode),
+          remaining_text
+        ]
+      end
     end
   end
 end

data/lib/prawn/emoji/image.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'yaml'
+require_relative 'unicode'
 
 module Prawn
   module Emoji
@@ -14,18 +15,12 @@ module Prawn
       end
 
       def path
-        STORE.join("#{codepoint}.png").to_s
+        STORE.join("#{unicode.codepoint}.png").to_s
       end
 
       def ==(other)
         unicode == other.unicode
       end
-
-      private
-
-      def codepoint
-        @codepoint ||= @unicode.codepoints.map { |c| '%04x' % c.to_s }.join('-').downcase
-      end
     end
   end
 end

data/lib/prawn/emoji/index.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'unicode'
+
 module Prawn
   module Emoji
     class Index
@@ -18,7 +20,10 @@ module Prawn
       private
 
       def build_regexp
-        Regexp.new(codepoints.map { |codepoint| unicode(codepoint) }.join('|'))
+        emojis = codepoints.map { |codepoint| unicode(codepoint) }
+        variation_selectors = Emoji::Unicode::VARIATION_SELECTORS.values
+
+        Regexp.new("(#{emojis.join('|')})[#{variation_selectors.join}]?")
       end
 
       def load_emoji_codepoints

data/lib/prawn/emoji/unicode.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Prawn
+  module Emoji
+    class Unicode
+      VARIATION_SELECTORS = {
+        text:  '\ufe0e',
+        emoji: '\ufe0f'
+      }.freeze
+
+      def initialize(char)
+        @present_as_text = !!char.match(VARIATION_SELECTORS[:text])
+        @unicode = delete_variation_selector(char)
+      end
+
+      def ==(other)
+        to_s == other.to_s
+      end
+
+      def codepoint
+        @codepoint ||= @unicode.codepoints.map { |c| '%04x' % c.to_s }.join('-').downcase
+      end
+
+      def text?
+        @present_as_text
+      end
+
+      def to_s
+        @unicode
+      end
+
+      private
+
+      def delete_variation_selector(char)
+        char.gsub(/[#{VARIATION_SELECTORS.values.join}]/, '')
+      end
+    end
+  end
+end

data/lib/prawn/emoji/version.rb

@@ -2,6 +2,6 @@
 
 module Prawn
   module Emoji
-    VERSION = '2.0.1'.freeze
+    VERSION = '2.1.0'.freeze
   end
 end

data/test/prawn/emoji/drawer_test.rb

@@ -7,7 +7,8 @@ describe Prawn::Emoji::Drawer do
   let(:drawer) { Prawn::Emoji::Drawer.new document: document }
 
   let(:sushi)  { '🍣' }
-  let(:sushi_image) { Prawn::Emoji::Image.new(sushi) }
+  let(:sushi_unicode) { Prawn::Emoji::Unicode.new(sushi) }
+  let(:sushi_image) { Prawn::Emoji::Image.new(sushi_unicode) }
 
   before do
     document.font Prawn::Emoji.root.join 'test', 'fonts', 'DejaVuSans.ttf'
@@ -48,7 +49,7 @@ describe Prawn::Emoji::Drawer do
     end
 
     describe 'when includes emoji' do
-      let(:text) { "aaa#{sushi}bbb"}
+      let(:text) { "aaa#{sushi}bbb" }
 
       it 'draws image for included emoji' do
         image_width = 12

data/test/prawn/emoji/image_test.rb

@@ -3,13 +3,20 @@
 require 'test_helper'
 
 describe Prawn::Emoji::Image do
-  let(:emojis) { %w( 😀 © 🇯🇵 ) }
+  describe '#path' do
+    let(:emojis) { %w( 😀 © 🇯🇵 ) }
+    let(:emoji_unicodes) { emojis.map { |emoji| Prawn::Emoji::Unicode.new(emoji) } }
 
-  it 'possible to find the image file' do
-    emojis.each do |emoji|
-      emoji_image = Prawn::Emoji::Image.new(emoji)
-
-      assert File.exist?(emoji_image.path), "#{emoji}  not found"
+    it 'possible to find the image file' do
+      emoji_unicodes.each do |emoji_unicode|
+        emoji_image = Prawn::Emoji::Image.new(emoji_unicode)
+        assert File.exist?(emoji_image.path), "#{emoji_unicode}  not found"
+      end
     end
   end
+
+  describe '#==' do
+    it { Prawn::Emoji::Image.new('🍣').must_be :==, Prawn::Emoji::Image.new('🍣') }
+    it { Prawn::Emoji::Image.new('🍣').wont_be :==, Prawn::Emoji::Image.new('🐟') }
+  end
 end

data/test/prawn/emoji/index_test.rb

@@ -20,6 +20,6 @@ describe Prawn::Emoji::Index do
     subject { index.to_regexp }
     before  { stub(index).codepoints { %w( 00a9 00ae 002a-20e3 ) } }
 
-    it { subject.must_equal(/\u{00a9}|\u{00ae}|\u{002a 20e3}/) }
+    it { subject.must_equal(/(\u{00a9}|\u{00ae}|\u{002a 20e3})[\ufe0e\ufe0f]?/) }
   end
 end

data/test/prawn/emoji/unicode_test.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+describe Prawn::Emoji::Unicode do
+  let(:klass) { Prawn::Emoji::Unicode }
+
+  describe '#==' do
+    it { klass.new('🐟').must_be :==, klass.new('🐟') }
+    it { klass.new('🐟').wont_be :==, klass.new('🍣') }
+  end
+
+  describe '#codepoint' do
+    it { klass.new('🍣').codepoint.must_equal '1f363' }
+    it { klass.new('🇯🇵').codepoint.must_equal '1f1ef-1f1f5' }
+  end
+
+  describe '#to_s' do
+    it { klass.new('🍣').to_s.must_equal '🍣' }
+    it { klass.new('❤️').to_s.wont_match /[\ufe0e\ufe0f]/ }
+  end
+
+  describe '#text?' do
+    describe 'no selector' do
+      it { klass.new('☀').wont_be :text? }
+    end
+
+    describe 'with text presentation selector' do
+      it { klass.new('☀︎').must_be :text? }
+    end
+
+    describe 'with emoji presentation selector' do
+      it { klass.new('☀️').wont_be :text? }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-emoji
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Katsuya HIDAKA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-21 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -1947,6 +1947,7 @@ files:
 - lib/prawn/emoji/image.rb
 - lib/prawn/emoji/index.rb
 - lib/prawn/emoji/substitution.rb
+- lib/prawn/emoji/unicode.rb
 - lib/prawn/emoji/version.rb
 - prawn-emoji.gemspec
 - test/fonts/DejaVuSans.ttf
@@ -1959,6 +1960,7 @@ files:
 - test/prawn/emoji/image_test.rb
 - test/prawn/emoji/index_test.rb
 - test/prawn/emoji/substitution_test.rb
+- test/prawn/emoji/unicode_test.rb
 - test/prawn/emoji_test.rb
 - test/test_helper.rb
 homepage: https://github.com/hidakatsuya/prawn-emoji