Change the schema for dict fields to specify the properties as a list…

…, so that the corresponding fields can be ordered appropriately in the editor view.
sargamm · Aug 18, 2014 · 79876fc · 79876fc
1 parent 80a743c
commit 79876fc
Show file tree

Hide file tree

Showing 8 changed files with 128 additions and 119 deletions.
diff --git a/core/templates/dev/head/components/formBuilder.js b/core/templates/dev/head/components/formBuilder.js
@@ -392,7 +392,7 @@ oppia.directive('unicodeWithParametersEditor', ['$modal', '$log', 'warningsData'
                   // TODO(sll): This is a somewhat hacky solution. Can it be cleaned up?
                   $timeout(function() {
                     $scope.currentlyEditing = false;
-                  }, 5000);
+                  }, 50);
                 });
               });
 
@@ -451,8 +451,8 @@ oppia.factory('schemaDefaultValueService', [function() {
         return [];
       } else if (schema.type === 'dict') {
         var result = {};
-        for (var key in schema.properties) {
-          result[key] = this.getDefaultValue(schema.properties[key]);
+        for (var i = 0; i < schema.properties.length; i++) {
+          result[schema.properties[i].name] = this.getDefaultValue(schema.properties[i].schema);
         }
         return result;
       } else if (schema.type === 'int' || schema.type === 'float') {

diff --git a/core/templates/dev/head/components/formBuilderTests.js b/core/templates/dev/head/components/formBuilderTests.js
@@ -122,29 +122,34 @@ oppia.controller('FormBuilderTests', [
     name: 'Dict with a bool, a unicode string and a list of ints. The string must be either \'abc\' or \'def\'.',
     schema: {
       type: 'dict',
-      properties: {
-        a_boolean: {
-          type: 'bool'
-        },
-        a_unicode_string: {
+      properties: [{
+        name: 'a_unicode_string_appearing_first',
+        schema: {
           type: 'unicode',
           post_normalizers: [{
             id: 'require_is_one_of',
             choices: ['abc', 'def']
           }]
-        },
-        a_list: {
+        }
+      }, {
+        name: 'a_list_appearing_second',
+        schema: {
           type: 'list',
           items: {
             type: 'int'
           }
         }
-      }
+      }, {
+        name: 'a_boolean_appearing_last',
+        schema: {
+          type: 'bool'
+        }
+      }]
     },
     value: {
-      a_boolean: false,
-      a_unicode_string: 'abc',
-      a_list: [2, 3]
+      a_boolean_appearing_last: false,
+      a_unicode_string_appearing_first: 'abc',
+      a_list_appearing_second: [2, 3]
     }
   }, {
     name: 'List of unicode strings',
@@ -171,14 +176,17 @@ oppia.controller('FormBuilderTests', [
       type: 'list',
       items: {
         type: 'dict',
-        properties: {
-          intField: {
+        properties: [{
+          name: 'intField',
+          schema: {
             type: 'int',
-          },
-          htmlField: {
+          }
+        }, {
+          name: 'htmlField',
+          schema: {
             type: 'html'
           }
-        }
+        }]
       }
     },
     value: [{

diff --git a/core/templates/dev/head/components/form_builder_templates.html b/core/templates/dev/head/components/form_builder_templates.html
@@ -131,11 +131,11 @@
 
 <script type="text/ng-template" id="schemaBasedEditor/dict">
   <form role="form">
-    <div ng-repeat="(key, schema) in propertySchemas()">
+    <div ng-repeat="property in propertySchemas()">
       <div class="form-group">
         <!-- TODO(sll): Add a 'for' attribute to the label tag. -->
-        <label><[key]></label>
-        <schema-builder schema="schema" mode="mode" local-value="localValue[key]">
+        <label><[property.name]></label>
+        <schema-builder schema="property.schema" mode="mode" local-value="localValue[property.name]">
         </schema-builder>
       </div>
     </div>

diff --git a/core/templates/dev/head/components/richTextEditor.js b/core/templates/dev/head/components/richTextEditor.js
@@ -167,13 +167,29 @@ oppia.directive('richTextEditor', [
           });
         };
 
+        $scope.currentlyEditing = false;
+        $scope.$watch('htmlContent', function(newValue, oldValue) {
+          if ($scope.hasFullyLoaded && !$scope.currentlyEditing) {
+            // This is an external change.
+            console.log($scope.htmlContent);
+            $scope.rteContent = $scope._convertHtmlToRte(newValue);
+            $(rteNode).wysiwyg('setContent', $scope.rteContent);
+          }
+        });
+
         $scope._saveContent = function() {
           var content = $(rteNode).wysiwyg('getContent');
           if (content !== null && content !== undefined) {
-            $scope.htmlContent = $scope._convertRteToHtml(content);
             // The following $timeout removes the '$apply in progress' errors.
             $timeout(function() {
-              $scope.$apply();
+              $scope.$apply(function() {
+                $scope.currentlyEditing = true;
+                $scope.htmlContent = $scope._convertRteToHtml(content);
+                // TODO(sll): This is a somewhat hacky solution. Can it be cleaned up?
+                $timeout(function() {
+                  $scope.currentlyEditing = false;
+                }, 50);
+              });
             });
           }
         };

diff --git a/extensions/objects/models/objects.py b/extensions/objects/models/objects.py
@@ -186,12 +186,19 @@ class CodeEvaluation(BaseObject):
 
     SCHEMA = {
         'type': 'dict',
-        'properties': {
-            'code': UnicodeString.SCHEMA,
-            'output': UnicodeString.SCHEMA,
-            'evaluation': UnicodeString.SCHEMA,
-            'error': UnicodeString.SCHEMA,
-        }
+        'properties': [{
+            'name': 'code',
+            'schema': UnicodeString.SCHEMA,
+        }, {
+            'name': 'output',
+            'schema': UnicodeString.SCHEMA,
+        }, {
+            'name': 'evaluation',
+            'schema': UnicodeString.SCHEMA,
+        }, {
+            'name': 'error',
+            'schema': UnicodeString.SCHEMA,
+        }]
     }
 
 
@@ -263,48 +270,6 @@ class MathLatexString(BaseObject):
     SCHEMA = UnicodeString.SCHEMA
 
 
-class TabContent(BaseObject):
-    """Class for editing the content of a single tab.
-
-    The object is described by a dict with two keys: 'title' and 'content'.
-    These have types UnicodeString and Html respectively.
-    """
-
-    description = 'Content for a single tab.'
-    edit_html_filename = 'tab_content_editor'
-    edit_js_filename = 'TabContentEditor'
-
-    SCHEMA = {
-        'type': 'dict',
-        'properties': {
-            'title': {
-                'type': 'unicode',
-                'post_normalizers': [{
-                    'id': 'require_nonempty'
-                }]
-            },
-            'content': Html.SCHEMA,
-        }
-    }
-
-
-class ListOfTabContent(BaseObject):
-    """Class for editing the content of a tabbed view.
-
-    The object is described by a list of dicts, each representing a TabContent
-    object.
-    """
-
-    description = 'Content for a set of tabs.'
-    edit_html_filename = 'list_editor'
-    edit_js_filename = 'ListOfTabContentEditor'
-
-    SCHEMA = {
-        'type': 'list',
-        'items': TabContent.SCHEMA,
-    }
-
-
 class SanitizedUrl(BaseObject):
     """HTTP or HTTPS url string class."""
 
@@ -328,12 +293,21 @@ class MusicPhrase(BaseObject):
     edit_html_filename = 'music_phrase_editor'
     edit_js_filename = 'MusicPhraseEditor'
 
+    _FRACTION_PART_SCHEMA = {
+        'type': 'int',
+        'post_normalizers': [{
+            'id': 'require_at_least',
+            'min_value': 1
+        }]
+    }
+
     SCHEMA = {
         'type': 'list',
         'items': {
             'type': 'dict',
-            'properties': {
-                'readableNoteName': {
+            'properties': [{
+                'name': 'readableNoteName',
+                'schema': {
                     'type': 'unicode',
                     'post_normalizers': [{
                         'id': 'require_is_one_of',
@@ -342,28 +316,20 @@ class MusicPhrase(BaseObject):
                             'D5', 'E5', 'F5', 'G5', 'A5'
                         ]
                     }]
-                },
-                'noteDuration': {
+                }
+            }, {
+                'name': 'noteDuration',
+                'schema': {
                     'type': 'dict',
-                    'properties': {
-                        'num': {
-                            'type': 'int',
-                            'post_normalizers': [{
-                                'id': 'require_at_least',
-                                'min_value': 1
-                            }]
-                        },
-                        'den': {
-                            'type': 'int',
-                            'post_normalizers': [{
-                                'id': 'require_at_least',
-                                'min_value': 1
-                            }]
-                        }
-                    }
-                },
-            }
-
+                    'properties': [{
+                        'name': 'num',
+                        'schema': _FRACTION_PART_SCHEMA
+                    }, {
+                        'name': 'den',
+                        'schema': _FRACTION_PART_SCHEMA
+                    }]
+                }
+            }],
         }
     }
 

diff --git a/extensions/widgets/noninteractive/Tabs/Tabs.py b/extensions/widgets/noninteractive/Tabs/Tabs.py
@@ -3,17 +3,20 @@
 
 TAB_CONTENT_SCHEMA = {
     'type': 'dict',
-    'properties': {
-        'title': {
+    'properties': [{
+        'name': 'title',
+        'schema': {
             'type': 'unicode',
             'post_normalizers': [{
                 'id': 'require_nonempty'
             }]
-        },
-        'content': {
+        }
+    }, {
+        'name': 'content',
+        'schema': {
             'type': 'html',
         }
-    }
+    }]
 }
 
 

diff --git a/schema_utils.py b/schema_utils.py
@@ -40,6 +40,8 @@
 SCHEMA_KEY_TYPE = 'type'
 SCHEMA_KEY_POST_NORMALIZERS = 'post_normalizers'
 SCHEMA_KEY_CHOICES = 'choices'
+SCHEMA_KEY_NAME = 'name'
+SCHEMA_KEY_SCHEMA = 'schema'
 
 SCHEMA_TYPE_BOOL = 'bool'
 SCHEMA_TYPE_DICT = 'dict'
@@ -69,12 +71,15 @@ def normalize_against_schema(obj, schema):
         normalized_obj = obj
     elif schema[SCHEMA_KEY_TYPE] == SCHEMA_TYPE_DICT:
         assert isinstance(obj, dict), ('Expected dict, received %s' % obj)
-        assert set(obj.keys()) == set(schema[SCHEMA_KEY_PROPERTIES].keys())
-        normalized_obj = {
-            key: normalize_against_schema(
-                obj[key], schema[SCHEMA_KEY_PROPERTIES][key])
-            for key in schema[SCHEMA_KEY_PROPERTIES]
-        }
+        expected_dict_keys = [
+            p[SCHEMA_KEY_NAME] for p in schema[SCHEMA_KEY_PROPERTIES]]
+        assert set(obj.keys()) == set(expected_dict_keys)
+
+        normalized_obj = {}
+        for prop in schema[SCHEMA_KEY_PROPERTIES]:
+            key = prop[SCHEMA_KEY_NAME]
+            normalized_obj[key] = normalize_against_schema(
+                obj[key], prop[SCHEMA_KEY_SCHEMA])
     elif schema[SCHEMA_KEY_TYPE] == SCHEMA_TYPE_FLOAT:
         obj = float(obj)
         assert isinstance(obj, numbers.Real), (