Merge branch 'class'
This commit is contained in:
commit
24287f7f94
248
index.js
248
index.js
@ -14,139 +14,141 @@ const gerberFiles = [
|
||||
'CAMOutputs/GerberFiles/profile.gbr',
|
||||
];
|
||||
|
||||
/**
|
||||
* Configures the folders used
|
||||
* @param {Object} folderConfig Object with properties tmpDir and imgDir containing paths to temporary and image output folders
|
||||
*/
|
||||
function config(folderConfig) {
|
||||
// Create tmpDir if it does not exist
|
||||
fs.ensureDirSync(folderConfig.tmpDir);
|
||||
// Create imgDir if it does not exist
|
||||
fs.ensureDirSync(folderConfig.imgDir);
|
||||
}
|
||||
class ImageGenerator {
|
||||
constructor(folderConfig, imgConfig) {
|
||||
// this.folderConfig = folderConfig;
|
||||
this.tmpDir = folderConfig.tmpDir;
|
||||
this.imgDir = folderConfig.imgDir;
|
||||
this.imgConfig = imgConfig;
|
||||
|
||||
/**
|
||||
* Extracts the passed in zip file
|
||||
* @param {string} fileName Name of the file to be extracted
|
||||
* @param {string} tmpDir Temporary directory to extract to
|
||||
* @returns {Promise} Promise object represents number of files extracted
|
||||
*/
|
||||
function extractArchive(fileName, tmpDir) {
|
||||
// Check archive exists
|
||||
try {
|
||||
if (!fs.existsSync(fileName)) {
|
||||
throw Error('Archive does not exist.');
|
||||
// Ensure that the folders exist
|
||||
try {
|
||||
fs.ensureDirSync(this.tmpDir);
|
||||
fs.ensureDirSync(this.imgDir);
|
||||
} catch (error) {
|
||||
throw new Error(error);
|
||||
}
|
||||
if (!fs.existsSync(tmpDir)) {
|
||||
throw Error('Temporary folder does not exist.');
|
||||
}
|
||||
} catch (e) {
|
||||
throw new Error(e);
|
||||
}
|
||||
|
||||
const zip = new AdmZip(fileName);
|
||||
zip.extractAllTo(path.join(tmpDir, 'archive'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Take in a directory of layer files and return an array of the layers files
|
||||
* @param {string} dir Directory containing layer files
|
||||
* @returns {Array} Array of paths to the layers files
|
||||
*/
|
||||
function getLayers(dir) {
|
||||
return new Promise((resolve, reject) => {
|
||||
// Make sure the directory exists
|
||||
if (!fs.existsSync(dir)) {
|
||||
return reject(new Error('Layers folder does not exist.'));
|
||||
/**
|
||||
* Extracts the passed in zip file
|
||||
* @param {string} fileName Name of the file to be extracted
|
||||
* @param {string} tmpDir Temporary directory to extract to
|
||||
* @returns {Promise} Promise object represents number of files extracted
|
||||
*/
|
||||
static extractArchive(fileName, tmpDir) {
|
||||
// Check archive exists
|
||||
try {
|
||||
if (!fs.existsSync(fileName)) {
|
||||
throw Error('Archive does not exist.');
|
||||
}
|
||||
if (!fs.existsSync(tmpDir)) {
|
||||
throw Error('Temporary folder does not exist.');
|
||||
}
|
||||
} catch (e) {
|
||||
throw new Error(e);
|
||||
}
|
||||
// Check that the required layer files exist in source dir
|
||||
let layersValid = true;
|
||||
gerberFiles.forEach((layer) => {
|
||||
if (!fs.existsSync(path.join(dir, layer))) layersValid = false;
|
||||
});
|
||||
if (!layersValid) return reject(new Error('Layer not found.'));
|
||||
// Construct array of layers that match the supplied filenames array
|
||||
const layers = gerberFiles.map((layerName) => ({
|
||||
filename: layerName,
|
||||
gerber: fs.createReadStream(path.join(dir, layerName)),
|
||||
}));
|
||||
return resolve(layers);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Clean up the archive folder in the specified directory
|
||||
* @param {string} dir Path to a directory to clean up
|
||||
*/
|
||||
function cleanupFiles(dir) {
|
||||
try {
|
||||
const folder = path.join(dir, 'archive');
|
||||
fs.emptyDirSync(folder);
|
||||
} catch (err) {
|
||||
throw new Error(err);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Take an archive containing gerber files, config object, temporary dir
|
||||
* and output dir and create a PNG image from the gerber in the output dir
|
||||
* @param {string} gerber Path to an archive file containing gerber
|
||||
* @param {Object} config Object containing sharp settings for resizeWidth, compLevel and density
|
||||
* @param {string} tmpDir Temporary directory to extract the archive to
|
||||
* @param {string} outputDir Directory to save the image to
|
||||
*/
|
||||
function gerberToImage(gerber, imgConfig, tmpDir, outputDir) {
|
||||
// Create output dir if it doesn't exist
|
||||
try {
|
||||
fs.ensureDirSync(outputDir, 0o644);
|
||||
} catch (e) {
|
||||
throw new Error(e);
|
||||
const zip = new AdmZip(fileName);
|
||||
zip.extractAllTo(path.join(tmpDir, 'archive'));
|
||||
}
|
||||
|
||||
// Check temp and output dirs exist
|
||||
try {
|
||||
if (!fs.existsSync(gerber)) {
|
||||
throw Error('Archive does not exist.');
|
||||
}
|
||||
if (!fs.existsSync(tmpDir)) {
|
||||
throw Error('Temporary folder does not exist.');
|
||||
}
|
||||
if (!fs.existsSync(outputDir)) {
|
||||
throw Error('Output folder does not exist.');
|
||||
}
|
||||
} catch (e) {
|
||||
throw new Error(e);
|
||||
}
|
||||
|
||||
// Set filenames
|
||||
const imageName = path.basename(gerber, '.zip');
|
||||
const destFile = `${path.join(outputDir, imageName)}.png`;
|
||||
|
||||
return new Promise((resolve, reject) => {
|
||||
extractArchive(gerber, tmpDir);
|
||||
getLayers(path.join(tmpDir, 'archive'))
|
||||
.then(pcbStackup)
|
||||
.then((stackup) => {
|
||||
sharp(Buffer.from(stackup.top.svg), { density: imgConfig.density })
|
||||
.resize({ width: imgConfig.resizeWidth })
|
||||
.png({ compressionLevel: imgConfig.compLevel })
|
||||
.toFile(destFile);
|
||||
})
|
||||
.then(() => {
|
||||
cleanupFiles(tmpDir);
|
||||
resolve(destFile);
|
||||
})
|
||||
.catch((e) => {
|
||||
cleanupFiles(tmpDir);
|
||||
reject(new Error(e));
|
||||
/**
|
||||
* Take in a directory of layer files and return an array of the layers files
|
||||
* @param {string} dir Directory containing layer files
|
||||
* @returns {Array} Array of paths to the layers files
|
||||
*/
|
||||
static getLayers(dir) {
|
||||
return new Promise((resolve, reject) => {
|
||||
// Make sure the directory exists
|
||||
if (!fs.existsSync(dir)) {
|
||||
return reject(new Error('Layers folder does not exist.'));
|
||||
}
|
||||
// Check that the required layer files exist in source dir
|
||||
let layersValid = true;
|
||||
gerberFiles.forEach((layer) => {
|
||||
if (!fs.existsSync(path.join(dir, layer))) layersValid = false;
|
||||
});
|
||||
});
|
||||
if (!layersValid) return reject(new Error('Layer not found.'));
|
||||
// Construct array of layers that match the supplied filenames array
|
||||
const layers = gerberFiles.map((layerName) => ({
|
||||
filename: layerName,
|
||||
gerber: fs.createReadStream(path.join(dir, layerName)),
|
||||
}));
|
||||
return resolve(layers);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Clean up the archive folder in the specified directory
|
||||
* @param {string} dir Path to a directory to clean up
|
||||
*/
|
||||
static cleanupFiles(dir) {
|
||||
try {
|
||||
const folder = path.join(dir, 'archive');
|
||||
fs.emptyDirSync(folder);
|
||||
} catch (err) {
|
||||
throw new Error(err);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Take an archive containing gerber files, config object, temporary dir
|
||||
* and output dir and create a PNG image from the gerber in the output dir
|
||||
* @param {string} gerber Path to an archive file containing gerber
|
||||
* @returns {Promise.<string>} Promise to return path to image
|
||||
*/
|
||||
gerberToImage(gerber) {
|
||||
// Create output dir if it doesn't exist
|
||||
try {
|
||||
fs.ensureDirSync(this.imgDir, 0o644);
|
||||
} catch (e) {
|
||||
throw new Error(e);
|
||||
}
|
||||
|
||||
// Check temp and output dirs exist
|
||||
try {
|
||||
if (!fs.existsSync(gerber)) {
|
||||
throw Error('Archive does not exist.');
|
||||
}
|
||||
if (!fs.existsSync(this.tmpDir)) {
|
||||
throw Error('Temporary folder does not exist.');
|
||||
}
|
||||
if (!fs.existsSync(this.imgDir)) {
|
||||
throw Error('Output folder does not exist.');
|
||||
}
|
||||
} catch (e) {
|
||||
throw new Error(e);
|
||||
}
|
||||
|
||||
// Set filenames
|
||||
const imageName = path.basename(gerber, '.zip');
|
||||
const destFile = `${path.join(this.imgDir, imageName)}.png`;
|
||||
|
||||
return new Promise((resolve, reject) => {
|
||||
ImageGenerator.extractArchive(gerber, this.tmpDir);
|
||||
ImageGenerator.getLayers(path.join(this.tmpDir, 'archive'))
|
||||
.then(pcbStackup)
|
||||
.then((stackup) => {
|
||||
sharp(Buffer.from(stackup.top.svg), {
|
||||
density: this.imgConfig.density,
|
||||
})
|
||||
.resize({ width: this.imgConfig.resizeWidth })
|
||||
.png({ compressionLevel: this.imgConfig.compLevel })
|
||||
.toFile(destFile);
|
||||
})
|
||||
.then(() => {
|
||||
ImageGenerator.cleanupFiles(this.tmpDir);
|
||||
resolve(destFile);
|
||||
})
|
||||
.catch((e) => {
|
||||
ImageGenerator.cleanupFiles(this.tmpDir);
|
||||
reject(new Error(e));
|
||||
});
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
cleanupFiles,
|
||||
getLayers,
|
||||
extractArchive,
|
||||
config,
|
||||
gerberToImage,
|
||||
ImageGenerator,
|
||||
};
|
||||
|
||||
@ -1,24 +1,45 @@
|
||||
/* eslint-disable */
|
||||
const path = require('path');
|
||||
const fs = require('fs-extra');
|
||||
const fileProc = require('../index.js');
|
||||
const { ImageGenerator } = require('../index.js');
|
||||
require('../index.js');
|
||||
|
||||
const testGerber = path.join(__dirname, 'Arduino-Pro-Mini.zip');
|
||||
const testLayers = path.join(__dirname, 'layers');
|
||||
const emptyFolder = path.join(__dirname, 'layers', 'Empty');
|
||||
const tmpDir = path.join(__dirname, 'tmp');
|
||||
const imgDir = path.join(__dirname, 'tmp');
|
||||
const nonWritableDir = fs.ensureDirSync(path.join(tmpDir, 'no-write'), 0o400);
|
||||
|
||||
// const tmpDir = path.join(__dirname, 'tmp');
|
||||
// const imgDir = path.join(__dirname, 'tmp');
|
||||
const folderConfig = {
|
||||
tmpDir: path.join(__dirname, 'tmp'),
|
||||
imgDir: path.join(__dirname, 'tmp'),
|
||||
};
|
||||
const noTempConfig = {
|
||||
tmpDir: emptyFolder,
|
||||
imgDir: path.join(__dirname, 'tmp'),
|
||||
};
|
||||
const noImageConfig = {
|
||||
tmpDir: path.join(__dirname, 'tmp'),
|
||||
imgDir: emptyFolder,
|
||||
};
|
||||
const nonWritableDir = fs.ensureDirSync(path.join(folderConfig.tmpDir, 'no-write'), 0o400);
|
||||
const imgConfig = {
|
||||
resizeWidth: 600,
|
||||
density: 1000,
|
||||
compLevel: 1,
|
||||
};
|
||||
|
||||
const fileProc = new ImageGenerator(folderConfig, imgConfig);
|
||||
const fileProcNoTemp = new ImageGenerator(noTempConfig, imgConfig);
|
||||
const fileProcNoImage = new ImageGenerator(noImageConfig, imgConfig);
|
||||
|
||||
/**************
|
||||
* Tests
|
||||
***************/
|
||||
|
||||
// getLayers
|
||||
test('Promise of an array of layers from a given folder', () => {
|
||||
return fileProc.getLayers(testLayers).then((data) => {
|
||||
expect.assertions(1);
|
||||
return ImageGenerator.getLayers(testLayers).then((data) => {
|
||||
expect(data).toEqual(
|
||||
expect.arrayContaining([
|
||||
expect.objectContaining({
|
||||
@ -31,59 +52,64 @@ test('Promise of an array of layers from a given folder', () => {
|
||||
});
|
||||
|
||||
test('Non-existent folder should reject promise with error', () => {
|
||||
return expect(fileProc.getLayers('./invalid_folder')).rejects.toThrow(
|
||||
'Layers folder does not exist.'
|
||||
expect.assertions(1);
|
||||
return expect(ImageGenerator.getLayers('./invalid_folder')).rejects.toThrow(
|
||||
new Error('Layers folder does not exist.')
|
||||
);
|
||||
});
|
||||
|
||||
test('Folder with incorrect number of layers should reject promise with error', () => {
|
||||
return expect(fileProc.getLayers(emptyFolder)).rejects.toThrow(
|
||||
'Layer not found.'
|
||||
expect.assertions(1);
|
||||
return expect(ImageGenerator.getLayers(emptyFolder)).rejects.toThrow(
|
||||
new Error('Layer not found.')
|
||||
);
|
||||
});
|
||||
|
||||
// extractArchive
|
||||
test('Non-existent archive should throw an error', () => {
|
||||
expect(() => fileProc.extractArchive('invalid.zip', tmpDir).toThrow(Error));
|
||||
expect(() =>
|
||||
ImageGenerator.extractArchive('invalid.zip', folderConfig.tmpDir).toThrow(Error)
|
||||
);
|
||||
});
|
||||
|
||||
test('Temp dir not existing should throw an error', () => {
|
||||
expect(() =>
|
||||
fileProc.extractArchive(testGerber, './invalid_dir').toThrow(Error)
|
||||
ImageGenerator.extractArchive(testGerber, './invalid_dir').toThrow(Error)
|
||||
);
|
||||
});
|
||||
|
||||
test('Should extract archive and resolve with the number of files extracted', () => {
|
||||
expect(() => fileProc.extractArchive(testGerber, tmpDir).toBe(12));
|
||||
expect(() => ImageGenerator.extractArchive(testGerber, folderConfig.tmpDir).toBe(12));
|
||||
});
|
||||
|
||||
// gerberToImage
|
||||
test('Temp dir not existing should throw an error', () => {
|
||||
expect(() =>
|
||||
fileProc
|
||||
.gerberToImage(testGerber, imgConfig, './invalid_dir', imgDir)
|
||||
.toThrow('Temporary folder does not exist.')
|
||||
fileProcNoTemp
|
||||
.gerberToImage(testGerber)
|
||||
.toThrow(new Error('Temporary folder does not exist.'))
|
||||
);
|
||||
});
|
||||
|
||||
test('Output dir not existing should throw an error', () => {
|
||||
expect(() =>
|
||||
fileProc
|
||||
.gerberToImage(testGerber, imgConfig, tmpDir, './invalid_dir')
|
||||
.toThrow('Output folder does not exist.')
|
||||
fileProcNoImage
|
||||
.gerberToImage(testGerber)
|
||||
.toThrow(new Error('Output folder does not exist.'))
|
||||
);
|
||||
});
|
||||
|
||||
test('Invalid archive file should throw an error', () => {
|
||||
expect(() =>
|
||||
fileProc
|
||||
.gerberToImage('invalid.zip', imgConfig, tmpDir, imgDir)
|
||||
.toThrow('Archive does not exist.')
|
||||
.gerberToImage('invalid.zip')
|
||||
.toThrow(new Error('Archive does not exist.'))
|
||||
);
|
||||
});
|
||||
|
||||
test('Gerber archive should resolve promise and return a filename of an image', () => {
|
||||
expect.assertions(1);
|
||||
return expect(
|
||||
fileProc.gerberToImage(testGerber, imgConfig, tmpDir, imgDir)
|
||||
fileProc.gerberToImage(testGerber)
|
||||
).resolves.toEqual(expect.stringContaining('Arduino-Pro-Mini.png'));
|
||||
});
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user