Merge pull request #5701 from edx/will/call-default-something-else

Use 'defaultValue' instead of 'default' in the form description.

common/djangoapps/user_api/helpers.py

@@ -103,7 +103,7 @@ class FormDescription(object):
     }
 
     OVERRIDE_FIELD_PROPERTIES = [
-        "label", "type", "default", "placeholder",
+        "label", "type", "defaultValue", "placeholder",
         "instructions", "required", "restrictions",
         "options"
     ]
@@ -172,7 +172,7 @@ class FormDescription(object):
             "name": name,
             "label": label,
             "type": field_type,
-            "default": default,
+            "defaultValue": default,
             "placeholder": placeholder,
             "instructions": instructions,
             "required": required,
@@ -217,7 +217,7 @@ class FormDescription(object):
                 {
                     "name": "cheese_or_wine",
                     "label": "Cheese or Wine?",
-                    "default": "cheese",
+                    "defaultValue": "cheese",
                     "type": "select",
                     "required": True,
                     "placeholder": "",
@@ -231,7 +231,7 @@ class FormDescription(object):
                 {
                     "name": "comments",
                     "label": "comments",
-                    "default": "",
+                    "defaultValue": "",
                     "type": "text",
                     "required": False,
                     "placeholder": "Any comments?",
@@ -275,6 +275,11 @@ class FormDescription(object):
         if "field_type" in kwargs:
             kwargs["type"] = kwargs["field_type"]
 
+        # Transform kwarg "default" to "defaultValue", since "default"
+        # is a reserved word in JavaScript
+        if "default" in kwargs:
+            kwargs["defaultValue"] = kwargs["default"]
+
         self._field_overrides[field_name].update({
             property_name: property_value
             for property_name, property_value in kwargs.iteritems()

common/djangoapps/user_api/tests/test_helpers.py

@@ -98,7 +98,7 @@ class FormDescriptionTest(TestCase):
                     "name": "name",
                     "label": "label",
                     "type": "text",
-                    "default": "default",
+                    "defaultValue": "default",
                     "placeholder": "placeholder",
                     "instructions": "instructions",
                     "required": True,

common/djangoapps/user_api/tests/test_views.py

@@ -587,7 +587,7 @@ class LoginSessionViewTest(ApiTestCase):
         self.assertEqual(form_desc["fields"], [
             {
                 "name": "email",
-                "default": "",
+                "defaultValue": "",
                 "type": "text",
                 "required": True,
                 "label": "E-mail",
@@ -600,7 +600,7 @@ class LoginSessionViewTest(ApiTestCase):
             },
             {
                 "name": "password",
-                "default": "",
+                "defaultValue": "",
                 "type": "password",
                 "required": True,
                 "label": "Password",
@@ -613,7 +613,7 @@ class LoginSessionViewTest(ApiTestCase):
             },
             {
                 "name": "remember",
-                "default": False,
+                "defaultValue": False,
                 "type": "checkbox",
                 "required": False,
                 "label": "Remember me",
@@ -746,7 +746,7 @@ class RegistrationViewTest(ApiTestCase):
             no_extra_fields_setting,
             {
                 u"name": u"email",
-                u"default": u"",
+                u"defaultValue": u"",
                 u"type": u"text",
                 u"required": True,
                 u"label": u"E-mail",
@@ -763,7 +763,7 @@ class RegistrationViewTest(ApiTestCase):
             no_extra_fields_setting,
             {
                 u"name": u"name",
-                u"default": u"",
+                u"defaultValue": u"",
                 u"type": u"text",
                 u"required": True,
                 u"label": u"Full Name",
@@ -779,7 +779,7 @@ class RegistrationViewTest(ApiTestCase):
             no_extra_fields_setting,
             {
                 u"name": u"username",
-                u"default": u"",
+                u"defaultValue": u"",
                 u"type": u"text",
                 u"required": True,
                 u"label": u"Public Username",
@@ -796,7 +796,7 @@ class RegistrationViewTest(ApiTestCase):
             no_extra_fields_setting,
             {
                 u"name": u"password",
-                u"default": u"",
+                u"defaultValue": u"",
                 u"type": u"text",
                 u"required": True,
                 u"label": u"Password",
@@ -822,7 +822,7 @@ class RegistrationViewTest(ApiTestCase):
                 no_extra_fields_setting,
                 {
                     "name": "password",
-                    "default": "",
+                    "defaultValue": "",
                     "type": "hidden",
                     "required": False,
                     "label": "",
@@ -837,7 +837,7 @@ class RegistrationViewTest(ApiTestCase):
                 no_extra_fields_setting,
                 {
                     u"name": u"email",
-                    u"default": u"bob@example.com",
+                    u"defaultValue": u"bob@example.com",
                     u"type": u"text",
                     u"required": True,
                     u"label": u"E-mail",
@@ -855,7 +855,7 @@ class RegistrationViewTest(ApiTestCase):
                 no_extra_fields_setting,
                 {
                     u"name": u"name",
-                    u"default": u"Bob",
+                    u"defaultValue": u"Bob",
                     u"type": u"text",
                     u"required": True,
                     u"label": u"Full Name",
@@ -872,7 +872,7 @@ class RegistrationViewTest(ApiTestCase):
                 no_extra_fields_setting,
                 {
                     u"name": u"username",
-                    u"default": u"Bob123",
+                    u"defaultValue": u"Bob123",
                     u"type": u"text",
                     u"required": True,
                     u"label": u"Public Username",
@@ -890,7 +890,7 @@ class RegistrationViewTest(ApiTestCase):
             {"level_of_education": "optional"},
             {
                 "name": "level_of_education",
-                "default": "",
+                "defaultValue": "",
                 "type": "select",
                 "required": False,
                 "label": "Highest Level of Education Completed",
@@ -917,7 +917,7 @@ class RegistrationViewTest(ApiTestCase):
             {"gender": "optional"},
             {
                 "name": "gender",
-                "default": "",
+                "defaultValue": "",
                 "type": "select",
                 "required": False,
                 "label": "Gender",
@@ -945,7 +945,7 @@ class RegistrationViewTest(ApiTestCase):
             {"year_of_birth": "optional"},
             {
                 "name": "year_of_birth",
-                "default": "",
+                "defaultValue": "",
                 "type": "select",
                 "required": False,
                 "label": "Year of Birth",
@@ -961,7 +961,7 @@ class RegistrationViewTest(ApiTestCase):
             {"mailing_address": "optional"},
             {
                 "name": "mailing_address",
-                "default": "",
+                "defaultValue": "",
                 "type": "textarea",
                 "required": False,
                 "label": "Mailing Address",
@@ -976,7 +976,7 @@ class RegistrationViewTest(ApiTestCase):
             {"goals": "optional"},
             {
                 "name": "goals",
-                "default": "",
+                "defaultValue": "",
                 "type": "textarea",
                 "required": False,
                 "label": "Please share with us your reasons for registering with edX",
@@ -991,7 +991,7 @@ class RegistrationViewTest(ApiTestCase):
             {"city": "optional"},
             {
                 "name": "city",
-                "default": "",
+                "defaultValue": "",
                 "type": "text",
                 "required": False,
                 "label": "City",
@@ -1014,7 +1014,7 @@ class RegistrationViewTest(ApiTestCase):
             {
                 "label": "Country",
                 "name": "country",
-                "default": "",
+                "defaultValue": "",
                 "type": "select",
                 "required": True,
                 "placeholder": "",
@@ -1034,7 +1034,7 @@ class RegistrationViewTest(ApiTestCase):
             {
                 "label": "I agree to the <a href=\"https://www.test.com/honor\">Terms of Service and Honor Code</a>",
                 "name": "honor_code",
-                "default": False,
+                "defaultValue": False,
                 "type": "checkbox",
                 "required": True,
                 "placeholder": "",
@@ -1051,7 +1051,7 @@ class RegistrationViewTest(ApiTestCase):
             {
                 "label": "I agree to the <a href=\"/honor\">Terms of Service and Honor Code</a>",
                 "name": "honor_code",
-                "default": False,
+                "defaultValue": False,
                 "type": "checkbox",
                 "required": True,
                 "placeholder": "",
@@ -1074,7 +1074,7 @@ class RegistrationViewTest(ApiTestCase):
             {
                 "label": "I agree to the <a href=\"https://www.test.com/honor\">Honor Code</a>",
                 "name": "honor_code",
-                "default": False,
+                "defaultValue": False,
                 "type": "checkbox",
                 "required": True,
                 "placeholder": "",
@@ -1089,7 +1089,7 @@ class RegistrationViewTest(ApiTestCase):
             {
                 "label": "I agree to the <a href=\"https://www.test.com/tos\">Terms of Service</a>",
                 "name": "terms_of_service",
-                "default": False,
+                "defaultValue": False,
                 "type": "checkbox",
                 "required": True,
                 "placeholder": "",
@@ -1108,7 +1108,7 @@ class RegistrationViewTest(ApiTestCase):
             {
                 "label": "I agree to the <a href=\"/honor\">Honor Code</a>",
                 "name": "honor_code",
-                "default": False,
+                "defaultValue": False,
                 "type": "checkbox",
                 "required": True,
                 "placeholder": "",
@@ -1123,7 +1123,7 @@ class RegistrationViewTest(ApiTestCase):
             {
                 "label": "I agree to the <a href=\"/tos\">Terms of Service</a>",
                 "name": "terms_of_service",
-                "default": False,
+                "defaultValue": False,
                 "type": "checkbox",
                 "required": True,
                 "placeholder": "",

lms/static/js/student_account/views/PasswordResetView.js

@@ -32,7 +32,8 @@ var edx = edx || {};
                 name: 'email',
                 required: true,
                 type: 'email',
-                restrictions: []
+                restrictions: [],
+                defaultValue: ''
             }]);
 
             this.tpl = $(this.tpl).html();

lms/static/js/student_account/views/RegisterView.js

@@ -88,9 +88,6 @@ var edx = edx || {};
                 len = data.length,
                 fieldTpl = this.fieldTpl;
             for ( i=0; i<len; i++ ) {
-                // "default" is reserved in JavaScript
-                data[i].value = data[i]["default"];
-
                 html.push( _.template( fieldTpl, $.extend( data[i], {
                     form: 'register'
                 }) ) );

lms/templates/student_account/form_field.underscore

@@ -27,7 +27,7 @@
             <% if ( restrictions.min_length ) { %> minlength="<%= restrictions.min_length %>"<% } %>
             <% if ( restrictions.max_length ) { %> maxlength="<%= restrictions.max_length %>"<% } %>
             <% if ( required ) { %> required<% } %>
-            value="<%- value %>"
+            value="<%- defaultValue %>"
         />
     <% } %>