Changeset 420 for Dev/branches/rest-dojo-ui/client/qed/pages

Timestamp:

12/16/12 20:07:35 (12 years ago)

Author:

hendrikvanantwerpen

Message:

We can store answers for surveys now!

Introduces SurveyRun?, which can be edited. Workflow not quite clear yet. A
running survey can be accessed to leave a response. When the response
has an ID, it is loaded (used for closed surveys and continuations). A
researcher cannot create responses yet. He should also be able to add
comments to responses (that he creates).

Introduced caching of store requests.

Factored out path matching and formatting.

Put object creation in separate classes, to localize model/storage
dependency. Not consistent at the moment.

Location:

Dev/branches/rest-dojo-ui/client/qed/pages

Files:

• previewSurvey.js (moved) (moved from Dev/branches/rest-dojo-ui/client/qed/pages/viewSurvey.js) (1 diff)
• question.js (modified) (3 diffs)
• response.js (added)
• session.js (modified) (4 diffs)
• survey.js (modified) (6 diffs)
• surveyRun.js (copied) (copied from Dev/branches/rest-dojo-ui/client/qed/pages/survey.js) (2 diffs)
• surveys.js (modified) (5 diffs)
• templates/previewSurvey.html (moved) (moved from Dev/branches/rest-dojo-ui/client/qed/pages/templates/viewSurvey.html) (1 diff)
• templates/response.html (added)
• templates/surveyRun.html (added)
• templates/surveys.html (modified) (1 diff)

Dev/branches/rest-dojo-ui/client/qed/pages/previewSurvey.js

@@ -2 +2 @@
     'dojo/_base/array',
     'dojo/_base/declare',
-    'dojo/_base/Deferred',
-    'dojo/_base/event',
     'dojo/_base/lang',
+    'dojo/when',
     '../store',
     '../app/Page',
-    '../model/widgets/QuestionWidgetFactory',
-    'dojo/text!./templates/viewSurvey.html'
-],function(array,declare,Deferred,event,lang,store,Page,QuestionWidgetFactory,template){
+    'dojo/text!./templates/previewSurvey.html'
+],function(array,declare,lang,when,store,Page,template){
     return declare([Page],{
         templateString: template,
-        survey: null,
-        surveyId: "",
-        options: null,
-        constructor: function(){
-            this._dataMap = {};
-            this.options = this.options || {};
-        },
         startup: function() {
             if ( this._started ) { return; }
             this.inherited(arguments);
-
-
             if ( this.surveyId ) {
-                Deferred.when(store.get(this.surveyId))
+                when(store.get(this.surveyId))
                 .then(lang.hitch(this,function(survey){
-                    if ( !survey.published ) {
-                        this.options.preview = true;
-                    }
-                    if ( this.options.preview ) {
-                        this.buttonsPane.destroyRecursive();
-                    }
-                    this.titleNode.innerHTML = survey.title +
-                            (this.options.preview?' [preview]':'');
-                    var f = new QuestionWidgetFactory();
-                    this.survey = survey;
-                    store.query(null,{keys:this.survey.questions,include_docs:true})
-                    .forEach(function(question){
-                        array.forEach(question.content || [],function(item){
-                            var w = f.createViewWidget(item,{
-                                name: question.code+'.'+item.code
-                            });
-                            if ( w !== null ) {
-                                w.placeAt(this.questionsAnchor,'before');
-                            }
-                        },this);
-                    },this);
+                    this.titleNode.innerHTML = survey.title;
+                    this.surveyWidget.set('survey',survey);
                 }));
             } else {
                 throw new Error("No valid uid or survey passed!");
             }
-        },
-        _onSubmit: function(evt) {
-            if ( this.options.preview ) { return; }
-            var value = this.questionsForm.get('value');
-            this.questionsPane.set('content','<pre>'+JSON.stringify(value)+'</pre>');
-            event.stop(evt);
-            return false;
-        },
-        _onCancel: function(evt) {
-            if ( this.options.preview ) { return; }
-            event.stop(evt);
-            return false;
         }
     });

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

@@ -1 +1 @@
 define([
     'dojo/_base/declare',
-    'dojo/_base/Deferred',
     'dojo/_base/event',
     'dojo/_base/lang',
+    'dojo/when',
     '../store',
     '../app/Content',
     '../app/Router',
     '../app/Page',
+    '../model/classes/Question',
     '../model/widgets/QuestionEditorPreview',
     '../model/widgets/QuestionEditorToolkit',
     'dojo/text!./templates/question.html'
-],function(declare, Deferred, event, lang, store, Content, Router, Page, QuestionEditorPreview, QuestionEditorToolkit, template){
+],function(declare, event, lang, when, store, Content, Router, Page, Question, QuestionEditorPreview, QuestionEditorToolkit, template){
     return declare([Page], {
         templateString: template,
@@ -26 +27 @@
             this._setupEditor();
             if (this.questionId === "new") {
-                this.question = { type: 'Question' };
+                this.question = Question.create();
                 this._refresh();
             } else {
-                Deferred.when(store.get(this.questionId))
+                when(store.get(this.questionId))
                 .then(lang.hitch(this, function(obj) {
                     this.question = obj;
@@ -40 +41 @@
         },
         _refresh: function () {
-            this.titleNode.innerHTML = this.question.title || "";
+            this.titleNode.innerHTML = Question.DisplayTitle.get(this.question);
             this._toolkit.set('value',this.question);
-            this._preview.appendItems(this.question.content || []);
+            this._preview.appendItems(Question.Content.get(this.question));
         },
         _onSave: function(evt) {
             lang.mixin(this.question, this._toolkit.get('value'));
-            this.question.content = this._preview.getItems();
+            Question.Content.set(this.question, this._preview.getItems());
             store.put(this.question)
             .then(function() {

Dev/branches/rest-dojo-ui/client/qed/pages/session.js

@@ -2 +2 @@
     'dojo/_base/array',
     'dojo/_base/declare',
-    'dojo/_base/Deferred',
     'dojo/_base/event',
     'dojo/_base/lang',
+    'dojo/when',
     '../search',
     '../store',
@@ -10 +10 @@
     '../app/Router',
     '../widgets/ThresholdFilteringSelect',
+    '../model/classes/SessionTemplate',
     '../model/widgets/AccountListView',
     'dojo/text!./templates/session.html'
-],function(array,declare,Deferred,event,lang,search,store,Page,Router,ThresholdFilteringSelect,AccountListView,template){
+],function(array,declare,event,lang,when,search,store,Page,Router,ThresholdFilteringSelect,SessionTemplate,AccountListView,template){
     return declare([Page],{
         templateString: template,
@@ -30 +31 @@
         _loadSession: function() {
             if ( this.sessionId === "new" ) {
-                this.session = {
-                    type: 'SessionTemplate'
-                };
+                this.session = SessionTemplate.create();
             } else {
-                Deferred.when(store.get(this.sessionId))
+                when(store.get(this.sessionId))
                 .then(lang.hitch(this,function(obj){
                     this.session = obj;
@@ -43 +42 @@
         },
         _refresh: function() {
-            this.titleNode.innerHTML = this.session.title || '';
+            this.titleNode.innerHTML = SessionTemplate.DisplayTitle.get(this.session);
             this.propertiesForm.set('value',this.session);
         },

Dev/branches/rest-dojo-ui/client/qed/pages/survey.js

@@ -2 +2 @@
     'dojo/_base/array',
     'dojo/_base/declare',
-    'dojo/_base/Deferred',
     'dojo/_base/event',
     'dojo/_base/lang',
+    'dojo/when',
     '../app/Router',
     '../store',
     '../app/Page',
+    '../model/classes/Survey',
     '../model/widgets/QuestionListView',
     '../model/widgets/TabbedQuestionBrowser',
     'dojo/text!./templates/survey.html'
-],function(array,declare,Deferred,event,lang,Router,store,Page,
+],function(array,declare,event,lang,when,Router,store,Page,Survey,
          QuestionListView,TabbedQuestionBrowser,template){
     return declare([Page],{
@@ -17 +18 @@
         survey: null,
         questionList: null,
-        _dataMap: null,
-        constructor: function(){
-            this._dataMap = {};
-        },
         startup: function() {
             if ( this._started ) { return; }
@@ -62 +59 @@
         _loadSurvey: function() {
             if ( this.surveyId === "new" ) {
-                this.survey = {
-                    type: 'Survey'
-                };
+                this.survey = Survey.create();
                 this.refresh();
             } else {
-                Deferred.when(store.get(this.surveyId))
+                when(store.get(this.surveyId))
                 .then(lang.hitch(this,function(survey){
                     this.survey = survey;
-                    store.query(null,{keys:this.survey.questions || [], include_docs: true})
-                    .forEach(lang.hitch(this.questionList,'appendItem'));
+                    array.forEach(Survey.Questions.get(this.survey),
+                        lang.hitch(this.questionList,'appendItem'));
                     this.refresh();
                 }));
@@ -80 +75 @@
         },
         refresh: function() {
-            this.titleNode.innerHTML = this.survey.title || "(set title in properties)";
+            this.titleNode.innerHTML = Survey.DisplayTitle.get(this.survey) || "(set title in properties)";
             this.propertiesDialog.set('value',this.survey);
         },
@@ -100 +95 @@
         },
         _onSave: function(evt) {
-            this.survey.questions = array.map(this.questionList.getItems(),function(item){
-                return store.getIdentity(item);
-            });
+            this.survey.questions = this.questionList.getItems();
             store.put(this.survey)
             .then(function() { 
@@ -114 +107 @@
         },
         _onShowPreview: function() {
-            Router.go('/viewSurvey/'+store.getIdentity(this.survey),{
+            Router.go('/previewSurvey/'+store.getIdentity(this.survey),{
                 preview: true
             });

Dev/branches/rest-dojo-ui/client/qed/pages/surveyRun.js

@@ -1 +1 @@
 define([
-    'dojo/_base/array',
     'dojo/_base/declare',
-    'dojo/_base/Deferred',
     'dojo/_base/event',
     'dojo/_base/lang',
+    'dojo/when',
+    '../app/Content',
     '../app/Router',
+    '../lib/func',
     '../store',
     '../app/Page',
-    '../model/widgets/QuestionListView',
-    '../model/widgets/TabbedQuestionBrowser',
-    'dojo/text!./templates/survey.html'
-],function(array,declare,Deferred,event,lang,Router,store,Page,
-         QuestionListView,TabbedQuestionBrowser,template){
+    '../model/classes/SurveyRun',
+    'dojo/text!./templates/surveyRun.html'
+],function(declare,event,lang,when,Content,Router,func,store,Page,SurveyRun,template){
     return declare([Page],{
         templateString: template,
-        survey: null,
-        questionList: null,
-        _dataMap: null,
-        constructor: function(){
-            this._dataMap = {};
-        },
+        surveyRun: null,
         startup: function() {
             if ( this._started ) { return; }
             this.inherited(arguments);
-            if ( this.surveyId ) {
-                this._setupQuestionBrowser();
-                this._setupListView();
-                this._loadSurvey();
+            this.propertiesForm.on("blur",lang.hitch(this,'_onPropChange'));
+            if ( this.surveyRunId ) {
+                this._loadSurveyRun();
             } else {
                 throw "No valid uid or survey passed!";
             }
         },
-        _setupQuestionBrowser: function() {
-            this.questionBrowser = new TabbedQuestionBrowser({
-                region: 'center',
-                'class': 'blue',
-                include: 'published',
-                selectedActions: {
-                    "Include": {
-                        callback: lang.hitch(this,this._includeQuestion),
-                        icon: "Accept",
-                        description: "Include in survey"
-                    }
-                },
-                itemActions: {
-                    "Info": {
-                        callback: function(item){ item.description && alert(item.description); },
-                        icon: "Inspect",
-                        description: "Show item description"
-                    }
-                }
-            },this.questionBrowser);
-            this.questionBrowser.startup();
+        _loadSurveyRun: function() {
+            when(store.get(this.surveyRunId))
+            .then(lang.hitch(this,function(surveyRun){
+                this.surveyRun = surveyRun;
+                this.refresh();
+            }));
         },
-        _setupListView: function() {
-            this.questionList = new QuestionListView({
-                region: 'center'
-            },this.surveyListViewNode);
-            this.questionList.startup();
+        refresh: function() {
+            this.titleNode.innerHTML = SurveyRun.DisplayTitle.get(this.surveyRun);
+            this.surveyNode.set('value',SurveyRun.Survey.get(this.surveyRun));
+            this.propertiesForm.set('value',this.surveyRun);
+            this._onPropChange();
         },
-        _loadSurvey: function() {
-            if ( this.surveyId === "new" ) {
-                this.survey = {
-                    type: 'Survey'
-                };
-                this.refresh();
+        _onPropChange: function(e) {
+            var surveyRun = this.propertiesForm.get('value');
+            if ( surveyRun.mode === "open" ) {
+                var url = 'response.html#!/'+store.getIdentity(this.surveyRun);
+                this.runURLNode.innerHTML = '<a target="_black" href="'+url+'">'+url+'</a>';
             } else {
-                Deferred.when(store.get(this.surveyId))
-                .then(lang.hitch(this,function(survey){
-                    this.survey = survey;
-                    store.query(null,{keys:this.survey.questions || [], include_docs: true})
-                    .forEach(lang.hitch(this.questionList,'appendItem'));
-                    this.refresh();
-                }));
+                this.runURLNode.innerHTML = "No general URL. Add individual respondents below.";
             }
         },
-        _includeQuestion: function(question) {
-            this.questionList.insertItem(question);
-        },
-        refresh: function() {
-            this.titleNode.innerHTML = this.survey.title || "(set title in properties)";
-            this.propertiesDialog.set('value',this.survey);
-        },
-        _onShowProperties: function(evt) {
-            this.propertiesDialog.show();
-        },
-        _onPropertiesOk: function(evt) {
-            this.propertiesDialog.hide();
-            lang.mixin(this.survey, this.propertiesDialog.get('value'));
-            this.refresh();
-            event.stop(evt);
-            return false;
-        },
-        _onPropertiesCancel: function(evt) {
-            this.propertiesDialog.hide();
-            this.propertiesDialog.reset('value',this.survey);
-            event.stop(evt);
-            return false;
-        },
         _onSave: function(evt) {
-            this.survey.questions = array.map(this.questionList.getItems(),function(item){
-                return store.getIdentity(item);
-            });
-            store.put(this.survey)
+            lang.mixin(this.surveyRun,this.propertiesForm.get('value'));
+            var not = function(p){ return !p; };
+            func.modPropIf(this.surveyRun,"startDate",not.compose(lang.isString),store.formatDate);
+            func.modPropIf(this.surveyRun,"endDate",not.compose(lang.isString),store.formatDate);
+            store.put(this.surveyRun)
             .then(function() { 
                 Router.go('/surveys');
+            },function(err){
+                Content.notify(err);
             });
             event.stop(evt);
@@ -112 +63 @@
         _onDiscard: function(evt) {
             Router.go('/surveys');
-        },
-        _onShowPreview: function() {
-            Router.go('/viewSurvey/'+store.getIdentity(this.survey),{
-                preview: true
-            });
         }
     });

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

@@ -9 +9 @@
     '../app/Page',
     '../app/Router',
+    '../model/classes/Survey',
+    '../model/classes/SurveyRun',
     '../widgets/LineWithActionsWidget',
     'dojo/text!./templates/surveys.html'
-],function(array,declare,lang,when,Rx,store,Content,Page,Router,LineWithActionsWidget,template){
+],function(array,declare,lang,when,Rx,store,Content,Page,Router,Survey,SurveyRun,LineWithActionsWidget,template){
     return declare([Page],{
         templateString: template,
@@ -45 +47 @@
         },
         _onPreviewSurvey:function(survey){
-            Router.go('/viewSurvey/'+store.getIdentity(survey),{preview:true});
+            Router.go('/previewSurvey/'+store.getIdentity(survey));
         },
         _onRunSurvey:function(survey){
-            this.surveyRun = {
-                type: 'SurveyRun',
-                surveyId: store.getIdentity(survey),
-                publicationDate: store.timestamp()
-            };
-            this.surveyRunDialog.set('value',this.surveyRun);
-            this.surveyRunDialog.show();
-        },
-        _onSurveyRunOk: function() {
-            var surveyRun = lang.mixin(lang.clone(this.surveyRun),this.surveyRunDialog.get('value'));
+            var surveyRun = SurveyRun.create();
+            SurveyRun.Survey.set(surveyRun,survey);
             store.put(surveyRun)
-            .then(lang.hitch(this,function(){
-                this.surveyRunDialog.hide();
-                this.refreshRuns();
+            .then(lang.hitch(this,function(surveyRun){
+                this._onRunDetails(surveyRun);
             }),function(err){
                 Content.notify(err);
             });
         },
-        _onSurveyRunCancel: function() {
-            this.surveyRunDialog.hide();
+        _onRunDetails: function(surveyRun) {
+            Router.go('/surveyRun/'+store.getIdentity(surveyRun));
         },
         refresh: function() {
@@ -81 +74 @@
                 array.forEach(surveys,function(survey){
                     var w = new LineWithActionsWidget({
-                        title: survey.title || '(unnamed)',
+                        title: Survey.DisplayTitle.get(survey) || '(unnamed)',
                         actions: [{
                             callback: lang.hitch(this,'_onPublishSurvey',survey),
@@ -123 +116 @@
                 array.forEach(surveys,function(survey){
                     var w = new LineWithActionsWidget({
-                        title: survey.title,
+                        title: Survey.DisplayTitle.get(survey),
                         actions:[{
                             callback: lang.hitch(this,'_onPreviewSurvey',survey),
@@ -151 +144 @@
                 array.forEach(surveyRuns,function(surveyRun){
                     var w = new LineWithActionsWidget({
-                        title: surveyRun.title+" (from "+surveyRun.startDate+" to "+surveyRun.endDate+")",
+                        title: SurveyRun.DisplayTitle.get(surveyRun),
                         actions:[{
-                            callback: lang.hitch(this,'_onCloseRun',surveyRun),
+                            callback: lang.hitch(this,'_onRunDetails',surveyRun),
                             properties: {
-                                label: 'Close',
-                                tooltip: 'Close survey',
-                                icon: 'Close'
+                                label: 'Details',
+                                tooltip: 'Show details for this run',
+                                icon: 'Details'
                             }
                         }]

Dev/branches/rest-dojo-ui/client/qed/pages/templates/previewSurvey.html

@@ -9 +9 @@
     
     <div data-dojo-type="dijit/layout/ContentPane" data-dojo-props="region:'center'" data-dojo-attach-point="questionsPane">
-        <form data-dojo-type="dijit/form/Form" data-dojo-attach-point="questionsForm"
-              data-dojo-attach-event="onSubmit:_onSubmit"
-              style="overflow: auto">
-            <div data-dojo-attach-point="questionsAnchor"></div>
+        <form data-dojo-type="dijit/form/Form" data-dojo-attach-point="questionsForm" style="overflow: auto">
+            <div data-dojo-type="qed/model/widgets/SurveyWidget" data-dojo-attach-point="surveyWidget"></div>
         </form>
     </div>
     
-    <div data-dojo-attach-point="buttonsPane" data-dojo-type="dijit/layout/ContentPane" data-dojo-props="region:'bottom'">
-        <button data-dojo-type="dijit/form/Button"
-                type="submit"
-                data-dojo-attach-event="onClick:_onSubmit">
-            Submit</button>
-        <button data-dojo-type="dijit/form/Button"
-                type="button"
-                data-dojo-attach-event="onClick:_onCancel">
-            Cancel</button>
-    </div>
-
 </div>

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

@@ -36 +36 @@
     </div>
 
-    <div data-dojo-type="dijit/Dialog"
-         title="SurveyRun properties"
-         data-dojo-attach-point="surveyRunDialog">
-        <fieldset data-dojo-type="qed/model/widgets/SurveyRunFieldset"></fieldset>
-        <button data-dojo-type="dijit/form/Button" data-dojo-attach-event="onClick:_onSurveyRunOk">OK</button>
-        <button data-dojo-type="dijit/form/Button" data-dojo-attach-event="onClick:_onSurveyRunCancel">Cancel</button>
-    </div>
-
 </div>