Overhaul [not ready]

.travis.yml

@@ -1,29 +1,69 @@
 language: cpp
-os:
-- linux
-- osx
-compiler:
-- clang
-- gcc
+
+matrix:
+  include:
+     # Coverage
+     - os: osx
+       compiler: clang
+       env: NODE_VERSION="0.10" COVERAGE=true
+     # Linux
+     - os: linux
+       compiler: clang
+       env: NODE_VERSION="0.10"
+     - os: linux
+       compiler: clang
+       env: NODE_VERSION="0.12"
+     # OS X
+     - os: osx
+       compiler: clang
+       env: NODE_VERSION="0.10"
+     - os: osx
+       compiler: clang
+       env: NODE_VERSION="0.12"
+
 env:
-  matrix:
-  - NODE_NVM_VERSION="0.8.26"
-  - NODE_NVM_VERSION="0.10"
   global:
-  - BUILD: '/tmp/fontnik-build'
-  - PKG_CONFIG_PATH: '/tmp/fontnik-build/lib/pkgconfig'
-  - secure: "XV0lekmfgT+D9t0ZTIU+UJF6g+p3cBQMO6T6C9lkoKTC0YbtLtxSFtBahD/4PjL86DMJgTaf1nBmxqOxbrfkcpJUxnLe3r8u4Z2L/+7+QSACLNktlIfWNSO+33WxKNb4mVw6jMFZIo4ZurF016MXYzLzjpxRELW2oO2STUs2m44="
-  - secure: "CQNHbxw8yHlAdUVbKokHzHmj7C+duXP3mifWOkZm9GKw4myWsRFhhoSYZmOSkgj9EWfYYkedrqEr9+GaMg9rkVJuO/7jzn6S+M7CFXKJju6MoZEDO6WcFva4M8pw6IFb9q22GcQ+OsE8/i0DwchTokyFkNb3fpwWuwROUPQ/nWg="
+   - JOBS: "8"
+   - BUILD: '/tmp/fontnik-build'
+   - PKG_CONFIG_PATH: '/tmp/fontnik-build/lib/pkgconfig'
+   - secure: "XV0lekmfgT+D9t0ZTIU+UJF6g+p3cBQMO6T6C9lkoKTC0YbtLtxSFtBahD/4PjL86DMJgTaf1nBmxqOxbrfkcpJUxnLe3r8u4Z2L/+7+QSACLNktlIfWNSO+33WxKNb4mVw6jMFZIo4ZurF016MXYzLzjpxRELW2oO2STUs2m44="
+   - secure: "CQNHbxw8yHlAdUVbKokHzHmj7C+duXP3mifWOkZm9GKw4myWsRFhhoSYZmOSkgj9EWfYYkedrqEr9+GaMg9rkVJuO/7jzn6S+M7CFXKJju6MoZEDO6WcFva4M8pw6IFb9q22GcQ+OsE8/i0DwchTokyFkNb3fpwWuwROUPQ/nWg="
+
 before_install:
-- export platform=$(uname -s | sed "y/ABCDEFGHIJKLMNOPQRSTUVWXYZ/abcdefghijklmnopqrstuvwxyz/")
-- export PATH="$BUILD/bin:$PATH"
-- if [[ "$platform" == "linux" ]]; then export CXX=g++-4.8; export CC=gcc-4.8; fi
-- ./deps/nvm_install.sh
-- ./deps/travis_build.sh
+ - export COVERAGE=${COVERAGE:-false}
+ # here we set up the node version on the fly based on the matrix value.
+ # This is done manually so that it is easy to flip the 'language' to
+ # objective-c in another branch (to run the same travis.yml on OS X)
+ - git clone https://github.com/creationix/nvm.git ../.nvm
+ - source ../.nvm/nvm.sh
+ - nvm install $NODE_VERSION
+ - nvm use $NODE_VERSION
+ - node --version
+ - npm --version
+ - if [[ ${COVERAGE} == true ]]; then
+      brew update;
+      brew install pyenv;
+      eval "$(pyenv init -)";
+      pyenv install 2.7.6;
+      pyenv global 2.7.6;
+      pyenv rehash;
+      pip install cpp-coveralls;
+      pyenv rehash;
+     fi;
+ - export PATH="$BUILD/bin:$PATH"
+ - ./deps/travis_build.sh
+
 install:
-- npm install --build-from-source
+ - if [[ ${COVERAGE} == true ]]; then
+    export LDFLAGS="--coverage" && export CXXFLAGS="--coverage" && npm install --build-from-source --debug --clang=1;
+  else
+    npm install --build-from-source --clang=1;
+  fi;
+
 script:
-- npm test
+ - npm test
+ - if [[ ${COVERAGE} == true ]]; then cpp-coveralls --exclude node_modules --exclude tests --build-root build --gcov-options '\-lp' --exclude doc --exclude build/Debug/obj/gen; fi;
+
 after_success:
-- ./deps/travis_publish.sh
+ - ./deps/travis_publish.sh
 

API.md

@@ -2,40 +2,19 @@
 
 ### `range(options: object, callback: function)`
 
-`options` is an object with options:
-
+Get a range of glyphs as a protocol buffer. `options` is an object with options:
+* `file: string`
 * `start: number`
 * `end: number`
-* `fontstack: ?string`
-
-Get a range of glyphs as a gzipped protocol buffer.
-
-### `conf(options: object)`
-
-`options` is an object with options:
-
-* `fonts: Array<string>`
-
-Configure node-fontnik.
-
-### `getRange(start: number, end: number): Array<number>`
-
-Generate an array of the numbers from `start` to `end`. `start` must be 
-less than `end` and both numbers must be in the inclusive range 0 to 65535.
-
-### `faces(): Array<string>`
-
-Return an array of supported font faces, as strings.
-
-## `new fontnik.Glyphs()`
-
-Create a new Glyphs object.
-
-### `glyphs.codepoints(face: string): Array<number>`
 
-Get an array of numbers corresponding to unicode points where this font face
-has coverage.
+`file` is the path to a font file on disk.]
 
-### `glyphs.range(face: string, range: string, chars: Array<number>, callback: function)`
+### `load(fontpath: string, callback: function)`
 
-### `glyphs.serialize(): Buffer`
+Read a font's metadata. Returns an object like
+``` json
+"family_name": "Open Sans",
+"style_name": "Regular",
+"points": [32,33,34,35…]
+```
+where `points` is an array of numbers corresponding to unicode points where this font face has coverage.

README.md

@@ -1,6 +1,8 @@
 # node-fontnik
 
-[![NPM](https://nodei.co/npm/fontnik.png?compact=true)](https://nodei.co/npm/fontnik/) [![Build Status](https://travis-ci.org/mapbox/node-fontnik.svg?branch=master)](https://travis-ci.org/mapbox/node-fontnik)
+[![NPM](https://nodei.co/npm/fontnik.png?compact=true)](https://nodei.co/npm/fontnik/)
+[![Build Status](https://travis-ci.org/mapbox/node-fontnik.svg?branch=master)](https://travis-ci.org/mapbox/node-fontnik)
+[![Coverage Status](https://coveralls.io/repos/mapbox/node-fontnik/badge.svg?branch=coverage)](https://coveralls.io/r/mapbox/node-fontnik?branch=coverage)
 
 A library that delivers a range of glyphs rendered as SDFs (signed distance fields) in a protocol buffer. We use these encoded glyphs as the basic blocks of font rendering in [Mapbox GL](https://github.com/mapbox/mapbox-gl-js). SDF encoding is superior to traditional fonts for our usecase terms of scaling, rotation, and quickly deriving halos - WebGL doesn't have built-in font rendering, so the decision is between vectorization, which tends to be slow, and SDF generation.
 

bench/bench.js

@@ -0,0 +1,49 @@
+'use strict';
+
+var path = require('path');
+var fontnik = require('../');
+var queue = require('queue-async');
+var fs = require('fs');
+
+// https://gist.github.com/mourner/96b1335c6a43e68af252
+// https://gist.github.com/fengmk2/4345606
+function now() {
+    var hr = process.hrtime();
+    return hr[0] + hr[1] / 1e9;
+}
+
+function bench(opts,cb) {
+    var q = queue(opts.concurrency);
+    var start = now();
+    for (var i = 1; i <= opts.iterations; i++) {
+        q.defer.apply({},opts.args);
+    }
+    q.awaitAll(function(error, results) {
+        var seconds = now() - start;
+        console.log(opts.name, Math.round(opts.iterations / (seconds)),'ops/sec',opts.iterations,opts.concurrency);
+        return cb();
+    });
+}
+
+function main() {
+    var opensans = fs.readFileSync(path.resolve(__dirname + '/../fonts/open-sans/OpenSans-Regular.ttf'));
+
+    var suite = queue(1);
+    suite.defer(bench, {
+        name:"fontnik.load",
+        args:[fontnik.load,opensans],
+        iterations: 10,
+        concurrency: 10
+    });
+    suite.defer(bench, {
+        name:"fontnik.range",
+        args:[fontnik.range,{font:opensans,start:0,end:256}],
+        iterations: 1000,
+        concurrency: 100
+    });
+    suite.awaitAll(function(err) {
+        if (err) throw err;
+    })
+}
+
+main();

bench/bench2.js

@@ -0,0 +1,38 @@
+'use strict';
+
+var path = require('path');
+var fontnik = require('../');
+var Benchmark = require('benchmark');
+var fs = require('fs');
+
+var opensans = fs.readFileSync(path.resolve(__dirname + '/../fonts/open-sans/OpenSans-Regular.ttf'));
+
+var suite = new Benchmark.Suite();
+
+suite
+.add('fontnik.load', {
+    'defer': true,
+    'fn': function(deferred) {
+      // avoid test inlining
+      suite.name;
+      fontnik.load(opensans,function(err) {
+        if (err) throw err;
+        deferred.resolve();
+      });
+    }
+})
+.add('fontnik.range', {
+    'defer': true,
+    'fn': function(deferred) {
+      // avoid test inlining
+      suite.name;
+      fontnik.range({font:opensans,start:0,end:256},function(err) {
+        if (err) throw err;
+        deferred.resolve();
+      });
+    }
+})
+.on('cycle', function(event) {
+    console.log(String(event.target));
+})
+.run({async:true});

binding.gyp

@@ -24,29 +24,17 @@
         'src/node_fontnik.cpp',
         'src/glyphs.cpp',
         'vendor/agg/src/agg_curves.cpp',
-        'vendor/fontnik/src/glyphs.cpp',
-        'vendor/fontnik/src/face.cpp',
-        'vendor/mapnik/src/debug.cpp',
-        'vendor/mapnik/src/font_engine_freetype.cpp',
-        'vendor/mapnik/src/font_set.cpp',
-        'vendor/mapnik/src/fs.cpp',
-        'vendor/mapnik/src/text/face_set.cpp',
         '<(SHARED_INTERMEDIATE_DIR)/glyphs.pb.cc'
       ],
       'include_dirs': [
         './include',
         './vendor/agg/include',
-        './vendor/fontnik/include',
-        './vendor/mapnik/include',
-        './vendor/node_mapnik/include',
         '<(SHARED_INTERMEDIATE_DIR)/',
         '<!@(pkg-config freetype2 --cflags-only-I | sed s/-I//g)',
         '<!@(pkg-config protobuf --cflags-only-I | sed s/-I//g)',
         "<!(node -e \"require('nan')\")"
       ],
       'libraries': [
-        '-lboost_system',
-        '-lboost_filesystem',
         '<!@(pkg-config freetype2 --libs --static)',
         '<!@(pkg-config protobuf --libs --static)'
       ],

deps/travis_publish.sh

@@ -3,15 +3,15 @@
 set -e
 
 # Inspect binary.
-if [ $platform == "linux" ]; then
+if [[ $(uname -s) == "Linux" ]]; then
     ldd ./lib/fontnik.node
 else
     otool -L ./lib/fontnik.node
 fi
 
 COMMIT_MESSAGE=$(git show -s --format=%B $TRAVIS_COMMIT | tr -d '\n')
 
-if test "${COMMIT_MESSAGE#*'[publish binary]'}" != "$COMMIT_MESSAGE"
+if test "${COMMIT_MESSAGE#*'[publish binary]'}" != "$COMMIT_MESSAGE" && [[ ${COVERAGE} == false ]];
     then
 
     npm install aws-sdk

index.js

@@ -1,36 +1 @@
-var zlib = require('zlib');
-var path = require('path');
-var util = require('util');
-var fontnik = require('./lib/fontnik.node');
-
-module.exports = fontnik;
-module.exports.range = range;
-module.exports.getRange = getRange;
-
-// Retrieve a range of glyphs as a pbf.
-function range(options, callback) {
-    'use strict';
-    options = options || {};
-    options.fontstack = options.fontstack || 'Open Sans Regular';
-
-    var glyphs = new fontnik.Glyphs();
-    glyphs.range(options.fontstack, options.start + '-' + options.end, getRange(options.start, options.end), gzip);
-
-    function gzip(err) {
-        if (err) return callback(err);
-        var after = glyphs.serialize();
-        zlib.gzip(after, callback);
-    }
-}
-
-function getRange(start, end) {
-    if (typeof start !== 'number') throw new Error('start must be a number from 0-65535');
-    if (start < 0) throw new Error('start must be a number from 0-65535');
-    if (typeof end !== 'number') throw new Error('end must be a number from 0-65535');
-    if (end > 65535) throw new Error('end must be a number from 0-65535');
-    if (start > end) throw new Error('start must be less than or equal to end');
-    var range = [];
-    for (var i = start; i <= end; i++) range.push(i);
-    return range;
-}
-
+module.exports = require('./lib/fontnik.node');

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fontnik",
-  "version": "0.2.6",
+  "version": "1.0.0",
   "description": "A library that delivers a range of glyphs rendered as SDFs (signed distance fields) in a protobuf.",
   "keywords": [
     "font",
@@ -23,9 +23,10 @@
     }
   ],
   "dependencies": {
+    "benchmark": "^1.0.0",
     "minimist": "^0.2.0",
-    "nan": "^1.2.0",
-    "node-pre-gyp": "^0.5.31",
+    "nan": "^1.7.0",
+    "node-pre-gyp": "~0.6.4",
     "queue-async": "^1.0.7"
   },
   "bundledDependencies": [