Better performance (especially on large files).

.github/workflows/tartufo.yml

@@ -0,0 +1,21 @@
+name: 🍨 Tartufo 🏴‍☠️
+
+on: [push]
+
+jobs:
+  tartufo:
+    name: Run Tartufo
+    runs-on: ubuntu-latest
+    steps:
+    - uses: "actions/checkout@v2"
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Setup Python 🐍
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.x
+    - name: Check for leaks 💦
+      run: |
+        git pull --unshallow
+        pip install tartufo
+        tartufo --config tartufo.toml scan-local-repo .

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: 🧪 Lint, Test & Check Coverage 🧐
+
+on: [push]
+
+jobs:
+  build:
+    name: Test the build
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12, 14]
+
+    steps:
+    - uses: "actions/checkout@v2"
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Setup NodeJS ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install packages
+      run: npm install
+    - name: Lint & Test
+      run: npm run test

.npmignore

@@ -0,0 +1 @@
+/assets/

.pre-commit-config.yaml

@@ -0,0 +1,5 @@
+repos:
+- repo: https://github.com/godaddy/tartufo
+  rev: v2.6.0
+  hooks:
+  - id: tartufo

README.md

@@ -1,2 +1,77 @@
-# node-im-metadata
-Retrieve image metadata using ImageMagick's identify command 
+# im-metadata
+
+[![NPM downloads](https://img.shields.io/npm/dm/im-metadata.svg "NPM downloads")](https://www.npmjs.com/package/im-metadata)
+[![NPM version](https://img.shields.io/npm/v/im-metadata.svg "NPM version")](https://www.npmjs.com/package/im-metadata)
+[![Node version](https://img.shields.io/node/v/im-metadata.svg "Node version")](https://www.npmjs.com/package/im-metadata)
+[![Dependency status](https://img.shields.io/david/turistforeningen/node-im-metadata.svg "Dependency status")](https://david-dm.org/turistforeningen/node-im-metadata)
+
+Retrieve image metadata as a JSON object using ImageMagick's `identify` command.
+
+## Requiremets
+
+* Node.JS v0.10 or newer
+* ImageMagick v6.8 or newer
+
+## Install
+
+```
+npm install im-metadata --save
+```
+
+## API
+
+```js
+var metadata = require('im-metadata');
+```
+
+### metadata(**string** `src`, **object** `opts`, **function** `callback`)
+
+Return metadata **object** for a given `src` image.
+
+* **string** `src` - path to the image on disk
+* **object** `opts` - metadata parsing options
+  * **boolean** `exif` - return exif data or not (default `false`)
+  * **boolean** `autoOrient` - auto-orient height/width (default `false`)
+  * **integer** `timeout` - command timeout length (default `5000`)
+* **function** `callback` - callback function (**Error** `error`, **object** `data`)
+  * **Error** `error` - error output if command failed
+  * **object** `data` - parsed metadata object
+
+#### Return
+
+Returns an `object` with parsed metada:
+
+* **string** `path` - original image path
+* **string** `name` - original image name
+* **string** `size` - image file size in bytes (ex. `4504682`)
+* **string** `format` - image format (`JPEG`, `PNG`, `TIFF` etc.)
+* **string** `colorspace` - image colorspace (`RGB`, `CMYK` etc.)
+* **integer** `height` - image pixel height
+* **integer** `width` - image pixel width
+* **string** `orientation` - image orientation
+
+#### Example
+
+```js
+metadata('/path/to/image.jpg', {exif: true}, function(error, metadata) {
+  if (error) { console.error(error); }
+  console.log(metadata);
+  console.log(metadata.exif);
+});
+```
+
+## Contributing
+
+### Prerequisites
+
+```
+$ pip install pre-commit
+```
+
+### Installation
+
+```
+$ pre-commit install --install-hooks
+```
+
+## [MIT License](https://github.com/Turistforeningen/node-im-metadata/blob/master/LICENSE)

docker-compose.yml

@@ -1,6 +1,6 @@
-builder:
-  image: starefossen/iojs-imagemagick:1.6-6.9
+dev:
+  image: starefossen/iojs-imagemagick:2-6
   working_dir: /usr/src/app
   volumes:
     - ".:/usr/src/app"
-  command: "node polling.js"
+  command: "npm run watch"

index.js

@@ -1,27 +1,30 @@
+/*jshint laxbreak:true */
+
+var sizeParser = require('filesize-parser');
 var exec = require('child_process').exec, child;
 
-module.exports = function(src, opts, cb) {
+module.exports = function(path, opts, cb) {
   if (!cb) {
     cb = opts;
     opts = {};
   }
 
-  var cmd = module.exports.cmd(src, opts);
+  var cmd = module.exports.cmd(path, opts);
   opts.timeout = opts.timeout || 5000;
 
   exec(cmd, opts, function(e, stdout, stderr) {
     if (e) { return cb(e); }
     if (stderr) { return cb(new Error(stderr)); }
 
-    return cb(null, module.exports.parse(stdout));
+    return cb(null, module.exports.parse(path, stdout, opts));
   });
 };
 
-module.exports.cmd = function(src, opts) {
+module.exports.cmd = function(path, opts) {
   opts = opts || {};
   var format = [
-    'name=%[name]',
-    'size=%[size]',
+    'name=',
+    'size=%b',
     'format=%m',
     'colorspace=%[colorspace]',
     'height=%[height]',
@@ -30,29 +33,62 @@ module.exports.cmd = function(src, opts) {
     (opts.exif ? '%[exif:*]' : '')
   ].join("\n");
 
-  return 'identify -format "' + format + '" ' + src;
+  return 'convert -ping ' + path + ' -format "' + format + '" -precision 12 info:';
 };
 
-module.exports.parse = function(metadata) {
-  var lines = metadata.split('\n'), ret = {}, i;
+module.exports.parse = function(path, stdout, opts) {
+  var lines = stdout.split('\n');
+  var ret = {path: path};
+  var i;
 
   for (i = 0; i < lines.length; i++) {
     if (lines[i]) {
       lines[i] = lines[i].split('=');
-      ret[lines[i][0]] = lines[i][1];
+
+      // Parse exif metadata keys
+      if (lines[i][0].substr(0, 5) === 'exif:') {
+        if (!ret.exif) {
+          ret.exif = {};
+        }
+
+        ret.exif[lines[i][0].substr(5)] = lines[i][1];
+
+      // Parse normal metadata keys
+      } else {
+        ret[lines[i][0]] = lines[i][1];
+      }
     }
   }
 
   if (ret.width) { ret.width = parseInt(ret.width, 10); }
   if (ret.height) { ret.height = parseInt(ret.height, 10); }
 
-  if (ret.size && ret.size.substr(ret.size.length - 2) === "BB") {
-    ret.size = ret.size.substr(0, ret.size.length - 1);
+  if (ret.size) {
+    if (ret.size.substr(ret.size.length - 2) === 'BB') {
+      ret.size = ret.size.substr(0, ret.size.length - 1);
+    }
+
+    ret.size = parseInt(sizeParser(ret.size));
   }
 
   if (ret.colorspace && ret.colorspace === 'sRGB') {
     ret.colorspace = 'RGB';
   }
 
+  if (ret.orientation === 'Undefined') {
+    ret.orientation = '';
+  }
+
+  if (opts && opts.autoOrient
+      && ( ret.orientation === 'LeftTop'
+        || ret.orientation === 'RightTop'
+        || ret.orientation === 'LeftBottom'
+        || ret.orientation === 'RightBottom')) {
+
+    ret.width  = ret.width + ret.height;
+    ret.height = ret.width - ret.height;
+    ret.width  = ret.width - ret.height;
+  }
+
   return ret;
 };

package.json

@@ -1,10 +1,12 @@
 {
   "name": "im-metadata",
-  "version": "1.0.2",
+  "version": "3.0.1",
   "description": "Retrieve image metadata using ImageMagick's identify command",
   "main": "index.js",
   "scripts": {
-    "test": "mocha test.js"
+    "test": "mocha test.js",
+    "hint": "./node_modules/.bin/jshint index.js test.js",
+    "watch": "./node_modules/.bin/mocha -w test.js"
   },
   "repository": {
     "type": "git",
@@ -24,6 +26,14 @@
   },
   "homepage": "https://github.com/Turistforeningen/node-im-metadata",
   "devDependencies": {
-    "mocha": "^2.2.4"
+    "jshint": "~2",
+    "mocha": "~3.0.2"
+  },
+  "engines": {
+    "node": ">=0.10",
+    "iojs": ">=1.0.0"
+  },
+  "dependencies": {
+    "filesize-parser": "^1.3.0"
   }
 }

tartufo.toml

@@ -0,0 +1,6 @@
+[tool.tartufo]
+exclude-path-patterns = [
+  'package-lock.json',
+  'tartufo.toml'
+]
+exclude-signatures = []