Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-02-03 23:00:14 -05:00
Code Issues Activity

Refactored package-json lib into a class

Browse source 
- this helps bring all the code together so we can extract it in the
  future
- turning it into a class also lets us easily inject the i18n instance
  and store it locally
This commit is contained in:
Daniel Lockyer 2020-11-23 21:48:32 +00:00
parent 47e81e3ca1
commit 4378435e12
7 changed files with 195 additions and 221 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
core/frontend/services/themes/loader.js
View file

@ -4,8 +4,8 @@ const packageJSON = require('../../../server/lib/fs/package-json');
const themeList = require('./list');
const loadAllThemes = function loadAllThemes() {
return packageJSON.read
.all(config.getContentPath('themes'))
return packageJSON
.readPackages(config.getContentPath('themes'))
.then(function updateThemeList(themes) {
debug('loading themes', Object.keys(themes));
@ -14,8 +14,8 @@ const loadAllThemes = function loadAllThemes() {
};
const loadOneTheme = function loadOneTheme(themeName) {
return packageJSON.read
.one(config.getContentPath('themes'), themeName)
return packageJSON
.readPackage(config.getContentPath('themes'), themeName)
.then(function (readThemes) {
debug('loaded one theme', themeName);
return themeList.set(themeName, readThemes[themeName]);

43
core/server/lib/fs/package-json/filter.js
View file

@ -1,43 +0,0 @@
const _ = require('lodash');
const notAPackageRegex = /^\.|_messages|README.md/i;
/**
* ### 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
*/
const filterPackages = function filterPackages(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 result;
}, []);
};
module.exports = filterPackages;

25
core/server/lib/fs/package-json/index.js
View file

@ -1,23 +1,4 @@
/**
* # Package Utils
*
* Ghost has / is in the process of gaining 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.
*/
const PackageJson = require('./package-json');
const {i18n} = require('../../common');
module.exports = {
get read() {
return require('./read');
},
get parse() {
return require('./parse');
},
get filter() {
return require('./filter');
}
};
module.exports = new PackageJson(i18n);

179
core/server/lib/fs/package-json/package-json.js Normal file
View file

@ -0,0 +1,179 @@
const _ = require('lodash');
const Promise = require('bluebird');
const fs = require('fs-extra');
const join = require('path').join;
const errors = require('@tryghost/errors');
const notAPackageRegex = /^\.|_messages|README.md|node_modules|bower_components/i;
const packageJSONPath = 'package.json';
/**
* # Package Utils
*
* Ghost has / is in the process of gaining 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 {
constructor(i18n) {
this.i18n = i18n;
}
/**
* ### 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];
}
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 result;
}, []);
}
/**
* Parse package.json and validate it has
* all the required fields
*/
parse(path) {
const self = this;
return fs.readFile(path)
.catch(function () {
const err = new Error(self.i18n.t('errors.utils.parsepackagejson.couldNotReadPackage'));
err.context = path;
return Promise.reject(err);
})
.then(function (source) {
let hasRequiredKeys;
let json;
let err;
try {
json = JSON.parse(source);
hasRequiredKeys = json.name && json.version;
if (!hasRequiredKeys) {
err = new Error(self.i18n.t('errors.utils.parsepackagejson.nameOrVersionMissing'));
err.context = path;
err.help = self.i18n.t('errors.utils.parsepackagejson.willBeRequired', {url: 'https://ghost.org/docs/api/handlebars-themes/'});
return Promise.reject(err);
}
return json;
} catch (parseError) {
err = new Error(self.i18n.t('errors.utils.parsepackagejson.themeFileIsMalformed'));
err.context = path;
err.help = self.i18n.t('errors.utils.parsepackagejson.willBeRequired', {url: 'https://ghost.org/docs/api/handlebars-themes/'});
return Promise.reject(err);
}
});
}
/**
* Recursively read directory and find the packages in it
*
* @returns {object}
*/
processPackage(absolutePath, packageName) {
const pkg = {
name: packageName,
path: absolutePath
};
return this.parse(join(absolutePath, packageJSONPath))
.then(function gotPackageJSON(packageJSON) {
pkg['package.json'] = packageJSON;
return pkg;
})
.catch(function noPackageJSON() {
// 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;
});
}
readPackage(packagePath, packageName) {
const self = this;
const absolutePath = join(packagePath, packageName);
return fs.stat(absolutePath)
.then(function (stat) {
if (!stat.isDirectory()) {
return {};
}
return self.processPackage(absolutePath, packageName)
.then(function gotPackage(pkg) {
const res = {};
res[packageName] = pkg;
return res;
});
})
.catch(function (err) {
return Promise.reject(new errors.NotFoundError({
message: 'Package not found',
err: err,
help: 'path: ' + packagePath,
context: 'name: ' + packageName
}));
});
}
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');
});
}
};

56
core/server/lib/fs/package-json/parse.js
View file

@ -1,56 +0,0 @@
/**
* Dependencies
*/
const Promise = require('bluebird');
const fs = require('fs-extra');
const {i18n} = require('../../common');
/**
* Parse package.json and validate it has
* all the required fields
*/
function parsePackageJson(path) {
return fs.readFile(path)
.catch(function () {
const err = new Error(i18n.t('errors.utils.parsepackagejson.couldNotReadPackage'));
err.context = path;
return Promise.reject(err);
})
.then(function (source) {
let hasRequiredKeys;
let json;
let err;
try {
json = JSON.parse(source);
hasRequiredKeys = json.name && json.version;
if (!hasRequiredKeys) {
err = new Error(i18n.t('errors.utils.parsepackagejson.nameOrVersionMissing'));
err.context = path;
err.help = i18n.t('errors.utils.parsepackagejson.willBeRequired', {url: 'https://ghost.org/docs/api/handlebars-themes/'});
return Promise.reject(err);
}
return json;
} catch (parseError) {
err = new Error(i18n.t('errors.utils.parsepackagejson.themeFileIsMalformed'));
err.context = path;
err.help = i18n.t('errors.utils.parsepackagejson.willBeRequired', {url: 'https://ghost.org/docs/api/handlebars-themes/'});
return Promise.reject(err);
}
});
}
/**
* Expose `parsePackageJson`
*/
module.exports = parsePackageJson;

87
core/server/lib/fs/package-json/read.js
View file

@ -1,87 +0,0 @@
/**
* Dependencies
*/
const Promise = require('bluebird');
const _ = require('lodash');
const join = require('path').join;
const fs = require('fs-extra');
const parsePackageJson = require('./parse');
const errors = require('@tryghost/errors');
const notAPackageRegex = /^\.|_messages|README.md|node_modules|bower_components/i;
const packageJSONPath = 'package.json';
/**
* Recursively read directory and find the packages in it
*/
const processPackage = function processPackage(absolutePath, packageName) {
const pkg = {
name: packageName,
path: absolutePath
};
return parsePackageJson(join(absolutePath, packageJSONPath))
.then(function gotPackageJSON(packageJSON) {
pkg['package.json'] = packageJSON;
return pkg;
})
.catch(function noPackageJSON() {
// 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;
});
};
const readPackage = function readPackage(packagePath, packageName) {
const absolutePath = join(packagePath, packageName);
return fs.stat(absolutePath)
.then(function (stat) {
if (!stat.isDirectory()) {
return {};
}
return processPackage(absolutePath, packageName)
.then(function gotPackage(pkg) {
const res = {};
res[packageName] = pkg;
return res;
});
})
.catch(function (err) {
return Promise.reject(new errors.NotFoundError({
message: 'Package not found',
err: err,
help: 'path: ' + packagePath,
context: 'name: ' + packageName
}));
});
};
const readPackages = 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;
}
// 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');
});
};
/**
* Expose Public API
*/
module.exports.all = readPackages;
module.exports.one = readPackage;

18
test/unit/lib/fs/package-json/read_spec.js
View file

@ -19,7 +19,7 @@ describe('lib/fs/package-json: read', function () {
fs.mkdirSync(join(packagePath.name, '.git'));
fs.writeFileSync(join(packagePath.name, '.DS_Store'), '');
packageJSON.read.all(packagePath.name)
packageJSON.readPackages(packagePath.name)
.then(function (pkgs) {
pkgs.should.eql({
casper: {
@ -50,7 +50,7 @@ describe('lib/fs/package-json: read', function () {
fs.writeFileSync(join(packagePath.name, 'testtheme', 'package.json'), pkgJson);
fs.writeFileSync(join(packagePath.name, 'testtheme', 'index.hbs'), '');
packageJSON.read.all(packagePath.name)
packageJSON.readPackages(packagePath.name)
.then(function (pkgs) {
pkgs.should.eql({
testtheme: {
@ -83,7 +83,7 @@ describe('lib/fs/package-json: read', function () {
fs.writeFileSync(join(packagePath.name, 'testtheme', 'package.json'), pkgJson);
fs.writeFileSync(join(packagePath.name, 'testtheme', 'index.hbs'), '');
packageJSON.read.all(packagePath.name)
packageJSON.readPackages(packagePath.name)
.then(function (pkgs) {
pkgs.should.eql({
testtheme: {
@ -114,7 +114,7 @@ describe('lib/fs/package-json: read', function () {
fs.mkdirSync(join(packagePath.name, '.git'));
fs.writeFileSync(join(packagePath.name, '.DS_Store'), '');
packageJSON.read.one(packagePath.name, 'casper')
packageJSON.readPackage(packagePath.name, 'casper')
.then(function (pkgs) {
pkgs.should.eql({
casper: {
@ -145,7 +145,7 @@ describe('lib/fs/package-json: read', function () {
fs.writeFileSync(join(packagePath.name, 'testtheme', 'package.json'), pkgJson);
fs.writeFileSync(join(packagePath.name, 'testtheme', 'index.hbs'), '');
packageJSON.read.one(packagePath.name, 'testtheme')
packageJSON.readPackage(packagePath.name, 'testtheme')
.then(function (pkgs) {
pkgs.should.eql({
testtheme: {
@ -178,7 +178,7 @@ describe('lib/fs/package-json: read', function () {
fs.writeFileSync(join(packagePath.name, 'testtheme', 'package.json'), pkgJson);
fs.writeFileSync(join(packagePath.name, 'testtheme', 'index.hbs'), '');
packageJSON.read.one(packagePath.name, 'testtheme')
packageJSON.readPackage(packagePath.name, 'testtheme')
.then(function (pkgs) {
pkgs.should.eql({
testtheme: {
@ -209,7 +209,7 @@ describe('lib/fs/package-json: read', function () {
fs.mkdirSync(join(packagePath.name, 'not-casper'));
fs.writeFileSync(join(packagePath.name, 'not-casper', 'index.hbs'), '');
packageJSON.read.one(packagePath.name, 'casper')
packageJSON.readPackage(packagePath.name, 'casper')
.then(function (pkgs) {
pkgs.should.eql({
casper: {
@ -232,7 +232,7 @@ describe('lib/fs/package-json: read', function () {
fs.writeFileSync(join(packagePath.name, 'casper.zip'), '');
fs.writeFileSync(join(packagePath.name, '.DS_Store'), '');
packageJSON.read.one(packagePath.name, 'casper')
packageJSON.readPackage(packagePath.name, 'casper')
.then(function () {
done('Should have thrown an error');
})
@ -250,7 +250,7 @@ describe('lib/fs/package-json: read', function () {
fs.writeFileSync(join(packagePath.name, 'casper.zip'), '');
fs.writeFileSync(join(packagePath.name, '.DS_Store'), '');
packageJSON.read.one(packagePath.name, 'casper.zip')
packageJSON.readPackage(packagePath.name, 'casper.zip')
.then(function (pkg) {
pkg.should.eql({});