Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Set up validation_messages so that it goes through the RequireJS optimizer.

Browse Source
This commit is contained in:
cahrens
2014-11-07 09:52:54 -05:00
parent 1b858e5497
commit c550963fb9
5 changed files with 106 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
cms/static/build.js
View File

@@ -45,7 +45,8 @@
'js/factories/settings',
'js/factories/settings_advanced',
'js/factories/settings_graders',
'js/factories/textbooks'
'js/factories/textbooks',
'js/factories/xblock_validation'
]),
/**
* By default all the configuration for optimization happens from the command

2
cms/static/coffee/spec/main.coffee
View File

@@ -244,6 +244,8 @@ define([
"js/spec/views/modals/edit_xblock_spec",
"js/spec/views/modals/validation_error_modal_spec",
"js/spec/factories/xblock_validation_spec",
"js/spec/xblock/cms.runtime.v1_spec",
# these tests are run separately in the cms-squire suite, due to process

15
cms/static/js/factories/xblock_validation.js Normal file
View File

@@ -0,0 +1,15 @@
define(["js/views/xblock_validation", "js/models/xblock_validation"],
function (XBlockValidationView, XBlockValidationModel) {
'use strict';
return function (validationMessages, hasEditingUrl, isRoot, validationEle) {
if (hasEditingUrl && !isRoot) {
validationMessages.showSummaryOnly = true;
}
var model = new XBlockValidationModel(validationMessages, {parse: true});
if (!model.get("empty")) {
new XBlockValidationView({el: validationEle, model: model, root: isRoot}).render();
}
};
});

78
cms/static/js/spec/factories/xblock_validation_spec.js Normal file
View File

@@ -0,0 +1,78 @@
define(['jquery', 'js/factories/xblock_validation', 'js/common_helpers/template_helpers'],
function($, XBlockValidationFactory, TemplateHelpers) {
describe('XBlockValidationFactory', function() {
var messageDiv;
beforeEach(function () {
TemplateHelpers.installTemplate('xblock-validation-messages');
appendSetFixtures($('<div class="messages"></div>'));
messageDiv = $('.messages');
});
it('Does not attach a view if messages is empty', function() {
XBlockValidationFactory({"empty": true}, false, false, messageDiv);
expect(messageDiv.children().length).toEqual(0);
});
it('Does attach a view if messages are not empty', function() {
XBlockValidationFactory({"empty": false}, false, false, messageDiv);
expect(messageDiv.children().length).toEqual(1);
});
it('Passes through the root property to the view.', function() {
var noContainerContent = "no-container-content";
var notConfiguredMessages = {
"empty": false,
"summary": {"text": "my summary", "type": "not-configured"},
"messages": [],
"xblock_id": "id"
};
// Root is false, will not add noContainerContent.
XBlockValidationFactory(notConfiguredMessages, true, false, messageDiv);
expect(messageDiv.find('.validation')).not.toHaveClass(noContainerContent);
// Root is true, will add noContainerContent.
XBlockValidationFactory(notConfiguredMessages, true, true, messageDiv);
expect(messageDiv.find('.validation')).toHaveClass(noContainerContent);
});
describe('Controls display of detailed messages based on url and root property', function() {
var messagesWithSummary, checkDetailedMessages;
beforeEach(function () {
messagesWithSummary = {
"empty": false,
"summary": {"text": "my summary"},
"messages": [{"text": "one", "type": "warning"}, {"text": "two", "type": "error"}],
"xblock_id": "id"
};
});
checkDetailedMessages = function (expectedDetailedMessages) {
expect(messageDiv.children().length).toEqual(1);
expect(messageDiv.find('.xblock-message-item').length).toBe(expectedDetailedMessages);
};
it('Does not show details if xblock has an editing URL and it is not rendered as root', function() {
XBlockValidationFactory(messagesWithSummary, true, false, messageDiv);
checkDetailedMessages(0);
});
it('Shows details if xblock does not have its own editing URL, regardless of root value', function() {
XBlockValidationFactory(messagesWithSummary, false, false, messageDiv);
checkDetailedMessages(2);
XBlockValidationFactory(messagesWithSummary, false, true, messageDiv);
checkDetailedMessages(2);
});
it('Shows details if xblock has its own editing URL and is rendered as root', function() {
XBlockValidationFactory(messagesWithSummary, true, true, messageDiv);
checkDetailedMessages(2);
});
});
});
}
);

33
cms/templates/studio_xblock_wrapper.html
View File

@@ -1,4 +1,3 @@
<%!
from django.utils.translation import ugettext as _
from contentstore.views.helpers import xblock_studio_url
@@ -21,31 +20,17 @@ messages = json.dumps(xblock.validate().to_json())
</script>
</%block>
<script type='text/javascript'>
require(["js/views/xblock_validation", "js/models/xblock_validation"],
function (XBlockValidationView, XBlockValidationModel) {
var validationMessages = ${messages};
% if xblock_url and not is_root:
validationMessages.showSummaryOnly = true;
% endif
var model = new XBlockValidationModel(validationMessages, {parse: true});
if (!model.get("empty")) {
var validationEle = $('div.xblock-validation-messages[data-locator="${xblock.location | h}"]');
var viewOptions = {
el: validationEle,
model: model
};
% if is_root:
viewOptions.root = true;
% endif
var view = new XBlockValidationView(viewOptions);
view.render();
}
});
<script>
require(["jquery", "js/factories/xblock_validation"], function($, XBlockValidationFactory) {
XBlockValidationFactory(
${messages},
$.parseJSON("${bool(xblock_url)}".toLowerCase()),
$.parseJSON("${is_root == True}".toLowerCase()),
$('div.xblock-validation-messages[data-locator="${xblock.location | h}"]')
);
});
</script>
% if not is_root:
% if is_reorderable:
<li class="studio-xblock-wrapper is-draggable" data-locator="${xblock.location | h}" data-course-key="${xblock.location.course_key | h}">