prawn-emoji 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e67735305537c5ec4fca24c7b4782004899593e73dfa6a6e2c7a455fda9d49c
-  data.tar.gz: 50c89cba2c13ad094e51243db44d97e494b2fab1a39db200436d0479ee59425e
+  metadata.gz: 2b7d56de903eb9de13dd85933c035fd10b80adf07e1884f59917d4531c01fc34
+  data.tar.gz: b138d0eaafdbc6133b787a0af0ec02f53a036c2843cf5a0b58ccc729cdcc697d
 SHA512:
-  metadata.gz: 0ac550129702964230e6d2e9413355c9a79252a93f734afd7206344d65a015da91372f9c43f450fcf28b4042119e99de898bfb95c8e661aa0025a61107b3026c
-  data.tar.gz: bd16ea954b0302e3fdcfcf31332410cac05a6c3d31300c145f6a96253ad7b92b3d79edce70722466b47949488e2a2ef902f1b1ef7644730c5cb911b1f11cbe61
+  metadata.gz: 2a5a68b72b5cf442101ef53fa9bbba86887286d752cbc7ecf1ebcb7e759a0b59939e25ea6a13841ddbc34e13a5bb6e9a0c9d6d3555f352c8501115456c4d3905
+  data.tar.gz: '049e887b7f8cbc66343c4c8e683eae6268c564f5502ffe4058b4d4e072e24028f24b58918d22e6c1032cca5332c010e09e7a75072d68a17358ac9c5087f6f279'

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [hidakatsuya]

data/.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Test on ruby ${{ matrix.ruby_version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version:
+          - 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.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 }}
+      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/.gitignore

@@ -2,3 +2,4 @@
 /Gemfile.lock
 *.pdf
 !/test/pdf/*/expect.pdf
+/pkg/

data/CHANGELOG.md

@@ -1,20 +1,66 @@
+## Master (Unreleased)
+
+## 4.0.0
+
+### Enhancements
+
+* prawn-emoji is no longer dependent on a particular font due to the new emoji drawing process
+
+### Breaking Changes
+
+* Drop ruby 2.4 support
+* The drawing results of emoji will be chnaged slightly due to the new emoji drawing process
+
+### Bug Fixes
+
+* Some emojis are not displayed #34
+
+## 3.3.0
+
+### Minor Enhancements
+
+ * Support Emoji 13.0 #33 [@aried3r]
+
+## 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
+
+ * Update to Twemoji 12.1.3
+   * This version includes some new emoji support and emoji CHANGES. See [commit](https://github.com/hidakatsuya/prawn-emoji/commit/96cb731d337721bf89be9463d270cc46962380d9) for details
+ * Support Emoji 12.1
+
 ## 3.0.0
 
-Big Changes:
+### Big Changes
 
  * Switch emoji to [Twemoji](https://github.com/twitter/twemoji) v12.04 from EmojiOne v2.0
    * See [#23 Switch to Twemoji](https://github.com/hidakatsuya/prawn-emoji/issues/23) for further details
  * Support joined emojis like 👨‍👨‍👦 or 1️⃣
    * See [#24 Joined emojis like 👨‍👨‍👦 or 1️⃣ are not drawn](https://github.com/hidakatsuya/prawn-emoji/issues/24) for further details
 
-Breaking Changes:
+### Breaking Changes
 
  * Drop support ruby2.1 and 2.2, 2.3
  * prawn-emoji requires Prawn 2.2 (Drop support Prawn 2.1)
 
 ## 2.1.1
 
-### Bug Fixes:
+### Bug Fixes
 
  * Fixed: A text including multiple emojis are broken #19
 
@@ -28,7 +74,7 @@ Breaking Changes:
 
 ## 2.0.1
 
-### Bug Fixes:
+### Bug Fixes
 
  * Fixed: part of ASCII chars and symbols is unexpectedly replaced with emojis #17 [@juanfal]
 

data/Dockerfile

@@ -0,0 +1,12 @@
+FROM ruby:2.7.1
+
+RUN apt-get update -qq && apt-get install -y build-essential xvfb
+
+# Install diff-pdf
+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 /src
+
+WORKDIR /src
+VOLUME /src

data/README.md

@@ -1,10 +1,45 @@
 # 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 for [Prawn](https://github.com/prawnpdf/prawn), provides feature for drawing Emoji.
+Prawn::Emoji is an extention that adds Emoji support to [Prawn](https://github.com/prawnpdf/prawn).
+
+```ruby
+require 'prawn/emoji'
+
+Prawn::Document.generate 'sushi.pdf' do
+  font 'DejaVuSans.ttf'
+  text '🐟 / 🔪 + 🍚 / 🍾 = 🍣'
+end
+```
+
+For execute this code, you need [DejaVuSans.ttf](http://sourceforge.net/projects/dejavu/) font.
+
+## Features
+
+### Emoji
+
+  * Emoji is provided by [Twemoji](https://github.com/twitter/twemoji)
+  * Support Singleton/Combining/Modifier/Flag/ZWJ Sequence Emoji
+
+See [test/pdf/emoji_rendering/expect.pdf](https://github.com/hidakatsuya/prawn-emoji/blob/master/test/pdf/emoji_rendering/expect.pdf) for details.
+
+### Prawn Integration
+
+  * RTL support
+  * Character spacing support
+  * Rotation support
+  * Alignment support
+  * Font size support
+
+See [test/pdf/prawn_integration/expect.pdf](https://github.com/hidakatsuya/prawn-emoji/blob/master/test/pdf/prawn_integration/expect.pdf) for details.
+
+### Known Issues
+
+[prawn-emoji/issues](https://github.com/hidakatsuya/prawn-emoji/labels/known%20issue)
+
 
 ## Installation
 
@@ -22,60 +57,48 @@ Or install it yourself as:
 
     $ gem install prawn-emoji
 
-## Usage
-
-In order to run the following code, you need to place [DejaVuSans.ttf](http://sourceforge.net/projects/dejavu/) in the same directory as the script file.
+## Setup
 
 ```ruby
 require 'prawn/emoji'
-
-Prawn::Document.generate 'sushi.pdf' do
-  font 'DejaVuSans.ttf'
-  text '🐟 / 🔪 + 🍚 / 🍾 = 🍣'
-end
 ```
 
+### True Type Font Required
 
-### IMPORTANT
+In order to draw Emoji, you must use a True Type Font.
 
-In order to draw emoji, you must use a TTF - True Type Font. I recommend you use a Japanese font.
+## Configuring Emoji Regex
 
-## Feature
+Emoji Regex is a regular expression used to determine which emoji to draw.
 
-  * Emoji is provided by Twemoji https://github.com/twitter/twemoji
-  * Multi-character emoji support
-  * RTL support
-  * Character spacing support
-  * Rotation support
-  * Alignment support
-  * Font size support
+```ruby
+Prawn::Emoji.config.regex # => ::Unicode::Emoji::REGEX_VALID by default
+```
 
-### Known Issues
+You can override it with [unicode-emoji's Regex](https://github.com/janlelis/unicode-emoji#regex):
 
-See [prawn-emoji/issues](https://github.com/hidakatsuya/prawn-emoji/labels/known%20issue)
+```ruby
+Prawn::Emoji.config.regex = ::Unicode::Emoji::REGEX_INCLUDE_TEXT
+```
 
-## Supported versions
 
-See also https://travis-ci.org/hidakatsuya/prawn-emoji.
+## Supported Versions
 
 ### Ruby
 
-2.4, 2.5, 2.6
+2.5, 2.6, 2.7
 
 ### Prawn
 
 2.2+
 
-### NOTICE
-
-  * prawn-emoji 2.x supports Prawn 2.1
-  * prawn-emoji 1.x supports Prawn 1.3 and 2.0. See [README in 1.0-stable branch](https://github.com/hidakatsuya/prawn-emoji/blob/1.0-stable/README.md)
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/hidakatsuya/prawn-emoji.
 
-### How to test
+## Development
+
+### Running tests
 
 Run all tests:
 
@@ -95,12 +118,36 @@ Run pdf tests:
 $ bundle exec rake test:pdf
 ```
 
-**NOTICE:** In order to run `test:pdf`, you need to install [diff-pdf](https://github.com/vslavik/diff-pdf) in your environment.
+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.
+
+### Running tests in the docker container for development
 
-### How to update `emoji/index.yml`
+You can use the docker container for development. This container contains the libraries required for testing, such as diff-pdf.
 
 ```
-$ bundle exec rake emoji:update
+$ docker build -t prawn-emoji:latest .
+$ docker run -v $PWD:/src:cached -it prawn-emoji bash
+
+> src#
+```
+
+You can run test:
+
+```
+> src# bundle install
+> src# bundle exec rake test
+```
+
+Or, you can run test instantly like this:
+
+```
+$ docker run --rm -v $PWD:/src:cached -it prawn-emoji bash -c "bundle install && bundle exec rake test:pdf"
+```
+
+### Updating the bundled emojis
+
+```
+$ bundle exec rake emoji:update VERSION=<Twemoji version>
 ```
 
 This task works the following:
@@ -108,17 +155,16 @@ This task works the following:
 1. Download emoji images from https://github.com/twitter/twemoji/
 2. Save the emoji images in the `emoji/images/`
 3. Write image list in `emoji/images/` to `emoji/index.yml`
+4. Update version in `emoji/LICENSE`
+
+## License
 
-## Credit
+© 2015 Katsuya HIDAKA. See MIT-LICENSE for further details.
 
-### Twemoji 12.04
+### Twemoji
 
-[Twemoji](https://github.com/twitter/twemoji) Graphics licensed under [CC-BY4.0](https://creativecommons.org/licenses/by/4.0/)
+[Twemoji](https://github.com/twitter/twemoji) Graphics licensed under [CC-BY4.0](https://creativecommons.org/licenses/by/4.0/). See `emoji/LICENSE` for futher details.
 
 ### IPA Font
 
 [IPA Font License Agreement v1.0](http://ipafont.ipa.go.jp/ipa_font_license_v1.html)
-
-## License
-
-© 2015 Katsuya HIDAKA. See MIT-LICENSE for further details.

data/Rakefile

@@ -21,8 +21,13 @@ desc 'Run all unit and pdf tests'
 task test: %i( test:units test:pdf )
 
 namespace :emoji do
-  desc 'Update emoji'
-  task update: %i( clean_all twemoji:load update_index )
+  desc 'Update emoji > rake emoji:update VERSION=0.0.0'
+  task update: %i(
+    clean_all
+    twemoji:load
+    update_index
+    twemoji:update_version
+  )
 
   desc 'Update emoji/index.yml from emoji/images'
   task :update_index do
@@ -49,27 +54,28 @@ namespace :emoji do
   end
 
   namespace :twemoji do
-    desc 'Load and put github.com/twitter/twemoji/2/72x72/*.png in the emoji/images/'
+    desc 'Load and put github.com/twitter/twemoji/assets/72x72/*.png to the emoji/images/'
     task :load do
       require 'prawn/emoji'
       require 'open-uri'
       require 'zip'
       require 'tempfile'
 
+      target_version = ENV['VERSION']
       image_dir = Prawn::Emoji.root.join('emoji', 'images')
 
-      puts 'Loading source of github.com/twitter/twemoji...'
+      puts "Loading source of v#{target_version} from github.com/twitter/twemoji ..."
 
-      master_zip = Tempfile.open do |t|
+      source_zip = Tempfile.open do |t|
         t.binmode
-        t.write open('https://github.com/twitter/twemoji/archive/gh-pages.zip').read
+        t.write open("https://github.com/twitter/twemoji/archive/v#{target_version}.zip").read
         t
       end
 
       puts 'Loaded'
 
-      Zip::File.open(master_zip.path) do |master|
-        emojis = master.glob('twemoji-gh-pages/2/72x72/*.png')
+      Zip::File.open(source_zip.path) do |source|
+        emojis = source.glob("twemoji-#{target_version}/assets/72x72/*.png")
 
         puts "Saving #{emojis.size} emoji files..."
         emojis.each do |image|
@@ -79,6 +85,16 @@ namespace :emoji do
       end
     end
 
+    desc 'Update version in LICENSE file'
+    task :update_version do
+      require 'prawn/emoji'
+
+      license_file = Prawn::Emoji.root.join('emoji', 'LICENSE')
+      license_file.write("Twemoji #{ENV['VERSION']} Graphics licensed under CC-BY4.0.")
+
+      puts 'Updated LICENSE'
+    end
+
     class EmojiName
       attr_reader :original_name
 

data/emoji/LICENSE

@@ -0,0 +1 @@
+Twemoji 13.0.0 Graphics licensed under CC-BY4.0.