Migrated packages from Utils

refs https://github.com/TryGhost/Toolbox/issues/354

- these packages are more suited for SDK as they help people integrate
  and work with Ghost

Author: daniellockyer

packages/config-url-helpers/.eslintrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+    plugins: ['ghost'],
+    extends: [
+        'plugin:ghost/node'
+    ]
+};

packages/config-url-helpers/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-2022 Ghost Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/config-url-helpers/README.md

@@ -0,0 +1,39 @@
+# Config Url Helpers
+
+## Install
+
+`npm install @tryghost/config-url-helpers --save`
+
+or
+
+`yarn add @tryghost/config-url-helpers`
+
+
+## Usage
+
+
+## Develop
+
+This is a mono repository, managed with [lerna](https://lernajs.io/).
+
+Follow the instructions for the top-level repo.
+1. `git clone` this repo & `cd` into it as usual
+2. Run `yarn` to install top-level dependencies.
+
+
+## Run
+
+- `yarn dev`
+
+
+## Test
+
+- `yarn lint` run just eslint
+- `yarn test` run lint and tests
+
+
+
+
+# Copyright & License 
+
+Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE).

packages/config-url-helpers/index.js

@@ -0,0 +1,15 @@
+const configUrlHelpers = require('./lib/config-url-helpers');
+
+/**
+ * @typedef {Object} BoundHelpers
+ * @property {configUrlHelpers.getSubdirFn} getSubdir
+ * @property {configUrlHelpers.getSiteUrlFn} getSiteUrl
+ * @property {configUrlHelpers.getAdminUrlFn} getAdminUrl
+ *
+ * @param {*} nconf
+ */
+module.exports.bindAll = (nconf) => {
+    Object.keys(configUrlHelpers).forEach((helper) => {
+        nconf[helper] = configUrlHelpers[helper].bind(nconf);
+    });
+};

packages/config-url-helpers/lib/config-url-helpers.js

@@ -0,0 +1,73 @@
+const deduplicateSubdirectory = require('./utils/deduplicate-subdirectory');
+
+/**
+ * Returns a subdirectory URL, if defined so in the config.
+ * @callback getSubdirFn
+ * @return {string} a subdirectory if configured.
+ */
+function getSubdir() {
+    // Parse local path location
+    let {pathname} = new URL(this.get('url'));
+    let subdir;
+
+    // Remove trailing slash
+    if (pathname !== '/') {
+        pathname = pathname.replace(/\/$/, '');
+    }
+
+    subdir = pathname === '/' ? '' : pathname;
+    return subdir;
+}
+
+/**
+ * Returns the base URL of the site as set in the config.
+ *
+ * Secure:
+ * If the request is secure, we want to force returning the site url as https.
+ * Imagine Ghost runs with http, but nginx allows SSL connections.
+ *
+ * @callback getSiteUrlFn
+ * @return {string} returns the url as defined in config, but always with a trailing `/`
+ */
+function getSiteUrl() {
+    let siteUrl = this.get('url');
+
+    if (!siteUrl.match(/\/$/)) {
+        siteUrl += '/';
+    }
+
+    return siteUrl;
+}
+
+/**
+ *
+ * @callback getAdminUrlFn
+ * @returns {string} returns the url as defined in config, but always with a trailing `/`
+ */
+function getAdminUrl() {
+    let adminUrl = this.get('admin:url');
+    const subdir = this.getSubdir();
+
+    if (!adminUrl) {
+        return;
+    }
+
+    if (!adminUrl.match(/\/$/)) {
+        adminUrl += '/';
+    }
+
+    adminUrl = `${adminUrl}${subdir}`;
+
+    if (!adminUrl.match(/\/$/)) {
+        adminUrl += '/';
+    }
+
+    adminUrl = deduplicateSubdirectory(adminUrl, this.getSiteUrl());
+    return adminUrl;
+}
+
+module.exports = {
+    getSubdir,
+    getSiteUrl,
+    getAdminUrl
+};

packages/config-url-helpers/lib/utils/deduplicate-subdirectory.js

@@ -0,0 +1,34 @@
+const {URL} = require('url');
+
+/**
+ * Remove duplicated directories from the start of a path or url's path
+ *
+ * @param {string} url URL or pathname with possible duplicate subdirectory
+ * @param {string} rootUrl Root URL with an optional subdirectory
+ * @returns {string} URL or pathname with any duplicated subdirectory removed
+ */
+const deduplicateSubdirectory = function deduplicateSubdirectory(url, rootUrl) {
+    // force root url to always have a trailing-slash for consistent behaviour
+    if (!rootUrl.endsWith('/')) {
+        rootUrl = `${rootUrl}/`;
+    }
+
+    // Cleanup any extraneous slashes in url for consistent behaviour
+    url = url.replace(/(^|[^:])\/\/+/g, '$1/');
+
+    const parsedRoot = new URL(rootUrl);
+
+    // do nothing if rootUrl does not have a subdirectory
+    if (parsedRoot.pathname === '/') {
+        return url;
+    }
+
+    const subdir = parsedRoot.pathname.replace(/(^\/|\/$)+/g, '');
+    // we can have subdirs that match TLDs so we need to restrict matches to
+    // duplicates that start with a / or the beginning of the url
+    const subdirRegex = new RegExp(`(^|/)${subdir}/${subdir}(/|$)`);
+
+    return url.replace(subdirRegex, `$1${subdir}/`);
+};
+
+module.exports = deduplicateSubdirectory;

packages/config-url-helpers/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@tryghost/config-url-helpers",
+  "version": "1.0.2",
+  "repository": "https://github.com/TryGhost/Utils/tree/main/packages/config-url-helpers",
+  "author": "Ghost Foundation",
+  "license": "MIT",
+  "main": "index.js",
+  "scripts": {
+    "dev": "echo \"Implement me!\"",
+    "test": "NODE_ENV=testing c8 --all --reporter text --reporter cobertura --check-coverage mocha './test/**/*.test.js'",
+    "coverage": "c8 report -r html",
+    "lint": "eslint . --ext .js --cache",
+    "posttest": "yarn lint"
+  },
+  "files": [
+    "index.js",
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "c8": "7.12.0",
+    "mocha": "10.0.0",
+    "should": "13.2.3",
+    "sinon": "14.0.0"
+  }
+}

packages/config-url-helpers/test/.eslintrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+    plugins: ['ghost'],
+    extends: [
+        'plugin:ghost/test'
+    ]
+};

packages/config-url-helpers/test/config-url-helpers.test.js

@@ -0,0 +1,115 @@
+// Switch these lines once there are useful utils
+// const testUtils = require('./utils');
+require('./utils');
+
+const sinon = require('sinon');
+
+const configUrlHelpers = require('../');
+
+let nconf;
+
+const fakeConfig = {
+    url: '',
+    adminUrl: null
+};
+
+describe('Config URL Helpers', function () {
+    before(function () {
+        const configFaker = (arg) => {
+            if (arg === 'url') {
+                return fakeConfig.url;
+            } else if (arg === 'admin:url') {
+                return fakeConfig.adminUrl;
+            }
+        };
+
+        nconf = {
+            get: sinon.stub().callsFake(configFaker)
+        };
+
+        configUrlHelpers.bindAll(nconf);
+    });
+
+    describe('getSubdir', function () {
+        it('url has no subdir', function () {
+            fakeConfig.url = 'http://my-ghost-blog.com/';
+
+            nconf.getSubdir().should.eql('');
+        });
+
+        it('url has subdir', function () {
+            fakeConfig.url = 'http://my-ghost-blog.com/blog';
+            nconf.getSubdir().should.eql('/blog');
+
+            fakeConfig.url = 'http://my-ghost-blog.com/blog/';
+            nconf.getSubdir().should.eql('/blog');
+
+            fakeConfig.url = 'http://my-ghost-blog.com/my/blog';
+            nconf.getSubdir().should.eql('/my/blog');
+
+            fakeConfig.url = 'http://my-ghost-blog.com/my/blog/';
+            nconf.getSubdir().should.eql('/my/blog');
+        });
+
+        it('should not return a slash for subdir', function () {
+            fakeConfig.url = 'http://my-ghost-blog.com';
+            nconf.getSubdir().should.eql('');
+
+            fakeConfig.url = 'http://my-ghost-blog.com/';
+            nconf.getSubdir().should.eql('');
+        });
+    });
+
+    describe('getSiteUrl', function () {
+        it('returns config url', function () {
+            fakeConfig.url = 'http://example.com/';
+
+            nconf.getSiteUrl().should.eql('http://example.com/');
+        });
+
+        it('adds trailing slash', function () {
+            fakeConfig.url = 'http://example.com';
+
+            nconf.getSiteUrl().should.eql('http://example.com/');
+        });
+    });
+
+    describe('getAdminUrl', function () {
+        it('returns undefinied if no admin URL is set', function () {
+            should.not.exist(nconf.getAdminUrl());
+        });
+
+        it('returns config url', function () {
+            fakeConfig.adminUrl = 'http://admin.example.com/';
+
+            nconf.getAdminUrl().should.eql('http://admin.example.com/');
+        });
+
+        it('adds trailing slash', function () {
+            fakeConfig.adminUrl = 'http://admin.example.com';
+
+            nconf.getAdminUrl().should.eql('http://admin.example.com/');
+        });
+
+        it('returns with subdirectory correctly if not provided', function () {
+            fakeConfig.url = 'http://example.com/blog/';
+            fakeConfig.adminUrl = 'http://admin.example.com';
+
+            nconf.getAdminUrl().should.eql('http://admin.example.com/blog/');
+        });
+
+        it('returns with subdirectory correctly if provided with slash', function () {
+            fakeConfig.url = 'http://example.com/blog/';
+            fakeConfig.adminUrl = 'http://admin.example.com/blog/';
+
+            nconf.getAdminUrl().should.eql('http://admin.example.com/blog/');
+        });
+
+        it('returns with subdirectory correctly if provided without slash', function () {
+            fakeConfig.url = 'http://example.com/blog/';
+            fakeConfig.adminUrl = 'http://admin.example.com/blog';
+
+            nconf.getAdminUrl().should.eql('http://admin.example.com/blog/');
+        });
+    });
+});