pdf-image - npm Package Compare versions

Comparing version 0.0.1 to 1.0.1

index.js

@@ -8,6 +8,12 @@ // node-pdf
 var util = require("util");
+var exec = require("child_process").exec;
 
-function PDFImage(pdfFilePath) {
+function PDFImage(pdfFilePath, options) {
+  if (!options) options = {};
+
   this.pdfFilePath = pdfFilePath;
   this.pdfFileBaseName = path.basename(pdfFilePath, ".pdf");
+
+  this.setConvertOptions(options.convertOptions || {});
+
   // TODO: make out dir customizable
@@ -18,2 +24,40 @@ this.outputDirectory = path.dirname(pdfFilePath);
 PDFImage.prototype = {
+  constructGetInfoCommand: function () {
+    return util.format(
+      "pdfinfo '%s'",
+      this.pdfFilePath
+    );
+  },
+  parseGetInfoCommandOutput: function (output) {
+    var info = {};
+    output.split("\n").forEach(function (line) {
+      if (line.match(/^(.*?):[ \t]*(.*)$/)) {
+        info[RegExp.$1] = RegExp.$2;
+      }
+    });
+    return info;
+  },
+  getInfo: function () {
+    var self = this;
+    var getInfoCommand = this.constructGetInfoCommand();
+    var promise = new Promise(function (resolve, reject) {
+      exec(getInfoCommand, function (err, stdout, stderr) {
+        if (err) {
+          return reject({
+            message: "Failed to get PDF'S information",
+            error: err,
+            stdout: stdout,
+            stderr: stderr
+          });
+        }
+        return resolve(self.parseGetInfoCommandOutput(stdout));
+      });
+    });
+    return promise;
+  },
+  numberOfPages: function () {
+    return this.getInfo().then(function (info) {
+      return info["Pages"];
+    });
+  },
   getOutputImagePathForPage: function (pageNumber) {
@@ -25,20 +69,40 @@ return path.join(
   },
-  getConvertCommandForPage: function (pageNumber) {
+  setConvertOptions: function (convertOptions) {
+    this.convertOptions = convertOptions || {};
+  },
+  constructConvertCommandForPage: function (pageNumber) {
     var pdfFilePath = this.pdfFilePath;
     var outputImagePath = this.getOutputImagePathForPage(pageNumber);
+    var convertOptionString = this.constructConvertOptions();
     return util.format(
-      "convert '%s[%d]' %s",
+      "convert %s'%s[%d]' %s",
+      convertOptionString ? convertOptionString + " " : "",
       pdfFilePath, pageNumber, outputImagePath
     );
   },
+  constructConvertOptions: function () {
+    return Object.keys(this.convertOptions).sort().map(function (optionName) {
+      if (this.convertOptions[optionName] !== null) {
+        return optionName + " " + this.convertOptions[optionName];
+      } else {
+        return optionName;
+      }
+    }, this).join(" ");
+  },
   convertPage: function (pageNumber) {
     var pdfFilePath     = this.pdfFilePath;
     var outputImagePath = this.getOutputImagePathForPage(pageNumber);
-    var convertCommand  = this.getConvertCommandForPage(pageNumber);
+    var convertCommand  = this.constructConvertCommandForPage(pageNumber);
 
     var promise = new Promise(function (resolve, reject) {
       function convertPageToImage() {
-        var exec = require("child_process").exec;
         exec(convertCommand, function (err, stdout, stderr) {
-          if (err) { return reject(err); }
+          if (err) {
+            return reject({
+              message: "Failed to convert page to image",
+              error: err,
+              stdout: stdout,
+              stderr: stderr
+            });
+          }
           return resolve(outputImagePath);
@@ -50,3 +114,8 @@ });
         var imageNotExists = err && err.code === "ENOENT";
-        if (!imageNotExists && err) { return reject(err); }
+        if (!imageNotExists && err) {
+          return reject({
+            message: "Failed to stat image file",
+            error: err
+          });
+        }
 
@@ -64,3 +133,8 @@ // convert when (1) image doesn't exits or (2) image exists
         fs.stat(pdfFilePath, function (err, pdfFileStat) {
-          if (err) { return reject(err); }
+          if (err) {
+            return reject({
+              message: "Failed to stat PDF file",
+              error: err
+            });
+          }
 
@@ -67,0 +141,0 @@ if (imageFileStat.mtime < pdfFileStat.mtime) {

package.json

 {
   "name": "pdf-image",
-  "version": "0.0.1",
+  "version": "1.0.1",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mooz/node-pdf-image.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mooz/node-pdf-image/issues"
+  },
+  "homepage": "https://github.com/mooz/node-pdf-image#readme",
   "dependencies": {
-    "es6-promise": "~2.0.0"
+    "es6-promise": "~2.0.0",
+    "chai": "~1.9.2"
   }
 }

README.md

@@ -10,7 +10,7 @@ # pdf-image
 
-Ensure you have `convert` and `gs` commands.
+Ensure you have `convert`, `gs`, and `pdfinfo` (part of poppler) commands.
 
 ### Ubuntu
 
-    sudo apt-get install imagemagick ghostscript
+    sudo apt-get install imagemagick ghostscript poppler-utils
 
@@ -17,0 +17,0 @@ ## Usage

tests/test-main.js

@@ -12,3 +12,3 @@ var assert = require("assert");
 
-  it("should has correct basename", function () {
+  it("should have correct basename", function () {
     expect(pdfImage.pdfFileBaseName).equal("test");
@@ -27,3 +27,3 @@ });
   it("should return correct convert command", function () {
-    expect(pdfImage.getConvertCommandForPage(1))
+    expect(pdfImage.constructConvertCommandForPage(1))
       .equal("convert '/tmp/test.pdf[1]' /tmp/test-1.png");
@@ -43,2 +43,17 @@ });
   });
+
+  it("should return # of pages", function () {
+    pdfImage.numberOfPages().then(function (numberOfPages) {
+      expect(numberOfPages).to.be.equal(21);
+    });
+  });
+
+  it("should construct convert options correctly", function () {
+    pdfImage.setConvertOptions({
+      "-density": 300,
+      "-trim": null
+    });
+    expect(pdfImage.constructConvertOptions()).equal("-density 300 -trim");
+    pdfImage.setConvertOptions(null);
+  });
 });

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7587

increased by59.12%

Lines of code

182

increased by85.71%

Number of low maintenance alerts

2

decreased by-33.33%

Number of low quality alerts

0

decreased by-100%

Number of low supply chain risk alerts

2

decreased by-33.33%

Worsened metrics

Dependency count

2

increased by100%

Dependency changes

• + Addedchai@~1.9.2

• + Addedassertion-error@1.0.0(transitive)

• + Addedchai@1.9.2(transitive)

• + Addeddeep-eql@0.1.3(transitive)

• + Addedtype-detect@0.1.1(transitive)