Add compaction

* If you don't provide the --compact command, nothing will happen
* If you don't provide a compact config for your bundle, nothing will happen
* If you set compact to "images", the default image compact functions
will be used.
* Otherwise, it will use whatever is provided

compact needs to be an object that maps file extensions to functions.
These functions take a buffer and return either a buffer or a Promise
yielding a buffer. All packages from the imagemin project follow this
signature.

Also adjusted the .travis.yml to download the example images and install
the required APTs to compile the C dependencies. Also adjusted the
editorconfig, because YAML files apparently are only allowed to contain
spaces, not tabs.

Author: moonglum

.editorconfig

@@ -14,6 +14,10 @@ indent_size = 4
 [*.md]
 indent_style = space
 
+[*.yml]
+indent_style = space
+indent_size = 2
+
 [COMMIT_EDITMSG]
 trim_trailing_whitespace = false
 max_line_length = 72

.gitignore

@@ -5,3 +5,10 @@
 /samples/output/
 
 /package-lock.json
+
+# Ignore the images
+*.jpg
+*.png
+*.webp
+*.gif
+*.svg

.travis.yml

@@ -4,5 +4,18 @@ node_js:
 - 8
 - 10
 
+addons:
+  apt:
+    packages:
+    - autoconf
+    - automake
+    - libtool
+    - nasm
+    - make
+    - pkg-config
+
 script:
 - npm test
+
+before_install:
+- npm run test:prepare

index.js

@@ -5,14 +5,14 @@ let FileFinder = require("faucet-pipeline-core/lib/util/files/finder");
 let readFile = promisify(require("fs").readFile);
 let stat = promisify(require("fs").stat);
 
-module.exports = (pluginConfig, assetManager) => {
+module.exports = (pluginConfig, assetManager, { compact }) => {
 	let copiers = pluginConfig.map(copyConfig =>
-		buildCopier(copyConfig, assetManager));
+		buildCopier(copyConfig, assetManager, { compact }));
 
 	return files => Promise.all(copiers.map(copier => copier(files)));
 };
 
-function buildCopier(copyConfig, assetManager) {
+function buildCopier(copyConfig, assetManager, { compact }) {
 	let source = assetManager.resolvePath(copyConfig.source);
 	let target = assetManager.resolvePath(copyConfig.target, {
 		enforceRelative: true
@@ -22,19 +22,36 @@ function buildCopier(copyConfig, assetManager) {
 		filter: copyConfig.filter
 	});
 	let { fingerprint } = copyConfig;
+	let plugins = determinePlugins(compact, copyConfig);
 
 	return files => {
 		return Promise.all([
 			(files ? fileFinder.match(files) : fileFinder.all()),
 			determineTargetDir(source, target)
 		]).then(([fileNames, targetDir]) => {
 			return processFiles(fileNames, {
-				assetManager, source, target, targetDir, fingerprint
+				assetManager, source, target, targetDir, plugins, fingerprint
 			});
 		});
 	};
 }
 
+function determinePlugins(compact, copyConfig) {
+	if(!compact) {
+		return {};
+	}
+
+	if(copyConfig.compact === "images") {
+		return {
+			jpg: require("imagemin-mozjpeg")({ quality: 80 }),
+			png: require("imagemin-pngquant")(),
+			svg: require("imagemin-svgo")()
+		};
+	}
+
+	return copyConfig.compact || {};
+}
+
 // If `source` is a directory, `target` is used as target directory -
 // otherwise, `target`'s parent directory is used
 function determineTargetDir(source, target) {
@@ -47,11 +64,16 @@ function processFiles(fileNames, config) {
 }
 
 function processFile(fileName,
-		{ source, target, targetDir, fingerprint, assetManager }) {
+		{ source, target, targetDir, fingerprint, assetManager, plugins }) {
 	let sourcePath = path.join(source, fileName);
 	let targetPath = path.join(target, fileName);
 
 	return readFile(sourcePath).
+		then(content => {
+			let type = determineFileType(sourcePath);
+			let plugin = type && plugins[type];
+			return plugin ? plugin(content) : content;
+		}).
 		then(content => {
 			let options = { targetDir };
 			if(fingerprint !== undefined) {
@@ -60,3 +82,7 @@ function processFile(fileName,
 			return assetManager.writeFile(targetPath, content, options);
 		});
 }
+
+function determineFileType(sourcePath) {
+	return path.extname(sourcePath).substr(1).toLowerCase();
+}

package.json

@@ -6,6 +6,7 @@
 	"scripts": {
 		"test": "npm-run-all --parallel lint test:cli",
 		"test:cli": "./test/run",
+		"test:prepare": "./test/prepare",
 		"lint": "eslint --cache index.js test && echo ✓"
 	},
 	"repository": {
@@ -23,6 +24,9 @@
 	},
 	"devDependencies": {
 		"eslint-config-fnd": "^1.6.0",
+		"imagemin-mozjpeg": "^7.0.0",
+		"imagemin-pngquant": "^6.0.0",
+		"imagemin-svgo": "^7.0.0",
 		"json-diff": "^0.5.2",
 		"npm-run-all": "^4.1.3",
 		"release-util-fnd": "^1.1.1"

test/prepare

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+set -xeuo pipefail
+
+curl -o "test/test_compact_images/src/example.jpg" "https://images.unsplash.com/photo-1498496294664-d9372eb521f3?fm=jpg&q=85"
+curl -o "test/test_compact_images/src/example.png" "https://upload.wikimedia.org/wikipedia/commons/thumb/4/47/PNG_transparency_demonstration_1.png/560px-PNG_transparency_demonstration_1.png"
+curl -o "test/test_compact_images/src/example.gif" "https://upload.wikimedia.org/wikipedia/commons/2/2c/Rotating_earth_%28large%29.gif"
+curl -o "test/test_compact_images/src/example.svg" "https://upload.wikimedia.org/wikipedia/commons/0/02/SVG_logo.svg"
+curl -o "test/test_compact_images/src/example.webp" "https://www.gstatic.com/webp/gallery3/2_webp_a.webp"
+
+cp test/test_compact_images/src/example.jpg test/test_compact_undefined/src/example.jpg
+cp test/test_compact_images/src/example.png test/test_compact_undefined/src/example.png
+cp test/test_compact_images/src/example.gif test/test_compact_undefined/src/example.gif
+cp test/test_compact_images/src/example.svg test/test_compact_undefined/src/example.svg
+cp test/test_compact_images/src/example.webp test/test_compact_undefined/src/example.webp
+
+cp test/test_compact_images/src/example.jpg test/test_compact_custom/src/example.jpg
+cp test/test_compact_images/src/example.png test/test_compact_custom/src/example.png
+cp test/test_compact_images/src/example.gif test/test_compact_custom/src/example.gif
+cp test/test_compact_images/src/example.svg test/test_compact_custom/src/example.svg
+cp test/test_compact_images/src/example.webp test/test_compact_custom/src/example.webp

test/run

@@ -6,6 +6,18 @@ root=`node -r fs -p "fs.realpathSync(process.argv[1]);" "$root"`
 
 . "$root/../node_modules/faucet-pipeline-core/test/cli_harness.sh"
 
+# ensures the second file is smaller than the first file
+function assert_smaller_size {
+	original=$(wc -c < "${1:?}")
+	result=$(wc -c < "${2:?}")
+
+	if [ $(bc <<< "$result < $original") != 1 ]; then
+		fail "file \`$2\` is not smaller than \`$1\`"
+	else
+		true
+	fi
+}
+
 begin "$root/test_basic"
 	faucet
 	assert_identical "./dist/test.txt" "./src/test.txt"
@@ -70,4 +82,44 @@ begin "$root/test_match_multiple"
 	assert_missing "./dist/nope.json"
 end
 
+begin "$root/test_compact_undefined"
+	faucet --compact
+	assert_identical src/test.txt dist/test.txt
+	assert_identical src/example.jpg dist/example.jpg
+	assert_identical src/example.png dist/example.png
+	assert_identical src/example.gif dist/example.gif
+	assert_identical src/example.svg dist/example.svg
+	assert_identical src/example.webp dist/example.webp
+end
+
+begin "$root/test_compact_images"
+	faucet
+	assert_identical src/test.txt dist/test.txt
+	assert_identical src/example.jpg dist/example.jpg
+	assert_identical src/example.png dist/example.png
+	assert_identical src/example.gif dist/example.gif
+	assert_identical src/example.svg dist/example.svg
+	assert_identical src/example.webp dist/example.webp
+end
+
+begin "$root/test_compact_images"
+	faucet --compact
+	assert_identical src/test.txt dist/test.txt
+	assert_smaller_size src/example.jpg dist/example.jpg
+	assert_smaller_size src/example.png dist/example.png
+	assert_identical src/example.gif dist/example.gif
+	assert_smaller_size src/example.svg dist/example.svg
+	assert_identical src/example.webp dist/example.webp
+end
+
+begin "$root/test_compact_custom"
+	faucet --compact
+	assert_identical src/test.txt dist/test.txt
+	assert_identical src/example.jpg dist/example.jpg
+	assert_identical src/example.png dist/example.png
+	assert_identical src/example.gif dist/example.gif
+	assert_smaller_size src/example.svg dist/example.svg
+	assert_identical src/example.webp dist/example.webp
+end
+
 echo; echo "SUCCESS: all tests passed"

test/test_compact_custom/faucet.config.js

@@ -0,0 +1,18 @@
+"use strict";
+let path = require("path");
+
+module.exports = {
+	static: [{
+		source: "./src",
+		target: "./dist",
+		compact: {
+			svg: require("imagemin-svgo")()
+		}
+	}],
+	plugins: {
+		"static": {
+			plugin: path.resolve("../.."),
+			bucket: "static"
+		}
+	}
+};

test/test_compact_custom/src/.keep

@@ -0,0 +1 @@
+Just copy me, ok?