Studio support for creating and editing libraries (PR 6046)
SOL-1, SOL-2, SOL-3
This commit is contained in:
Braden MacDonald
committed by
E. Kolpakov
E. Kolpakov
parent
80e0d56afd
commit
3e0f08ebc2
@@ -4,48 +4,21 @@
|
||||
define(["jquery", "underscore", "gettext", "js/views/utils/view_utils"],
|
||||
function ($, _, gettext, ViewUtils) {
|
||||
return function (selectors, classes) {
|
||||
var validateRequiredField, validateCourseItemEncoding, validateTotalCourseItemsLength, setNewCourseFieldInErr,
|
||||
hasInvalidRequiredFields, createCourse, validateFilledFields, configureHandlers;
|
||||
var validateTotalCourseItemsLength, setNewCourseFieldInErr, hasInvalidRequiredFields,
|
||||
createCourse, validateFilledFields, configureHandlers;
|
||||
|
||||
validateRequiredField = function (msg) {
|
||||
return msg.length === 0 ? gettext('Required field.') : '';
|
||||
};
|
||||
var validateRequiredField = ViewUtils.validateRequiredField;
|
||||
var validateURLItemEncoding = ViewUtils.validateURLItemEncoding;
|
||||
|
||||
// Check that a course (org, number, run) doesn't use any special characters
|
||||
validateCourseItemEncoding = function (item) {
|
||||
var required = validateRequiredField(item);
|
||||
if (required) {
|
||||
return required;
|
||||
}
|
||||
if ($(selectors.allowUnicode).val() === 'True') {
|
||||
if (/\s/g.test(item)) {
|
||||
return gettext('Please do not use any spaces in this field.');
|
||||
}
|
||||
}
|
||||
else {
|
||||
if (item !== encodeURIComponent(item)) {
|
||||
return gettext('Please do not use any spaces or special characters in this field.');
|
||||
}
|
||||
}
|
||||
return '';
|
||||
};
|
||||
var keyLengthViolationMessage = gettext('The combined length of the organization, course number, and course run fields cannot be more than <%=limit%> characters.');
|
||||
|
||||
// Ensure that org/course_num/run < 65 chars.
|
||||
// Ensure that org, course_num and run passes checkTotalKeyLengthViolations
|
||||
validateTotalCourseItemsLength = function () {
|
||||
var totalLength = _.reduce(
|
||||
ViewUtils.checkTotalKeyLengthViolations(
|
||||
selectors, classes,
|
||||
[selectors.org, selectors.number, selectors.run],
|
||||
function (sum, ele) {
|
||||
return sum + $(ele).val().length;
|
||||
}, 0
|
||||
keyLengthViolationMessage
|
||||
);
|
||||
if (totalLength > 65) {
|
||||
$(selectors.errorWrapper).addClass(classes.shown).removeClass(classes.hiding);
|
||||
$(selectors.errorMessage).html('<p>' + gettext('The combined length of the organization, course number, and course run fields cannot be more than 65 characters.') + '</p>');
|
||||
$(selectors.save).addClass(classes.disabled);
|
||||
}
|
||||
else {
|
||||
$(selectors.errorWrapper).removeClass(classes.shown).addClass(classes.hiding);
|
||||
}
|
||||
};
|
||||
|
||||
setNewCourseFieldInErr = function (el, msg) {
|
||||
@@ -117,7 +90,7 @@ define(["jquery", "underscore", "gettext", "js/views/utils/view_utils"],
|
||||
if (event.keyCode === 9) {
|
||||
return;
|
||||
}
|
||||
var error = validateCourseItemEncoding($ele.val());
|
||||
var error = validateURLItemEncoding($ele.val(), $(selectors.allowUnicode).val() === 'True');
|
||||
setNewCourseFieldInErr($ele.parent(), error);
|
||||
validateTotalCourseItemsLength();
|
||||
if (!validateFilledFields()) {
|
||||
@@ -138,8 +111,6 @@ define(["jquery", "underscore", "gettext", "js/views/utils/view_utils"],
|
||||
};
|
||||
|
||||
return {
|
||||
validateRequiredField: validateRequiredField,
|
||||
validateCourseItemEncoding: validateCourseItemEncoding,
|
||||
validateTotalCourseItemsLength: validateTotalCourseItemsLength,
|
||||
setNewCourseFieldInErr: setNewCourseFieldInErr,
|
||||
hasInvalidRequiredFields: hasInvalidRequiredFields,
|
||||
|
||||
129
cms/static/js/views/utils/create_library_utils.js
Normal file
129
cms/static/js/views/utils/create_library_utils.js
Normal file
@@ -0,0 +1,129 @@
|
||||
/**
|
||||
* Provides utilities for validating libraries during creation.
|
||||
*/
|
||||
define(["jquery", "underscore", "gettext", "js/views/utils/view_utils"],
|
||||
function ($, _, gettext, ViewUtils) {
|
||||
"use strict";
|
||||
return function (selectors, classes) {
|
||||
var validateTotalKeyLength, setNewLibraryFieldInErr, hasInvalidRequiredFields,
|
||||
createLibrary, validateFilledFields, configureHandlers;
|
||||
|
||||
var validateRequiredField = ViewUtils.validateRequiredField;
|
||||
var validateURLItemEncoding = ViewUtils.validateURLItemEncoding;
|
||||
|
||||
var keyLengthViolationMessage = gettext("The combined length of the organization and library code fields cannot be more than <%=limit%> characters.");
|
||||
|
||||
// Ensure that org/librarycode passes validateTotalKeyLength check
|
||||
validateTotalKeyLength = function () {
|
||||
ViewUtils.checkTotalKeyLengthViolations(
|
||||
selectors, classes,
|
||||
[selectors.org, selectors.number],
|
||||
keyLengthViolationMessage
|
||||
);
|
||||
};
|
||||
|
||||
setNewLibraryFieldInErr = function (element, message) {
|
||||
if (message) {
|
||||
element.addClass(classes.error);
|
||||
element.children(selectors.tipError).addClass(classes.showing).removeClass(classes.hiding).text(message);
|
||||
$(selectors.save).addClass(classes.disabled);
|
||||
}
|
||||
else {
|
||||
element.removeClass(classes.error);
|
||||
element.children(selectors.tipError).addClass(classes.hiding).removeClass(classes.showing);
|
||||
// One "error" div is always present, but hidden or shown
|
||||
if ($(selectors.error).length === 1) {
|
||||
$(selectors.save).removeClass(classes.disabled);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// One final check for empty values
|
||||
hasInvalidRequiredFields = function () {
|
||||
return _.reduce(
|
||||
[selectors.name, selectors.org, selectors.number],
|
||||
function (acc, element) {
|
||||
var $element = $(element);
|
||||
var error = validateRequiredField($element.val());
|
||||
setNewLibraryFieldInErr($element.parent(), error);
|
||||
return error ? true : acc;
|
||||
},
|
||||
false
|
||||
);
|
||||
};
|
||||
|
||||
createLibrary = function (libraryInfo, errorHandler) {
|
||||
$.postJSON(
|
||||
'/library/',
|
||||
libraryInfo
|
||||
).done(function (data) {
|
||||
ViewUtils.redirect(data.url);
|
||||
}).fail(function(jqXHR, textStatus, errorThrown) {
|
||||
var reason = errorThrown;
|
||||
if (jqXHR.responseText) {
|
||||
try {
|
||||
var detailedReason = $.parseJSON(jqXHR.responseText).ErrMsg;
|
||||
if (detailedReason) {
|
||||
reason = detailedReason;
|
||||
}
|
||||
} catch (e) {}
|
||||
}
|
||||
errorHandler(reason);
|
||||
});
|
||||
};
|
||||
|
||||
// Ensure that all fields are not empty
|
||||
validateFilledFields = function () {
|
||||
return _.reduce(
|
||||
[selectors.org, selectors.number, selectors.name],
|
||||
function (acc, element) {
|
||||
var $element = $(element);
|
||||
return $element.val().length !== 0 ? acc : false;
|
||||
},
|
||||
true
|
||||
);
|
||||
};
|
||||
|
||||
// Handle validation asynchronously
|
||||
configureHandlers = function () {
|
||||
_.each(
|
||||
[selectors.org, selectors.number],
|
||||
function (element) {
|
||||
var $element = $(element);
|
||||
$element.on('keyup', function (event) {
|
||||
// Don't bother showing "required field" error when
|
||||
// the user tabs into a new field; this is distracting
|
||||
// and unnecessary
|
||||
if (event.keyCode === $.ui.keyCode.TAB) {
|
||||
return;
|
||||
}
|
||||
var error = validateURLItemEncoding($element.val(), $(selectors.allowUnicode).val() === 'True');
|
||||
setNewLibraryFieldInErr($element.parent(), error);
|
||||
validateTotalKeyLength();
|
||||
if (!validateFilledFields()) {
|
||||
$(selectors.save).addClass(classes.disabled);
|
||||
}
|
||||
});
|
||||
}
|
||||
);
|
||||
var $name = $(selectors.name);
|
||||
$name.on('keyup', function () {
|
||||
var error = validateRequiredField($name.val());
|
||||
setNewLibraryFieldInErr($name.parent(), error);
|
||||
validateTotalKeyLength();
|
||||
if (!validateFilledFields()) {
|
||||
$(selectors.save).addClass(classes.disabled);
|
||||
}
|
||||
});
|
||||
};
|
||||
|
||||
return {
|
||||
validateTotalKeyLength: validateTotalKeyLength,
|
||||
setNewLibraryFieldInErr: setNewLibraryFieldInErr,
|
||||
hasInvalidRequiredFields: hasInvalidRequiredFields,
|
||||
createLibrary: createLibrary,
|
||||
validateFilledFields: validateFilledFields,
|
||||
configureHandlers: configureHandlers
|
||||
};
|
||||
};
|
||||
});
|
||||
@@ -5,7 +5,11 @@ define(["jquery", "underscore", "gettext", "js/views/feedback_notification", "js
|
||||
function ($, _, gettext, NotificationView, PromptView) {
|
||||
var toggleExpandCollapse, showLoadingIndicator, hideLoadingIndicator, confirmThenRunOperation,
|
||||
runOperationShowingMessage, disableElementWhileRunning, getScrollOffset, setScrollOffset,
|
||||
setScrollTop, redirect, reload, hasChangedAttributes, deleteNotificationHandler;
|
||||
setScrollTop, redirect, reload, hasChangedAttributes, deleteNotificationHandler,
|
||||
validateRequiredField, validateURLItemEncoding, validateTotalKeyLength, checkTotalKeyLengthViolations;
|
||||
|
||||
// see https://openedx.atlassian.net/browse/TNL-889 for what is it and why it's 65
|
||||
var MAX_SUM_KEY_LENGTH = 65;
|
||||
|
||||
/**
|
||||
* Toggles the expanded state of the current element.
|
||||
@@ -173,6 +177,55 @@ define(["jquery", "underscore", "gettext", "js/views/feedback_notification", "js
|
||||
return false;
|
||||
};
|
||||
|
||||
/**
|
||||
* Helper method for course/library creation - verifies a required field is not blank.
|
||||
*/
|
||||
validateRequiredField = function (msg) {
|
||||
return msg.length === 0 ? gettext('Required field.') : '';
|
||||
};
|
||||
|
||||
/**
|
||||
* Helper method for course/library creation.
|
||||
* Check that a course (org, number, run) doesn't use any special characters
|
||||
*/
|
||||
validateURLItemEncoding = function (item, allowUnicode) {
|
||||
var required = validateRequiredField(item);
|
||||
if (required) {
|
||||
return required;
|
||||
}
|
||||
if (allowUnicode) {
|
||||
if (/\s/g.test(item)) {
|
||||
return gettext('Please do not use any spaces in this field.');
|
||||
}
|
||||
}
|
||||
else {
|
||||
if (item !== encodeURIComponent(item)) {
|
||||
return gettext('Please do not use any spaces or special characters in this field.');
|
||||
}
|
||||
}
|
||||
return '';
|
||||
};
|
||||
|
||||
// Ensure that sum length of key field values <= ${MAX_SUM_KEY_LENGTH} chars.
|
||||
validateTotalKeyLength = function (key_field_selectors) {
|
||||
var totalLength = _.reduce(
|
||||
key_field_selectors,
|
||||
function (sum, ele) { return sum + $(ele).val().length;},
|
||||
0
|
||||
);
|
||||
return totalLength <= MAX_SUM_KEY_LENGTH;
|
||||
};
|
||||
|
||||
checkTotalKeyLengthViolations = function(selectors, classes, key_field_selectors, message_tpl) {
|
||||
if (!validateTotalKeyLength(key_field_selectors)) {
|
||||
$(selectors.errorWrapper).addClass(classes.shown).removeClass(classes.hiding);
|
||||
$(selectors.errorMessage).html('<p>' + _.template(message_tpl, {limit: MAX_SUM_KEY_LENGTH}) + '</p>');
|
||||
$(selectors.save).addClass(classes.disabled);
|
||||
} else {
|
||||
$(selectors.errorWrapper).removeClass(classes.shown).addClass(classes.hiding);
|
||||
}
|
||||
};
|
||||
|
||||
return {
|
||||
'toggleExpandCollapse': toggleExpandCollapse,
|
||||
'showLoadingIndicator': showLoadingIndicator,
|
||||
@@ -186,6 +239,10 @@ define(["jquery", "underscore", "gettext", "js/views/feedback_notification", "js
|
||||
'setScrollOffset': setScrollOffset,
|
||||
'redirect': redirect,
|
||||
'reload': reload,
|
||||
'hasChangedAttributes': hasChangedAttributes
|
||||
'hasChangedAttributes': hasChangedAttributes,
|
||||
'validateRequiredField': validateRequiredField,
|
||||
'validateURLItemEncoding': validateURLItemEncoding,
|
||||
'validateTotalKeyLength': validateTotalKeyLength,
|
||||
'checkTotalKeyLengthViolations': checkTotalKeyLengthViolations
|
||||
};
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user