woff 1.0.0 → 1.1.0

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+python: "3.4"
+before_install:
+  - curl "https://bootstrap.pypa.io/get-pip.py" -o "get-pip.py"
+  - sudo python get-pip.py
+  - python -V
+  - pip -V
+install:
+  - bundle install
+  - sudo pip install -r requirements.txt
+rvm:
+  - 2.2
+  - 2.3

data/README.md

@@ -1,12 +1,17 @@
-# Woff
+# WOFF
 
-TODO: Write a gem description
+[![Gem Version](https://badge.fury.io/rb/woff.svg)](https://badge.fury.io/rb/woff)
+[![Build Status](https://travis-ci.org/friendsoftheweb/woff-rb.svg?branch=master)](https://travis-ci.org/friendsoftheweb/woff-rb)
+[![Code Climate](https://codeclimate.com/github/friendsoftheweb/woff-rb/badges/gpa.svg)](https://codeclimate.com/github/friendsoftheweb/woff-rb)
+
+This reads binary data from WOFF files in pure Ruby and allows limited
+modification of metadata.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'woff'
+    gem 'woff', '~> 1.1.0'
 
 And then execute:
 
@@ -16,9 +21,25 @@ Or install it yourself as:
 
     $ gem install woff
 
+## WOFF2 Support
+
+The gem can currently read, but not write to WOFF2 files. Both reading and writing
+WOFF2 files should be considered in development, with API changes likely.
+
 ## Usage
 
-TODO: Write usage instructions here
+Used in generation of WOFF files. Returns the data to be written to a file or
+sent to the Zip gem of your choice.
+
+```ruby
+woff = WOFF::Builder.new("/Users/Desktop/sample.woff")
+
+# This will set or update the metadata's licensee name to `The Friends` and the
+# metadata's license id to `L012356093901`.
+data = woff.font_with_licensee_and_id("The Friends", "L012356093901")
+
+File.binwrite("/Users/Desktop/sample-with-metadata.woff", data)
+```
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+
+task :default => :spec

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/lib/woff.rb

@@ -1,9 +1,10 @@
 require "woff/version"
 require "zlib"
+require "brotli"
 require "bindata"
 require "rexml/document"
+require "woff/file"
 require "woff/builder"
-require "woff/data"
 
 module WOFF
   class FontNotFoundError < StandardError
@@ -11,4 +12,10 @@ module WOFF
       super(msg)
     end
   end
+
+  class InvalidSignatureError < StandardError
+    def initialize(msg = "The WOFF file contains an invalid WOFF or WOFF2 signature.")
+      super(msg)
+    end
+  end
 end

data/lib/woff/builder.rb

@@ -1,10 +1,9 @@
 module WOFF
-  # Used in generation of WOFF files. Currently only modifies licensee
-  # information and writes to a file. In the future it should stream
-  # the output for use in one time use downloads.
+  # Used in generation of WOFF files with modified metadata for licensee and
+  # license id information.
   #
   #   woff = WOFF::Builder.new("/Users/Josh/Desktop/sample.woff")
-  #   woff.font_with_licensee("The Friends")
+  #   woff.font_with_licensee_and_id("The Friends", "L012356093901")
   #
   class Builder
     def initialize(file)
@@ -12,36 +11,88 @@ module WOFF
     end
 
     def font_with_licensee_and_id(name, id)
-      metadata_xml = ::Zlib::Inflate.inflate(data.metadata)
+      font_with_metadata(licensee: name, license_id: id)
+    end
+
+    def font_with_metadata(licensee: nil, license_id: nil, license_text: nil, description: nil)
+      metadata_xml = data.metadata.length > 0 ? compressor.inflate(data.metadata) : default_metadata
       metadata_doc = REXML::Document.new(metadata_xml)
 
-      if metadata_doc.root.elements["licensee"]
-        metadata_doc.root.elements["licensee"].attributes["name"] = name
-      else
-        metadata_doc.root.add_element "licensee", { "name" => name }
+      if licensee
+        if metadata_doc.root.elements["licensee"]
+          metadata_doc.root.elements["licensee"].attributes["name"] = licensee
+        else
+          metadata_doc.root.add_element "licensee", { "name" => licensee }
+        end
       end
 
-      if metadata_doc.root.elements["license"]
-        metadata_doc.root.elements["license"].attributes["id"] = id
-      else
-        metadata_doc.root.add_element "license", { "id" => id }
+      if license_id
+        if metadata_doc.root.elements["license"]
+          metadata_doc.root.elements["license"].attributes["id"] = license_id
+        else
+          metadata_doc.root.add_element "license", { "id" => license_id }
+        end
       end
 
-      compressed_metadata = ::Zlib::Deflate.deflate(metadata_doc.to_s)
+      if license_text
+        license_el = metadata_doc.root.elements["license"]
+        unless license_el
+          license_el = metadata_doc.root.add_element "license"
+        end
+
+        license_text_el = license_el.elements["text"]
+        unless license_text_el
+          license_text_el = license_el.add_element("text", { "lang" => "en "})
+        end
+
+        license_text_el.text = license_text
+      end
+
+      if description
+        description_el = metadata_doc.root.elements["description"]
+        unless description_el
+          description_el = metadata_doc.root.add_element "description"
+        end
+
+        description_text_el = description_el.elements["text"]
+        unless description_text_el
+          description_text_el = description_el.add_element("text", { "lang" => "en "})
+        end
+
+        description_text_el.text = description
+      end
+
+      compressed_metadata = compressor.deflate(metadata_doc.to_s)
 
       data.meta_orig_length = metadata_doc.to_s.bytesize
       data.metadata = compressed_metadata
       data.meta_length = compressed_metadata.bytesize
+      data.meta_offset = data.metadata.abs_offset # "Offset to metadata block, from beginning of WOFF file."
+
       data.data_length = data.num_bytes
 
       data.to_binary_s
     end
 
+
     private
     attr_reader :location
 
     def data
-      @data ||= WOFF::Data.read(File.open(location))
+      @data ||= WOFF::File.read(::File.open(location))
+    end
+
+    def compressor
+      case data
+      when WOFF::File::V1
+        ::Zlib
+      when WOFF::File::V2
+        ::Brotli
+      end
+    end
+
+    def default_metadata
+      %Q{<?xml version="1.0" encoding="UTF-8"?><metadata version="1.0"></metadata>}
     end
   end
 end

data/lib/woff/file.rb

@@ -0,0 +1,152 @@
+class UIntBase128 < BinData::BasePrimitive
+  # TODO: This should, like actually encode the value. This file might help:
+  # https://github.com/khaledhosny/woff2/blob/f43ad222715f58ea62a004b54e4b6a31e589e762/src/variable_length.cc
+  def value_to_binary_string(value)
+    "0"
+  end
+
+  def read_and_return_value(io)
+    value = 0
+    offset = 0
+
+    loop do
+      byte = io.readbytes(1).unpack('C')[0]
+      value |= (byte & 0x7F) << offset
+      offset += 7
+      if byte & 0x80 == 0
+        break
+      end
+    end
+
+    value
+  end
+
+  def sensible_default
+    0
+  end
+end
+
+module WOFF
+  class File
+    def self.read(file)
+      data = Data.read(file)
+      file.rewind
+
+      if data.signature == 0x774F4646
+        V1.read(file)
+      elsif data.signature == 0x774F4632
+        V2.read(file)
+      else
+        raise WOFF::InvalidSignatureError
+      end
+    end
+
+    class Data < ::BinData::Record
+      endian :big
+
+      uint32 :signature
+    end
+
+    class V1 < ::BinData::Record
+      endian :big
+      count_bytes_remaining :bytes_remaining
+
+      uint32 :signature
+      uint32 :flavor
+      uint32 :data_length
+      uint16 :num_tables
+      uint16 :reserved
+      uint32 :total_s_fnt_size
+      uint16 :major_version
+      uint16 :minor_version
+      uint32 :meta_offset
+      uint32 :meta_length
+      uint32 :meta_orig_length
+      uint32 :priv_offset
+      uint32 :priv_length
+
+      array :table_directory, initial_length: :num_tables do
+        uint32 :tag
+        uint32 :table_offset
+        uint32 :comp_length
+        uint32 :orig_length
+        uint32 :orig_checksum
+      end
+
+      string :fonts, read_length: lambda {
+        dir = table_directory.sort_by { |entry| entry["table_offset"] }
+
+        first_table_start = dir.first["table_offset"]
+        last_table_end = dir.last["table_offset"] + dir.last["comp_length"]
+
+        table_length = last_table_end - first_table_start
+
+        # Next largest number divisible by 4
+        (table_length / 4.0).ceil * 4
+      }
+
+      string :metadata, read_length: :meta_length
+
+      rest :private_data
+    end
+
+
+    class V2 < ::BinData::Record
+      endian :big
+      count_bytes_remaining :bytes_remaining
+
+      uint32 :signature
+      uint32 :flavor
+      uint32 :data_length
+      uint16 :num_tables
+      uint16 :reserved
+      uint32 :total_s_fnt_size
+      uint32 :total_compressed_size
+      uint16 :major_version
+      uint16 :minor_version
+      uint32 :meta_offset
+      uint32 :meta_length
+      uint32 :meta_orig_length
+      uint32 :priv_offset
+      uint32 :priv_length
+
+      array :table_directory, initial_length: :num_tables do
+        uint8 :flags
+        uint32 :tag, onlyif: -> {
+          bits = flags.to_binary_s.unpack('B*')[0]
+          tag_index = bits[0..5].to_i(2)
+
+          tag_index == 63
+        }
+        u_int_base128 :orig_length
+        u_int_base128 :transform_length, onlyif: -> {
+          bits = flags.to_binary_s.unpack('B*')[0]
+          tag_index = bits[0..5].to_i(2)
+          transform_version = bits[6..7].to_i(2)
+          is_loca_or_glyf = [10, 11].include?(tag_index)
+
+          (is_loca_or_glyf && transform_version != 3) || (!is_loca_or_glyf && transform_version != 0)
+        }
+      end
+
+      struct :collection_directory, onlyif: :has_collection? do
+        uint32 :version
+        uint16 :num_fonts # 255UInt16
+
+        array :collection_font_entries, initial_length: :num_fonts do
+          uint16 :num_collection_tables # 255UInt16
+        end
+      end
+
+      string :compressed_data, read_length: :total_compressed_size
+
+      string :metadata, read_length: :meta_length
+
+      rest :private_data
+
+      def has_collection?
+        flavor == 0x74746366
+      end
+    end
+  end
+end

data/lib/woff/version.rb

@@ -1,3 +1,3 @@
 module WOFF
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/requirements.txt

@@ -0,0 +1 @@
+fonttools==3.1.1

data/spec/builder_spec.rb

@@ -0,0 +1,49 @@
+# This uses the forked and embedded woffTools script, it needs python available, as well
+# as woffTools python dependencies.
+
+require 'spec_helper.rb'
+require 'tmpdir'
+
+describe WOFF::Builder do
+  let(:tmpdir_path) { Dir.mktmpdir }
+  let(:output_path) { File.join(tmpdir_path, "with_licensee_and_id.woff") }
+  let(:no_metadata_woff_path) { File.expand_path("../data/font-with-no-metadata.woff", __FILE__) }
+
+  let(:validate_script) { File.expand_path("../../woffTools/Lib/woffTools/tools/validate.py", __FILE__) }
+
+  after do
+    FileUtils.rm_r(tmpdir_path)
+  end
+
+  describe "#font_with_licensee_and_id" do
+    let(:licensee) { "Some Licensee" }
+    let(:id) { "L012356093901" }
+
+    before do
+      woff = WOFF::Builder.new(no_metadata_woff_path)
+
+      data = woff.font_with_licensee_and_id("The Friends", "L012356093901")
+      File.binwrite(output_path, data)
+    end
+
+    it "is valid according to woffTools" do
+      expect(system("python", validate_script, output_path, "-q")).to be(true)
+    end
+  end
+
+  describe "#font_with_metadata" do
+    let(:licensee) { "Some Licensee" }
+    let(:license_id) { "L012356093901" }
+    let(:license_text) { "Do the right things" }
+    let(:description) { "very nice font" }
+
+    let(:woff) { woff = WOFF::Builder.new(no_metadata_woff_path) }
+
+    it "can set just license_text and description" do
+      data = woff.font_with_metadata(license_text: license_text, description: description)
+      File.binwrite(output_path, data)
+
+      expect(system("python", validate_script, output_path, "-q")).to be(true)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "bundler/setup"
+Bundler.setup
+
+require "woff"
+
+RSpec.configure do |config|
+end