prawn-emoji 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c7814b9fcdf6df957493097c0a5a82b8759e4102058afda188a3323f7a48ea2
-  data.tar.gz: 5759ef6fbdfdc30bb48dbf9a8c8e87c7ddf9aa65c7f7ea5ddf52aa643d4d3469
+  metadata.gz: 0e67735305537c5ec4fca24c7b4782004899593e73dfa6a6e2c7a455fda9d49c
+  data.tar.gz: 50c89cba2c13ad094e51243db44d97e494b2fab1a39db200436d0479ee59425e
 SHA512:
-  metadata.gz: 6ca4f75d9382b7a9df0be903b07761b7d924edbdb493516d48784664885e9fe775024273c0c049298b627d69770c74d6bed3c11415a0e4c5a4c42418576ec30d
-  data.tar.gz: d6040f8f133f46b844523836e10e4ec0f0bf3ab326e31a42349894a8f828e4ba66769538756384a0d58f0be581456760b420787443e2219e798c9acbf1fc5319
+  metadata.gz: 0ac550129702964230e6d2e9413355c9a79252a93f734afd7206344d65a015da91372f9c43f450fcf28b4042119e99de898bfb95c8e661aa0025a61107b3026c
+  data.tar.gz: bd16ea954b0302e3fdcfcf31332410cac05a6c3d31300c145f6a96253ad7b92b3d79edce70722466b47949488e2a2ef902f1b1ef7644730c5cb911b1f11cbe61

data/.gitignore

@@ -1,2 +1,4 @@
 /.bundle/
 /Gemfile.lock
+*.pdf
+!/test/pdf/*/expect.pdf

data/.travis.yml

@@ -3,17 +3,16 @@ language: ruby
 sudo: false
 
 rvm:
-  - 2.1.10
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-
-gemfile:
-  - test/gemfiles/prawn-2.1
-  - test/gemfiles/prawn-2.2
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 
 before_install:
-  - travis_retry gem update --system
+  - 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

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 3.0.0
+
+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:
+
+ * 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:

data/README.md

@@ -2,6 +2,7 @@
 
 [![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.
 
@@ -23,20 +24,14 @@ Or install it yourself as:
 
 ## Usage
 
-In order to run the following code, you need to place both [DejaVuSans.ttf](http://sourceforge.net/projects/dejavu/) and [ipag.ttf](http://ipafont.ipa.go.jp/old/ipafont/download.html) in the same directory as the script file.
+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.
 
 ```ruby
-require 'prawn'
 require 'prawn/emoji'
 
-Prawn::Document.generate 'foo.pdf' do
+Prawn::Document.generate 'sushi.pdf' do
   font 'DejaVuSans.ttf'
-  text '🐟 + 🔪 = 🍣'
-
-  font 'ipag.ttf'
-  text_box '🍣が食べたい', at: [100, 100], width: 300
-
-  draw_text '🍣🍣🍣🍣🍣', at: [100, 200]
+  text '🐟 / 🔪 + 🍚 / 🍾 = 🍣'
 end
 ```
 
@@ -47,7 +42,7 @@ In order to draw emoji, you must use a TTF - True Type Font. I recommend you use
 
 ## Feature
 
-  * Emoji is provided by EmojiOne http://emojione.com
+  * Emoji is provided by Twemoji https://github.com/twitter/twemoji
   * Multi-character emoji support
   * RTL support
   * Character spacing support
@@ -55,37 +50,70 @@ In order to draw emoji, you must use a TTF - True Type Font. I recommend you use
   * Alignment support
   * Font size support
 
+### Known Issues
+
+See [prawn-emoji/issues](https://github.com/hidakatsuya/prawn-emoji/labels/known%20issue)
+
 ## Supported versions
 
 See also https://travis-ci.org/hidakatsuya/prawn-emoji.
 
 ### Ruby
 
-2.1, 2.2, 2.3, 2.4, 2.5
+2.4, 2.5, 2.6
 
 ### Prawn
 
-2.1, 2.2
+2.2+
+
+### NOTICE
 
-INFO: Version 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).
+  * 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 update `emoji/index.yml`
+### How to test
+
+Run all tests:
+
+```
+$ bundle exec rake test
+```
+
+Run unit tests:
 
-If you update emoji image in `emoji/images`, you need to update `emoji/index.yml` to run the following task:
+```
+$ bundle exec rake test:units
+```
+
+Run pdf tests:
 
 ```
-$ bundle exec rake emoji:generate_index
+$ 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.
+
+### How to update `emoji/index.yml`
+
+```
+$ bundle exec rake emoji:update
+```
+
+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`
+
 ## Credit
 
-### Emoji One
+### Twemoji 12.04
 
-Emoji provided free by [Emoji One](http://emojione.com/).
+[Twemoji](https://github.com/twitter/twemoji) Graphics licensed under [CC-BY4.0](https://creativecommons.org/licenses/by/4.0/)
 
 ### IPA Font
 

data/Rakefile

@@ -3,25 +3,99 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
-Rake::TestTask.new(:test) do |t|
+Rake::TestTask.new('test:units') do |t|
   t.libs << 'test'
   t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList['test/units/**/*_test.rb']
   t.warning = false
 end
 
-task default: :test
+Rake::TestTask.new('test:pdf') do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/pdf/*/test_case.rb']
+  t.warning = false
+end
+
+desc 'Run all unit and pdf tests'
+task test: %i( test:units test:pdf )
 
 namespace :emoji do
-  desc 'Generate emoji/index.yml from emoji/images'
-  task :generate_index do
+  desc 'Update emoji'
+  task update: %i( clean_all twemoji:load update_index )
+
+  desc 'Update emoji/index.yml from emoji/images'
+  task :update_index do
     require 'prawn/emoji'
     require 'yaml'
 
-    emoji_files = Prawn::Emoji.root / 'emoji' / 'images' / '*.png'
+    emoji_files = Prawn::Emoji.root.join('emoji', 'images', '*.png')
     emoji_names = Pathname.glob(emoji_files).map { |f| f.basename('.png').to_s }
 
-    index_file  = Prawn::Emoji.root / 'emoji' / 'index.yml'
-    index_file.write emoji_names.to_yaml
+    index_file  = Prawn::Emoji.root.join('emoji', 'index.yml')
+    index_file.write emoji_names.sort.to_yaml
+
+    puts 'Updated index.yml'
+  end
+
+  desc 'Clean all emojis'
+  task :clean_all do
+    require 'prawn/emoji'
+    require 'fileutils'
+
+    FileUtils.rm(Prawn::Emoji.root.join('emoji', 'images').glob('*.png'))
+
+    puts 'Cleaned'
+  end
+
+  namespace :twemoji do
+    desc 'Load and put github.com/twitter/twemoji/2/72x72/*.png in the emoji/images/'
+    task :load do
+      require 'prawn/emoji'
+      require 'open-uri'
+      require 'zip'
+      require 'tempfile'
+
+      image_dir = Prawn::Emoji.root.join('emoji', 'images')
+
+      puts 'Loading source of github.com/twitter/twemoji...'
+
+      master_zip = Tempfile.open do |t|
+        t.binmode
+        t.write open('https://github.com/twitter/twemoji/archive/gh-pages.zip').read
+        t
+      end
+
+      puts 'Loaded'
+
+      Zip::File.open(master_zip.path) do |master|
+        emojis = master.glob('twemoji-gh-pages/2/72x72/*.png')
+
+        puts "Saving #{emojis.size} emoji files..."
+        emojis.each do |image|
+          emoji_name = EmojiName.new(File.basename(image.name))
+          image_dir.join(emoji_name.name).binwrite(image.get_input_stream.read)
+        end
+      end
+    end
+
+    class EmojiName
+      attr_reader :original_name
+
+      def initialize(original_name)
+        @original_name = original_name
+      end
+
+      def name
+        @name ||= convert
+      end
+
+      private
+
+      def convert
+        codepoints = original_name.gsub('.png', '').split('-')
+        Prawn::Emoji::Unicode.format_codepoint(codepoints) + '.png'
+      end
+    end
   end
 end