TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-22 10:21:36 +03:00
Code Issues Projects Releases Wiki Activity
46c806358b
Ghost/core/test/unit/helpers/get_spec.js

462 lines
18 KiB
JavaScript
Raw Normal View History

💄 🐷 Test consistency (#8199) no issue - change out should.equal for // jshint ignore:line - ensure should is the first require in every test, and ALWAYS require - make sinon the second require, and sandbox the last thing - ALWAYS use sandbox, futureproofs tests against contributors who don't know it - change require formatting
2017-03-21 11:24:11 +03:00
var should = require('should'),
sinon = require('sinon'),
Promise = require('bluebird'),
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
📖 replace any support.ghost.org link (#8555) refs #7421
2017-06-08 22:34:20 +03:00
// Stuff we are testing
💄 🐷 Test consistency (#8199) no issue - change out should.equal for // jshint ignore:line - ensure should is the first require in every test, and ALWAYS require - make sinon the second require, and sandbox the last thing - ALWAYS use sandbox, futureproofs tests against contributors who don't know it - change require formatting
2017-03-21 11:24:11 +03:00
helpers = require('../../../server/helpers'),
📖 replace any support.ghost.org link (#8555) refs #7421
2017-06-08 22:34:20 +03:00
models = require('../../../server/models'),
💄 🐷 Test consistency (#8199) no issue - change out should.equal for // jshint ignore:line - ensure should is the first require in every test, and ALWAYS require - make sinon the second require, and sandbox the last thing - ALWAYS use sandbox, futureproofs tests against contributors who don't know it - change require formatting
2017-03-21 11:24:11 +03:00
api = require('../../../server/api'),
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
Moved labs, auth, permissions, settings, mail, themes to services (#9339) refs #9178 - move tests as well
2017-12-14 05:01:23 +03:00
labs = require('../../../server/services/labs'),
Move get helper behind labs flag issue #5976 - break out the labs check into a utility - wrap the get helper in a labs check, so it only works if the checkbox is checked - make the get helper output an error to both the server and browser console if used when not enabled
2015-11-03 22:17:24 +03:00
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
sandbox = sinon.sandbox.create();
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
describe('{{#get}} helper', function () {
🔥 🎨 Cleanup & simplify theme helpers (#8223) no issue 🔥 Remove adminHbs concept from tests 🔥 Get rid of unnecessary helper test utils 🔥 Remove helper missing code - this hasn't been registered / used for ages 😱 - gscan no longer allows us to activate themes that have missing helpers, so this wouldn't be used anyway TODO: consider whether we should make a way to override this? 🎨 Reduce coupling inside of /helpers 🎨 Use settingsCache in ghost_foot ✨ Labs util for enabling helpers 🎨 Move loadCoreHelpers to blog - This needs a proper home, but at the very least it doesn't belong in server/app.js! 🎨 Use settingsCache in ghost_head
2017-03-23 22:00:58 +03:00
var fn, inverse, labsStub;
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
let locals = {};
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
📖 replace any support.ghost.org link (#8555) refs #7421
2017-06-08 22:34:20 +03:00
before(function () {
models.init();
});
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
beforeEach(function () {
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
fn = sandbox.spy();
inverse = sandbox.spy();
🔥 🎨 Cleanup & simplify theme helpers (#8223) no issue 🔥 Remove adminHbs concept from tests 🔥 Get rid of unnecessary helper test utils 🔥 Remove helper missing code - this hasn't been registered / used for ages 😱 - gscan no longer allows us to activate themes that have missing helpers, so this wouldn't be used anyway TODO: consider whether we should make a way to override this? 🎨 Reduce coupling inside of /helpers 🎨 Use settingsCache in ghost_foot ✨ Labs util for enabling helpers 🎨 Move loadCoreHelpers to blog - This needs a proper home, but at the very least it doesn't belong in server/app.js! 🎨 Use settingsCache in ghost_head
2017-03-23 22:00:58 +03:00
labsStub = sandbox.stub(labs, 'isSet').returns(true);
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
locals = {root: {_locals: {apiVersion: 'v0.1'}}};
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
});
afterEach(function () {
sandbox.restore();
});
🔥 🎨 Cleanup & simplify theme helpers (#8223) no issue 🔥 Remove adminHbs concept from tests 🔥 Get rid of unnecessary helper test utils 🔥 Remove helper missing code - this hasn't been registered / used for ages 😱 - gscan no longer allows us to activate themes that have missing helpers, so this wouldn't be used anyway TODO: consider whether we should make a way to override this? 🎨 Reduce coupling inside of /helpers 🎨 Use settingsCache in ghost_foot ✨ Labs util for enabling helpers 🎨 Move loadCoreHelpers to blog - This needs a proper home, but at the very least it doesn't belong in server/app.js! 🎨 Use settingsCache in ghost_head
2017-03-23 22:00:58 +03:00
it('errors correctly if labs flag not set', function (done) {
labsStub.returns(false);
helpers.get.call(
{},
'posts',
{hash: {}, fn: fn, inverse: inverse}
).then(function (result) {
labsStub.calledOnce.should.be.true();
fn.called.should.be.false();
inverse.called.should.be.false();
should.exist(result);
result.should.be.a.Function();
result().should.be.an.Object().with.property(
'string',
'<script>console.error("The {{get}} helper is not available. ' +
🐛 Added 409 DisabledFeatureError for labs features (#8890) fixes #8889 - This is a user error, not a system error - Downgrading to a 4xx status code means it doesn't appear in logs where it shouldn't - We didn't have a suitable error available so I added DisabledFeatureError with 409 status - Ref: https://stackoverflow.com/questions/36874263/expected-http-status-code-for-an-action-on-a-disabled-resource - Also tweaked the error message slightly as it didn't read clearly to me
2017-08-15 11:50:36 +03:00
'The Public API flag must be enabled in labs if you wish to use the {{get}} helper. ' +
📖 replace any support.ghost.org link (#8555) refs #7421
2017-06-08 22:34:20 +03:00
'See https://help.ghost.org/hc/en-us/articles/115000301672-Public-API-Beta");</script>'
🔥 🎨 Cleanup & simplify theme helpers (#8223) no issue 🔥 Remove adminHbs concept from tests 🔥 Get rid of unnecessary helper test utils 🔥 Remove helper missing code - this hasn't been registered / used for ages 😱 - gscan no longer allows us to activate themes that have missing helpers, so this wouldn't be used anyway TODO: consider whether we should make a way to override this? 🎨 Reduce coupling inside of /helpers 🎨 Use settingsCache in ghost_foot ✨ Labs util for enabling helpers 🎨 Move loadCoreHelpers to blog - This needs a proper home, but at the very least it doesn't belong in server/app.js! 🎨 Use settingsCache in ghost_head
2017-03-23 22:00:58 +03:00
);
done();
}).catch(done);
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
});
Extended resource lookup in {{get}} helper refs #10061 - prep task to add authors for content API
2018-11-06 16:08:13 +03:00
describe('posts v0.1', function () {
Remove featured, tag, author & role API params refs #5943 - removed featured, tag and author parameters from posts API - featured was only used in tests - removed role filter from users API - role was only used in tests - fixed up the tests, skipping those that don't quite work yet
2015-10-24 23:39:47 +03:00
var browsePostsStub, readPostsStub, readTagsStub, readUsersStub, testPostsArr = [
💄 🐷 Test consistency (#8199) no issue - change out should.equal for // jshint ignore:line - ensure should is the first require in every test, and ALWAYS require - make sinon the second require, and sandbox the last thing - ALWAYS use sandbox, futureproofs tests against contributors who don't know it - change require formatting
2017-03-21 11:24:11 +03:00
{id: 1, title: 'Test Post 1', author: {slug: 'cameron'}},
{id: 2, title: 'Test Post 2', author: {slug: 'cameron'}, featured: true},
{id: 3, title: 'Test Post 3', tags: [{slug: 'test'}]},
{id: 4, title: 'Test Post 4'}
],
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
meta = {pagination: {}};
🔥 🎨 Cleanup & simplify theme helpers (#8223) no issue 🔥 Remove adminHbs concept from tests 🔥 Get rid of unnecessary helper test utils 🔥 Remove helper missing code - this hasn't been registered / used for ages 😱 - gscan no longer allows us to activate themes that have missing helpers, so this wouldn't be used anyway TODO: consider whether we should make a way to override this? 🎨 Reduce coupling inside of /helpers 🎨 Use settingsCache in ghost_foot ✨ Labs util for enabling helpers 🎨 Move loadCoreHelpers to blog - This needs a proper home, but at the very least it doesn't belong in server/app.js! 🎨 Use settingsCache in ghost_head
2017-03-23 22:00:58 +03:00
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
beforeEach(function () {
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
browsePostsStub = sandbox.stub(api["v0.1"].posts, 'browse');
readPostsStub = sandbox.stub(api["v0.1"].posts, 'read');
readTagsStub = sandbox.stub(api["v0.1"].tags, 'read').returns(new Promise.resolve({tags: []}));
readUsersStub = sandbox.stub(api["v0.1"].users, 'read').returns(new Promise.resolve({users: []}));
Remove featured, tag, author & role API params refs #5943 - removed featured, tag and author parameters from posts API - featured was only used in tests - removed role filter from users API - role was only used in tests - fixed up the tests, skipping those that don't quite work yet
2015-10-24 23:39:47 +03:00
Ensure {{get}} helper returns pagination No Issue - pagination returned if meta pagination exists - needed to allow pagination helper to work
2015-12-14 16:19:38 +03:00
browsePostsStub.returns(new Promise.resolve({posts: testPostsArr, meta: meta}));
💄 🐷 Test consistency (#8199) no issue - change out should.equal for // jshint ignore:line - ensure should is the first require in every test, and ALWAYS require - make sinon the second require, and sandbox the last thing - ALWAYS use sandbox, futureproofs tests against contributors who don't know it - change require formatting
2017-03-21 11:24:11 +03:00
browsePostsStub.withArgs({limit: '3'}).returns(new Promise.resolve({
posts: testPostsArr.slice(0, 3),
meta: meta
}));
Remove featured, tag, author & role API params refs #5943 - removed featured, tag and author parameters from posts API - featured was only used in tests - removed role filter from users API - role was only used in tests - fixed up the tests, skipping those that don't quite work yet
2015-10-24 23:39:47 +03:00
browsePostsStub.withArgs({limit: '1'}).returns(new Promise.resolve({posts: testPostsArr.slice(0, 1)}));
browsePostsStub.withArgs({filter: 'tags:test'}).returns(new Promise.resolve({posts: testPostsArr.slice(2, 3)}));
browsePostsStub.withArgs({filter: 'tags:none'}).returns(new Promise.resolve({posts: []}));
browsePostsStub.withArgs({filter: 'author:cameron'}).returns(new Promise.resolve({posts: testPostsArr.slice(0, 2)}));
browsePostsStub.withArgs({filter: 'featured:true'}).returns(new Promise.resolve({posts: testPostsArr.slice(2, 3)}));
readPostsStub.withArgs({id: '2'}).returns(new Promise.resolve({posts: testPostsArr.slice(1, 2)}));
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
});
it('should handle default browse posts call', function (done) {
helpers.get.call(
{},
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {}, data: locals, fn: fn, inverse: inverse}
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
).then(function () {
🔥 🎨 Cleanup & simplify theme helpers (#8223) no issue 🔥 Remove adminHbs concept from tests 🔥 Get rid of unnecessary helper test utils 🔥 Remove helper missing code - this hasn't been registered / used for ages 😱 - gscan no longer allows us to activate themes that have missing helpers, so this wouldn't be used anyway TODO: consider whether we should make a way to override this? 🎨 Reduce coupling inside of /helpers 🎨 Use settingsCache in ghost_foot ✨ Labs util for enabling helpers 🎨 Move loadCoreHelpers to blog - This needs a proper home, but at the very least it doesn't belong in server/app.js! 🎨 Use settingsCache in ghost_head
2017-03-23 22:00:58 +03:00
labsStub.calledOnce.should.be.true();
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
fn.called.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
fn.firstCall.args[0].posts.should.eql(testPostsArr);
fn.firstCall.args[0].posts.should.have.lengthOf(4);
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
inverse.called.should.be.false();
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
done();
}).catch(done);
});
Ensure {{get}} helper returns pagination No Issue - pagination returned if meta pagination exists - needed to allow pagination helper to work
2015-12-14 16:19:38 +03:00
it('should return pagination and meta pagination with default browse posts call', function (done) {
helpers.get.call(
{},
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {}, data: locals, fn: fn, inverse: inverse}
Ensure {{get}} helper returns pagination No Issue - pagination returned if meta pagination exists - needed to allow pagination helper to work
2015-12-14 16:19:38 +03:00
).then(function () {
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
fn.firstCall.args[0].pagination.should.be.an.Object();
fn.firstCall.args[0].meta.should.be.an.Object();
fn.firstCall.args[0].meta.pagination.should.be.an.Object();
inverse.called.should.be.false();
Ensure {{get}} helper returns pagination No Issue - pagination returned if meta pagination exists - needed to allow pagination helper to work
2015-12-14 16:19:38 +03:00
done();
}).catch(done);
});
it('should not return pagination if meta pagination does not exist', function (done) {
helpers.get.call(
{},
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {limit: '1'}, data: locals, fn: fn, inverse: inverse}
Ensure {{get}} helper returns pagination No Issue - pagination returned if meta pagination exists - needed to allow pagination helper to work
2015-12-14 16:19:38 +03:00
).then(function () {
should.not.exist(fn.firstCall.args[0].pagination);
should.not.exist(fn.firstCall.args[0].meta);
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
inverse.called.should.be.false();
Ensure {{get}} helper returns pagination No Issue - pagination returned if meta pagination exists - needed to allow pagination helper to work
2015-12-14 16:19:38 +03:00
done();
}).catch(done);
});
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
it('should handle browse posts call with limit 3', function (done) {
helpers.get.call(
{},
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {limit: '3'}, data: locals, fn: fn, inverse: inverse}
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
).then(function () {
💄 🐷 Test consistency (#8199) no issue - change out should.equal for // jshint ignore:line - ensure should is the first require in every test, and ALWAYS require - make sinon the second require, and sandbox the last thing - ALWAYS use sandbox, futureproofs tests against contributors who don't know it - change require formatting
2017-03-21 11:24:11 +03:00
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
fn.firstCall.args[0].posts.should.have.lengthOf(3);
fn.firstCall.args[0].posts.should.eql(testPostsArr.slice(0, 3));
inverse.called.should.be.false();
done();
}).catch(done);
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
});
it('should handle browse posts call with limit 1', function (done) {
helpers.get.call(
{},
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {limit: '1'}, data: locals, fn: fn, inverse: inverse}
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
).then(function () {
💄 🐷 Test consistency (#8199) no issue - change out should.equal for // jshint ignore:line - ensure should is the first require in every test, and ALWAYS require - make sinon the second require, and sandbox the last thing - ALWAYS use sandbox, futureproofs tests against contributors who don't know it - change require formatting
2017-03-21 11:24:11 +03:00
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
fn.firstCall.args[0].posts.should.have.lengthOf(1);
fn.firstCall.args[0].posts.should.eql(testPostsArr.slice(0, 1));
inverse.called.should.be.false();
done();
}).catch(done);
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
});
it('should handle browse posts call with limit 1', function (done) {
helpers.get.call(
{},
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {limit: '1'}, data: locals, fn: fn, inverse: inverse}
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
).then(function () {
💄 🐷 Test consistency (#8199) no issue - change out should.equal for // jshint ignore:line - ensure should is the first require in every test, and ALWAYS require - make sinon the second require, and sandbox the last thing - ALWAYS use sandbox, futureproofs tests against contributors who don't know it - change require formatting
2017-03-21 11:24:11 +03:00
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
fn.firstCall.args[0].posts.should.have.lengthOf(1);
fn.firstCall.args[0].posts.should.eql(testPostsArr.slice(0, 1));
inverse.called.should.be.false();
done();
}).catch(done);
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
});
it('should handle browse post call with explicit tag', function (done) {
helpers.get.call(
{},
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {filter: 'tags:test'}, data: locals, fn: fn, inverse: inverse}
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
).then(function () {
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
fn.firstCall.args[0].posts.should.have.lengthOf(1);
fn.firstCall.args[0].posts.should.eql(testPostsArr.slice(2, 3));
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
inverse.called.should.be.false();
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
done();
}).catch(done);
});
it('should handle browse post call with explicit author', function (done) {
helpers.get.call(
{},
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {filter: 'author:cameron'}, data: locals, fn: fn, inverse: inverse}
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
).then(function () {
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
fn.firstCall.args[0].posts.should.have.lengthOf(2);
fn.firstCall.args[0].posts.should.eql(testPostsArr.slice(0, 2));
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
inverse.called.should.be.false();
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
done();
}).catch(done);
});
it('should handle browse post call with featured:true', function (done) {
helpers.get.call(
{},
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {filter: 'featured:true'}, data: locals, fn: fn, inverse: inverse}
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
).then(function () {
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
fn.firstCall.args[0].posts.should.have.lengthOf(1);
fn.firstCall.args[0].posts.should.eql(testPostsArr.slice(2, 3));
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
inverse.called.should.be.false();
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
done();
}).catch(done);
});
it('should handle read post by id call', function (done) {
helpers.get.call(
{},
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {id: '2'}, data: locals, fn: fn, inverse: inverse}
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
).then(function () {
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
fn.firstCall.args[0].posts.should.have.lengthOf(1);
fn.firstCall.args[0].posts.should.eql(testPostsArr.slice(1, 2));
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
inverse.called.should.be.false();
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
done();
}).catch(done);
});
it('should handle empty result set', function (done) {
helpers.get.call(
{},
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {filter: 'tags:none'}, data: locals, fn: fn, inverse: inverse}
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
).then(function () {
✨ 🎨 Allow foreach else inside of get helper (#8160) closes #7242 - before this, the get helper's else was used for empty resultsets - the argument was made that we should fall through to a foreach or with helper's else instead - I agree that this is the more natural, consistent approach, and so would like to change it for Ghost 1.0 E.g. as of this PR we now have: {{#get "posts" filter="tag:doesnt-exist"}} {{#foreach posts}} {{else}} this ges executed because there are no results {{/foreach}} {{/get}} instead of {{#get "posts" filter="tag:doesnt-exist"}} {{#foreach posts}} {{else}} {{/foreach}} {{each}} this ges executed because there are no results {{/get}}
2017-03-14 19:44:52 +03:00
fn.calledOnce.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('posts');
fn.firstCall.args[0].posts.should.have.lengthOf(0);
inverse.called.should.be.false();
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
done();
}).catch(done);
});
});
Extended resource lookup in {{get}} helper refs #10061 - prep task to add authors for content API
2018-11-06 16:08:13 +03:00
describe('users v0.1', function () {
let browseUsersStub;
const meta = {pagination: {}};
beforeEach(function () {
browseUsersStub = sandbox.stub(api["v0.1"].users, 'browse');
browseUsersStub.returns(new Promise.resolve({users: [], meta: meta}));
});
it('browse users v0.1', function (done) {
helpers.get.call(
{},
'users',
{hash: {}, data: locals, fn: fn, inverse: inverse}
).then(function () {
labsStub.calledOnce.should.be.true();
fn.called.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('users');
fn.firstCall.args[0].users.should.eql([]);
inverse.called.should.be.false();
done();
}).catch(done);
});
});
describe('users v2', function () {
let browseUsersStub;
const meta = {pagination: {}};
beforeEach(function () {
locals = {root: {_locals: {apiVersion: 'v2'}}};
browseUsersStub = sandbox.stub(api["v2"], 'users').get(() => {
return {
browse: sandbox.stub().resolves({users: [], meta: meta})
};
});
});
it('browse users', function (done) {
helpers.get.call(
{},
'users',
{hash: {}, data: locals, fn: fn, inverse: inverse}
).then(function () {
labsStub.calledOnce.should.be.true();
fn.called.should.be.true();
fn.firstCall.args[0].should.be.an.Object().with.property('users');
fn.firstCall.args[0].users.should.eql([]);
inverse.called.should.be.false();
done();
}).catch(done);
});
});
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
describe('general error handling', function () {
it('should return an error for an unknown resource', function (done) {
helpers.get.call(
{},
'magic',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {}, data: locals, fn: fn, inverse: inverse}
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
).then(function () {
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
fn.called.should.be.false();
inverse.calledOnce.should.be.true();
inverse.firstCall.args[1].should.be.an.Object().and.have.property('data');
inverse.firstCall.args[1].data.should.be.an.Object().and.have.property('error');
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
inverse.firstCall.args[1].data.error.should.eql('Invalid resource given to get helper');
done();
}).catch(done);
});
it('should handle error from the API', function (done) {
helpers.get.call(
{},
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {status: 'thing!'}, data: locals, fn: fn, inverse: inverse}
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
).then(function () {
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
fn.called.should.be.false();
inverse.calledOnce.should.be.true();
inverse.firstCall.args[1].should.be.an.Object().and.have.property('data');
inverse.firstCall.args[1].data.should.be.an.Object().and.have.property('error');
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
inverse.firstCall.args[1].data.error.should.match(/^Validation/);
done();
}).catch(done);
});
it('should show warning for call without any options', function (done) {
helpers.get.call(
{},
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
'posts',
{data: locals}
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
).then(function () {
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
fn.called.should.be.false();
inverse.called.should.be.false();
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
done();
}).catch(done);
});
});
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
describe('path resolution', function () {
🐛Fixed {{get}} helper's date comparison (#9454) no issue - Date comparisons are possible via API, but there's no way to inject a valid date into the get helper - JavaScript's Date.toString() function outputs dates in a useless format - Swap to using Date.toISOString() and now the format can be understood anywhere! - {{#get "posts" filter="published_at:<='{{published_at}}'"}}{{/get}} works now as expected
2018-02-14 20:33:07 +03:00
var browseStub, readStub,
pubDate = new Date(),
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
resource = {
🐛Fixed {{get}} helper's date comparison (#9454) no issue - Date comparisons are possible via API, but there's no way to inject a valid date into the get helper - JavaScript's Date.toString() function outputs dates in a useless format - Swap to using Date.toISOString() and now the format can be understood anywhere! - {{#get "posts" filter="published_at:<='{{published_at}}'"}}{{/get}} works now as expected
2018-02-14 20:33:07 +03:00
post: {id: 3, title: 'Test 3', author: {slug: 'cameron'}, tags: [{slug: 'test'}, {slug: 'magic'}], published_at: pubDate}
};
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
beforeEach(function () {
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
browseStub = sandbox.stub(api["v0.1"].posts, 'browse').returns(new Promise.resolve());
readStub = sandbox.stub(api["v0.1"].posts, 'read').returns(new Promise.resolve());
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
});
it('should resolve post.tags alias', function (done) {
helpers.get.call(
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
resource,
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {filter: 'tags:[{{post.tags}}]'}, data: locals, fn: fn, inverse: inverse}
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
).then(function () {
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
browseStub.firstCall.args.should.be.an.Array().with.lengthOf(1);
browseStub.firstCall.args[0].should.be.an.Object().with.property('filter');
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
browseStub.firstCall.args[0].filter.should.eql('tags:[test,magic]');
done();
}).catch(done);
});
it('should resolve post.author alias', function (done) {
helpers.get.call(
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
resource,
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {filter: 'author:{{post.author}}'}, data: locals, fn: fn, inverse: inverse}
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
).then(function () {
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
browseStub.firstCall.args.should.be.an.Array().with.lengthOf(1);
browseStub.firstCall.args[0].should.be.an.Object().with.property('filter');
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
browseStub.firstCall.args[0].filter.should.eql('author:cameron');
done();
}).catch(done);
});
it('should resolve basic path', function (done) {
helpers.get.call(
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
resource,
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {filter: 'id:-{{post.id}}'}, data: locals, fn: fn, inverse: inverse}
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
).then(function () {
💄 🐷 Test consistency (#8199) no issue - change out should.equal for // jshint ignore:line - ensure should is the first require in every test, and ALWAYS require - make sinon the second require, and sandbox the last thing - ALWAYS use sandbox, futureproofs tests against contributors who don't know it - change require formatting
2017-03-21 11:24:11 +03:00
browseStub.firstCall.args.should.be.an.Array().with.lengthOf(1);
browseStub.firstCall.args[0].should.be.an.Object().with.property('filter');
browseStub.firstCall.args[0].filter.should.eql('id:-3');
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
💄 🐷 Test consistency (#8199) no issue - change out should.equal for // jshint ignore:line - ensure should is the first require in every test, and ALWAYS require - make sinon the second require, and sandbox the last thing - ALWAYS use sandbox, futureproofs tests against contributors who don't know it - change require formatting
2017-03-21 11:24:11 +03:00
done();
}).catch(done);
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
});
it('should handle arrays the same as handlebars', function (done) {
helpers.get.call(
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
resource,
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {filter: 'tags:{{post.tags.[0].slug}}'}, data: locals, fn: fn, inverse: inverse}
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
).then(function () {
deps: should@8.2.1 closes #6448 -upgraded should.js to the latest version (8.2.1) -Changed the tests so that they comply with the breaking changes introduced in the new version of should.js -Installs the package should-http so should.be.json() can be used -Installs the package should-sinon so that should.be.calledOnce() can be used
2016-02-08 00:27:01 +03:00
browseStub.firstCall.args.should.be.an.Array().with.lengthOf(1);
browseStub.firstCall.args[0].should.be.an.Object().with.property('filter');
🔥 🎨 Cleanup & simplify theme helpers (#8223) no issue 🔥 Remove adminHbs concept from tests 🔥 Get rid of unnecessary helper test utils 🔥 Remove helper missing code - this hasn't been registered / used for ages 😱 - gscan no longer allows us to activate themes that have missing helpers, so this wouldn't be used anyway TODO: consider whether we should make a way to override this? 🎨 Reduce coupling inside of /helpers 🎨 Use settingsCache in ghost_foot ✨ Labs util for enabling helpers 🎨 Move loadCoreHelpers to blog - This needs a proper home, but at the very least it doesn't belong in server/app.js! 🎨 Use settingsCache in ghost_head
2017-03-23 22:00:58 +03:00
browseStub.firstCall.args[0].filter.should.eql('tags:test');
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
done();
}).catch(done);
});
🐛Fixed {{get}} helper's date comparison (#9454) no issue - Date comparisons are possible via API, but there's no way to inject a valid date into the get helper - JavaScript's Date.toString() function outputs dates in a useless format - Swap to using Date.toISOString() and now the format can be understood anywhere! - {{#get "posts" filter="published_at:<='{{published_at}}'"}}{{/get}} works now as expected
2018-02-14 20:33:07 +03:00
it('should handle dates', function (done) {
helpers.get.call(
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
resource,
🐛Fixed {{get}} helper's date comparison (#9454) no issue - Date comparisons are possible via API, but there's no way to inject a valid date into the get helper - JavaScript's Date.toString() function outputs dates in a useless format - Swap to using Date.toISOString() and now the format can be understood anywhere! - {{#get "posts" filter="published_at:<='{{published_at}}'"}}{{/get}} works now as expected
2018-02-14 20:33:07 +03:00
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {filter: "published_at:<='{{post.published_at}}'"}, data: locals, fn: fn, inverse: inverse}
🐛Fixed {{get}} helper's date comparison (#9454) no issue - Date comparisons are possible via API, but there's no way to inject a valid date into the get helper - JavaScript's Date.toString() function outputs dates in a useless format - Swap to using Date.toISOString() and now the format can be understood anywhere! - {{#get "posts" filter="published_at:<='{{published_at}}'"}}{{/get}} works now as expected
2018-02-14 20:33:07 +03:00
).then(function () {
browseStub.firstCall.args.should.be.an.Array().with.lengthOf(1);
browseStub.firstCall.args[0].should.be.an.Object().with.property('filter');
browseStub.firstCall.args[0].filter.should.eql(`published_at:<='${pubDate.toISOString()}'`);
done();
}).catch(done);
});
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
it('should output nothing if path does not resolve', function (done) {
helpers.get.call(
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
resource,
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
'posts',
Updated blog site components to respect the api version refs #9866 - the api call must be dynamic based on the api version information
2018-10-17 10:23:59 +03:00
{hash: {filter: 'id:{{post.thing}}'}, data: locals, fn: fn, inverse: inverse}
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
).then(function () {
💄 🐷 Test consistency (#8199) no issue - change out should.equal for // jshint ignore:line - ensure should is the first require in every test, and ALWAYS require - make sinon the second require, and sandbox the last thing - ALWAYS use sandbox, futureproofs tests against contributors who don't know it - change require formatting
2017-03-21 11:24:11 +03:00
browseStub.firstCall.args.should.be.an.Array().with.lengthOf(1);
browseStub.firstCall.args[0].should.be.an.Object().with.property('filter');
browseStub.firstCall.args[0].filter.should.eql('id:');
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
💄 🐷 Test consistency (#8199) no issue - change out should.equal for // jshint ignore:line - ensure should is the first require in every test, and ALWAYS require - make sinon the second require, and sandbox the last thing - ALWAYS use sandbox, futureproofs tests against contributors who don't know it - change require formatting
2017-03-21 11:24:11 +03:00
done();
}).catch(done);
Add path resolution to get helper refs #5993 - deps: jsonpath@0.2.0 - adds `resolvePaths` method - supports handlebars style arrays with `.[]` - supports shorthand post.tags and post.author for common usecases - adds more tests & improves existing ones
2015-10-22 13:12:21 +03:00
});
});
The {{#get}} helper closes #4439 - adds basic get helper which works with the current API - allows theme developers to make requests against the API - supports block params and @error message - includes 100% test coverage using posts ---- The `{{#get}}` helper is an asynchronous block helper which allows for making requests for data from the API. This allows theme developers to customise the data which can be shown on a particular page of a blog. Requests can be made to the posts, tags or users API endpoints: ``` {{#get "posts" limit="3"}} {{#foreach posts}} <a href="{{url}}">{{title}}</a> {{/foreach}} {{/get}} ``` The `{{#get}}` helper must be used as a block helper, it supports `{{else}}` logic, for when no data matching the request is available or if an error has occurred: ``` {{#get "posts" tag="photo"}} ... {{else}} {{#if @error}} <p>Something went wrong: {{@error}}</p> {{else}} <p>No posts found</p> {{/if}} {{/get}} ``` The helper also supports block params, meaning the data it outputs can be given a different name: ``` {{#get "posts" featured="true" as |featured|}} {{#foreach featured}} ... {{/foreach}} {{/get}} ``` Please Note: At present asynchronous helpers cannot be nested.
2015-06-27 18:42:10 +03:00
});
Reference in New Issue Copy Permalink