prawn-emoji 3.3.0 → 4.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da5130c4ae6b64826ec888c2eae4e859f9ebe98656b3367b9b2a3ef33657d5cc
-  data.tar.gz: 0336be5198d8f4869e291f8b2d73ac1bd1c0bbf3a2394e9ff9eac1b1f8e98ca3
+  metadata.gz: df6049f973c509b992f095c4e0ba9350d60c3c4aa9a400e2d2ad8ed0e3a5770c
+  data.tar.gz: e8dc6fad7e6dfa7c77160462d46f93d5544d6de0b483507fc904cd1ab5cb0d1a
 SHA512:
-  metadata.gz: 8f4fbdd4c9288065b02adfe14f49f3fc160fc47a2defa0b996ee2781eb2e4bc1ebfe99da6d9bc3b46a8b261aeb757c10349592527b295a862acd35d46cf39edf
-  data.tar.gz: 4c9b700b7b0d647ca8e9cf5b7df17f7619959d6c7700576d6aa5d24d5e14fb8829fa1d3eefd9697d0b9f7bdd810341e03e2e6fa5e2a0741d40a043922b17d781
+  metadata.gz: dcc0640b6ee339682aec4a53dd65d620f370c93f7c19e011754b8493f66a710af911f8441fdf61e389695321aa661de20897bac39e78e6fa3236eef6fdf61168
+  data.tar.gz: '087003d57a544f7f6538d555f2cdb392c6b17eef2edf83e3fd94d73e11c0e50db369787334738fb22c4b805d23e9a2531454a33e935abf0b197f4834dde27a4c'

data/.github/workflows/test.yml

@@ -9,7 +9,6 @@ jobs:
     strategy:
       matrix:
         ruby_version:
-          - 2.4.x
           - 2.5.x
           - 2.6.x
           - 2.7.x
@@ -19,7 +18,7 @@ jobs:
       run: |
         sudo apt-get update
         sudo apt-get install make automake g++ libpoppler-glib-dev poppler-utils libwxgtk3.0-dev
-        git clone https://github.com/vslavik/diff-pdf.git -b v0.3 --depth 1 /tmp/diff-pdf-src
+        git clone https://github.com/vslavik/diff-pdf.git -b v0.4.1 --depth 1 /tmp/diff-pdf-src
         cd /tmp/diff-pdf-src
         ./bootstrap && ./configure && make && sudo make install
     - name: Set up Ruby ${{ matrix.ruby_version }}

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## Master (Unreleased)
 
+## 4.0.0.beta.1
+
+### Breaking Changes
+
+* Changes how to draw text including emoji:
+  * The result of drawing emoji will changes slightly
+  * prawn-emoji no longer requires Japanese fonts because it stopped replacing an emoji with the substitution char such as full-width space
+* Drop ruby 2.4 support
+
 ## 3.3.0
 
 ### Minor Enhancements

data/Dockerfile

@@ -6,7 +6,7 @@ RUN apt-get update -qq && apt-get install -y build-essential xvfb
 WORKDIR /tmp
 RUN apt-get install -y libpoppler-glib-dev poppler-utils libwxgtk3.0-dev && curl -L https://github.com/vslavik/diff-pdf/archive/master.tar.gz -o diff-pdf-master.tar.gz && tar zxf diff-pdf-master.tar.gz && cd diff-pdf-master && ./bootstrap && ./configure && make && make install
 
-RUN mkdir /prawn-emoji
+RUN mkdir /src
 
-WORKDIR /prawn-emoji
-VOLUME /prawn-emoji
+WORKDIR /src
+VOLUME /src

data/README.md

@@ -65,7 +65,7 @@ require 'prawn/emoji'
 
 ### True Type Font Required
 
-In order to draw Emoji, you must use a True Type Font. I recommend you use a Japanese font.
+In order to draw Emoji, you must use a True Type Font.
 
 ## Configuring Emoji Regex
 
@@ -86,7 +86,7 @@ Prawn::Emoji.config.regex = ::Unicode::Emoji::REGEX_INCLUDE_TEXT
 
 ### Ruby
 
-2.4, 2.5, 2.6, 2.7
+2.5, 2.6, 2.7
 
 ### Prawn
 
@@ -98,7 +98,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/hidaka
 
 ## Development
 
-### How to test
+### Running tests
 
 Run all tests:
 
@@ -120,26 +120,25 @@ $ bundle exec rake test:pdf
 
 In order to run `test:pdf`, you need to install [diff-pdf](https://github.com/vslavik/diff-pdf) in your environment, or you can run test in the docker container as below.
 
-### How to develop in Docker container
+### Running tests in the docker container for development
 
-You can use the Docker container for development. This container contains the libraries required for testing, such as diff-pdf.
+You can use the docker container for development. This container contains the libraries required for testing, such as diff-pdf.
 
 ```
-$ docker build -t prawn-emoji-dev .
+$ docker build -t prawn-emoji:latest .
+$ docker run -v $PWD:/src:cached -it prawn-emoji bash
 
-$ docker run -v $PWD:/prawn-emoji -it prawn-emoji-dev bash
-
-> /prawn-emoji#
+> src#
 ```
 
 You can run test:
 
 ```
-> /prawn-emoji# bundle install
-> /prawn-emoji# bundle exec rake test
+> src# bundle install
+> src# bundle exec rake test
 ```
 
-### How to update bundled emojis
+### Updating the bundled emojis
 
 ```
 $ bundle exec rake emoji:update VERSION=<Twemoji version>

data/lib/prawn/emoji/char.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Prawn
+  module Emoji
+    class Char
+      VARIATION_SELECTORS = %w(fe0e fe0f).freeze
+
+      class << self
+        def format_codepoint(codepoints)
+          (codepoints - VARIATION_SELECTORS).map { |c| c.rjust(4, '0') }.join('-').downcase
+        end
+      end
+
+      attr_reader :font_size, :char
+      alias_method :to_s, :char
+
+      def initialize(char, font_size)
+        @char = char
+        @font_size = font_size
+      end
+
+      def ==(other)
+        char == other.to_s
+      end
+
+      def codepoint
+        @codepoint ||= self.class.format_codepoint(char.codepoints.map { |c| c.to_s(16) })
+      end
+
+      def width
+        @width ||= font_size * 0.85
+      end
+
+      def height
+        @height ||= font_size * 0.8
+      end
+    end
+  end
+end

data/lib/prawn/emoji/drawable.rb

@@ -5,9 +5,16 @@ require_relative 'drawer'
 module Prawn
   module Emoji
     module Drawable
+      # == Additional Options
+      # <tt>:emoji</tt>:: <tt>boolean</tt>. Whether or not to draw an emoji [true]
       def draw_text!(text, options)
-        text_without_emoji = emoji_drawer.draw(text.to_s, options)
-        super text_without_emoji, options
+        draw_emoji = options.fetch(:emoji, true)
+
+        if draw_emoji && text.encoding == ::Encoding::UTF_8 && Emoji.regex.match?(text)
+          emoji_drawer.draw(text.to_s, options)
+        else
+          super(text, options)
+        end
       end
 
       private

data/lib/prawn/emoji/drawer.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'substitution'
 require_relative 'index'
 require_relative 'image'
 require_relative 'text'
@@ -14,41 +13,40 @@ module Prawn
       end
 
       def draw(text, text_options)
-        return text unless text.encoding == ::Encoding::UTF_8
-        return text unless Emoji.regex.match?(text)
+        cursor_x, cursor_y = text_options[:at]
 
-        result = []
-        target = Emoji::Text.new(text)
+        emoji_text = Emoji::Text.new(text, document.font_size)
 
-        while target.contains_emoji? do
-          if emoji_index.include?(target.emoji.codepoint)
-            draw_emoji(
-              target,
-              text_options: text_options,
-              base_text: result.join
-            )
-            result << target.left + Emoji::Substitution.new(@document).to_s
+        while emoji_text.contains_emoji? do
+          if emoji_index.include?(emoji_text.emoji.codepoint)
+            cursor_x += draw_text(emoji_text.left, at: [cursor_x, cursor_y], text_options: text_options)
+            cursor_x += draw_emoji(emoji_text.emoji, at: [cursor_x, cursor_y])
           else
-            result << target.left_with_emoji
+            cursor_x += draw_text(emoji_text.left_with_emoji, at: [cursor_x, cursor_y], text_options: text_options)
           end
-
-          target = Emoji::Text.new(target.remaining)
+          emoji_text = Emoji::Text.new(emoji_text.remaining, document.font_size)
         end
 
-        result.join + target.to_s
+        draw_text!(emoji_text.to_s, at: [cursor_x, cursor_y], text_options: text_options)
       end
 
       private
 
-      attr_reader :emoji_index
+      attr_reader :emoji_index, :document
 
-      def draw_emoji(text, text_options:, base_text:)
-        image = Emoji::Image.new(text.emoji, @document.font_size)
+      def draw_text!(text, at:, text_options:)
+        document.draw_text!(text, text_options.merge(emoji: false, at: at))
+      end
 
-        base_x, base_y = text_options[:at]
+      def draw_text(text, at:, text_options:)
+        draw_text!(text, at: at, text_options: text_options)
+        document.width_of(text, text_options)
+      end
 
-        x = image.adjust_x(base_x + @document.width_of(base_text + text.left, text_options))
-        y = image.adjust_y(base_y)
+      def draw_emoji(emoji_char, at:)
+        emoji_image = Emoji::Image.new(emoji_char)
+
+        x, y = at
 
         # Prawn 2.2 does not close the image file when Pathname is passed to Document#image method.
         #
@@ -57,9 +55,11 @@ module Prawn
         #
         #   @document.image(image_file.path, at: [x, y], width: image.width)
         #
-        File.open(image.path, 'rb') do |image_file|
-          @document.image(image_file, at: [x, y], width: image.width)
+        File.open(emoji_image.path, 'rb') do |image_file|
+          @document.image(image_file, at: [x, y + emoji_char.height], width: emoji_char.width)
         end
+
+        emoji_char.width + document.character_spacing
       end
     end
   end

data/lib/prawn/emoji/image.rb

@@ -1,35 +1,21 @@
 # frozen_string_literal: true
 
-require 'yaml'
-require_relative 'unicode'
-
 module Prawn
   module Emoji
     class Image
       STORE = Emoji.root.join 'emoji', 'images'
 
-      attr_reader :unicode, :font_size
-
-      def initialize(unicode, font_size)
-        @unicode = unicode
-        @font_size = font_size
+      def initialize(emoji_char)
+        @emoji_char = emoji_char
       end
 
       def path
-        STORE.join("#{unicode.codepoint}.png").to_s
-      end
-
-      def adjust_x(base_x)
-        base_x + (font_size - width) / 2
+        STORE.join("#{emoji_char.codepoint}.png").to_s
       end
 
-      def adjust_y(base_y)
-        base_y + font_size * 0.8
-      end
+      private
 
-      def width
-        font_size * 0.85
-      end
+      attr_reader :emoji_char
     end
   end
 end

data/lib/prawn/emoji/index.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'unicode'
+require 'yaml'
 
 module Prawn
   module Emoji

data/lib/prawn/emoji/text.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-require_relative 'unicode'
+require_relative 'char'
 
 module Prawn
   module Emoji
     class Text
       attr_reader :left, :emoji, :remaining
 
-      def initialize(text)
+      def initialize(text, font_size)
+        @text = text
         @left, emoji_char, @remaining = partition_by_emoji(text)
-        @emoji = Emoji::Unicode.new(emoji_char) unless emoji_char.empty?
+        @emoji = Emoji::Char.new(emoji_char, font_size) unless emoji_char.empty?
       end
 
       def contains_emoji?
@@ -21,7 +22,7 @@ module Prawn
       end
 
       def to_s
-        left_with_emoji + remaining
+        @text
       end
 
       private

data/lib/prawn/emoji/version.rb

@@ -2,6 +2,6 @@
 
 module Prawn
   module Emoji
-    VERSION = '3.3.0'
+    VERSION = '4.0.0.beta.1'
   end
 end

data/prawn-emoji.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/hidakatsuya/prawn-emoji'
   spec.license       = 'MIT'
 
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 2.5'
 
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-emoji
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.0.beta.1
 platform: ruby
 authors:
 - Katsuya HIDAKA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-30 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -3486,13 +3486,12 @@ files:
 - emoji/images/e50a.png
 - emoji/index.yml
 - lib/prawn/emoji.rb
+- lib/prawn/emoji/char.rb
 - lib/prawn/emoji/drawable.rb
 - lib/prawn/emoji/drawer.rb
 - lib/prawn/emoji/image.rb
 - lib/prawn/emoji/index.rb
-- lib/prawn/emoji/substitution.rb
 - lib/prawn/emoji/text.rb
-- lib/prawn/emoji/unicode.rb
 - lib/prawn/emoji/version.rb
 - prawn-emoji.gemspec
 homepage: https://github.com/hidakatsuya/prawn-emoji
@@ -3507,12 +3506,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: 

data/lib/prawn/emoji/substitution.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-
-module Prawn
-  module Emoji
-    class Substitution
-      extend Forwardable
-
-      FULL_SIZE_SPACE = '　'
-      HALF_SIZE_SPACE = Prawn::Text::NBSP
-
-      def_delegator :@document, :width_of
-
-      def initialize(document)
-        @document = document
-        @font = document.font
-        @font_size = document.font_size
-      end
-
-      def to_s
-        emoji_width == full_size_space_width ? FULL_SIZE_SPACE : half_size_spaces
-      end
-
-      private
-
-      def emoji_width
-        @emoji_width ||= @font_size + @document.character_spacing
-      end
-
-      def full_size_space_width
-        width_of @font.normalize_encoding(FULL_SIZE_SPACE)
-      end
-
-      def half_size_spaces
-        HALF_SIZE_SPACE * (emoji_width.to_f / width_of(HALF_SIZE_SPACE)).round
-      end
-    end
-  end
-end

data/lib/prawn/emoji/unicode.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Prawn
-  module Emoji
-    class Unicode
-      VARIATION_SELECTORS = %w(fe0e fe0f).freeze
-
-      class << self
-        def format_codepoint(codepoints)
-          (codepoints - VARIATION_SELECTORS).map { |c| c.rjust(4, '0') }.join('-').downcase
-        end
-      end
-
-      def initialize(char)
-        @unicode = char
-      end
-
-      def ==(other)
-        to_s == other.to_s
-      end
-
-      def codepoint
-        @codepoint ||= self.class.format_codepoint(@unicode.codepoints.map { |c| c.to_s(16) })
-      end
-
-      def to_s
-        @unicode
-      end
-    end
-  end
-end