From 3b6cdc2bc5f64dfa717191223b0a08f45588225a Mon Sep 17 00:00:00 2001 From: Daniel Lockyer Date: Tue, 26 Apr 2022 13:26:40 +0100 Subject: [PATCH] Renamed `preview` files to `previews` refs https://github.com/TryGhost/Toolbox/issues/308 - we have a pattern of using plurals around Ghost but this was singular - this shouldn't change any API functionality, it's just code refactoring --- core/frontend/services/routing/PreviewRouter.js | 6 +++--- core/frontend/services/routing/config.js | 6 +++--- core/frontend/services/routing/controllers/index.js | 4 ++-- .../routing/controllers/{preview.js => previews.js} | 0 core/server/api/canary/index.js | 4 ++-- core/server/api/canary/{preview.js => previews.js} | 2 +- .../api/canary/utils/serializers/output/index.js | 4 ++-- .../serializers/output/{preview.js => previews.js} | 4 ++-- .../output/{preview.test.js => previews.test.js} | 6 +++--- .../controllers/{preview.test.js => previews.test.js} | 10 +++++----- 10 files changed, 23 insertions(+), 23 deletions(-) rename core/frontend/services/routing/controllers/{preview.js => previews.js} (100%) rename core/server/api/canary/{preview.js => previews.js} (97%) rename core/server/api/canary/utils/serializers/output/{preview.js => previews.js} (83%) rename test/unit/api/canary/utils/serializers/output/{preview.test.js => previews.test.js} (88%) rename test/unit/frontend/services/routing/controllers/{preview.test.js => previews.test.js} (89%) diff --git a/core/frontend/services/routing/PreviewRouter.js b/core/frontend/services/routing/PreviewRouter.js index 3e57fb5ad5..969bb61bb4 100644 --- a/core/frontend/services/routing/PreviewRouter.js +++ b/core/frontend/services/routing/PreviewRouter.js @@ -9,7 +9,7 @@ class PreviewRouter extends ParentRouter { constructor(RESOURCE_CONFIG) { super('PreviewRouter'); - this.RESOURCE_CONFIG = RESOURCE_CONFIG.QUERY.preview; + this.RESOURCE_CONFIG = RESOURCE_CONFIG.QUERY.previews; // @NOTE: hardcoded, not configureable this.route = {value: '/p/'}; @@ -25,8 +25,8 @@ class PreviewRouter extends ParentRouter { // REGISTER: prepare context this.router().use(this._prepareContext.bind(this)); - // REGISTER: actual preview route - this.mountRoute(urlUtils.urlJoin(this.route.value, ':uuid', ':options?'), controllers.preview); + // REGISTER: actual previews route + this.mountRoute(urlUtils.urlJoin(this.route.value, ':uuid', ':options?'), controllers.previews); } /** diff --git a/core/frontend/services/routing/config.js b/core/frontend/services/routing/config.js index cd35bd473c..a45f03b389 100644 --- a/core/frontend/services/routing/config.js +++ b/core/frontend/services/routing/config.js @@ -32,9 +32,9 @@ module.exports.QUERY = { slug: '%s' } }, - preview: { - controller: 'preview', - resource: 'preview' + previews: { + controller: 'previews', + resource: 'previews' }, email: { controller: 'emailPost', diff --git a/core/frontend/services/routing/controllers/index.js b/core/frontend/services/routing/controllers/index.js index 8c9c4e6166..a60a9c48d4 100644 --- a/core/frontend/services/routing/controllers/index.js +++ b/core/frontend/services/routing/controllers/index.js @@ -11,8 +11,8 @@ module.exports = { return require('./rss'); }, - get preview() { - return require('./preview'); + get previews() { + return require('./previews'); }, get email() { diff --git a/core/frontend/services/routing/controllers/preview.js b/core/frontend/services/routing/controllers/previews.js similarity index 100% rename from core/frontend/services/routing/controllers/preview.js rename to core/frontend/services/routing/controllers/previews.js diff --git a/core/server/api/canary/index.js b/core/server/api/canary/index.js index 19153e1482..b7d5173aef 100644 --- a/core/server/api/canary/index.js +++ b/core/server/api/canary/index.js @@ -121,8 +121,8 @@ module.exports = { return shared.pipeline(require('./users'), localUtils); }, - get preview() { - return shared.pipeline(require('./preview'), localUtils); + get previews() { + return shared.pipeline(require('./previews'), localUtils); }, get emailPost() { diff --git a/core/server/api/canary/preview.js b/core/server/api/canary/previews.js similarity index 97% rename from core/server/api/canary/preview.js rename to core/server/api/canary/previews.js index a97bcbc87e..d86b6fc48c 100644 --- a/core/server/api/canary/preview.js +++ b/core/server/api/canary/previews.js @@ -8,7 +8,7 @@ const messages = { }; module.exports = { - docName: 'preview', + docName: 'previews', read: { permissions: true, diff --git a/core/server/api/canary/utils/serializers/output/index.js b/core/server/api/canary/utils/serializers/output/index.js index 8f4f325cd0..51b2080b27 100644 --- a/core/server/api/canary/utils/serializers/output/index.js +++ b/core/server/api/canary/utils/serializers/output/index.js @@ -85,8 +85,8 @@ module.exports = { return require('./users'); }, - get preview() { - return require('./preview'); + get previews() { + return require('./previews'); }, get email_post() { diff --git a/core/server/api/canary/utils/serializers/output/preview.js b/core/server/api/canary/utils/serializers/output/previews.js similarity index 83% rename from core/server/api/canary/utils/serializers/output/preview.js rename to core/server/api/canary/utils/serializers/output/previews.js index b60c156d0d..96f400209d 100644 --- a/core/server/api/canary/utils/serializers/output/preview.js +++ b/core/server/api/canary/utils/serializers/output/previews.js @@ -10,8 +10,8 @@ module.exports = { const data = await mappers.posts(model, frame, {tiers}); frame.response = { - preview: [data] + previews: [data] }; - frame.response.preview[0].page = model.get('type') === 'page'; + frame.response.previews[0].page = model.get('type') === 'page'; } }; diff --git a/test/unit/api/canary/utils/serializers/output/preview.test.js b/test/unit/api/canary/utils/serializers/output/previews.test.js similarity index 88% rename from test/unit/api/canary/utils/serializers/output/preview.test.js rename to test/unit/api/canary/utils/serializers/output/previews.test.js index d7b4d77972..6732eb5f78 100644 --- a/test/unit/api/canary/utils/serializers/output/preview.test.js +++ b/test/unit/api/canary/utils/serializers/output/previews.test.js @@ -5,7 +5,7 @@ const mappers = require('../../../../../../../core/server/api/canary/utils/seria const serializers = require('../../../../../../../core/server/api/canary/utils/serializers'); const membersService = require('../../../../../../../core/server/services/members'); -describe('Unit: canary/utils/serializers/output/preview', function () { +describe('Unit: canary/utils/serializers/output/previews', function () { let pageModel; beforeEach(function () { @@ -46,11 +46,11 @@ describe('Unit: canary/utils/serializers/output/preview', function () { type: 'page' })); - await serializers.output.preview.all(ctrlResponse, apiConfig, frame); + await serializers.output.previews.all(ctrlResponse, apiConfig, frame); mappers.posts.callCount.should.equal(1); mappers.posts.getCall(0).args.should.eql([ctrlResponse, frame, {tiers: []}]); - frame.response.preview[0].page.should.equal(true); + frame.response.previews[0].page.should.equal(true); }); }); diff --git a/test/unit/frontend/services/routing/controllers/preview.test.js b/test/unit/frontend/services/routing/controllers/previews.test.js similarity index 89% rename from test/unit/frontend/services/routing/controllers/preview.test.js rename to test/unit/frontend/services/routing/controllers/previews.test.js index 0fbc153d63..cc6f30f29b 100644 --- a/test/unit/frontend/services/routing/controllers/preview.test.js +++ b/test/unit/frontend/services/routing/controllers/previews.test.js @@ -9,7 +9,7 @@ const renderer = require('../../../../../../core/frontend/services/rendering'); const urlService = require('../../../../../../core/server/services/url'); const urlUtils = require('../../../../../../core/shared/url-utils'); -describe('Unit - services/routing/controllers/preview', function () { +describe('Unit - services/routing/controllers/previews', function () { let secureStub; let renderStub; let req; @@ -35,7 +35,7 @@ describe('Unit - services/routing/controllers/preview', function () { post = testUtils.DataGenerator.forKnex.createPost({status: 'draft'}); apiResponse = { - preview: [post] + previews: [post] }; req = { @@ -48,7 +48,7 @@ describe('Unit - services/routing/controllers/preview', function () { res = { routerOptions: { - query: {controller: 'preview', resource: 'preview'} + query: {controller: 'previews', resource: 'previews'} }, locals: {}, render: sinon.spy(), @@ -80,7 +80,7 @@ describe('Unit - services/routing/controllers/preview', function () { include: 'authors,tags,tiers' }).resolves(apiResponse); - sinon.stub(api, 'preview').get(() => { + sinon.stub(api, 'previews').get(() => { return { read: previewStub }; @@ -88,7 +88,7 @@ describe('Unit - services/routing/controllers/preview', function () { }); it('should render post', function (done) { - controllers.preview(req, res, failTest(done)).then(function () { + controllers.previews(req, res, failTest(done)).then(function () { renderStub.called.should.be.true(); secureStub.called.should.be.true(); done();