mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-11-26 04:08:01 +03:00
Removed class pattern
- removed the class pattern in the simplest possible way - have package-json expose only the public methods - move parse to an independent, not public file so that we can test it independently still
This commit is contained in:
Hannah Wolfe
parent
dd129e0920
commit
93e4577caf
@ -1,194 +1,142 @@
|
||||
const _ = require('lodash');
|
||||
const Promise = require('bluebird');
|
||||
const fs = require('fs-extra');
|
||||
const join = require('path').join;
|
||||
const errors = require('@tryghost/errors');
|
||||
const tpl = require('@tryghost/tpl');
|
||||
|
||||
const notAPackageRegex = /^\.|_messages|README.md|node_modules|bower_components/i;
|
||||
const packageJSONPath = 'package.json';
|
||||
|
||||
const messages = {
|
||||
couldNotReadPackage: 'Could not read package.json file',
|
||||
nameOrVersionMissing: '"name" or "version" is missing from theme package.json file.',
|
||||
willBeRequired: 'This will be required in future. Please see {url}',
|
||||
themeFileIsMalformed: 'Theme package.json file is malformed'
|
||||
};
|
||||
|
||||
/**
|
||||
/*
|
||||
* # Package Utils
|
||||
*
|
||||
* Ghost has / is in the process of gaining support for several different types of sub-packages:
|
||||
* Ghost has support for several different types of sub-packages:
|
||||
* - Themes: have always been packages, but we're going to lean more heavily on npm & package.json in future
|
||||
* - Adapters: replace fundamental pieces like storage, will become npm modules
|
||||
*
|
||||
* These utils facilitate loading, reading, managing etc, packages from the file system.
|
||||
*
|
||||
*/
|
||||
module.exports = class PackageJson {
|
||||
/**
|
||||
* ### Filter Packages
|
||||
* Normalizes packages read by read-packages so that the themes module can use them.
|
||||
* Iterates over each package and return an array of objects which are simplified representations of the package
|
||||
* with 3 properties:
|
||||
* - `name` - the package name
|
||||
* - `package` - contents of the package.json or false if there isn't one
|
||||
* - `active` - set to true if this package is active
|
||||
* This data structure is used for listings of packages provided over the API and as such
|
||||
* deliberately combines multiple sources of information in order to be efficient.
|
||||
*
|
||||
* TODO: simplify the package.json representation to contain only fields we use
|
||||
*
|
||||
* @param {object} packages as returned by read-packages
|
||||
* @param {array/string} active as read from the settings object
|
||||
* @returns {Array} of objects with useful info about themes
|
||||
*/
|
||||
filter(packages, active) {
|
||||
// turn active into an array if it isn't one, so this function can deal with lists and one-offs
|
||||
if (!Array.isArray(active)) {
|
||||
active = [active];
|
||||
const _ = require('lodash');
|
||||
const Promise = require('bluebird');
|
||||
const fs = require('fs-extra');
|
||||
const join = require('path').join;
|
||||
const errors = require('@tryghost/errors');
|
||||
const parse = require('./parse');
|
||||
|
||||
const notAPackageRegex = /^\.|_messages|README.md|node_modules|bower_components/i;
|
||||
const packageJSONPath = 'package.json';
|
||||
|
||||
/**
|
||||
* Recursively read directory and find the packages in it
|
||||
*
|
||||
* @param {string} absolutePath
|
||||
* @param {string} packageName
|
||||
* @returns {object}
|
||||
*/
|
||||
async function processPackage(absolutePath, packageName) {
|
||||
const pkg = {
|
||||
name: packageName,
|
||||
path: absolutePath
|
||||
};
|
||||
|
||||
try {
|
||||
const packageJSON = await parse(join(absolutePath, packageJSONPath));
|
||||
pkg['package.json'] = packageJSON;
|
||||
} catch (err) {
|
||||
// ignore invalid package.json for now,
|
||||
// because Ghost does not rely/use them at the moment
|
||||
// in the future, this .catch() will need to be removed,
|
||||
// so that error is thrown on invalid json syntax
|
||||
pkg['package.json'] = null;
|
||||
}
|
||||
|
||||
return pkg;
|
||||
}
|
||||
|
||||
/**
|
||||
* ### Filter Packages
|
||||
* Normalizes packages read by read-packages so that the themes module can use them.
|
||||
* Iterates over each package and return an array of objects which are simplified representations of the package
|
||||
* with 3 properties:
|
||||
* - `name` - the package name
|
||||
* - `package` - contents of the package.json or false if there isn't one
|
||||
* - `active` - set to true if this package is active
|
||||
* This data structure is used for listings of packages provided over the API and as such
|
||||
* deliberately combines multiple sources of information in order to be efficient.
|
||||
*
|
||||
* TODO: simplify the package.json representation to contain only fields we use
|
||||
*
|
||||
* @param {object} packages as returned by read-packages
|
||||
* @param {array|string} active as read from the settings object
|
||||
* @returns {Array} of objects with useful info about themes
|
||||
*/
|
||||
function filter(packages, active) {
|
||||
// turn active into an array if it isn't one, so this function can deal with lists and one-offs
|
||||
if (!Array.isArray(active)) {
|
||||
active = [active];
|
||||
}
|
||||
|
||||
return _.reduce(packages, function (result, pkg, key) {
|
||||
let item = {};
|
||||
if (!key.match(notAPackageRegex)) {
|
||||
item = {
|
||||
name: key,
|
||||
package: pkg['package.json'] || false,
|
||||
active: _.indexOf(active, key) !== -1
|
||||
};
|
||||
|
||||
result.push(item);
|
||||
}
|
||||
|
||||
return _.reduce(packages, function (result, pkg, key) {
|
||||
let item = {};
|
||||
if (!key.match(notAPackageRegex)) {
|
||||
item = {
|
||||
name: key,
|
||||
package: pkg['package.json'] || false,
|
||||
active: _.indexOf(active, key) !== -1
|
||||
};
|
||||
return result;
|
||||
}, []);
|
||||
}
|
||||
|
||||
result.push(item);
|
||||
/**
|
||||
* @param {string} packagePath
|
||||
* @param {string} packageName
|
||||
*/
|
||||
async function readPackage(packagePath, packageName) {
|
||||
const absolutePath = join(packagePath, packageName);
|
||||
|
||||
try {
|
||||
const stat = await fs.stat(absolutePath);
|
||||
if (!stat.isDirectory()) {
|
||||
return {};
|
||||
}
|
||||
|
||||
const pkg = await processPackage(absolutePath, packageName);
|
||||
const res = {};
|
||||
res[packageName] = pkg;
|
||||
return res;
|
||||
} catch (err) {
|
||||
return Promise.reject(new errors.NotFoundError({
|
||||
message: 'Package not found',
|
||||
err: err,
|
||||
help: 'path: ' + packagePath,
|
||||
context: 'name: ' + packageName
|
||||
}));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} packagePath
|
||||
*/
|
||||
function readPackages(packagePath) {
|
||||
return Promise.resolve(fs.readdir(packagePath))
|
||||
.filter(function (packageName) {
|
||||
// Filter out things which are not packages by regex
|
||||
if (packageName.match(notAPackageRegex)) {
|
||||
return;
|
||||
}
|
||||
|
||||
return result;
|
||||
}, []);
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse package.json and validate it has
|
||||
* all the required fields
|
||||
*
|
||||
* @param {string} path
|
||||
*/
|
||||
async parse(path) {
|
||||
let source;
|
||||
let json;
|
||||
|
||||
try {
|
||||
source = await fs.readFile(path);
|
||||
} catch (readError) {
|
||||
const err = new errors.IncorrectUsageError();
|
||||
err.message = tpl(messages.couldNotReadPackage);
|
||||
err.context = path;
|
||||
err.err = readError;
|
||||
|
||||
return Promise.reject(err);
|
||||
}
|
||||
|
||||
try {
|
||||
json = JSON.parse(source);
|
||||
} catch (parseError) {
|
||||
const err = new errors.IncorrectUsageError();
|
||||
err.message = tpl(messages.themeFileIsMalformed);
|
||||
err.context = path;
|
||||
err.err = parseError;
|
||||
err.help = tpl(messages.willBeRequired, {url: 'https://ghost.org/docs/themes/'});
|
||||
|
||||
return Promise.reject(err);
|
||||
}
|
||||
|
||||
const hasRequiredKeys = json.name && json.version;
|
||||
|
||||
if (!hasRequiredKeys) {
|
||||
const err = new errors.IncorrectUsageError();
|
||||
err.message = tpl(messages.nameOrVersionMissing);
|
||||
err.context = path;
|
||||
err.help = tpl(messages.willBeRequired, {url: 'https://ghost.org/docs/themes/'});
|
||||
|
||||
return Promise.reject(err);
|
||||
}
|
||||
|
||||
return json;
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively read directory and find the packages in it
|
||||
*
|
||||
* @param {string} absolutePath
|
||||
* @param {string} packageName
|
||||
* @returns {object}
|
||||
*/
|
||||
async processPackage(absolutePath, packageName) {
|
||||
const pkg = {
|
||||
name: packageName,
|
||||
path: absolutePath
|
||||
};
|
||||
|
||||
try {
|
||||
const packageJSON = await this.parse(join(absolutePath, packageJSONPath));
|
||||
pkg['package.json'] = packageJSON;
|
||||
} catch (err) {
|
||||
// ignore invalid package.json for now,
|
||||
// because Ghost does not rely/use them at the moment
|
||||
// in the future, this .catch() will need to be removed,
|
||||
// so that error is thrown on invalid json syntax
|
||||
pkg['package.json'] = null;
|
||||
}
|
||||
|
||||
return pkg;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} packagePath
|
||||
* @param {string} packageName
|
||||
*/
|
||||
async readPackage(packagePath, packageName) {
|
||||
const absolutePath = join(packagePath, packageName);
|
||||
|
||||
try {
|
||||
const stat = await fs.stat(absolutePath);
|
||||
if (!stat.isDirectory()) {
|
||||
return {};
|
||||
}
|
||||
|
||||
const pkg = await this.processPackage(absolutePath, packageName);
|
||||
const res = {};
|
||||
res[packageName] = pkg;
|
||||
return res;
|
||||
} catch (err) {
|
||||
return Promise.reject(new errors.NotFoundError({
|
||||
message: 'Package not found',
|
||||
err: err,
|
||||
help: 'path: ' + packagePath,
|
||||
context: 'name: ' + packageName
|
||||
}));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} packagePath
|
||||
*/
|
||||
readPackages(packagePath) {
|
||||
const self = this;
|
||||
|
||||
return Promise.resolve(fs.readdir(packagePath))
|
||||
.filter(function (packageName) {
|
||||
// Filter out things which are not packages by regex
|
||||
if (packageName.match(notAPackageRegex)) {
|
||||
return;
|
||||
}
|
||||
// Check the remaining items to ensure they are a directory
|
||||
return fs.stat(join(packagePath, packageName)).then(function (stat) {
|
||||
return stat.isDirectory();
|
||||
});
|
||||
})
|
||||
.map(function readPackageJson(packageName) {
|
||||
const absolutePath = join(packagePath, packageName);
|
||||
return self.processPackage(absolutePath, packageName);
|
||||
})
|
||||
.then(function (packages) {
|
||||
return _.keyBy(packages, 'name');
|
||||
// Check the remaining items to ensure they are a directory
|
||||
return fs.stat(join(packagePath, packageName)).then(function (stat) {
|
||||
return stat.isDirectory();
|
||||
});
|
||||
}
|
||||
})
|
||||
.map(function readPackageJson(packageName) {
|
||||
const absolutePath = join(packagePath, packageName);
|
||||
return processPackage(absolutePath, packageName);
|
||||
})
|
||||
.then(function (packages) {
|
||||
return _.keyBy(packages, 'name');
|
||||
});
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
filter,
|
||||
readPackage,
|
||||
readPackages
|
||||
};
|
||||
|
||||
60
ghost/package-json/lib/parse.js
Normal file
60
ghost/package-json/lib/parse.js
Normal file
@ -0,0 +1,60 @@
|
||||
const Promise = require('bluebird');
|
||||
const fs = require('fs-extra');
|
||||
const errors = require('@tryghost/errors');
|
||||
const tpl = require('@tryghost/tpl');
|
||||
|
||||
const messages = {
|
||||
couldNotReadPackage: 'Could not read package.json file',
|
||||
nameOrVersionMissing: '"name" or "version" is missing from theme package.json file.',
|
||||
willBeRequired: 'This will be required in future. Please see {url}',
|
||||
themeFileIsMalformed: 'Theme package.json file is malformed'
|
||||
};
|
||||
|
||||
/**
|
||||
* Parse package.json and validate it has
|
||||
* all the required fields
|
||||
*
|
||||
* @param {string} path
|
||||
*/
|
||||
async function parse(path) {
|
||||
let source;
|
||||
let json;
|
||||
|
||||
try {
|
||||
source = await fs.readFile(path);
|
||||
} catch (readError) {
|
||||
const err = new errors.IncorrectUsageError();
|
||||
err.message = tpl(messages.couldNotReadPackage);
|
||||
err.context = path;
|
||||
err.err = readError;
|
||||
|
||||
return Promise.reject(err);
|
||||
}
|
||||
|
||||
try {
|
||||
json = JSON.parse(source);
|
||||
} catch (parseError) {
|
||||
const err = new errors.IncorrectUsageError();
|
||||
err.message = tpl(messages.themeFileIsMalformed);
|
||||
err.context = path;
|
||||
err.err = parseError;
|
||||
err.help = tpl(messages.willBeRequired, {url: 'https://ghost.org/docs/themes/'});
|
||||
|
||||
return Promise.reject(err);
|
||||
}
|
||||
|
||||
const hasRequiredKeys = json.name && json.version;
|
||||
|
||||
if (!hasRequiredKeys) {
|
||||
const err = new errors.IncorrectUsageError();
|
||||
err.message = tpl(messages.nameOrVersionMissing);
|
||||
err.context = path;
|
||||
err.help = tpl(messages.willBeRequired, {url: 'https://ghost.org/docs/themes/'});
|
||||
|
||||
return Promise.reject(err);
|
||||
}
|
||||
|
||||
return json;
|
||||
}
|
||||
|
||||
module.exports = parse;
|
||||
@ -1,9 +1,7 @@
|
||||
require('./utils');
|
||||
const PackageJSON = require('../');
|
||||
const packageJSON = require('../');
|
||||
|
||||
const packageJSON = new PackageJSON();
|
||||
|
||||
describe('lib/fs/package-json', function () {
|
||||
describe('package-json filter', function () {
|
||||
// @TODO: introduce some non-theme package examples
|
||||
const casper = {
|
||||
name: 'casper',
|
||||
|
||||
@ -2,11 +2,9 @@ require('./utils');
|
||||
|
||||
const tmp = require('tmp');
|
||||
const fs = require('fs-extra');
|
||||
const PackageJSON = require('../');
|
||||
const parse = require('../lib/parse');
|
||||
|
||||
const packageJSON = new PackageJSON();
|
||||
|
||||
describe('lib/fs/package-json: parse', function () {
|
||||
describe('package-json parse', function () {
|
||||
it('should parse valid package.json', function (done) {
|
||||
let pkgJson;
|
||||
let tmpFile;
|
||||
@ -19,7 +17,7 @@ describe('lib/fs/package-json: parse', function () {
|
||||
|
||||
fs.writeSync(tmpFile.fd, pkgJson);
|
||||
|
||||
packageJSON.parse(tmpFile.name)
|
||||
parse(tmpFile.name)
|
||||
.then(function (pkg) {
|
||||
pkg.should.eql({
|
||||
name: 'test',
|
||||
@ -43,7 +41,7 @@ describe('lib/fs/package-json: parse', function () {
|
||||
|
||||
fs.writeSync(tmpFile.fd, pkgJson);
|
||||
|
||||
packageJSON.parse(tmpFile.name)
|
||||
parse(tmpFile.name)
|
||||
.then(function () {
|
||||
done(new Error('packageJSON.parse succeeded, but should\'ve failed'));
|
||||
})
|
||||
@ -69,7 +67,7 @@ describe('lib/fs/package-json: parse', function () {
|
||||
|
||||
fs.writeSync(tmpFile.fd, pkgJson);
|
||||
|
||||
packageJSON.parse(tmpFile.name)
|
||||
parse(tmpFile.name)
|
||||
.then(function () {
|
||||
done(new Error('packageJSON.parse succeeded, but should\'ve failed'));
|
||||
})
|
||||
@ -93,7 +91,7 @@ describe('lib/fs/package-json: parse', function () {
|
||||
|
||||
fs.writeSync(tmpFile.fd, pkgJson);
|
||||
|
||||
packageJSON.parse(tmpFile.name)
|
||||
parse(tmpFile.name)
|
||||
.then(function () {
|
||||
done(new Error('packageJSON.parse succeeded, but should\'ve failed'));
|
||||
})
|
||||
@ -112,7 +110,7 @@ describe('lib/fs/package-json: parse', function () {
|
||||
const tmpFile = tmp.fileSync();
|
||||
|
||||
tmpFile.removeCallback();
|
||||
packageJSON.parse(tmpFile.name)
|
||||
parse(tmpFile.name)
|
||||
.then(function () {
|
||||
done(new Error('packageJSON.parse succeeded, but should\'ve failed'));
|
||||
})
|
||||
|
||||
@ -3,12 +3,10 @@ require('./utils');
|
||||
const tmp = require('tmp');
|
||||
const join = require('path').join;
|
||||
const fs = require('fs-extra');
|
||||
const PackageJSON = require('../');
|
||||
const packageJSON = require('../');
|
||||
|
||||
const packageJSON = new PackageJSON();
|
||||
|
||||
describe('lib/fs/package-json: read', function () {
|
||||
describe('all', function () {
|
||||
describe('package-json read', function () {
|
||||
describe('readPackages', function () {
|
||||
it('should read directory and ignore unneeded items', function (done) {
|
||||
const packagePath = tmp.dirSync({unsafeCleanup: true});
|
||||
|
||||
@ -103,7 +101,7 @@ describe('lib/fs/package-json: read', function () {
|
||||
});
|
||||
});
|
||||
|
||||
describe('one', function () {
|
||||
describe('readPackage', function () {
|
||||
it('should read directory and ignore unneeded items', function (done) {
|
||||
const packagePath = tmp.dirSync({unsafeCleanup: true});
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user