Changeset 415 for Dev/branches/rest-dojo-ui/client

Timestamp:

12/04/12 16:29:49 (12 years ago)

Author:

hendrikvanantwerpen

Message:

Support data validation and increase dendency separation.

Added json-schema validation before documents are saved. Acts both as
a safe-guard and as a reference of the data model.

Added directory for server related material. For now it contains scripts
to configure CouchDB and check validity of documents against the schema.

Started separating out parts that depend on the data model from parts
that do not.

Location:

Dev/branches/rest-dojo-ui/client/rft

Files:

• pages/question.html (modified) (1 diff)
• pages/question.js (modified) (4 diffs)
• pages/questions.js (modified) (3 diffs)
• pages/survey.html (modified) (1 diff)
• pages/surveys.html (modified) (1 diff)
• pages/surveys.js (modified) (4 diffs)
• pages/viewSurvey.js (modified) (2 diffs)
• schema.js (added)
• stddeps.js (modified) (2 diffs)
• store.js (modified) (1 diff)
• store/CouchStore.js (modified) (3 diffs)
• ui/QuestionEditorPreviewItem.js (modified) (4 diffs)
• ui/generic (added)
• ui/generic/DateTimeTextBox.js (added)
• ui/generic/TemplatedForm.js (added)
• ui/generic/templates (added)
• ui/generic/templates/DateTimeTextBox.html (added)
• ui/model (moved) (moved from Dev/branches/rest-dojo-ui/client/rft/ui/content)
• ui/model/ContentWidgetFactory.js (deleted)
• ui/model/QuestionWidgetFactory.js (copied) (copied from Dev/branches/rest-dojo-ui/client/rft/ui/content/ContentWidgetFactory.js)
• ui/model/SurveyForm.js (added)
• ui/model/SurveyRunForm.js (added)
• ui/model/templates (added)
• ui/model/templates/SurveyForm.html (added)
• ui/model/templates/SurveyRunForm.html (added)

Dev/branches/rest-dojo-ui/client/rft/pages/question.html

@@ -3 +3 @@
         <h2>
             <span class="rftIcon rftIconSurvey"></span>
-            <span class="headerText">Question 123 [Editing]</span>
+            <span class="headerText"><span data-dojo-attach-point="titleNode">Question title</span> [Editing]</span>
         </h2>
     </div>

Dev/branches/rest-dojo-ui/client/rft/pages/question.js

@@ -21 +21 @@
             if ( this._started ) { return; }
             this.inherited(arguments);
-            if (this.questionId) {
+            if ( !this.questionId ) {
+                throw new Error("Error: no reference to object set!");
+            }
+            this._setupEditor();
+            if (this.questionId === "new") {
+                this.question = { type: 'Question' };
+                this._refresh();
+            } else {
                 Deferred.when(store.get(this.questionId))
                 .then(lang.hitch(this, function(obj) {
@@ -27 +34 @@
                     this._refresh();
                 }));
-            } else {
-                throw new Error("Error: no reference to object set!");
             }
-            this._setupEditor();
         },
         onLeave: function() {
@@ -36 +40 @@
         },
         _refresh: function () {
+            this.titleNode.innerHTML = this.question.title || "";
             this._toolkit.set('value',this.question);
             this._preview.appendItems(this.question.content || []);
@@ -46 +51 @@
                 Router.go('/questions');
             },function(err){
-                Content.notify(err.reason,'error');
+                Content.notify(err,'error');
             });
             evt && event.stop( evt );

Dev/branches/rest-dojo-ui/client/rft/pages/questions.js

@@ -40 +40 @@
         },
         onNewQuestion: function() {
-            Deferred.when(store.add({type:'Question'}))
-            .then(lang.hitch(this,function(question){
-                this.onEditQuestion(question);
-            }));
+            Router.go("/question/new");
         },
         onDeleteQuestion: function(question) {
@@ -50 +47 @@
                 Content.notify("Question deleted.");
             },function(err){
-                Content.notify(err.reason,'error');
+                Content.notify(err,'error');
             });
         },
@@ -62 +59 @@
                 Content.notify("Question published.");
             },function(err){
-                Content.notify(err.reason,'error');
+                Content.notify(err,'error');
             });
         }

Dev/branches/rest-dojo-ui/client/rft/pages/survey.html

@@ -40 +40 @@
          data-dojo-attach-event="onSubmit:_onPropertiesOk">
 
-        <form data-dojo-type="dijit/form/Form"
-              data-dojo-attach-point="propertiesForm">
-            <label for="title">Title</label>
-            <input data-dojo-type="dijit/form/TextBox" name="title"/><br/>
-            <label for="description">Description</label>
-            <input data-dojo-type="dijit/form/Textarea" name="description"/><br/>
-        </form>
+        <div data-dojo-type="rft/ui/model/SurveyForm"
+              data-dojo-attach-point="propertiesForm"></div>
             
         <div>

Dev/branches/rest-dojo-ui/client/rft/pages/surveys.html

@@ -36 +36 @@
     </div>
 
+    <div data-dojo-type="dijit/Dialog"
+         title="SurveyRun properties"
+         data-dojo-attach-point="surveyRunDialog">
+        <form data-dojo-type="rft/ui/model/SurveyRunForm" data-dojo-attach-point="surveyRunForm">
+            <button data-dojo-type="dijit/form/Button">OK</button>
+            <button data-dojo-type="dijit/form/Button">Cancel</button>
+        </form>
+    </div>
+
 </div>

Dev/branches/rest-dojo-ui/client/rft/pages/surveys.js

@@ -23 +23 @@
                 Router.go('/survey/'+store.getIdentity(survey));
             },function(err){
-                Content.notify(err.reason,'error');
+                Content.notify(err,'error');
             });
         },
@@ -33 +33 @@
                 self.refreshPublished();
             },function(err){
-                Content.notify(err.reason,'error');
+                Content.notify(err,'error');
             });
         },
@@ -42 +42 @@
                 self.refreshDrafts();
             },function(err){
-                Content.notify(err.reason,'error');
+                Content.notify(err,'error');
             });
         },
@@ -52 +52 @@
         },
         _onRunSurvey:function(survey){
-
+            this.surveyRunDialog.show();
         },
         refresh: function() {

Dev/branches/rest-dojo-ui/client/rft/pages/viewSurvey.js

@@ -7 +7 @@
     '../store',
     '../app/Page',
-    '../ui/content/ContentWidgetFactory',
+    '../ui/model/QuestionWidgetFactory',
     'dojo/text!./viewSurvey.html'
-],function(array,declare,Deferred,event,lang,store,Page,ContentWidgetFactory,template){
+],function(array,declare,Deferred,event,lang,store,Page,QuestionWidgetFactory,template){
     return declare([Page],{
         templateString: template,
@@ -35 +35 @@
                     this.titleNode.innerHTML = survey.title +
                             (this.options.preview?' [preview]':'');
-                    var f = new ContentWidgetFactory();
+                    var f = new QuestionWidgetFactory();
                     this.survey = survey;
                     store.query(null,{keys:this.survey.questions,include_docs:true})

Dev/branches/rest-dojo-ui/client/rft/stddeps.js

@@ -21 +21 @@
     'dijit/form/Textarea',
     'dijit/form/TextBox',
+    'dijit/form/TimeTextBox',
 
     'dojox/grid/DataGrid',
@@ -33 +34 @@
     'rft/ui/Selector',
     'rft/ui/TitleGroup',
+    'rft/ui/generic/DateTimeTextBox',
+    'rft/ui/model/SurveyForm',
+    'rft/ui/model/SurveyRunForm',
     'rft/ui/lists/AccountListView',
     'rft/ui/lists/List',

Dev/branches/rest-dojo-ui/client/rft/store.js

@@ -1 +1 @@
 define([
     'dojo/date/stamp',
+    'dojox/json/schema',
+    './schema',
     './store/CouchStore'
-],function(stamp,CouchStore){
+],function(stamp,jsonSchema,schema,CouchStore){
     
-    var store = new CouchStore({target: 'data/couch/'});
+    var store = new CouchStore({
+        target: 'data/couch/',
+        validate: function(object) {
+            var result = jsonSchema.validate(object,schema);
+            if ( result.valid ) {
+                return true;
+            } else {
+                console.log("Found error ",result," for invalid object ",object);
+                return false;
+            }
+        }
+    });
     store.formatDate = function(date){
         return stamp.toISOString(date,{zulu:true});

Dev/branches/rest-dojo-ui/client/rft/store/CouchStore.js

@@ -10 +10 @@
     
     function getCouchError(err){
-        return (err.response && err.response.data)
-                ? json.fromJson(err.response.data)
-                : "Unknown error.";
+        var reason = err.response &&
+                     err.response.data &&
+                     json.fromJson(err.response.data).reason;
+        return reason || "Unknown error.";
     }
 
@@ -74 +75 @@
             return dfd.promise;
         },
+        validate: function(object) {
+            return true;
+        },
         put: function(object, options){
              // summary:
@@ -83 +87 @@
              //         id: String
              //
+
+            if ( !this.validate(object) ) {
+                var dfd = new Deferred();
+                dfd.reject("Invalid document.");
+                return dfd.promise;
+            }
+            return this._putValid(object, options);
+
+        },
+        _putValid: function(object,options) {
+            var dfd = new Deferred();
             options = options || {};
-
-            var dfd = new Deferred();
             var id = options.id ? options.id : this.getIdentity(object);
-            var hasId = typeof id != "undefined";
+            var hasId = typeof id !== "undefined";
             xhr(hasId ? "PUT" : "POST", {
                 url: hasId ? this.target + id : this.target,

Dev/branches/rest-dojo-ui/client/rft/ui/QuestionEditorPreviewItem.js

@@ -10 +10 @@
     'dijit/_WidgetBase',
     'dijit/_WidgetsInTemplateMixin',
-    './content/ContentWidgetFactory',
+    './model/QuestionWidgetFactory',
     'dojo/text!./templates/QuestionEditorPreviewItem.html'
 ], function(
@@ -23 +23 @@
     _WidgetBase,
     _WidgetsInTemplateMixin,
-    ContentWidgetFactory,
+    QuestionWidgetFactory,
     template
 ){
@@ -55 +55 @@
         },
         _showViewWidget: function() {
-            var factory = new ContentWidgetFactory();
+            var factory = new QuestionWidgetFactory();
             this.innerWidget = factory.createViewWidget( this.item );
             if ( this.innerWidget !== null ) {
@@ -65 +65 @@
         },
         _showEditWidget: function() {
-            var factory = new ContentWidgetFactory();
+            var factory = new QuestionWidgetFactory();
             this.innerWidget = factory.createEditWidget( this.item );
             if ( this.innerWidget !== null ) {