From ab5199267b6f0994daec9f80f555d62c6e9b355e Mon Sep 17 00:00:00 2001 From: kirrg001 Date: Wed, 25 Apr 2018 19:37:39 +0200 Subject: [PATCH] Renamed `urlService.getUrl` to `urlService.getUrlByResourceId` no issue - explicit function naming - no functional change, only renaming --- core/server/models/post.js | 2 +- core/server/services/url/UrlService.js | 2 +- .../test/unit/services/url/UrlService_spec.js | 92 +++++++++---------- 3 files changed, 48 insertions(+), 48 deletions(-) diff --git a/core/server/models/post.js b/core/server/models/post.js index 1da961ef94..66e3ece588 100644 --- a/core/server/models/post.js +++ b/core/server/models/post.js @@ -375,7 +375,7 @@ Post = ghostBookshelf.Model.extend({ * - `author_id`: /:author/:slug, /:primary_author/:slug * - @TODO: with channels, we no longer need these * - because the url service pre-generates urls based on the resources - * - you can ask `urlService.getUrl(post.id)` + * - you can ask `urlService.getUrlByResourceId(post.id)` * - @TODO: there is currently a bug in here * - you request `fields=title,url` * - you don't use `include=tags` diff --git a/core/server/services/url/UrlService.js b/core/server/services/url/UrlService.js index aec39c5f90..a953a0b748 100644 --- a/core/server/services/url/UrlService.js +++ b/core/server/services/url/UrlService.js @@ -117,7 +117,7 @@ class UrlService { /** * Get url by resource id. */ - getUrl(id) { + getUrlByResourceId(id) { const obj = this.urls.getByResourceId(id); if (obj) { diff --git a/core/test/unit/services/url/UrlService_spec.js b/core/test/unit/services/url/UrlService_spec.js index 4823e8ed5d..b463fece11 100644 --- a/core/test/unit/services/url/UrlService_spec.js +++ b/core/test/unit/services/url/UrlService_spec.js @@ -167,43 +167,43 @@ describe('Unit: services/url/UrlService', function () { } }); - let url = urlService.getUrl(testUtils.DataGenerator.forKnex.posts[0].id); + let url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.posts[0].id); url.should.eql('/html-ipsum/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.posts[1].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.posts[1].id); url.should.eql('/ghostly-kitchen-sink/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.posts[2].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.posts[2].id); should.not.exist(url); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.tags[0].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.tags[0].id); url.should.eql('/tag/kitchen-sink/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.tags[1].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.tags[1].id); url.should.eql('/tag/bacon/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.tags[2].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.tags[2].id); url.should.eql('/tag/chorizo/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.tags[3].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.tags[3].id); url.should.eql('/tag/pollo/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.tags[4].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.tags[4].id); url.should.eql('/tag/injection/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.users[0].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.users[0].id); url.should.eql('/author/joe-bloggs/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.users[1].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.users[1].id); url.should.eql('/author/smith-wellingsworth/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.users[2].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.users[2].id); url.should.eql('/author/jimothy-bogendath/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.users[3].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.users[3].id); url.should.eql('/author/slimer-mcectoplasm/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.users[4].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.users[4].id); url.should.eql('/author/contributor/'); }); @@ -220,7 +220,7 @@ describe('Unit: services/url/UrlService', function () { return models.Post.edit({featured: true}, {id: testUtils.DataGenerator.forKnex.posts[1].id}) .then(function (post) { // There is no collection which owns featured posts. - let url = urlService.getUrl(post.id); + let url = urlService.getUrlByResourceId(post.id); should.not.exist(url); urlService.urlGenerators.forEach(function (generator) { @@ -238,7 +238,7 @@ describe('Unit: services/url/UrlService', function () { it('page: false => page:true', function () { return models.Post.edit({page: true}, {id: testUtils.DataGenerator.forKnex.posts[1].id}) .then(function (post) { - let url = urlService.getUrl(post.id); + let url = urlService.getUrlByResourceId(post.id); url.should.eql('/ghostly-kitchen-sink/'); @@ -257,7 +257,7 @@ describe('Unit: services/url/UrlService', function () { it('page: true => page:false', function () { return models.Post.edit({page: false}, {id: testUtils.DataGenerator.forKnex.posts[5].id}) .then(function (post) { - let url = urlService.getUrl(post.id); + let url = urlService.getUrlByResourceId(post.id); url.should.eql('/static-page-test/'); @@ -283,7 +283,7 @@ describe('Unit: services/url/UrlService', function () { title: 'Brand New Story!', author_id: testUtils.DataGenerator.forKnex.users[4].id }).then(function (post) { - let url = urlService.getUrl(post.id); + let url = urlService.getUrlByResourceId(post.id); url.should.eql('/brand-new-story/'); let resource = urlService.getResource(url); @@ -299,7 +299,7 @@ describe('Unit: services/url/UrlService', function () { title: 'Brand New Story!', author_id: testUtils.DataGenerator.forKnex.users[4].id }).then(function (post) { - let url = urlService.getUrl(post.id); + let url = urlService.getUrlByResourceId(post.id); should.not.exist(url); let resource = urlService.getResource(url); @@ -461,44 +461,44 @@ describe('Unit: services/url/UrlService', function () { } }); - let url = urlService.getUrl(testUtils.DataGenerator.forKnex.posts[0].id); + let url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.posts[0].id); url.should.eql('/collection/2015/html-ipsum/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.posts[1].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.posts[1].id); url.should.eql('/collection/2015/ghostly-kitchen-sink/'); // featured - url = urlService.getUrl(testUtils.DataGenerator.forKnex.posts[2].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.posts[2].id); url.should.eql('/podcast/short-and-sweet/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.tags[0].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.tags[0].id); url.should.eql('/category/kitchen-sink/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.tags[1].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.tags[1].id); url.should.eql('/category/bacon/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.tags[2].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.tags[2].id); url.should.eql('/category/chorizo/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.tags[3].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.tags[3].id); url.should.eql('/category/pollo/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.tags[4].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.tags[4].id); url.should.eql('/category/injection/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.users[0].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.users[0].id); url.should.eql('/persons/joe-bloggs/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.users[1].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.users[1].id); url.should.eql('/persons/smith-wellingsworth/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.users[2].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.users[2].id); url.should.eql('/persons/jimothy-bogendath/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.users[3].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.users[3].id); url.should.eql('/persons/slimer-mcectoplasm/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.users[4].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.users[4].id); url.should.eql('/persons/contributor/'); }); @@ -507,7 +507,7 @@ describe('Unit: services/url/UrlService', function () { return models.Post.edit({featured: true}, {id: testUtils.DataGenerator.forKnex.posts[1].id}) .then(function (post) { // There is no collection which owns featured posts. - let url = urlService.getUrl(post.id); + let url = urlService.getUrlByResourceId(post.id); url.should.eql('/podcast/ghostly-kitchen-sink/'); urlService.urlGenerators.forEach(function (generator) { @@ -526,7 +526,7 @@ describe('Unit: services/url/UrlService', function () { return models.Post.edit({featured: false}, {id: testUtils.DataGenerator.forKnex.posts[2].id}) .then(function (post) { // There is no collection which owns featured posts. - let url = urlService.getUrl(post.id); + let url = urlService.getUrlByResourceId(post.id); url.should.eql('/collection/2015/short-and-sweet/'); urlService.urlGenerators.forEach(function (generator) { @@ -698,44 +698,44 @@ describe('Unit: services/url/UrlService', function () { } }); - let url = urlService.getUrl(testUtils.DataGenerator.forKnex.posts[0].id); + let url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.posts[0].id); url.should.eql('/blog/collection/2015/html-ipsum/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.posts[1].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.posts[1].id); url.should.eql('/blog/collection/2015/ghostly-kitchen-sink/'); // featured - url = urlService.getUrl(testUtils.DataGenerator.forKnex.posts[2].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.posts[2].id); url.should.eql('/blog/podcast/short-and-sweet/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.tags[0].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.tags[0].id); url.should.eql('/blog/category/kitchen-sink/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.tags[1].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.tags[1].id); url.should.eql('/blog/category/bacon/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.tags[2].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.tags[2].id); url.should.eql('/blog/category/chorizo/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.tags[3].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.tags[3].id); url.should.eql('/blog/category/pollo/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.tags[4].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.tags[4].id); url.should.eql('/blog/category/injection/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.users[0].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.users[0].id); url.should.eql('/blog/persons/joe-bloggs/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.users[1].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.users[1].id); url.should.eql('/blog/persons/smith-wellingsworth/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.users[2].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.users[2].id); url.should.eql('/blog/persons/jimothy-bogendath/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.users[3].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.users[3].id); url.should.eql('/blog/persons/slimer-mcectoplasm/'); - url = urlService.getUrl(testUtils.DataGenerator.forKnex.users[4].id); + url = urlService.getUrlByResourceId(testUtils.DataGenerator.forKnex.users[4].id); url.should.eql('/blog/persons/contributor/'); }); });