prawn-emoji 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daf771f97cb509327b1887c2f0776a9c6ea25defe006274890c78ab7cb68e53e
-  data.tar.gz: 9d080701c9efa0fc90cdc3c1580345212dca0ae6f1d532ed9edd9040e9205a4f
+  metadata.gz: f1a48927e147cd633cc847c169b4f333b65e8317871fd5779a6eb2dd092952d6
+  data.tar.gz: 4d801491bbc68dfe274fb86a8f2537e8f2b0833a0304a4c9c0ffd3955de610d2
 SHA512:
-  metadata.gz: 38a841a56569f78bccdd3527d508cab7707bf249eee141de98b8d97435c0c5ffbdd9d9465d23dfed8e6b9e949ecafd00a5f0084e0396fe482e53832282177f9d
-  data.tar.gz: d2ec11134a18df62585ee5c1606ebacb22d65715471dc87b8ddfa83c3bce843bc12bc1402950c023a5a6fb6e9b454abf952b6167d11147f8ff34a09a57aabb40
+  metadata.gz: ca9c35d3e86f5d0425ac553a81c7fac39a618541736cfa0399444ffdbbb1d53e29c365fa47a6209edc6ab5331dcba76ac4a90c912c5ee285e5ff72f91f6bcbc2
+  data.tar.gz: bea7ba7dcfa9db8b208252b81afcad78afeaa29e5b541acf46745e6fc94fedf4a1ba7669a85c6e94ce90faa523f9cead703dfa7817852f6e1bd33e0497e66cfa

data/.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Test on ruby ${{ matrix.ruby_version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version:
+          - 2.4.x
+          - 2.5.x
+          - 2.6.x
+          - 2.7.x
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up diff-pdf
+      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
+        cd /tmp/diff-pdf-src
+        ./bootstrap && ./configure && make && sudo make install
+    - name: Set up Ruby ${{ matrix.ruby_version }}
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## Master (Unreleased)
+
+## 3.2.0
+
+### Minor Enhancements
+
+ * Ruby 2.7.0 support
+ * Emoji Regex is now configurable using `Prawn::Emoji.config.regex` #30
+   ```
+   Prawn::Emoji.config.regex # => ::Unicode::Emoji::REGEX_VALID by default
+   Prawn::Emoji.config.regex = ::Unicode::Emoji::REGEX_INCLUDE_TEXT
+   ```
+
+### Bug Fixes
+
+ * Fixed: Emoji Drawer does not close the file descriptor of emoji image #31
+
 ## 3.1.0
 
 ### Minor Enhancements

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.6.3
+FROM ruby:2.6.5
 
 RUN apt-get update -qq && apt-get install -y build-essential xvfb
 
@@ -8,11 +8,5 @@ RUN apt-get install -y libpoppler-glib-dev poppler-utils libwxgtk3.0-dev && curl
 
 RUN mkdir /prawn-emoji
 
-ADD . /prawn-emoji
-
 WORKDIR /prawn-emoji
-
-RUN bundle install
-
-ENTRYPOINT [ "bundle", "exec", "rake" ]
-CMD [ "test:pdf" ]
+VOLUME /prawn-emoji

data/README.md

@@ -1,7 +1,7 @@
 # Prawn::Emoji
 
+[![Test](https://github.com/hidakatsuya/prawn-emoji/workflows/Test/badge.svg?branch=master)](https://github.com/hidakatsuya/prawn-emoji/actions)
 [![Gem Version](https://badge.fury.io/rb/prawn-emoji.svg)](https://badge.fury.io/rb/prawn-emoji)
-[![Build Status](https://travis-ci.org/hidakatsuya/prawn-emoji.svg)](https://travis-ci.org/hidakatsuya/prawn-emoji)
 [![Maintainability](https://api.codeclimate.com/v1/badges/edcd23ef38c2e393513b/maintainability)](https://codeclimate.com/github/hidakatsuya/prawn-emoji/maintainability)
 
 Prawn::Emoji is an extention that adds Emoji support to [Prawn](https://github.com/prawnpdf/prawn).
@@ -67,11 +67,26 @@ require 'prawn/emoji'
 
 In order to draw Emoji, you must use a True Type Font. I recommend you use a Japanese font.
 
+## Configuring Emoji Regex
+
+Emoji Regex is a regular expression used to determine which emoji to draw.
+
+```ruby
+Prawn::Emoji.config.regex # => ::Unicode::Emoji::REGEX_VALID by default
+```
+
+You can override it with [unicode-emoji's Regex](https://github.com/janlelis/unicode-emoji#regex):
+
+```ruby
+Prawn::Emoji.config.regex = ::Unicode::Emoji::REGEX_INCLUDE_TEXT
+```
+
+
 ## Supported Versions
 
 ### Ruby
 
-2.4, 2.5, 2.6
+2.4, 2.5, 2.6, 2.7
 
 ### Prawn
 
@@ -105,21 +120,23 @@ $ 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.
 
-### Run test using the Docker container
+### How to develop in Docker container
 
-The `diff-pdf` is already installed on the Docker container, so there is no need to install it in your environment.
+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-test .
+$ docker build -t prawn-emoji-dev .
 
-# Run test:pdf by default
-$ docker run --rm prawn-emoji-test
+$ docker run -v $PWD:/prawn-emoji -it prawn-emoji-dev bash
 
-# Run test:units
-$ docker run --rm prawn-emoji-test test:units
+> /prawn-emoji#
+```
+
+You can run test:
 
-# Run all test
-$ docker run --rm prawn-emoji-test test
+```
+> /prawn-emoji# bundle install
+> /prawn-emoji# bundle exec rake test
 ```
 
 ### How to update bundled emojis

data/lib/prawn/emoji.rb

@@ -1,12 +1,25 @@
 # frozen_string_literal: true
 
 require 'prawn'
-require 'pathname'
 require 'unicode/emoji'
+require 'pathname'
 
 module Prawn
   module Emoji
-    REGEX = ::Unicode::Emoji::REGEX_VALID
+    Config = Struct.new(
+      # Emoji Regex
+      #
+      # The following values are available (Default is `Unicode::Emoji::REGEX_VALID`):
+      # https://github.com/janlelis/unicode-emoji#regex.
+      :regex
+    )
+    def self.config
+      @config ||= Config.new(::Unicode::Emoji::REGEX_VALID)
+    end
+
+    def self.regex
+      config.regex
+    end
 
     def self.root
       @root ||= Pathname.new File.expand_path('../..', File.dirname(__FILE__))

data/lib/prawn/emoji/drawer.rb

@@ -15,7 +15,7 @@ module Prawn
 
       def draw(text, text_options)
         return text unless text.encoding == ::Encoding::UTF_8
-        return text unless Emoji::REGEX.match?(text)
+        return text unless Emoji.regex.match?(text)
 
         result = []
         target = Emoji::Text.new(text)
@@ -50,7 +50,16 @@ module Prawn
         x = image.adjust_x(base_x + @document.width_of(base_text + text.left, text_options))
         y = image.adjust_y(base_y)
 
-        @document.image image.path, at: [x, y], width: image.width
+        # Prawn 2.2 does not close the image file when Pathname is passed to Document#image method.
+        #
+        # FIXME: This issue has been fixed by https://github.com/prawnpdf/prawn/pull/1090 but not released.
+        # Fix as follows after the PR released.
+        #
+        #   @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)
+        end
       end
     end
   end

data/lib/prawn/emoji/substitution.rb

@@ -7,7 +7,7 @@ module Prawn
     class Substitution
       extend Forwardable
 
-      FULL_SIZE_SPACE = '　'.freeze
+      FULL_SIZE_SPACE = '　'
       HALF_SIZE_SPACE = Prawn::Text::NBSP
 
       def_delegator :@document, :width_of

data/lib/prawn/emoji/text.rb

@@ -27,7 +27,7 @@ module Prawn
       private
 
       def partition_by_emoji(text)
-        text.partition(Emoji::REGEX)
+        text.partition(Emoji.regex)
       end
     end
   end

data/lib/prawn/emoji/version.rb

@@ -2,6 +2,6 @@
 
 module Prawn
   module Emoji
-    VERSION = '3.1.0'.freeze
+    VERSION = '3.2.0'
   end
 end

data/test/units/prawn/emoji/drawer_test.rb

@@ -47,7 +47,7 @@ describe Prawn::Emoji::Drawer do
           sushi_image.adjust_x(x),
           sushi_image.adjust_y(200)
         ]
-        mock(document).image(sushi_image.path, at: position, width: sushi_image.width).once
+        mock(document).image(is_a(File), at: position, width: sushi_image.width).once
       end
       subject
     end
@@ -117,4 +117,33 @@ describe Prawn::Emoji::Drawer do
       it { _(subject).must_equal [sub_char * 2, japanese, sub_char * 2, japanese, sub_char * 2].join }
     end
   end
+
+  describe 'Closing opened image files' do
+    let(:text) { '🍣' }
+    let(:text_options) { { at: [100, 200], font_size: 12 } }
+
+    it do
+      opened_files = { before: count_opened_files, after: nil }
+
+      disable_gc {
+        subject
+        opened_files[:after] = count_opened_files
+      }
+
+      _(opened_files[:after]).must_equal opened_files[:before]
+    end
+
+    def count_opened_files
+      ObjectSpace.each_object(File).reject(&:closed?).count
+    end
+
+    def disable_gc
+      was_disabled = GC.disable
+      begin
+        yield
+      ensure
+        GC.enable unless was_disabled
+      end
+    end
+  end
 end

data/test/units/prawn/emoji_test.rb

@@ -2,67 +2,20 @@
 
 require 'units/test_helper'
 
-describe 'Prawn integration' do
-  describe 'Prawn::Document#text' do
-    it 'properly render text' do
-      pdf = Prawn::Document.new do |doc|
-        doc.font font_path('DejaVuSans.ttf')
-        doc.text 'sushi🍣teacup🍵'
+describe Prawn::Emoji do
+  describe '.regex' do
+    subject { Prawn::Emoji.regex }
 
-        doc.move_down 20
-
-        doc.font font_path('ipag.ttf')
-        doc.text '寿司🍣お茶🍵'
-      end
-
-      assert_properly_render_text(pdf)
+    describe 'Default' do
+      it { _(subject).must_equal ::Unicode::Emoji::REGEX_VALID }
     end
-  end
 
-  describe 'Prawn::Document#text_box' do
-    it 'properly render text' do
-      pdf = Prawn::Document.new do |doc|
-        doc.font font_path('DejaVuSans.ttf')
-        doc.text_box 'sushi🍣teacup🍵', at: [100, 100], width: 500
+    describe 'Custom' do
+      let(:custom_regex) { ::Unicode::Emoji::REGEX_INCLUDE_TEXT }
 
-        doc.font font_path('ipag.ttf')
-        doc.text_box '寿司🍣お茶🍵', at: [100, 300], width: 500
-      end
+      before { stub(Prawn::Emoji.config).regex { custom_regex } }
 
-      assert_properly_render_text(pdf)
+      it { _(subject).must_equal custom_regex }
     end
   end
-
-  describe 'Prawn::Document#draw_text' do
-    it 'properly render text' do
-      pdf = Prawn::Document.new do |doc|
-        doc.font font_path('DejaVuSans.ttf')
-        doc.draw_text 'sushi🍣teacup🍵', at: [100, 100]
-
-        doc.font font_path('ipag.ttf')
-        doc.draw_text '寿司🍣お茶🍵', at: [100, 300]
-      end
-
-      assert_properly_render_text(pdf)
-    end
-  end
-
-  def assert_properly_render_text(pdf)
-    pdf_strings = extract_strings(pdf.render)
-
-    _(pdf_strings).must_include "sushi#{nbsp * 3}teacup#{nbsp * 3}"
-    _(pdf_strings).must_include "寿司　お茶　"
-  end
-
-  def font_path(name)
-    Prawn::Emoji.root.join 'test', 'fonts', name
-  end
-
-  def extract_strings(pdf)
-    PDF::Inspector::Text.analyze(pdf).strings
-  end
-
-  def nbsp
-    Prawn::Text::NBSP
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-emoji
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Katsuya HIDAKA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-31 00:00:00.000000000 Z
+date: 2020-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -128,8 +128,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Dockerfile
 - Gemfile
@@ -3261,7 +3261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Adds Emoji support to Prawn

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-
-sudo: false
-
-rvm:
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-
-before_install:
-  - sudo apt-get install make automake g++ libpoppler-glib-dev poppler-utils libwxgtk3.0-dev
-  - git clone https://github.com/vslavik/diff-pdf.git /tmp/diff-pdf-src
-  - cd /tmp/diff-pdf-src
-  - ./bootstrap && ./configure && make && sudo make install
-  - diff-pdf --help
-  - cd $TRAVIS_BUILD_DIR
-
-script: bundle exec rake test