dragonfly_fonts 0.0.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8c4f51e0a7125d4d21c70ccc57ee4e52dc72f17c
-  data.tar.gz: 2db35ec845bc028784147581c92412fadbd78e1e
+SHA256:
+  metadata.gz: 44223a769713686e569f9fe08487809b1defcd058f0ba6159f52ff7b24ad9ac7
+  data.tar.gz: 15a96a097b74c4c2d95edf2a2456f400a8ddacdba7f6935b8bf76c2185d83820
 SHA512:
-  metadata.gz: b592be81310cdc581c6e3a8044ff7e94a141edf09414eedab59654b7707430c74b4f4e555cb1e77f26d0fd39a449013fa34d01c81f75b90a108e49f90c8ef396
-  data.tar.gz: 1ec958c9a2fc62322031390101d74a992ec82ad91063c0296d07c8fb6ae886bd6e831617fce182156066bf0299319be545a8a8f31794a41dd37e1599d92ef823
+  metadata.gz: aeec99d3665329d6fb5d7a5dc459c1e88aeacb7cf92274019ebc01805ec98c52ad7d463b7e82c9dc9127858e8d3c4e14d050be2e61044e3b768bcf592fd81523
+  data.tar.gz: d9e576bfca8a265a2e6ac8303f8a51ac8dee821f2c7084889f17cec9518c3ac01ac3da72fe6ee39b40bb22f0ea965e603f29e9bfb5e612e5074628af417d3e29

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 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
+* skip unnecessary conversion from-to same format

data/README.md

@@ -36,9 +36,9 @@ Using debian/ubuntu packages:
 
 See [fonttools](https://github.com/behdad/fonttools)
 
-### ot-sanitise
+### ots-sanitize
 
-See [ot-sanitise](https://github.com/khaledhosny/ots)
+See [ots-sanitize](https://github.com/khaledhosny/ots)
 
 ### ttf2eot
 
@@ -62,6 +62,15 @@ Dragonfly.app.configure do
 end
 ```
 
+## Supported Formats
+
+List of supported formats is available as:
+
+```ruby
+DragonflyFonts::SUPPORTED_FORMATS # => ["bdf", "dfont", "bin", …]
+DragonflyFonts::SUPPORTED_OUTPUT_FORMATS # => ["eot", "ttf", …]
+```
+
 ## Analysers
 
 ### Bbox
@@ -96,12 +105,12 @@ Returns `Array` of gsub tables in the font.
 font.gsub_tables
 ```
 
-### OT Sanitise
+### OTS Sanitize
 
-Displays output of the `ot-sanitise` command.
+Displays output of the `ots-sanitize` command.
 
 ```ruby
-font.ot_sanitise
+font.ots_sanitize
 
 ```
 
@@ -154,10 +163,10 @@ font.normalize_names
 
 ### OTS
 
-Sanitise OTF/TTF & WOFF/2 font files.
+Sanitize OTF/TTF & WOFF/2 font files.
 
 ```ruby
-font.ot_sanitise!
+font.ots_sanitize!
 ```
 
 ### Set Dimensions

data/dragonfly_fonts.gemspec

@@ -1,5 +1,5 @@
-# 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_fonts/version'
 
@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activesupport'
   spec.add_dependency 'dragonfly', '~> 1.0'
   spec.add_dependency 'nokogiri'
 
@@ -24,5 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-minitest'
   spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-reporters'
   spec.add_development_dependency 'rake', '~> 10.0'
 end

data/lib/dragonfly_fonts.rb

@@ -1,8 +1,29 @@
 require 'dragonfly'
+require 'active_support/core_ext/object/blank'
+
 require 'dragonfly_fonts/plugin'
 require 'dragonfly_fonts/unicode_ranges'
 require 'dragonfly_fonts/version'
 
 module DragonflyFonts
-  SCRIPT_DIR = Pathname.new(File.expand_path('../../script', __FILE__))
+  class UnsupportedFormat < RuntimeError; end
+  class UnsupportedOutputFormat < RuntimeError; end
+
+  SCRIPT_DIR = Pathname.new(File.expand_path('../script', __dir__))
+
+  FONT_FORGE_SUPPORTED_FORMATS = %w[bdf dfont bin hqx otf sfd pfa pfb cid ps svg ttf ttc pcf woff].freeze
+  FONT_TOOLS_SUPPORTED_FORMATS = %w[ttx].freeze
+  OT_SANITISE_SUPPORTED_FORMATS = %w[otf ttf woff woff2].freeze
+  TTF_AUTOHINT_SUPPORTED_FORMATS = %w[ttf].freeze
+  WOFF2_SUPPORTED_FORMATS = %w[woff2].freeze
+
+  SUPPORTED_FORMATS = (
+    FONT_FORGE_SUPPORTED_FORMATS +
+    FONT_TOOLS_SUPPORTED_FORMATS +
+    OT_SANITISE_SUPPORTED_FORMATS +
+    TTF_AUTOHINT_SUPPORTED_FORMATS +
+    WOFF2_SUPPORTED_FORMATS
+  ).uniq.sort
+
+  SUPPORTED_OUTPUT_FORMATS = %w[eot ttf otf svg woff woff2 ttx].freeze
 end

data/lib/dragonfly_fonts/analysers/bbox.rb

@@ -3,27 +3,29 @@ require 'json'
 module DragonflyFonts
   module Analysers
     class Bbox
-      def call(font, glyph)
-        res = font.shell_eval do |path|
+      def call(content, glyph)
+        return {} unless FONT_FORGE_SUPPORTED_FORMATS.include?(content.ext)
+
+        res = content.shell_eval do |path|
           "#{fontforge_command} -lang=ff -c 'Open($1); Select(\"#{glyph}\"); Print(GlyphInfo(\"BBox\"));' #{path}"
         end
 
+        return {} unless res.present?
+
         dimensions = JSON.parse(res)
 
         Struct::Bbox.new(
           glyph,
-
           dimensions[0],
           dimensions[1],
           dimensions[2],
           dimensions[3],
-
           (dimensions[2] - dimensions[0]),
           (dimensions[3] - dimensions[1])
         )
       end
 
-      private # =============================================================
+      private
 
       def fontforge_command
         'fontforge'

data/lib/dragonfly_fonts/analysers/font_info.rb

@@ -4,10 +4,15 @@ module DragonflyFonts
   module Analysers
     class FontInfo
       # see http://dmtr.org/ff.php#Font
-      def call(font)
-        details = font.shell_eval do |path|
+      def call(content)
+        return {} unless FONT_FORGE_SUPPORTED_FORMATS.include?(content.ext)
+
+        details = content.shell_eval do |path|
           "#{DragonflyFonts::SCRIPT_DIR.join('font_info.py')} #{path}"
         end
+
+        return [] unless details.present?
+
         JSON.parse(details)
       end
     end

data/lib/dragonfly_fonts/analysers/glyphs.rb

@@ -3,10 +3,18 @@ require 'json'
 module DragonflyFonts
   module Analysers
     class Glyphs
-      def call(font)
-        details = font.shell_eval do |path|
-          "#{DragonflyFonts::SCRIPT_DIR.join('glyphs.py')} #{path}"
-        end
+      def call(content)
+        return [] unless FONT_FORGE_SUPPORTED_FORMATS.include?(content.ext)
+
+        # details = content.shell_eval do |path|
+        #   "#{DragonflyFonts::SCRIPT_DIR.join('glyphs.py')} #{path}"
+        # end
+
+        command = "#{DragonflyFonts::SCRIPT_DIR.join('glyphs.py')} #{content.path}"
+        details, stderr_str, status = Open3.capture3(command)
+
+        return [] unless details.present?
+
         JSON.parse(details)
       end
     end

data/lib/dragonfly_fonts/analysers/gsub_tables.rb

@@ -3,10 +3,18 @@ require 'json'
 module DragonflyFonts
   module Analysers
     class GsubTables
-      def call(font)
-        details = font.shell_eval do |path|
-          "#{DragonflyFonts::SCRIPT_DIR.join('gsub_tables.py')} #{path}"
-        end
+      def call(content)
+        return [] unless FONT_FORGE_SUPPORTED_FORMATS.include?(content.ext)
+
+        # details = content.shell_eval do |path|
+        #   "#{DragonflyFonts::SCRIPT_DIR.join('gsub_tables.py')} #{path}"
+        # end
+
+        command = "#{DragonflyFonts::SCRIPT_DIR.join('gsub_tables.py')} #{content.path}"
+        details, stderr_str, status = Open3.capture3(command)
+
+        return [] unless details.present?
+
         JSON.parse(details)
       end
     end

data/lib/dragonfly_fonts/analysers/ots_sanitize.rb

@@ -0,0 +1,19 @@
+require 'open3'
+
+module DragonflyFonts
+  module Analysers
+    class OtsSanitize
+      def call(content)
+        return unless OT_SANITISE_SUPPORTED_FORMATS.include?(content.ext)
+
+        `#{ots_sanitize_command} #{content.path} 2>&1`
+      end
+
+      private
+
+      def ots_sanitize_command
+        'ots-sanitize'
+      end
+    end
+  end
+end

data/lib/dragonfly_fonts/plugin.rb

@@ -2,14 +2,14 @@ require 'dragonfly_fonts/analysers/bbox'
 require 'dragonfly_fonts/analysers/font_info'
 require 'dragonfly_fonts/analysers/glyphs'
 require 'dragonfly_fonts/analysers/gsub_tables'
-require 'dragonfly_fonts/analysers/ot_sanitise'
+require 'dragonfly_fonts/analysers/ots_sanitize'
 
 require 'dragonfly_fonts/processors/correct_metrics'
 require 'dragonfly_fonts/processors/encode'
 require 'dragonfly_fonts/processors/extract_glyph'
 require 'dragonfly_fonts/processors/fix_dflt_table'
 require 'dragonfly_fonts/processors/normalize_names'
-require 'dragonfly_fonts/processors/ot_sanitise'
+require 'dragonfly_fonts/processors/ots_sanitize'
 require 'dragonfly_fonts/processors/set_dimensions'
 require 'dragonfly_fonts/processors/set_ttf_names'
 require 'dragonfly_fonts/processors/set_underline'
@@ -20,21 +20,18 @@ require 'dragonfly_fonts/processors/web_friendly'
 
 module DragonflyFonts
   class Plugin
-    def call(app, _opts = {})
+    def call(app, options = {})
       app.add_analyser :bbox, Analysers::Bbox.new
       app.add_analyser :font_info, Analysers::FontInfo.new
       app.add_analyser :glyphs, Analysers::Glyphs.new
       app.add_analyser :gsub_tables, Analysers::GsubTables.new
-      app.add_analyser :ot_sanitise, Analysers::OtSanitise.new
-
-      # ---------------------------------------------------------------------
+      app.add_analyser :ots_sanitize, Analysers::OtsSanitize.new
 
       app.add_processor :correct_metrics, Processors::CorrectMetrics.new
-      app.add_processor :encode, Processors::Encode.new
       app.add_processor :extract_glyph, Processors::ExtractGlyph.new
       app.add_processor :fix_dflt_table, Processors::FixDfltTable.new
       app.add_processor :normalize_names, Processors::NormalizeNames.new
-      app.add_processor :ot_sanitise!, Processors::OtSanitise.new
+      app.add_processor :ots_sanitize!, Processors::OtsSanitize.new
       app.add_processor :set_dimensions, Processors::SetDimensions.new
       app.add_processor :set_ttf_names, Processors::SetTtfNames.new
       app.add_processor :set_underline, Processors::SetUnderline.new
@@ -42,6 +39,34 @@ module DragonflyFonts
       app.add_processor :set_woff_metadata, Processors::SetWoffMetadata.new
       app.add_processor :ttf_autohint, Processors::TtfAutohint.new
       app.add_processor :web_friendly, Processors::WebFriendly.new
+
+      app.add_processor :encode do |content, format, options = {}|
+        case content.ext
+        when 'ttx'
+          # when ttf pre-convert to otf
+          Processors::Encode.new.call(content, 'otf', options) unless %w[font/ttf font/otf].include?(content.mime_type)
+        when 'woff2'
+          # when woff2 pre-convert to ttf
+          Processors::Encode.new.call(content, 'ttf', options)
+        end
+
+        case format
+        when 'eot'
+          # when converting to eot supply ttf
+          Processors::Encode.new.call(content, 'ttf', options) unless %w[font/ttf].include?(content.mime_type)
+        when 'woff2'
+          # when converting to woff2 supply otf
+          Processors::Encode.new.call(content, 'otf', options) unless %w[font/ttf font/otf].include?(content.mime_type)
+        end
+
+        Processors::Encode.new.call(content, format, options)
+      end
+
+      app.add_mime_type 'ttf', 'font/ttf'
+      app.add_mime_type 'otf', 'font/otf'
+      app.add_mime_type 'woff', 'font/woff'
+      app.add_mime_type 'woff2', 'font/woff2'
+      app.add_mime_type 'ttx', 'font/ttx'
     end
   end
 end

data/lib/dragonfly_fonts/processors/correct_metrics.rb

@@ -1,17 +1,20 @@
 module DragonflyFonts
   module Processors
     class CorrectMetrics
-      def call(font)
-        font.shell_update(ext: font.ext || :ttf) do |old_path, new_path|
+      def call(content, options = {})
+        # TODO: if other then convert first
+        raise UnsupportedFormat unless FONT_FORGE_SUPPORTED_FORMATS.include?(content.ext)
+
+        content.shell_update(ext: content.ext || 'ttf') do |old_path, new_path|
           "#{fontforge_command} -lang=ff -c 'Open($1); SetOS2Value(\"HHeadAscent\",$ascent); SetOS2Value(\"HHeadAscentIsOffset\",0); SetOS2Value(\"HHeadDescent\",-$descent); SetOS2Value(\"HHeadDescentIsOffset\",0); SetOS2Value(\"TypoLineGap\",0); Generate($2);' #{old_path} #{new_path}"
         end
       end
 
-      def update_url(attrs, *_args)
+      def update_url(attrs, *args)
         attrs.style = 'corrmetr'
       end
 
-      private # =============================================================
+      private
 
       def fontforge_command
         'fontforge'

data/lib/dragonfly_fonts/processors/encode.rb

@@ -3,24 +3,30 @@ require 'shellwords'
 module DragonflyFonts
   module Processors
     class Encode
-      class UnsupportedFormat < RuntimeError; end
+      def call(content, format, options = {})
+        raise UnsupportedFormat unless SUPPORTED_FORMATS.include?(content.ext)
+
+        format = format.to_s
+
+        raise UnsupportedOutputFormat unless SUPPORTED_OUTPUT_FORMATS.include?(format)
+
+        if content.mime_type == Rack::Mime.mime_type(".#{format}")
+          content.ext ||= format
+          content.meta['format'] = format
+          return
+        end
 
-      def call(content, format)
         content.shell_update(ext: format, escape: false) do |old_path, new_path|
-          if content.ext == 'ttx' || content.meta['format'] == 'ttx'
-            fonttools(old_path, new_path)
-          else
-            case format.to_sym
-            when :eot then ttf2eot(old_path, new_path)
-            when :otf, :svg, :ttf, :woff then fontforge(old_path, new_path)
-            when :ttx then fonttools(old_path, new_path)
-            when :woff2 then woff2(old_path, new_path)
-            else fail UnsupportedFormat
-            end
+          case
+          when content.ext == 'woff2' && format == 'ttf' then woff2_decompress(old_path, new_path)
+          when format == 'eot' then ttf2eot(old_path, new_path)
+          when format == 'ttx' then fonttools(old_path, new_path)
+          when format == 'woff2' then woff2_compress(old_path, new_path)
+          else fontforge(old_path, new_path)
           end
         end
 
-        content.meta['format'] = format.to_s
+        content.meta['format'] = format
         content.ext = format
       end
 
@@ -28,7 +34,7 @@ module DragonflyFonts
         attrs.ext = format.to_s
       end
 
-      private # =============================================================
+      private
 
       def fontforge(old_path, new_path)
         "#{fontforge_command} -lang=ff -c 'Open($1); Generate($2)' #{old_path} #{new_path}"
@@ -38,8 +44,6 @@ module DragonflyFonts
         'fontforge'
       end
 
-      # ---------------------------------------------------------------------
-
       def fonttools(old_path, new_path)
         "#{fonttools_command} -o #{new_path} #{old_path}"
       end
@@ -48,8 +52,6 @@ module DragonflyFonts
         'ttx'
       end
 
-      # ---------------------------------------------------------------------
-
       def ttf2eot(old_path, new_path)
         "#{ttf2eot_command} < #{old_path} > #{new_path}"
       end
@@ -58,15 +60,27 @@ module DragonflyFonts
         'ttf2eot'
       end
 
-      # ---------------------------------------------------------------------
-
-      def woff2(old_path, new_path)
-        "#{woff2_command} #{old_path} && mv #{old_path.gsub(/\.\w{3,5}\z/, '.woff2')} #{new_path}"
+      def woff2_compress(old_path, new_path)
+        temp_file = Tempfile.new(['font', '.woff2']).tap do |file|
+          file.write(File.read(old_path))
+        end
+        "#{woff2_compress_command} #{temp_file.path} && mv #{temp_file.path.gsub(/\.\w{3,5}\z/, '.woff2')} #{new_path}"
       end
 
-      def woff2_command
+      def woff2_compress_command
         'woff2_compress'
       end
+
+      def woff2_decompress(old_path, new_path)
+        temp_file = Tempfile.new(['font', '.woff2']).tap do |file|
+          file.write(File.read(old_path))
+        end
+        "#{woff2_decompress_command} #{temp_file.path} && mv #{temp_file.path.gsub(/\.\w{3,5}\z/, '.ttf')} #{new_path}"
+      end
+
+      def woff2_decompress_command
+        'woff2_decompress'
+      end
     end
   end
 end