Merge pull request #195 from sjaakieb/186-migrate-to-muhammara

Migrated van hummus to muhammara

lib/Recipe.js

@@ -1,4 +1,4 @@
-const hummus = require('hummus');
+const muhammara = require('muhammara');
 const path = require('path');
 const fs = require('fs');
 const streams = require('memory-streams');
@@ -42,8 +42,8 @@ class Recipe {
                 this.filename = path.basename(this.src);
             }
         }
-        this.hummus = hummus;
-        this.logFile = 'hummus-error.log';
+        this.muhammara = muhammara;
+        this.logFile = 'muhammara-error.log';
 
         this.textMarkupAnnotations = [
             'Highlight', 'Underline', 'StrikeOut', 'Squiggly'
@@ -69,7 +69,7 @@ class Recipe {
 
     _createWriter() {
         if (this.isNewPDF) {
-            this.writer = hummus.createWriter(this.output,
+            this.writer = muhammara.createWriter(this.output,
                 Object.assign( {}, this.encryptOptions, {
                     version: this._getVersion(this.options.version)
                 })
@@ -78,15 +78,15 @@ class Recipe {
             this.read();
             try {
                 if (this.isBufferSrc) {
-                    this.writer = hummus.createWriterToModify(
-                        new hummus.PDFRStreamForBuffer(this.src),
-                        new hummus.PDFStreamForResponse(this.outStream),
+                    this.writer = muhammara.createWriterToModify(
+                        new muhammara.PDFRStreamForBuffer(this.src),
+                        new muhammara.PDFStreamForResponse(this.outStream),
                         Object.assign( {}, this.encryptOptions, {
                             log: this.logFile
                         })
                     );
                 } else {
-                    this.writer = hummus.createWriterToModify(this.src,
+                    this.writer = muhammara.createWriterToModify(this.src,
                         Object.assign( {}, this.encryptOptions, {
                             modifiedFilePath: this.output,
                             log: this.logFile
@@ -108,7 +108,7 @@ class Recipe {
         if (!supportedVersions.includes(version)) {
             version = 1.7;
         }
-        version = hummus[`ePDFVersion${version * 10}`];
+        version = muhammara[`ePDFVersion${version * 10}`];
 
         return version;
     }
@@ -129,9 +129,9 @@ class Recipe {
         try {
             let src = (isForExternal) ? inSrc : this.src;
             if (this.isBufferSrc) {
-                src = new hummus.PDFRStreamForBuffer(this.src);
+                src = new muhammara.PDFRStreamForBuffer(this.src);
             }
-            const pdfReader = hummus.createReader(src, this.encryptOptions);
+            const pdfReader = muhammara.createReader(src, this.encryptOptions);
             const pages = pdfReader.getPagesCount();
             if (pages == 0) {
                 // broken or modify password protected
@@ -215,15 +215,15 @@ class Recipe {
                 const oldStream = this.outStream;
                 this.outStream = new streams.WritableStream();
 
-                this.writer = hummus.createWriterToModify(
-                    new hummus.PDFRStreamForBuffer(oldStream.toBuffer()),
-                    new hummus.PDFStreamForResponse(this.outStream),
+                this.writer = muhammara.createWriterToModify(
+                    new muhammara.PDFRStreamForBuffer(oldStream.toBuffer()),
+                    new muhammara.PDFStreamForResponse(this.outStream),
                     Object.assign( {}, this.encryptOptions, {
                         log: this.logFile
                     })
                 );
             } else {
-                this.writer = hummus.createWriterToModify(this.output,
+                this.writer = muhammara.createWriterToModify(this.output,
                     Object.assign( {}, this.encryptOptions, {
                         modifiedFilePath: this.output,
                         log: this.logFile

lib/appendPage.js

@@ -1,4 +1,4 @@
-const hummus = require('hummus');
+const muhammara = require('muhammara');
 const hummusUtils = require('./utils');
 
 /**
@@ -14,8 +14,8 @@ exports.appendPage = function appendPage(pdfSrc, pages = []) {
         pages = [pages];
     }
     // Using stream so it can be closed to release reader resource (Issue #61)
-    const instream  = new hummus.PDFRStreamForFile(pdfSrc);
-    const pdfReader = hummus.createReader(instream);
+    const instream  = new muhammara.PDFRStreamForFile(pdfSrc);
+    const pdfReader = muhammara.createReader(instream);
     const pageCount = pdfReader.getPagesCount();
     instream.close();
 

lib/colors.js

@@ -1,4 +1,4 @@
-const hummus = require('hummus');
+const muhammara = require('muhammara');
 const fs = require('fs');
 
 this.knownColors = {  // knownColors.colorspace.colorName = value
@@ -117,7 +117,7 @@ function createColorSpaces(self, colorName, color) {
             .writeName(colorName)
             .writeName(altCS)
             .writeIndirectObjectReference(transformFunction)
-            .endArray(hummus.eTokenSeparatorEndLine)
+            .endArray(muhammara.eTokenSeparatorEndLine)
             .endIndirectObject();
         self.resumeContext();
         this.colorSpaces[altCS][colorName] = colorSpaceID;

lib/encrypt.js

@@ -1,4 +1,4 @@
-const hummus = require('hummus');
+const muhammara = require('muhammara');
 const fs = require('fs');
 
 
@@ -101,6 +101,6 @@ exports._encrypt = function _encrypt() {
 
     const tmp = this.output + '.tmp.pdf';
     fs.renameSync(this.output, tmp);
-    hummus.recrypt(tmp, this.output, this.encryption_);
+    muhammara.recrypt(tmp, this.output, this.encryption_);
     fs.unlinkSync(tmp);
 };

lib/info.js

@@ -1,5 +1,5 @@
 const fs = require('fs');
-const hummus = require('hummus');
+const muhammara = require('muhammara');
 /**
  * @name info
  * @desc Add new PDF information, or retrieve existing PDF information.
@@ -29,7 +29,7 @@ exports.info = function info(options) {
 
 exports._readInfo = function _readInfo() {
     if (!this.isNewPDF && !this.infoDictionary) {
-        const copyFrom = this.isBufferSrc ? new hummus.PDFRStreamForBuffer(this.src) : this.src;
+        const copyFrom = this.isBufferSrc ? new muhammara.PDFRStreamForBuffer(this.src) : this.src;
         const copyCtx  = this.writer.createPDFCopyingContext(copyFrom);
         const infoDict = copyCtx.getSourceDocumentParser().queryDictionaryObject(
             copyCtx.getSourceDocumentParser().getTrailer(), 'Info'
@@ -144,7 +144,7 @@ exports._writeInfo = function _writeInfo() {
         infoDictionary.setCreationDate(new Date());
     }
     infoDictionary.setModDate(new Date());
-    infoDictionary.producer = 'PDFHummus (https://github.com/galkahana/HummusJS)';
+    infoDictionary.producer = 'MuhammaraJS (https://github.com/julianhille/MuhammaraJS)';
     infoDictionary.creator = 'Hummus-Recipe (https://github.com/chunyenHuang/hummusRecipe)';
 
     fields.forEach((item) => {
@@ -192,7 +192,7 @@ exports.structure = function structure(output) {
     // PDF file format http://lotabout.me/orgwiki/pdf.html
     // const outputFileType = path.extname(output);
     const outputFile = fs.openSync(output, 'w');
-    const hummus = this.hummus;
+    const muhammara = this.muhammara;
     const pdfReader = this.pdfReader;
 
     const tabWidth = '  ';
@@ -224,12 +224,12 @@ exports.structure = function structure(output) {
 
         const iterateObjectTypes = (inObject) => {
             const type = inObject.getType();
-            const label = hummus.getTypeLabel(type);
+            const label = muhammara.getTypeLabel(type);
             let output = '';
             let objectID, jsArray, aDictionary, keys;
 
             switch (type) {
-                case hummus.ePDFObjectIndirectObjectReference:
+                case muhammara.ePDFObjectIndirectObjectReference:
                     ++mTabLevel;
                     objectID = inObject.toPDFIndirectObjectReference().getObjectID();
                     output += `Indirect object reference (${objectID}): `;
@@ -243,7 +243,7 @@ exports.structure = function structure(output) {
                     }
                     --mTabLevel;
                     return;
-                case hummus.ePDFObjectArray:
+                case muhammara.ePDFObjectArray:
                     jsArray = inObject.toPDFArray().toJSArray();
                     output += `- ${label} [${jsArray.length}]`;
                     logToFile(output);
@@ -253,7 +253,7 @@ exports.structure = function structure(output) {
                     });
                     --mTabLevel;
                     break;
-                case hummus.ePDFObjectDictionary:
+                case muhammara.ePDFObjectDictionary:
                     aDictionary = inObject.toPDFDictionary().toJSObject();
                     keys = Object.getOwnPropertyNames(aDictionary).join(', ');
                     output += `- ${label} {${keys}}`;
@@ -265,7 +265,7 @@ exports.structure = function structure(output) {
                     });
                     --mTabLevel;
                     break;
-                case hummus.ePDFObjectStream:
+                case muhammara.ePDFObjectStream:
                     output += 'Stream . iterating stream dictionary:';
                     logToFile(output);
                     iterateObjectTypes(inObject.toPDFStream().getDictionary());
@@ -293,29 +293,29 @@ exports._parseObjectByType = function _parseObjectByType(inObject) {
     if (!inObject) {
         return;
     }
-    const hummus = this.hummus;
+    const muhammara = this.muhammara;
     const pdfReader = this.pdfReader;
     const type = inObject.getType();
-    const label = hummus.getTypeLabel(type);
+    const label = muhammara.getTypeLabel(type);
     const saveToObject = this.pdfStructure || {};
     let objectID, parsed, dictionaryObject, dictionary;
     switch (type) {
-        case hummus.ePDFObjectIndirectObjectReference:
+        case muhammara.ePDFObjectIndirectObjectReference:
             objectID = inObject.toPDFIndirectObjectReference().getObjectID();
             parsed = pdfReader.parseNewObject(objectID);
             return this._parseObjectByType(parsed);
-        case hummus.ePDFObjectArray:
+        case muhammara.ePDFObjectArray:
             inObject.toPDFArray().toJSArray().forEach((element) => {
                 this._parseObjectByType(element);
             });
             break;
-        case hummus.ePDFObjectDictionary:
+        case muhammara.ePDFObjectDictionary:
             dictionaryObject = inObject.toPDFDictionary().toJSObject();
             Object.getOwnPropertyNames(dictionaryObject).forEach((element) => {
                 this._parseObjectByType(dictionaryObject[element]);
             });
             break;
-        case hummus.ePDFObjectStream:
+        case muhammara.ePDFObjectStream:
             dictionary = inObject.toPDFStream().getDictionary();
             return this._parseObjectByType(dictionary);
         default:

lib/insertPage.js

@@ -1,4 +1,4 @@
-const hummus = require('hummus');
+const muhammara = require('muhammara');
 const fs = require('fs');
 const hummusUtils = require('./utils');
 /**
@@ -40,7 +40,7 @@ exports._insertPages = function _insertPages() {
     unlinkList.push(tmp);
     fs.renameSync(this.output, tmp);
 
-    const pdfWriter = hummus.createWriter(this.output);
+    const pdfWriter = muhammara.createWriter(this.output);
     let lastInsertedOriginal = 0;
     pagesForInsert.forEach((pageNumber) => {
         const toAppendPage = pageNumber - 1;

lib/page.js

@@ -1,4 +1,4 @@
-const hummus = require('hummus');
+const muhammara = require('muhammara');
 
 /**
  * Create a new page, specifying either actual width and height, or the name
@@ -106,7 +106,7 @@ exports.endPage = function endPage() {
 exports.editPage = function editPage(pageNumber) {
     const pdfWriter = this.writer;
     const pageIndex = pageNumber - 1;
-    const pageModifier = new hummus.PDFPageModifier(pdfWriter, pageIndex, true);
+    const pageModifier = new muhammara.PDFPageModifier(pdfWriter, pageIndex, true);
     this.page = pageModifier;
     this.pageNumber = pageNumber;
     this.pageContext = pageModifier.startContext().getContext();

lib/split.js

@@ -1,4 +1,4 @@
-const hummus = require('hummus');
+const muhammara = require('muhammara');
 const path = require('path');
 const hummusUtils = require('./utils');
 
@@ -14,7 +14,7 @@ exports.split = function split(outputDir = '', prefix) {
     prefix = prefix || this.filename;
     for (let i = 0; i < this.metadata.pages; i++) {
         const newPdf = path.join(outputDir, `${prefix}-${i+1}.pdf`);
-        const pdfWriter = hummus.createWriter(newPdf);
+        const pdfWriter = muhammara.createWriter(newPdf);
         hummusUtils.appendPDFPageFromPDFWithAnnotations(pdfWriter, this.pdfReader, i);
         pdfWriter.end();
     }