penrose 0.2.41 → 0.2.43

package/lib/__tests__/penrose.test.js

@@ -0,0 +1,270 @@
+import _ from 'lodash';
+import Promise from 'bluebird';
+import fs from 'fs-extra';
+import globPromise from 'glob-promise';
+import path from 'path';
+import {describe, expect, test} from 'vitest';
+import {Penrose} from '../penrose';
+
+const dir = import.meta.dirname;
+
+describe('Penrose', () => {
+  const config = {
+    schemes: {
+      public: {
+        path: path.join(dir, 'data/files') + path.sep
+      }
+    },
+    styles: {
+      small: {
+        actions: [
+          {
+            name: 'resize',
+            width: 480
+          }
+        ],
+        quality: 75
+      }
+    }
+  };
+
+  const penrose = new Penrose(config);
+
+  /**
+   *
+   * @param   {Array} patterns
+   * @param   {Object} options
+   * @returns {Promise}
+   */
+  function multiGlob(patterns, options) {
+    let matches = [];
+
+    return Promise.mapSeries(patterns, function (pattern) {
+      return globPromise(pattern, options).then(function (files) {
+        matches = matches.concat(files);
+      });
+    }).then(() => {
+      return Promise.resolve(matches);
+    });
+  }
+
+  describe('resolvePath', () => {
+    test('Should return expected path if URI has scheme', () => {
+      const actual = penrose.resolvePath('public://dir/file.jpg');
+      const expected = config.schemes.public.path + 'dir/file.jpg';
+
+      expect(actual).toEqual(expected);
+    });
+
+    test('Should return expected path if URI has no scheme', () => {
+      const actual = penrose.resolvePath('dir/file.jpg');
+      const expected = 'dir/file.jpg';
+
+      expect(actual).toEqual(expected);
+    });
+
+    test('Should throw error if URI has unsupported scheme', () => {
+      expect(() => penrose.resolvePath('http://dir/file.jpg')).toThrowError(
+        'Scheme `http` not supported'
+      );
+    });
+  });
+
+  describe('getScheme', () => {
+    test('Should return expected scheme if URI has scheme', () => {
+      const actual = penrose.getScheme('public://dir/file.jpg');
+      const expected = 'public';
+
+      expect(actual).toEqual(expected);
+    });
+
+    test('Should return undefined scheme if URI has no scheme', () => {
+      const actual = penrose.getScheme('dir/file.jpg');
+      const expected = undefined;
+
+      expect(actual).toEqual(expected);
+    });
+  });
+
+  describe('getTarget', () => {
+    test('Should return expected target if URI has scheme', () => {
+      const actual = penrose.getTarget('public://dir/file.jpg');
+      const expected = 'dir/file.jpg';
+
+      expect(actual).toEqual(expected);
+    });
+
+    test('Should return expected target if URI has no scheme', () => {
+      const actual = penrose.getTarget('dir/file.jpg');
+      const expected = 'dir/file.jpg';
+
+      expect(actual).toEqual(expected);
+    });
+  });
+
+  describe('getURL', () => {
+    test('Should return expected URL if URI has scheme', () => {
+      const actual = penrose.getURL('public://dir/file.jpg');
+      const expected = '/' + config.schemes.public.path + 'dir/file.jpg';
+
+      expect(actual).toEqual(expected);
+    });
+
+    test('Should return expected URL if URI has no scheme', () => {
+      const actual = penrose.getURL('dir/file.jpg');
+      const expected = 'dir/file.jpg';
+
+      expect(actual).toEqual(expected);
+    });
+
+    test('Should return expected URL if URI has unsupported scheme', () => {
+      const actual = penrose.getURL('http://dir/file.jpg');
+      const expected = 'http://dir/file.jpg';
+
+      expect(actual).toEqual(expected);
+    });
+  });
+
+  describe('getStylePath', () => {
+    test('Should return expected path if URI has scheme', () => {
+      const actual = penrose.getStylePath('small', 'private://dir/file.jpg');
+      const expected = 'private://styles/small/dir/file.jpg';
+
+      expect(actual).toEqual(expected);
+    });
+
+    test('Should return expected path if URI has no scheme', () => {
+      const actual = penrose.getStylePath('small', 'dir/file.jpg');
+      const expected = 'public://styles/small/dir/file.jpg';
+
+      expect(actual).toEqual(expected);
+    });
+  });
+
+  describe('getStyleURL', () => {
+    test('Should return expected URL if URI has scheme', () => {
+      const actual = penrose.getStyleURL('small', 'public://dir/file.jpg');
+      const expected =
+        '/' + config.schemes.public.path + 'styles/small/dir/file.jpg';
+
+      expect(actual).toEqual(expected);
+    });
+
+    test('Should return expected URL if URI has no scheme', () => {
+      const actual = penrose.getStyleURL('small', 'dir/file.jpg');
+      const expected =
+        '/' + config.schemes.public.path + 'styles/small/dir/file.jpg';
+
+      expect(actual).toEqual(expected);
+    });
+
+    test('Should throw error if URI has unsupported scheme', () => {
+      expect(() =>
+        penrose.getStyleURL('small', 'http://dir/file.jpg')
+      ).toThrowError('Scheme `http` not supported');
+    });
+  });
+
+  describe('createDerivative', () => {
+    test('Should create derivative images', async () => {
+      await fs.remove(path.join(dir, 'data/files/styles'));
+
+      const files = await multiGlob(
+        _.map(config.schemes, function (scheme) {
+          return scheme.path + '**/*';
+        }),
+        {
+          nodir: true
+        }
+      );
+
+      const tasks = [];
+
+      _.forEach(files, function (file) {
+        _.forEach(config.styles, function (style, styleName) {
+          tasks.push({
+            style: style,
+            src: file,
+            dist: penrose.getStylePath(styleName, file)
+          });
+        });
+      });
+
+      await Promise.mapSeries(tasks, function (task) {
+        return penrose.createDerivative(task.style, task.src, task.dist);
+      });
+
+      const actual = await multiGlob(
+        _.map(config.schemes, function (scheme) {
+          return scheme.path + 'styles/**/*';
+        }),
+        {
+          nodir: true
+        }
+      );
+
+      const expected = [
+        path.join(
+          config.schemes.public.path,
+          'styles/small',
+          config.schemes.public.path,
+          'The_Earth_seen_from_Apollo_17.jpg'
+        )
+      ];
+
+      expect(actual).toEqual(expected);
+
+      await fs.remove(path.join(dir, 'data/files/styles'));
+    });
+  });
+
+  describe('createMathFile', () => {
+    test('Should create math files', async () => {
+      await fs.remove(path.join(dir, 'data/files/math'));
+
+      const math = [
+        {
+          data: 'E = mc^2',
+          format: 'tex'
+        }
+      ];
+
+      const tasks = [];
+      const expected = [];
+
+      _.forEach(math, function (value) {
+        const outputFormat = 'svg';
+        const task = {
+          input: value.data,
+          inputFormat: value.format,
+          outputFormat: outputFormat
+        };
+        const filename = penrose.getMathFilename(task);
+        task.output = penrose.getMathPath(outputFormat, filename);
+
+        tasks.push(task);
+
+        expected.push(
+          path.join(config.schemes.public.path, 'math/svg', filename)
+        );
+      });
+
+      await Promise.mapSeries(tasks, function (task) {
+        return penrose.createMathFile(task);
+      });
+
+      const actual = await multiGlob(
+        _.map(config.schemes, function (scheme) {
+          return scheme.path + 'math/**/*';
+        }),
+        {
+          nodir: true
+        }
+      );
+
+      expect(actual).toEqual(expected);
+
+      await fs.remove(path.join(dir, 'data/files/math'));
+    });
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "penrose",
-  "version": "0.2.41",
+  "version": "0.2.43",
   "description": "Build derivative images",
   "main": "lib/penrose.js",
   "repository": {
@@ -8,7 +8,7 @@
     "url": "git://github.com/netbek/penrose"
   },
   "scripts": {
-    "test": "make test"
+    "test": "vitest run"
   },
   "author": {
     "name": "Hein Bekker",
@@ -20,19 +20,19 @@
     "url": "https://github.com/netbek/penrose/issues"
   },
   "dependencies": {
-    "@babel/core": "7.23.9",
+    "@babel/core": "7.26.0",
     "babel-eslint": "10.1.0",
-    "babel-loader": "8.3.0",
+    "babel-loader": "8.4.1",
     "babel-plugin-lodash": "3.3.4",
     "babel-plugin-transform-class-properties": "6.24.1",
     "bluebird": "3.7.2",
     "canonical-json": "0.0.4",
     "chalk": "4.1.2",
     "cheerio": "0.22.0",
-    "eslint": "8.56.0",
+    "eslint": "8.57.1",
     "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-prettier": "5.1.3",
-    "espree": "10.0.0",
+    "eslint-plugin-prettier": "5.2.1",
+    "espree": "10.3.0",
     "fs-extra": "11.2.0",
     "glob": "7.2.3",
     "glob-promise": "4.2.2",
@@ -41,13 +41,11 @@
     "mathjax": "2.7.9",
     "mathjax-node": "0.5.2",
     "phantomjs-prebuilt": "2.1.16",
-    "prettier": "3.2.4",
+    "prettier": "3.3.3",
     "replace-ext": "2.0.0",
-    "sharp": "0.33.2"
+    "sharp": "0.33.5"
   },
   "devDependencies": {
-    "chai": "4.4.1",
-    "chai-as-promised": "7.1.1",
-    "mocha": "9.2.2"
+    "vitest": "2.1.5"
   }
 }

package/Makefile

@@ -1,9 +0,0 @@
-GREP ?=.
-
-test: node_modules
-	@node_modules/.bin/mocha --harmony --grep "$(GREP)"
-
-node_modules: package.json
-	@npm install
-
-.PHONY: test

package/test/index.js

@@ -1,307 +0,0 @@
-const _ = require('lodash');
-const chai = require('chai');
-const {assert} = chai;
-const chaiAsPromised = require('chai-as-promised');
-chai.use(chaiAsPromised);
-const fs = require('fs-extra');
-const globPromise = require('glob-promise');
-const {Penrose} = require('..');
-const Promise = require('bluebird');
-
-Promise.promisifyAll(fs);
-
-describe('Penrose', function () {
-  const testDir = __dirname.substring(process.cwd().length + 1) + '/';
-
-  const config = {
-    schemes: {
-      public: {
-        path: testDir + 'data/files/'
-      }
-    },
-    styles: {
-      small: {
-        actions: [
-          {
-            name: 'resize',
-            width: 480
-          }
-        ],
-        quality: 75
-      }
-    }
-  };
-
-  const penrose = new Penrose(config);
-
-  /**
-   *
-   * @param   {Array} patterns
-   * @param   {Object} options
-   * @returns {Promise}
-   */
-  function multiGlob(patterns, options) {
-    let matches = [];
-
-    return Promise.mapSeries(patterns, function (pattern) {
-      return globPromise(pattern, options).then(function (files) {
-        matches = matches.concat(files);
-      });
-    }).then(function () {
-      return Promise.resolve(matches);
-    });
-  }
-
-  /**
-   * Deletes test output files.
-   *
-   * @returns {Promise}
-   */
-  function deleteOutput() {
-    const dirs = _.map(config.schemes, function (scheme) {
-      return scheme.path + 'styles/';
-    }).concat([config.schemes.public.path + 'math/']);
-
-    return Promise.mapSeries(dirs, (dir) => fs.removeAsync(dir));
-  }
-
-  beforeEach(function (done) {
-    deleteOutput().then(function () {
-      done();
-    });
-  });
-
-  after(function (done) {
-    deleteOutput().then(function () {
-      done();
-    });
-  });
-
-  describe('resolvePath', function () {
-    it('Should return expected path if URI has scheme', function () {
-      const actual = penrose.resolvePath('public://dir/file.jpg');
-      const expected = config.schemes.public.path + 'dir/file.jpg';
-
-      assert.equal(actual, expected);
-    });
-
-    it('Should return expected path if URI has no scheme', function () {
-      const actual = penrose.resolvePath('dir/file.jpg');
-      const expected = 'dir/file.jpg';
-
-      assert.equal(actual, expected);
-    });
-
-    it('Should throw error if URI has unsupported scheme', function () {
-      let actual;
-      const expected = 'error';
-
-      try {
-        actual = penrose.resolvePath('http://dir/file.jpg');
-      } catch (e) {
-        actual = e;
-      }
-
-      assert.typeOf(actual, expected);
-    });
-  });
-
-  describe('getScheme', function () {
-    it('Should return expected scheme if URI has scheme', function () {
-      const actual = penrose.getScheme('public://dir/file.jpg');
-      const expected = 'public';
-
-      assert.equal(actual, expected);
-    });
-
-    it('Should return undefined scheme if URI has no scheme', function () {
-      const actual = penrose.getScheme('dir/file.jpg');
-      const expected = undefined;
-
-      assert.equal(actual, expected);
-    });
-  });
-
-  describe('getTarget', function () {
-    it('Should return expected target if URI has scheme', function () {
-      const actual = penrose.getTarget('public://dir/file.jpg');
-      const expected = 'dir/file.jpg';
-
-      assert.equal(actual, expected);
-    });
-
-    it('Should return expected target if URI has no scheme', function () {
-      const actual = penrose.getTarget('dir/file.jpg');
-      const expected = 'dir/file.jpg';
-
-      assert.equal(actual, expected);
-    });
-  });
-
-  describe('getURL', function () {
-    it('Should return expected URL if URI has scheme', function () {
-      const actual = penrose.getURL('public://dir/file.jpg');
-      const expected = '/' + config.schemes.public.path + 'dir/file.jpg';
-
-      assert.equal(actual, expected);
-    });
-
-    it('Should return expected URL if URI has no scheme', function () {
-      const actual = penrose.getURL('dir/file.jpg');
-      const expected = 'dir/file.jpg';
-
-      assert.equal(actual, expected);
-    });
-
-    it('Should return expected URL if URI has unsupported scheme', function () {
-      const actual = penrose.getURL('http://dir/file.jpg');
-      const expected = 'http://dir/file.jpg';
-
-      assert.equal(actual, expected);
-    });
-  });
-
-  describe('getStylePath', function () {
-    it('Should return expected path if URI has scheme', function () {
-      const actual = penrose.getStylePath('small', 'private://dir/file.jpg');
-      const expected = 'private://styles/small/dir/file.jpg';
-
-      assert.equal(actual, expected);
-    });
-
-    it('Should return expected path if URI has no scheme', function () {
-      const actual = penrose.getStylePath('small', 'dir/file.jpg');
-      const expected = 'public://styles/small/dir/file.jpg';
-
-      assert.equal(actual, expected);
-    });
-  });
-
-  describe('getStyleURL', function () {
-    it('Should return expected URL if URI has scheme', function () {
-      const actual = penrose.getStyleURL('small', 'public://dir/file.jpg');
-      const expected =
-        '/' + config.schemes.public.path + 'styles/small/dir/file.jpg';
-
-      assert.equal(actual, expected);
-    });
-
-    it('Should return expected URL if URI has no scheme', function () {
-      const actual = penrose.getStyleURL('small', 'dir/file.jpg');
-      const expected =
-        '/' + config.schemes.public.path + 'styles/small/dir/file.jpg';
-
-      assert.equal(actual, expected);
-    });
-
-    it('Should throw error if URI has unsupported scheme', function () {
-      let actual;
-      const expected = 'error';
-
-      try {
-        actual = penrose.getStyleURL('small', 'http://dir/file.jpg');
-      } catch (e) {
-        actual = e;
-      }
-
-      assert.typeOf(actual, expected);
-    });
-  });
-
-  describe('createDerivative', function () {
-    it('Should create derivative images', function () {
-      const actual = function () {
-        return multiGlob(
-          _.map(config.schemes, function (scheme) {
-            return scheme.path + '**/*';
-          }),
-          {
-            nodir: true
-          }
-        )
-          .then(function (files) {
-            const tasks = [];
-
-            _.forEach(files, function (file) {
-              _.forEach(config.styles, function (style, styleName) {
-                tasks.push({
-                  style: style,
-                  src: file,
-                  dist: penrose.getStylePath(styleName, file)
-                });
-              });
-            });
-
-            return Promise.mapSeries(tasks, function (task) {
-              return penrose.createDerivative(task.style, task.src, task.dist);
-            });
-          })
-          .then(function () {
-            return multiGlob(
-              _.map(config.schemes, function (scheme) {
-                return scheme.path + 'styles/**/*';
-              }),
-              {
-                nodir: true
-              }
-            );
-          });
-      };
-
-      const expected = [
-        config.schemes.public.path +
-          'styles/small/' +
-          config.schemes.public.path +
-          'The_Earth_seen_from_Apollo_17.jpg'
-      ];
-
-      return assert.eventually.deepEqual(actual(), expected);
-    });
-  });
-
-  describe('createMathFile', function () {
-    it('Should create math files', function () {
-      const math = [
-        {
-          data: 'E = mc^2',
-          format: 'tex'
-        }
-      ];
-
-      const tasks = [];
-      const expected = [];
-
-      _.forEach(math, function (value) {
-        const outputFormat = 'svg';
-        const task = {
-          input: value.data,
-          inputFormat: value.format,
-          outputFormat: outputFormat
-        };
-        const filename = penrose.getMathFilename(task);
-        task.output = penrose.getMathPath(outputFormat, filename);
-
-        tasks.push(task);
-
-        expected.push(config.schemes.public.path + 'math/svg/' + filename);
-      });
-
-      const actual = function () {
-        return Promise.mapSeries(tasks, function (task) {
-          return penrose.createMathFile(task);
-        }).then(function () {
-          return multiGlob(
-            _.map(config.schemes, function (scheme) {
-              return scheme.path + 'math/**/*';
-            }),
-            {
-              nodir: true
-            }
-          );
-        });
-      };
-
-      return assert.eventually.deepEqual(actual(), expected);
-    });
-  });
-});