490 lines
24 KiB
JavaScript
490 lines
24 KiB
JavaScript
define([ "jquery", "underscore", "js/common_helpers/ajax_helpers", "URI", "js/models/xblock_info",
|
|
"js/views/paged_container", "js/views/paging_header", "js/views/paging_footer"],
|
|
function ($, _, AjaxHelpers, URI, XBlockInfo, PagedContainer, PagingHeader, PagingFooter) {
|
|
|
|
var htmlResponseTpl = _.template('' +
|
|
'<div class="xblock-container-paging-parameters" data-start="<%= start %>" data-displayed="<%= displayed %>" data-total="<%= total %>"/>'
|
|
);
|
|
|
|
function getResponseHtml(options){
|
|
return '<div class="xblock" data-request-token="request_token">' +
|
|
'<div class="container-paging-header"></div>' +
|
|
htmlResponseTpl(options) +
|
|
'<div class="container-paging-footer"></div>' +
|
|
'</div>'
|
|
}
|
|
|
|
var PAGE_SIZE = 3;
|
|
|
|
var mockFirstPage = {
|
|
resources: [],
|
|
html: getResponseHtml({
|
|
start: 0,
|
|
displayed: PAGE_SIZE,
|
|
total: PAGE_SIZE + 1
|
|
})
|
|
};
|
|
|
|
var mockSecondPage = {
|
|
resources: [],
|
|
html: getResponseHtml({
|
|
start: PAGE_SIZE,
|
|
displayed: 1,
|
|
total: PAGE_SIZE + 1
|
|
})
|
|
};
|
|
|
|
var mockEmptyPage = {
|
|
resources: [],
|
|
html: getResponseHtml({
|
|
start: 0,
|
|
displayed: 0,
|
|
total: 0
|
|
})
|
|
};
|
|
|
|
var respondWithMockPage = function(requests) {
|
|
var requestIndex = requests.length - 1;
|
|
var request = requests[requestIndex];
|
|
var url = new URI(request.url);
|
|
var queryParameters = url.query(true); // Returns an object with each query parameter stored as a value
|
|
var page = queryParameters.page_number;
|
|
var response = page === "0" ? mockFirstPage : mockSecondPage;
|
|
AjaxHelpers.respondWithJson(requests, response, requestIndex);
|
|
};
|
|
|
|
var MockPagingView = PagedContainer.extend({
|
|
view: 'container_preview',
|
|
el: $("<div><div class='xblock' data-request-token='test_request_token'/></div>"),
|
|
model: new XBlockInfo({}, {parse: true})
|
|
});
|
|
|
|
describe("Paging Container", function() {
|
|
var pagingContainer;
|
|
|
|
beforeEach(function () {
|
|
var feedbackTpl = readFixtures('system-feedback.underscore');
|
|
setFixtures($("<script>", { id: "system-feedback-tpl", type: "text/template" }).text(feedbackTpl));
|
|
pagingContainer = new MockPagingView({ page_size: PAGE_SIZE });
|
|
});
|
|
|
|
describe("Container", function () {
|
|
describe("setPage", function () {
|
|
it('can set the current page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.collection.currentPage).toBe(0);
|
|
pagingContainer.setPage(1);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.collection.currentPage).toBe(1);
|
|
});
|
|
|
|
it('should not change page after a server error', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.setPage(1);
|
|
requests[1].respond(500);
|
|
expect(pagingContainer.collection.currentPage).toBe(0);
|
|
});
|
|
});
|
|
|
|
describe("nextPage", function () {
|
|
it('does not move forward after a server error', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.nextPage();
|
|
requests[1].respond(500);
|
|
expect(pagingContainer.collection.currentPage).toBe(0);
|
|
});
|
|
|
|
it('can move to the next page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.nextPage();
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.collection.currentPage).toBe(1);
|
|
});
|
|
|
|
it('can not move forward from the final page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(1);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.nextPage();
|
|
expect(requests.length).toBe(1);
|
|
});
|
|
});
|
|
|
|
describe("previousPage", function () {
|
|
it('can move back a page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(1);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.previousPage();
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.collection.currentPage).toBe(0);
|
|
});
|
|
|
|
it('can not move back from the first page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.previousPage();
|
|
expect(requests.length).toBe(1);
|
|
});
|
|
|
|
it('does not move back after a server error', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(1);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.previousPage();
|
|
requests[1].respond(500);
|
|
expect(pagingContainer.collection.currentPage).toBe(1);
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("PagingHeader", function () {
|
|
beforeEach(function () {
|
|
var pagingFooterTpl = readFixtures('paging-header.underscore');
|
|
appendSetFixtures($("<script>", { id: "paging-header-tpl", type: "text/template" }).text(pagingFooterTpl));
|
|
});
|
|
|
|
describe("Next page button", function () {
|
|
beforeEach(function () {
|
|
pagingContainer.render();
|
|
});
|
|
|
|
it('does not move forward if a server error occurs', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.pagingHeader.$('.next-page-link').click();
|
|
requests[1].respond(500);
|
|
expect(pagingContainer.collection.currentPage).toBe(0);
|
|
});
|
|
|
|
it('can move to the next page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.pagingHeader.$('.next-page-link').click();
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.collection.currentPage).toBe(1);
|
|
});
|
|
|
|
it('should be enabled when there is at least one more page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingHeader.$('.next-page-link')).not.toHaveClass('is-disabled');
|
|
});
|
|
|
|
it('should be disabled on the final page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(1);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingHeader.$('.next-page-link')).toHaveClass('is-disabled');
|
|
});
|
|
|
|
it('should be disabled on an empty page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
AjaxHelpers.respondWithJson(requests, mockEmptyPage);
|
|
expect(pagingContainer.pagingHeader.$('.next-page-link')).toHaveClass('is-disabled');
|
|
});
|
|
});
|
|
|
|
describe("Previous page button", function () {
|
|
beforeEach(function () {
|
|
pagingContainer.render();
|
|
});
|
|
|
|
it('does not move back if a server error occurs', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(1);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.pagingHeader.$('.previous-page-link').click();
|
|
requests[1].respond(500);
|
|
expect(pagingContainer.collection.currentPage).toBe(1);
|
|
});
|
|
|
|
it('can go back a page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(1);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.pagingHeader.$('.previous-page-link').click();
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.collection.currentPage).toBe(0);
|
|
});
|
|
|
|
it('should be disabled on the first page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingHeader.$('.previous-page-link')).toHaveClass('is-disabled');
|
|
});
|
|
|
|
it('should be enabled on the second page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(1);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingHeader.$('.previous-page-link')).not.toHaveClass('is-disabled');
|
|
});
|
|
|
|
it('should be disabled for an empty page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
AjaxHelpers.respondWithJson(requests, mockEmptyPage);
|
|
expect(pagingContainer.pagingHeader.$('.previous-page-link')).toHaveClass('is-disabled');
|
|
});
|
|
});
|
|
|
|
describe("Page metadata section", function() {
|
|
it('shows the correct metadata for the current page', function () {
|
|
var requests = AjaxHelpers.requests(this),
|
|
message;
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
message = pagingContainer.pagingHeader.$('.meta').html().trim();
|
|
expect(message).toBe('<p>Showing <span class="count-current-shown">1-3</span>' +
|
|
' out of <span class="count-total">4 total</span>, ' +
|
|
'sorted by <span class="sort-order">Date added</span> descending</p>');
|
|
});
|
|
});
|
|
|
|
describe("Children count label", function () {
|
|
it('should show correct count on first page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingHeader.$('.count-current-shown')).toHaveHtml('1-3');
|
|
});
|
|
|
|
it('should show correct count on second page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(1);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingHeader.$('.count-current-shown')).toHaveHtml('4-4');
|
|
});
|
|
|
|
it('should show correct count for an empty collection', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
AjaxHelpers.respondWithJson(requests, mockEmptyPage);
|
|
expect(pagingContainer.pagingHeader.$('.count-current-shown')).toHaveHtml('0-0');
|
|
});
|
|
});
|
|
|
|
describe("Children total label", function () {
|
|
it('should show correct total on the first page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingHeader.$('.count-total')).toHaveText('4 total');
|
|
});
|
|
|
|
it('should show correct total on the second page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(1);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingHeader.$('.count-total')).toHaveText('4 total');
|
|
});
|
|
|
|
it('should show zero total for an empty collection', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
AjaxHelpers.respondWithJson(requests, mockEmptyPage);
|
|
expect(pagingContainer.pagingHeader.$('.count-total')).toHaveText('0 total');
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("PagingFooter", function () {
|
|
var pagingFooter;
|
|
|
|
beforeEach(function () {
|
|
var pagingFooterTpl = readFixtures('paging-footer.underscore');
|
|
appendSetFixtures($("<script>", { id: "paging-footer-tpl", type: "text/template" }).text(pagingFooterTpl));
|
|
});
|
|
|
|
describe("Next page button", function () {
|
|
beforeEach(function () {
|
|
// Render the page and header so that they can react to events
|
|
pagingContainer.render();
|
|
});
|
|
|
|
it('does not move forward if a server error occurs', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.pagingFooter.$('.next-page-link').click();
|
|
requests[1].respond(500);
|
|
expect(pagingContainer.collection.currentPage).toBe(0);
|
|
});
|
|
|
|
it('can move to the next page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.pagingFooter.$('.next-page-link').click();
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.collection.currentPage).toBe(1);
|
|
});
|
|
|
|
it('should be enabled when there is at least one more page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingFooter.$('.next-page-link')).not.toHaveClass('is-disabled');
|
|
});
|
|
|
|
it('should be disabled on the final page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(1);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingFooter.$('.next-page-link')).toHaveClass('is-disabled');
|
|
});
|
|
|
|
it('should be disabled on an empty page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
AjaxHelpers.respondWithJson(requests, mockEmptyPage);
|
|
expect(pagingContainer.pagingFooter.$('.next-page-link')).toHaveClass('is-disabled');
|
|
});
|
|
});
|
|
|
|
describe("Previous page button", function () {
|
|
beforeEach(function () {
|
|
// Render the page and header so that they can react to events
|
|
pagingContainer.render();
|
|
});
|
|
|
|
it('does not move back if a server error occurs', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(1);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.pagingFooter.$('.previous-page-link').click();
|
|
requests[1].respond(500);
|
|
expect(pagingContainer.collection.currentPage).toBe(1);
|
|
});
|
|
|
|
it('can go back a page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(1);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.pagingFooter.$('.previous-page-link').click();
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.collection.currentPage).toBe(0);
|
|
});
|
|
|
|
it('should be disabled on the first page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingFooter.$('.previous-page-link')).toHaveClass('is-disabled');
|
|
});
|
|
|
|
it('should be enabled on the second page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(1);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingFooter.$('.previous-page-link')).not.toHaveClass('is-disabled');
|
|
});
|
|
|
|
it('should be disabled for an empty page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
AjaxHelpers.respondWithJson(requests, mockEmptyPage);
|
|
expect(pagingContainer.pagingFooter.$('.previous-page-link')).toHaveClass('is-disabled');
|
|
});
|
|
});
|
|
|
|
describe("Current page label", function () {
|
|
it('should show 1 on the first page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingFooter.$('.current-page')).toHaveText('1');
|
|
});
|
|
|
|
it('should show 2 on the second page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(1);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingFooter.$('.current-page')).toHaveText('2');
|
|
});
|
|
|
|
it('should show 1 for an empty collection', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
AjaxHelpers.respondWithJson(requests, mockEmptyPage);
|
|
expect(pagingContainer.pagingFooter.$('.current-page')).toHaveText('1');
|
|
});
|
|
});
|
|
|
|
describe("Page total label", function () {
|
|
it('should show the correct value with more than one page', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingFooter.$('.total-pages')).toHaveText('2');
|
|
});
|
|
|
|
it('should show page 1 when there are no assets', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
AjaxHelpers.respondWithJson(requests, mockEmptyPage);
|
|
expect(pagingContainer.pagingFooter.$('.total-pages')).toHaveText('1');
|
|
});
|
|
});
|
|
|
|
describe("Page input field", function () {
|
|
var input;
|
|
|
|
it('should initially have a blank page input', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
expect(pagingContainer.pagingFooter.$('.page-number-input')).toHaveValue('');
|
|
});
|
|
|
|
it('should handle invalid page requests', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.pagingFooter.$('.page-number-input').val('abc');
|
|
pagingContainer.pagingFooter.$('.page-number-input').trigger('change');
|
|
expect(pagingContainer.collection.currentPage).toBe(0);
|
|
expect(pagingContainer.pagingFooter.$('.page-number-input')).toHaveValue('');
|
|
});
|
|
|
|
it('should switch pages via the input field', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.pagingFooter.$('.page-number-input').val('2');
|
|
pagingContainer.pagingFooter.$('.page-number-input').trigger('change');
|
|
AjaxHelpers.respondWithJson(requests, mockSecondPage);
|
|
expect(pagingContainer.collection.currentPage).toBe(1);
|
|
expect(pagingContainer.pagingFooter.$('.page-number-input')).toHaveValue('');
|
|
});
|
|
|
|
it('should handle AJAX failures when switching pages via the input field', function () {
|
|
var requests = AjaxHelpers.requests(this);
|
|
pagingContainer.setPage(0);
|
|
respondWithMockPage(requests);
|
|
pagingContainer.pagingFooter.$('.page-number-input').val('2');
|
|
pagingContainer.pagingFooter.$('.page-number-input').trigger('change');
|
|
requests[1].respond(500);
|
|
expect(pagingContainer.collection.currentPage).toBe(0);
|
|
expect(pagingContainer.pagingFooter.$('.page-number-input')).toHaveValue('');
|
|
});
|
|
});
|
|
});
|
|
});
|
|
});
|