Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Post response move pagination -> meta #2617

Merged
merged 1 commit into from
Apr 20, 2014
Merged

Post response move pagination -> meta #2617

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions core/client/models/post.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,12 @@

parse: function (resp) {
if (_.isArray(resp.posts)) {
this.limit = resp.limit;
this.currentPage = resp.page;
this.totalPages = resp.pages;
this.totalPosts = resp.total;
this.nextPage = resp.next;
this.prevPage = resp.prev;
this.limit = resp.meta.pagination.limit;
this.currentPage = resp.meta.pagination.page;
this.totalPages = resp.meta.pagination.pages;
this.totalPosts = resp.meta.pagination.total;
this.nextPage = resp.meta.pagination.next;
this.prevPage = resp.meta.pagination.prev;
return resp.posts;
}
return resp;
Expand Down
6 changes: 4 additions & 2 deletions core/server/api/posts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ posts = {
// **takes:** filter / pagination parameters
browse: function browse(options) {
options = options || {};


// only published posts if no user is present
if (!this.user) {
options.status = 'published';
}
Expand All @@ -39,8 +40,9 @@ posts = {
// **takes:** an identifier (id or slug?)
read: function read(options) {
options = options || {};

// only published posts if no user is present
if (!this.user) {
// only published posts for
options.status = 'published';
}

Expand Down
36 changes: 13 additions & 23 deletions core/server/controllers/frontend.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ function getPostPage(options) {
}).then(function (page) {

// A bit of a hack for situations with no content.
if (page.pages === 0) {
page.pages = 1;
if (page.meta.pagination.pages === 0) {

This comment was marked as abuse.

Sign in to view

This comment was marked as abuse.

Sign in to view

page.meta.pagination.pages = 1;
}

return page;
Expand All @@ -44,14 +44,7 @@ function getPostPage(options) {
function formatPageResponse(posts, page) {
return {
posts: posts,
pagination: {
page: page.page,
prev: page.prev,
next: page.next,
limit: page.limit,
total: page.total,
pages: page.pages
}
pagination: page.meta.pagination
};
}

Expand Down Expand Up @@ -79,8 +72,8 @@ frontendControllers = {
return getPostPage(options).then(function (page) {

// If page is greater than number of pages we have, redirect to last page
if (pageParam > page.pages) {
return res.redirect(page.pages === 1 ? config().paths.subdir + '/' : (config().paths.subdir + '/page/' + page.pages + '/'));
if (pageParam > page.meta.pagination.pages) {
return res.redirect(page.meta.pagination.pages === 1 ? config().paths.subdir + '/' : (config().paths.subdir + '/page/' + page.meta.pagination.pages + '/'));
}

// Render the page of posts
Expand Down Expand Up @@ -116,8 +109,8 @@ frontendControllers = {
return getPostPage(options).then(function (page) {

// If page is greater than number of pages we have, redirect to last page
if (pageParam > page.pages) {
return res.redirect(tagUrl(options.tag, page.pages));
if (pageParam > page.meta.pagination.pages) {
return res.redirect(tagUrl(options.tag, page.meta.pagination.pages));
}

// Render the page of posts
Expand Down Expand Up @@ -264,9 +257,7 @@ frontendControllers = {
}
}

// TODO: needs refactor for multi user to not use first user as default
return when.settle([
api.users.read.call({user : 'internal'}, {id : 1}),
api.settings.read('title'),
api.settings.read('description'),
api.settings.read('permalinks')
Expand All @@ -278,13 +269,12 @@ frontendControllers = {

return api.posts.browse(options).then(function (page) {

var user = result[0].value,
title = result[1].value.value,
description = result[2].value.value,
permalinks = result[3].value,
var title = result[0].value.value,
description = result[1].value.value,
permalinks = result[2].value,
siteUrl = config.urlFor('home', null, true),
feedUrl = config.urlFor('rss', null, true),
maxPage = page.pages,
maxPage = page.meta.pagination.pages,
feedItems = [],
feed;

Expand All @@ -306,7 +296,7 @@ frontendControllers = {
// A bit of a hack for situations with no content.
if (maxPage === 0) {
maxPage = 1;
page.pages = 1;
page.meta.pagination.pages = 1;
}

// If page is greater than number of pages we have, redirect to last page
Expand All @@ -327,7 +317,7 @@ frontendControllers = {
url: config.urlFor('post', {post: post, permalinks: permalinks}, true),
date: post.published_at,
categories: _.pluck(post.tags, 'name'),
author: user ? user.name : null
author: post.author ? post.author.name : null
},
content = post.html;

Expand Down
4 changes: 2 additions & 2 deletions core/server/helpers/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -656,8 +656,8 @@ coreHelpers.pagination = function (options) {
errors.logAndThrowError('All values must be defined for page, pages, limit and total');
return;
}
if ((!_.isUndefined(this.pagination.next) && !_.isNumber(this.pagination.next))
|| (!_.isUndefined(this.pagination.prev) && !_.isNumber(this.pagination.prev))) {
if ((!_.isNull(this.pagination.next) && !_.isNumber(this.pagination.next))
|| (!_.isNull(this.pagination.prev) && !_.isNumber(this.pagination.prev))) {
errors.logAndThrowError('Invalid value, Next/Prev must be a number');
return;
}
Expand Down
37 changes: 22 additions & 15 deletions core/server/models/post.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,22 +364,29 @@ Post = ghostBookshelf.Model.extend({
// Format response of data
.then(function (resp) {
var totalPosts = parseInt(resp[0].aggregate, 10),
data = {
posts: postCollection.toJSON(),
page: parseInt(opts.page, 10),
limit: opts.limit,
pages: Math.ceil(totalPosts / opts.limit),
total: totalPosts
};

if (data.pages > 1) {
if (data.page === 1) {
data.next = data.page + 1;
} else if (data.page === data.pages) {
data.prev = data.page - 1;
pagination = {},
meta = {},
data = {};

pagination['page'] = parseInt(opts.page, 10);
pagination['limit'] = opts.limit;
pagination['pages'] = Math.ceil(totalPosts / opts.limit);
pagination['total'] = totalPosts;
pagination['next'] = null;
pagination['prev'] = null;

data['posts'] = postCollection.toJSON();
data['meta'] = meta;
meta['pagination'] = pagination;

if (pagination.pages > 1) {
if (pagination.page === 1) {
pagination.next = pagination.page + 1;
} else if (pagination.page === pagination.pages) {
pagination.prev = pagination.page - 1;
} else {
data.next = data.page + 1;
data.prev = data.page - 1;
pagination.next = pagination.page + 1;
pagination.prev = pagination.page - 1;
}
}

Expand Down
5 changes: 5 additions & 0 deletions core/test/functional/routes/api/posts_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ describe('Post API', function () {
testUtils.API.checkResponse(jsonResponse, 'posts');
jsonResponse.posts.should.have.length(5);
testUtils.API.checkResponse(jsonResponse.posts[0], 'post');
testUtils.API.checkResponse(jsonResponse.meta.pagination, 'pagination');
done();
});
});
Expand All @@ -118,6 +119,7 @@ describe('Post API', function () {
testUtils.API.checkResponse(jsonResponse, 'posts');
jsonResponse.posts.should.have.length(6);
testUtils.API.checkResponse(jsonResponse.posts[0], 'post');
testUtils.API.checkResponse(jsonResponse.meta.pagination, 'pagination');
done();
});

Expand All @@ -140,6 +142,7 @@ describe('Post API', function () {
testUtils.API.checkResponse(jsonResponse, 'posts');
jsonResponse.posts.should.have.length(8);
testUtils.API.checkResponse(jsonResponse.posts[0], 'post');
testUtils.API.checkResponse(jsonResponse.meta.pagination, 'pagination');
done();
});
});
Expand All @@ -159,6 +162,7 @@ describe('Post API', function () {
testUtils.API.checkResponse(jsonResponse, 'posts');
jsonResponse.posts.should.have.length(1);
testUtils.API.checkResponse(jsonResponse.posts[0], 'post');
testUtils.API.checkResponse(jsonResponse.meta.pagination, 'pagination');
done();
});
});
Expand All @@ -178,6 +182,7 @@ describe('Post API', function () {
testUtils.API.checkResponse(jsonResponse, 'posts');
jsonResponse.posts.should.have.length(1);
testUtils.API.checkResponse(jsonResponse.posts[0], 'post');
testUtils.API.checkResponse(jsonResponse.meta.pagination, 'pagination');
done();
});
});
Expand Down
58 changes: 29 additions & 29 deletions core/test/integration/model/model_posts_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,72 +356,72 @@ describe('Post Model', function () {
}).then(function () {
return PostModel.findPage({page: 2});
}).then(function (paginationResult) {
paginationResult.page.should.equal(2);
paginationResult.limit.should.equal(15);
paginationResult.meta.pagination.page.should.equal(2);
paginationResult.meta.pagination.limit.should.equal(15);
paginationResult.meta.pagination.pages.should.equal(4);
paginationResult.posts.length.should.equal(15);
paginationResult.pages.should.equal(4);

return PostModel.findPage({page: 5});
}).then(function (paginationResult) {
paginationResult.page.should.equal(5);
paginationResult.limit.should.equal(15);
paginationResult.meta.pagination.page.should.equal(5);
paginationResult.meta.pagination.limit.should.equal(15);
paginationResult.meta.pagination.pages.should.equal(4);
paginationResult.posts.length.should.equal(0);
paginationResult.pages.should.equal(4);

return PostModel.findPage({limit: 30});
}).then(function (paginationResult) {
paginationResult.page.should.equal(1);
paginationResult.limit.should.equal(30);
paginationResult.meta.pagination.page.should.equal(1);
paginationResult.meta.pagination.limit.should.equal(30);
paginationResult.meta.pagination.pages.should.equal(2);
paginationResult.posts.length.should.equal(30);
paginationResult.pages.should.equal(2);

return PostModel.findPage({limit: 10, staticPages: true});
}).then(function (paginationResult) {
paginationResult.page.should.equal(1);
paginationResult.limit.should.equal(10);
paginationResult.meta.pagination.page.should.equal(1);
paginationResult.meta.pagination.limit.should.equal(10);
paginationResult.meta.pagination.pages.should.equal(1);
paginationResult.posts.length.should.equal(1);
paginationResult.pages.should.equal(1);

return PostModel.findPage({limit: 10, page: 2, status: 'all'});
}).then(function (paginationResult) {
paginationResult.pages.should.equal(11);
paginationResult.meta.pagination.pages.should.equal(11);

// Test tag filter
return PostModel.findPage({page: 1, tag: 'bacon'});
}).then(function (paginationResult) {
paginationResult.page.should.equal(1);
paginationResult.limit.should.equal(15);
paginationResult.posts.length.should.equal(2);
paginationResult.pages.should.equal(1);
paginationResult.meta.pagination.page.should.equal(1);
paginationResult.meta.pagination.limit.should.equal(15);
paginationResult.meta.pagination.pages.should.equal(1);
paginationResult.aspect.tag.name.should.equal('bacon');
paginationResult.aspect.tag.slug.should.equal('bacon');
paginationResult.posts.length.should.equal(2);

return PostModel.findPage({page: 1, tag: 'kitchen-sink'});
}).then(function (paginationResult) {
paginationResult.page.should.equal(1);
paginationResult.limit.should.equal(15);
paginationResult.posts.length.should.equal(2);
paginationResult.pages.should.equal(1);
paginationResult.meta.pagination.page.should.equal(1);
paginationResult.meta.pagination.limit.should.equal(15);
paginationResult.meta.pagination.pages.should.equal(1);
paginationResult.aspect.tag.name.should.equal('kitchen sink');
paginationResult.aspect.tag.slug.should.equal('kitchen-sink');
paginationResult.posts.length.should.equal(2);

return PostModel.findPage({page: 1, tag: 'injection'});
}).then(function (paginationResult) {
paginationResult.page.should.equal(1);
paginationResult.limit.should.equal(15);
paginationResult.posts.length.should.equal(15);
paginationResult.pages.should.equal(2);
paginationResult.meta.pagination.page.should.equal(1);
paginationResult.meta.pagination.limit.should.equal(15);
paginationResult.meta.pagination.pages.should.equal(2);
paginationResult.aspect.tag.name.should.equal('injection');
paginationResult.aspect.tag.slug.should.equal('injection');
paginationResult.posts.length.should.equal(15);

return PostModel.findPage({page: 2, tag: 'injection'});
}).then(function (paginationResult) {
paginationResult.page.should.equal(2);
paginationResult.limit.should.equal(15);
paginationResult.posts.length.should.equal(11);
paginationResult.pages.should.equal(2);
paginationResult.meta.pagination.page.should.equal(2);
paginationResult.meta.pagination.limit.should.equal(15);
paginationResult.meta.pagination.pages.should.equal(2);
paginationResult.aspect.tag.name.should.equal('injection');
paginationResult.aspect.tag.slug.should.equal('injection');
paginationResult.posts.length.should.equal(11);

done();
}).then(null, done);
Expand Down
18 changes: 11 additions & 7 deletions core/test/unit/frontend_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ describe('Frontend Controller', function () {
};

sandbox.stub(api.posts, 'browse', function () {
return when({posts: {}, pages: 3});
return when({posts: {}, meta: {pagination: { pages: 3}}});
});

apiSettingsStub = sandbox.stub(api.settings, 'read');
Expand Down Expand Up @@ -183,10 +183,14 @@ describe('Frontend Controller', function () {
beforeEach(function () {
sandbox.stub(api.posts, 'browse', function (args) {
return when({
posts: mockPosts,
page: 1,
pages: 1,
aspect: {tag: mockTags[0]}
posts: mockPosts,
meta: {
pagination: {
page: 1,
pages: 1,
},
},
aspect: {tag: mockTags[0]}
});
});

Expand Down Expand Up @@ -254,7 +258,7 @@ describe('Frontend Controller', function () {
};

sandbox.stub(api.posts, 'browse', function () {
return when({posts: {}, pages: 3});
return when({posts: {}, meta: {pagination: { pages: 3}}});
});

apiSettingsStub = sandbox.stub(api.settings, 'read');
Expand Down Expand Up @@ -878,7 +882,7 @@ describe('Frontend Controller', function () {
};

sandbox.stub(api.posts, 'browse', function () {
return when({posts: {}, pages: 3});
return when({posts: {}, meta: {pagination: { pages: 3}}});
});

apiUsersStub = sandbox.stub(api.users, 'read').returns(when({}));
Expand Down
Loading