dragonfly_harfbuzz 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 12a1a1d9e43896d972f04db0af8fba629ff01c9a
-  data.tar.gz: 57713f254cdf739f93cd407d6662aaef451df471
+SHA256:
+  metadata.gz: df2c3ab44eceb11b1369967d4ba836e4e4a6b5c93a8aa1aaea2a4a76027cc74f
+  data.tar.gz: 3d3dca8871157110c99dae33bd081c1d3b137bd5d5c1f219e270849371abd62e
 SHA512:
-  metadata.gz: 24c63ab26bbced5fb03be3071c8f0be576573852e2c95780e30068087dfead89dd74c57a1afa4b453cc3f3ddb44b2c2b4cd9e841fd1ebf1ae4aeef3131af668a
-  data.tar.gz: e37a54bb7666077687d6f2bb2e0b9e9ead42f6af984a5c62f4c57c453f3f809711d1af2d4869705786460e9e2799a6950727d608e665e562c8440fc2e18080a4
+  metadata.gz: 12b1e43a879e9179f0ec66b7ff39927014fec014561eb1df12e7fc3778e411a4630f2305837e3c3d8c132885659b6c62de051b0f84fff3088d3d1d3b33c082bc
+  data.tar.gz: 72527b11a71864ca51f21f2fb30848df92e40b3fad9c0645e27cf08c541e233a5100102835f8a1866958d04a3349c2a7606c71a599e764b36041dd6d609d12d9

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+cache: bundler
+script: 'bundle exec rake'
+sudo: required
+dist: trusty
+rvm:
+  - 2.5.1
+
+before_install:
+  - gem update bundler
+  - sudo apt-get update
+  - wget --no-check-certificate http://www.freedesktop.org/software/harfbuzz/release/harfbuzz-1.7.6.tar.bz2 && tar -xjf harfbuzz-1.7.6.tar.bz2 --no-same-owner
+  - cd harfbuzz-1.7.6 && sudo ./configure && sudo make && sudo make install && rm -rf harfbuzz*
+
+notifications:
+  email:
+    recipients:
+      - tomas.celizna@gmail.com
+    on_failure: change
+    on_success: never

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# CHANGELOG
+
+## 1.0.0
+
+* add `SUPPORTED_FORMATS` and `SUPPORTED_OUTPUT_FORMATS` and raise errors when formats are not matching
+* add more thorough tests for supported formats

data/README.md

@@ -1,5 +1,7 @@
 # Dragonfly Harfbuzz
 
+[![Build Status](https://travis-ci.org/tomasc/dragonfly_harfbuzz.svg)](https://travis-ci.org/tomasc/dragonfly_harfbuzz) [![Gem Version](https://badge.fury.io/rb/dragonfly_harfbuzz.svg)](http://badge.fury.io/rb/dragonfly_harfbuzz) [![Coverage Status](https://img.shields.io/coveralls/tomasc/dragonfly_harfbuzz.svg)](https://coveralls.io/r/tomasc/dragonfly_harfbuzz)
+
 [Harfbuzz](http://fontforge.github.io) renderer wrapped by [Dragonfly](http://markevans.github.io/dragonfly) processors.
 
 ## Installation
@@ -20,7 +22,7 @@ You will also need Harfbuzz installed.
 
 Using [Homebrew](http://brew.sh):
 
-    $ brew install harfbuzz
+    $ brew install --with-cairo harfbuzz
 
 Or build from source. See [Harfbuzz](http://harfbuzz.org) website for instructions.
 
@@ -43,6 +45,15 @@ font.hb_view('my text', :svg, { font_size: 36 })
 
 See tests and `hb-view --help-all` for more details on options.
 
+## Supported Formats
+
+List of supported formats is available as:
+
+```ruby
+DragonflyHarfbuzz::SUPPORTED_FORMATS # => ["otf"]
+DragonflyHarfbuzz::SUPPORTED_OUTPUT_FORMATS # => ["ansi", "png", "svg", "pdf", "ps", "eps"]
+```
+
 ## Options
 
 Additionally (for `<svg>` only) you can pass the following options: `markup_svg: Boolean`, `split_paths: Boolean` and `flatten_svg: Boolean`. `markup_svg` returns an `<svg>` that is organized into word and characters and marked up with additional data attributes. `flatten_svg` uses the result of `markup_svg` and further cleans up the `<svg>`, replacing the `<symbol>`, `<use>` elements with nested `<svg>`s. This is handy if you want to do some more precise animation/manipulation of the resulting `<svg>`. `split_paths` is a feature of the `markup_svg` and controls whether the paths of each character are split up into smaller components.

data/dragonfly_harfbuzz.gemspec

@@ -1,29 +1,31 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'dragonfly_harfbuzz/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "dragonfly_harfbuzz"
+  spec.name          = 'dragonfly_harfbuzz'
   spec.version       = DragonflyHarfbuzz::VERSION
-  spec.authors       = ["Tomas Celizna"]
-  spec.email         = ["tomas.celizna@gmail.com"]
-  spec.summary       = %q{Harfbuzz renderer wrapped by Dragonfly processors.}
-  spec.homepage      = "https://github.com/tomasc/dragonfly_harfbuzz"
-  spec.license       = "MIT"
+  spec.authors       = ['Tomas Celizna']
+  spec.email         = ['tomas.celizna@gmail.com']
+  spec.summary       = 'Harfbuzz renderer wrapped by Dragonfly processors.'
+  spec.homepage      = 'https://github.com/tomasc/dragonfly_harfbuzz'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "dragonfly", "~> 1.0"
-  spec.add_dependency "ox"
-  spec.add_dependency "savage"
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'dragonfly', '~> 1.0'
+  spec.add_dependency 'ox'
+  spec.add_dependency 'savage'
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-minitest"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
 end

data/lib/dragonfly_harfbuzz/dom_attrs_service.rb

@@ -4,10 +4,8 @@ module DragonflyHarfbuzz
   class DomAttrsService < Struct.new :svg, :font_size, :margin
     attr_accessor :ox_doc
 
-    # =====================================================================
-
-    def self.call *args
-      self.new(*args).call
+    def self.call(*args)
+      new(*args).call
     end
 
     def call
@@ -17,7 +15,7 @@ module DragonflyHarfbuzz
       Ox.dump(ox_doc)
     end
 
-    private # =============================================================
+    private
 
     def ox_doc
       @ox_doc ||= Ox.parse(svg)

data/lib/dragonfly_harfbuzz/flatten_svg_service.rb

@@ -32,7 +32,7 @@ module DragonflyHarfbuzz
       Ox.dump(@ox_doc)
     end
 
-    private # =============================================================
+    private
 
     def add_lines_to_doc(lines)
       @ox_doc.nodes.clear

data/lib/dragonfly_harfbuzz/markup_svg_service.rb

@@ -6,14 +6,10 @@ module DragonflyHarfbuzz
     attr_accessor :ox_doc
     attr_accessor :text
 
-    # =====================================================================
-
     def self.call(*args)
       new(*args).call
     end
 
-    # =====================================================================
-
     def initialize(text, svg, options = {})
       @text = text
       @svg = svg
@@ -43,7 +39,7 @@ module DragonflyHarfbuzz
       Ox.dump(ox_doc)
     end
 
-    private # =============================================================
+    private
 
     def lines
       text.split(/\n+/)
@@ -57,8 +53,6 @@ module DragonflyHarfbuzz
       @options.fetch(:split_paths, true)
     end
 
-    # ---------------------------------------------------------------------
-
     # FIXME: fix issues with negative paths ('O', 'd', etc.)
     def split_paths
       symbols = ox_doc.locate('svg/defs/g/symbol')
@@ -77,8 +71,6 @@ module DragonflyHarfbuzz
       end
     end
 
-    # ---------------------------------------------------------------------
-
     def marked_up_word(word, word_index, line, line_group)
       word_group = Ox::Element.new('g').tap do |prop|
         prop[:word] = word

data/lib/dragonfly_harfbuzz/plugin.rb

@@ -2,11 +2,11 @@ require 'dragonfly_harfbuzz/processors/hb_view'
 
 module DragonflyHarfbuzz
   class Plugin
-
-    def call app, opts={}
+    def call(app, options={})
       app.add_processor :hb_view, Processors::HbView.new
-    end
 
+      app.add_mime_type 'otf', 'font/otf'
+    end
   end
 end
 

data/lib/dragonfly_harfbuzz/processors/hb_view.rb

@@ -3,45 +3,54 @@ require 'shellwords'
 module DragonflyHarfbuzz
   module Processors
     class HbView
-      def call(content, str, opts = {})
-        format = opts.fetch(:format, :svg)
-        flatten_svg = opts.fetch(:flatten_svg, false)
-        markup_svg = opts.fetch(:markup_svg, flatten_svg)
-        split_paths = opts.fetch(:split_paths, true)
+      def call(content, str, options = {})
+        options = options.each_with_object({}) { |(k, v), memo| memo[k.to_s] = v } # stringify keys
+
+        raise UnsupportedFormat unless SUPPORTED_FORMATS.include?(content.ext)
+
+        format = options.fetch('format', 'svg').to_s
+
+        raise UnsupportedOutputFormat unless SUPPORTED_OUTPUT_FORMATS.include?(format)
+
+        flatten_svg = options.fetch('flatten_svg', false)
+        markup_svg = options.fetch('markup_svg', flatten_svg)
+        split_paths = options.fetch('split_paths', true)
 
         content.shell_update(ext: format) do |old_path, new_path|
-          args = %W(
+          args = %W[
             --font-file=#{old_path}
             --output-file=#{new_path}
             --output-format=#{format}
-          )
+          ]
 
-          opts.reject { |k, _v| %w(format markup_svg flatten_svg split_paths).include?(k.to_s) }.each do |k, v|
-            args << "--#{k.to_s.tr('_', '-')}=#{Shellwords.escape(v)}"
+          args << "--text='#{str}'" unless options.has_key?('unicodes')
+
+          options.reject { |k, _| %w[format markup_svg flatten_svg split_paths].include?(k.to_s) }.each do |k, v|
+            args << "--#{k.to_s.tr('_', '-')}=#{Shellwords.escape(v)}" if v.present?
           end
 
-          "hb-view #{Shellwords.escape(str)} #{args.join(' ')}"
+          "#{hb_view_command} #{args.join(' ')}"
         end
 
-        if format
-          content.meta['format'] = format.to_s
-          content.ext = format
-        end
+        content.meta['format'] = format
+        content.ext = format
 
-        if format.to_s =~ /svg/i
-          content.update(DragonflyHarfbuzz::MarkupSvgService.call(str, content.data, split_paths: split_paths)) if markup_svg
-          content.update(DragonflyHarfbuzz::FlattenSvgService.call(content.data)) if flatten_svg
-          content.update(DragonflyHarfbuzz::DomAttrsService.call(content.data, opts[:font_size], opts[:margin]))
+        if format =~ /svg/i
+          content.update(MarkupSvgService.call(str, content.data, split_paths: split_paths), 'name' => "temp.#{format}") if markup_svg
+          content.update(FlattenSvgService.call(content.data), 'name' => "temp.#{format}") if flatten_svg
+          content.update(DomAttrsService.call(content.data, options[:font_size], options[:margin]), 'name' => "temp.#{format}")
         end
+      end
 
-        content
+      def update_url(attrs, str = '', options = {})
+        format = options.fetch('format', 'svg').to_s
+        attrs.ext = format
       end
 
-      # ---------------------------------------------------------------------
+      private
 
-      def update_url(attrs, _args = '', opts = {})
-        format = opts['format']
-        attrs.ext = format if format
+      def hb_view_command
+        'hb-view'
       end
     end
   end

data/lib/dragonfly_harfbuzz/version.rb

@@ -1,3 +1,3 @@
 module DragonflyHarfbuzz
-  VERSION = "0.0.4"
+  VERSION = '1.0.0'.freeze
 end

data/lib/dragonfly_harfbuzz.rb

@@ -1,12 +1,17 @@
 require 'dragonfly'
+require 'active_support/core_ext/object/blank'
 
-require "dragonfly_harfbuzz/dom_attrs_service"
-require "dragonfly_harfbuzz/flatten_svg_service"
-require "dragonfly_harfbuzz/markup_svg_service"
+require 'dragonfly_harfbuzz/dom_attrs_service'
+require 'dragonfly_harfbuzz/flatten_svg_service'
+require 'dragonfly_harfbuzz/markup_svg_service'
 
-require "dragonfly_harfbuzz/plugin"
-require "dragonfly_harfbuzz/version"
+require 'dragonfly_harfbuzz/plugin'
+require 'dragonfly_harfbuzz/version'
 
-Dragonfly.app.configure do
-  plugin :harfbuzz
+module DragonflyHarfbuzz
+  class UnsupportedFormat < RuntimeError; end
+  class UnsupportedOutputFormat < RuntimeError; end
+
+  SUPPORTED_FORMATS = %w[otf ttf].freeze
+  SUPPORTED_OUTPUT_FORMATS = %w[png svg pdf ps eps].freeze
 end

data/test/dragonfly_harfbuzz/flatten_svg_service_test.rb

@@ -1,19 +1,19 @@
-require 'minitest_helper'
+require 'test_helper'
 
 module DragonflyHarfbuzz
   describe FlattenSvgService do
     let(:app) { test_app.configure_with(:harfbuzz) }
     let(:processor) { DragonflyHarfbuzz::Processors::HbView.new }
-    let(:font) { Dragonfly::Content.new(app, SAMPLES_DIR.join('Inconsolata.otf')) }
+    let(:content) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample.otf')) }
     let(:string) { 'foo     foo' }
-    let(:svg) { processor.call(font, string) }
+    let(:svg) { processor.call(content, string) }
     let(:call) { DragonflyHarfbuzz::FlattenSvgService.call(string, svg) }
 
     let(:f_markup) { '<svg character="f" class="character" overflow="visible" x="1552" y="229.504">' }
 
-    it 'supports :flatten_svg' do
-      processor.call(font, string, flatten_svg: true)
-      font.data.sub(f_markup, '').wont_include f_markup
+    describe 'flatten_svg' do
+      before { processor.call(content, string, flatten_svg: true) }
+      it { content.data.sub(f_markup, '').wont_include f_markup }
     end
   end
 end

data/test/dragonfly_harfbuzz/plugin_test.rb

@@ -1,18 +1,10 @@
-require 'minitest_helper'
+require 'test_helper'
 
-module DragonflyHarfbuzz
-  describe Plugin do
-
-    let(:app) { test_app.configure_with(:harfbuzz) }
-    let(:font) { app.fetch_file(SAMPLES_DIR.join('Inconsolata.otf')) }
-
-    # ---------------------------------------------------------------------
-
-    describe 'processors' do
-      it 'adds #hb_view' do
-        font.must_respond_to :hb_view
-      end
-    end
+describe DragonflyHarfbuzz::Plugin do
+  let(:app) { test_app.configure_with(:harfbuzz) }
+  let(:content) { app.fetch_file(SAMPLES_DIR.join('sample.otf')) }
 
+  describe 'processors' do
+    it { content.must_respond_to :hb_view }
   end
 end

data/test/dragonfly_harfbuzz/processors/hb_view_test.rb

@@ -1,45 +1,50 @@
-require 'minitest_helper'
+require 'test_helper'
 
-module DragonflyHarfbuzz
-  module Processors
-    describe HbView do
+describe DragonflyHarfbuzz::Processors::HbView do
+  let(:app) { test_app.configure_with(:harfbuzz) }
+  let(:content) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample.otf')) }
+  let(:processor) { DragonflyHarfbuzz::Processors::HbView.new }
 
-      let(:app) { test_app.configure_with(:harfbuzz) }
-      let(:processor) { DragonflyHarfbuzz::Processors::HbView.new }
-      let(:font) { Dragonfly::Content.new(app, SAMPLES_DIR.join('Inconsolata.otf')) }
-      let(:string) { 'FOO' }
+  let(:string) { 'FOO' }
 
-      it 'renders SVG by default' do
-        processor.call(font, string)
-        font.meta['format'].must_equal 'svg'
+  describe 'SUPPORTED_FORMATS' do
+    DragonflyHarfbuzz::SUPPORTED_FORMATS.each do |format|
+      unless File.exists?(SAMPLES_DIR.join("sample.#{format}"))
+        it(format) { skip "sample.#{format} does not exist, skipping" }
+        next
       end
 
-      describe 'options' do
-        it 'passes options to command line ' do
-          processor.call(font, string, { foreground: '#ff00ff' })
-          font.data.must_include 'fill:rgb(100%,0%,100%);'
-        end
-
-        it 'supports :markup_svg' do
-          processor.call(font, string, { markup_svg: true })
-
-          font.data.must_include "word=\"#{string}\""
+      let(:content) { app.fetch_file SAMPLES_DIR.join("sample.#{format}") }
 
-          font.data.must_include 'character="F"'
-          font.data.must_include 'character="O"'
-          font.data.must_include 'character="O"'
-
-          font.data.must_include 'class="character"'
-          font.data.must_include 'class="word"'
+      DragonflyHarfbuzz::SUPPORTED_OUTPUT_FORMATS.each do |output_format|
+        it("#{format} to #{output_format}") do
+          result = content.hb_view(string, format: output_format)
+          result.ext.must_equal output_format
+          result.mime_type.must_equal Rack::Mime.mime_type(".#{output_format}")
+          result.size.must_be :>, 0
+          result.tempfile.path.must_match /\.#{output_format}\z/
         end
+      end
+    end
+  end
 
-        it 'supports :flatten_svg' do
-          processor.call(font, string, { flatten_svg: true })
+  describe 'foreground' do
+    before { processor.call(content, string, foreground: '#ff00ff') }
+    it { content.data.must_include 'fill:rgb(100%,0%,100%);' }
+  end
 
-          font.data.wont_include "#glyph0-1"
-        end
-      end
+  describe 'markup_svg' do
+    before { processor.call(content, string, markup_svg: true) }
+    it { content.data.must_include "word=\"#{string}\"" }
+    it { content.data.must_include 'character="F"' }
+    it { content.data.must_include 'character="O"' }
+    it { content.data.must_include 'character="O"' }
+    it { content.data.must_include 'class="character"' }
+    it { content.data.must_include 'class="word"' }
+  end
 
-    end
+  describe 'flatten_svg' do
+    before { processor.call(content, string, flatten_svg: true) }
+    it { content.data.wont_include '#glyph0-1' }
   end
 end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'bundler/setup'
+
+require 'minitest'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'minitest/spec'
+
+require 'dragonfly_harfbuzz'
+
+SAMPLES_DIR = Pathname.new(File.expand_path('../samples', __dir__))
+
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
+def test_app(name = nil)
+  Dragonfly::App.instance(name).tap do |app|
+    app.datastore = Dragonfly::MemoryDataStore.new
+    app.secret = 'test secret'
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dragonfly_harfbuzz
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Tomas Celizna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2018-07-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dragonfly
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - tomas.celizna@gmail.com
@@ -130,6 +158,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -143,11 +173,12 @@ files:
 - lib/dragonfly_harfbuzz/plugin.rb
 - lib/dragonfly_harfbuzz/processors/hb_view.rb
 - lib/dragonfly_harfbuzz/version.rb
-- samples/Inconsolata.otf
+- samples/sample.otf
+- samples/sample.ttf
 - test/dragonfly_harfbuzz/flatten_svg_service_test.rb
 - test/dragonfly_harfbuzz/plugin_test.rb
 - test/dragonfly_harfbuzz/processors/hb_view_test.rb
-- test/minitest_helper.rb
+- test/test_helper.rb
 homepage: https://github.com/tomasc/dragonfly_harfbuzz
 licenses:
 - MIT
@@ -168,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Harfbuzz renderer wrapped by Dragonfly processors.
@@ -176,4 +207,4 @@ test_files:
 - test/dragonfly_harfbuzz/flatten_svg_service_test.rb
 - test/dragonfly_harfbuzz/plugin_test.rb
 - test/dragonfly_harfbuzz/processors/hb_view_test.rb
-- test/minitest_helper.rb
+- test/test_helper.rb

data/test/minitest_helper.rb

@@ -1,21 +0,0 @@
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "bundler/setup"
-
-require "minitest"
-require "minitest/autorun"
-require "minitest/spec"
-
-require "dragonfly_harfbuzz"
-
-# ---------------------------------------------------------------------
-
-SAMPLES_DIR = Pathname.new(File.expand_path('../../samples', __FILE__))
-
-# ---------------------------------------------------------------------
-
-def test_app name=nil
-  app = Dragonfly::App.instance(name)
-  app.datastore = Dragonfly::MemoryDataStore.new
-  app.secret = "test secret"
-  app
-end