Changeset 1260

Timestamp:

Dec 10, 2010, 3:12:28 PM (13 years ago)

Author:

work@…

Message:

• resolves #198, user friendly error messages in wizard

Location:

trunk/grails-app

Files:

• controllers/dbnp/studycapturing/WizardController.groovy (modified) (26 diffs)
• i18n/messages.properties (modified) (1 diff)
• i18n/messages_nl.properties (modified) (1 diff)
• views/wizard/common/_error.gsp (modified) (1 diff)

trunk/grails-app/controllers/dbnp/studycapturing/WizardController.groovy

@@ -8 +8 @@
 import dbnp.authentication.AuthenticationService
 import dbnp.authentication.SecUser
+import org.codehaus.groovy.grails.plugins.web.taglib.ValidationTagLib
 
 
@@ -30 +31 @@
 class WizardController {
         def authenticationService
+        def validationTagLib = new ValidationTagLib()   
 
         /**
@@ -145 +147 @@
                                         }
                                 } else if (flow.jump && flow.jump.action == 'create') {
+                                        if (!flow.study) flow.study = new Study()
                                         toStudyPage()
                                 } else {
@@ -167 +170 @@
                                 // clean the flow scope
                                 flow.remove('study')
+
+                                // create a new study instance
+                                if (!flow.study) flow.study = new Study()                               
 
                                 // set 'quicksave' variable to false
@@ -469 +475 @@
                                 // remove eventGroup
                                 def eventGroupToRemove = flow.study.eventGroups.find { it.getIdentifier() == (params.get('do') as int) }
-                                if (eventGroupToRemove) {
-                                        println flow.study.deleteEventGroup( eventGroupToRemove )
-                                }
                         }.to "events"
                         on("previous") {
@@ -664 +667 @@
                                     flow.assay.setFieldValue(
                                             'externalAssayID',
-                                            this.ucwords(flow.study.code).replaceAll("([ ]{1,})", "") + '_' + this.ucwords(template.name).replaceAll("([ ]{1,})", "")
+                                            ucwords(flow.study.code).replaceAll("([ ]{1,})", "") + '_' + ucwords(template.name).replaceAll("([ ]{1,})", "")
                                     )
                             }
@@ -673 +676 @@
                                     flow.assay.setFieldValue(
                                             'externalAssayID',
-                                            this.ucwords(flow.study.code).replaceAll("([ ]{1,})", "") + '_' + this.ucwords(template.name).replaceAll("([ ]{1,})", "")
+                                            ucwords(flow.study.code).replaceAll("([ ]{1,})", "") + '_' + ucwords(template.name).replaceAll("([ ]{1,})", "")
                                     )
                             }
@@ -708 +711 @@
                         }.to "assays"
                         on("deleteAssay") {
-                                println params
-
                                 // handle form data
                                 assayPage(flow, flash, params)
@@ -908 +909 @@
          */
         def loadStudy(flow, flash, params, user) {
-                flash.wizardErrors = new LinkedHashMap()
+                flash.wizardErrors      = [:]
                 
                 // load study
@@ -960 +961 @@
          */
         def studyPage(flow, flash, params) {
-                // remember the params in the flash scope
-                flash.values = params
+                flash.values            = params
+                flash.wizardErrors      = [:]
 
                 // instantiate study of it is not yet present
@@ -968 +969 @@
                 // did the study template change?
                 if (params.get('template').size() && flow.study.template?.name != params.get('template')) {
-                        println ".change study template!"
-
-                        // yes, was the template already set?
-                        if (flow.study.template instanceof Template) {
-                                // yes, first make sure all values are unset?
-                                println "!!! check the database fields if data of a previous template remains in the database or is deleted by GORM!"
-                        }
-
                         // set the template
                         flow.study.template = Template.findByName(params.remove('template'))
@@ -1004 +997 @@
                 }
 
-                // validate the study
-                if (flow.study.validate()) {
-                        // instance is okay
-                        return true
+                // have we got a template?
+                if (flow.study.template && flow.study.template instanceof Template) {
+                        // validate the study
+                        if (flow.study.validate()) {
+                                // instance is okay
+                                return true
+                        } else {
+                                // validation failed
+                                this.appendErrors(flow.study, flash.wizardErrors)
+                                return false
+                        }
                 } else {
-                        // validation failed
-                        flash.wizardErrors = [:]
-                        this.appendErrors(flow.study, flash.wizardErrors)
+                        // no, return an error that the template is not set
+                        this.appendErrorMap(['template': g.message(code: 'select.not.selected.or.add', args: ['template'])], flash.wizardErrors)
                         return false
                 }
@@ -1024 +1023 @@
          */
         def handlePublications(flow, flash, params) {
+                flash.wizardErrors      = [:]
+
                 if (!flow.study.publications) flow.study.publications = []
 
@@ -1065 +1066 @@
          */
         def handleContacts(flow, flash, params) {
+                flash.wizardErrors      = [:]
+
                 if (!flow.study.persons) flow.study.persons = []
 
@@ -1126 +1129 @@
          */
         def handleUsers(flow, flash, params, type) {
+                flash.wizardErrors = [:]
+
                 def users = []
 
@@ -1140 +1145 @@
 
                 // Users are saved as user_id
-                def userIDs = params.get( type + '_ids')
+                def userIDs = params.get(type + '_ids')
                 if (userIDs) {
                         // Find the individual IDs and make integers
@@ -1153 +1158 @@
                                         def user = SecUser.get(id)
                                         if (user) {
-                                            users.add(user)
+                                                users.add(user)
                                         } else {
                                                 log.info('.user with ID ' + id + ' not found in database.')
@@ -1167 +1172 @@
                 if (type == "readers") {
                         if (flow.study.readers)
-                        flow.study.readers.clear()
+                                flow.study.readers.clear()
                         users.each { flow.study.addToReaders(it) }
                 } else if (type == "writers") {
                         if (flow.study.writers)
-                        flow.study.writers.clear()
+                                flow.study.writers.clear()
 
                         users.each { flow.study.addToWriters(it) }
                 }
-        }
+        }
 
         /**
@@ -1286 +1291 @@
                         errors = true
                         if (number < 1) this.appendErrorMap(['addNumber': 'Enter a positive number of subjects to add'], flash.wizardErrors)
-                        if (!species)   this.appendErrorMap(['species': 'You need to select a species, or add one if it is not yet present'], flash.wizardErrors)
-                        if (!template)  this.appendErrorMap(['template': 'You need to select a template, or add one if it is not yet present'], flash.wizardErrors)
+                        if (!species)   this.appendErrorMap(['species': g.message(code: 'select.not.selected.or.add', args: ['species'])], flash.wizardErrors)
+                        if (!template)  this.appendErrorMap(['template': g.message(code: 'select.not.selected.or.add', args: ['template'])], flash.wizardErrors)
                 }
 
@@ -1353 +1358 @@
                                                         eventGroup.subjects.each() { subject ->
                                                                 // instantiate a sample for this subject / event
-                                                                def samplingEventName = this.ucwords(event.template.name)
-                                                                def eventGroupName = this.ucwords(eventGroup.name).replaceAll("([ ]{1,})", "")
-                                                                def sampleName = (this.ucwords(subject.name) + '_' + samplingEventName + '_' + eventGroupName + '_' + new RelTime(event.startTime).toString()).replaceAll("([ ]{1,})", "")
+                                                                def samplingEventName = ucwords(event.template.name)
+                                                                def eventGroupName = ucwords(eventGroup.name).replaceAll("([ ]{1,})", "")
+                                                                def sampleName = (ucwords(subject.name) + '_' + samplingEventName + '_' + eventGroupName + '_' + new RelTime(event.startTime).toString()).replaceAll("([ ]{1,})", "")
                                                                 def tempSampleIterator = 0
                                                                 def tempSampleName = sampleName
@@ -1450 +1455 @@
                                                 // iterate through samplingEvents
                                                 eventGroup.samplingEvents.each() { samplingEvent ->
-                                                        def samplingEventName = this.ucwords(samplingEvent.template.name)
-                                                        def eventGroupName = this.ucwords(eventGroup.name)
-                                                        def sampleName = (this.ucwords(subject.name) + '_' + samplingEventName + '_' + eventGroupName + '_' + new RelTime(samplingEvent.startTime).toString()).replaceAll("([ ]{1,})", "")
+                                                        def samplingEventName = ucwords(samplingEvent.template.name)
+                                                        def eventGroupName = ucwords(eventGroup.name)
+                                                        def sampleName = (ucwords(subject.name) + '_' + samplingEventName + '_' + eventGroupName + '_' + new RelTime(samplingEvent.startTime).toString()).replaceAll("([ ]{1,})", "")
                                                         def tempSampleIterator = 0
                                                         def tempSampleName = sampleName
@@ -1609 +1614 @@
                         flow.study.assays.each() { assay ->
                                 if (params.get( 'sample_' + sample.getIdentifier() + '_assay_' + assay.getIdentifier() )) {
-                                        println "add sample "+sample.getIdentifier()+" to assay "+assay.getIdentifier()
                                         // add sample to assay
                                         assay.addToSamples( sample )
@@ -1616 +1620 @@
                                         assay.removeFromSamples( sample )
                                 }
-                                println assay.samples
                         }
                 }
@@ -1631 +1634 @@
          * @return String
          */
-        def ucwords(String text) {
+        public static ucwords(String text) {
                 def newText = ''
 
@@ -1670 +1673 @@
         def getHumanReadableErrors(object) {
                 def errors = [:]
-                object.errors.getAllErrors().each() {
-                        def message = it.toString()
-
-                        //errors[it.getArguments()[0]] = it.getDefaultMessage()
-                        errors[it.getArguments()[0]] = message.substring(0, message.indexOf(';'))
+                object.errors.getAllErrors().each() { error ->
+                        // error.codes.each() { code -> println code }
+
+                        // generally speaking g.message(...) should work,
+                        // however it fails in some steps of the wizard
+                        // (add event, add assay, etc) so g is not always
+                        // availably. Using our own instance of the
+                        // validationTagLib instead so it is always
+                        // available to us
+                        errors[ error.getArguments()[0] ] = validationTagLib.message(error: error)
                 }
 
@@ -1687 +1695 @@
          */
         def appendErrors(object, map) {
-                this.appendErrorMap(this.getHumanReadableErrors(object), map)
+                this.appendErrorMap(getHumanReadableErrors(object), map)
         }
 
         def appendErrors(object, map, prepend) {
-                this.appendErrorMap(this.getHumanReadableErrors(object), map, prepend)
+                this.appendErrorMap(getHumanReadableErrors(object), map, prepend)
         }
 

trunk/grails-app/i18n/messages.properties

@@ -55 +55 @@
 typeMismatch.java.math.BigInteger=Property {0} must be a valid number
 
-// TemplateEntity errors
-templateEntity.typeMismatch.integer=Property {0} must be of type Integer and is currently of type {1}
-templateEntity.typeMismatch.string=Property {0} must be of type String and is currently of type {1}
-templateEntity.tooLong.string=Property {0} may contain at most 255 characters.
+# Generic error messages
+nullable={0} is required and may not be left blank
+select.not.selected=You need to select a {0}
+select.not.selected.or.add=You need to select a {0}, or add one if it is not yet present
+
+# TemplateEntity errors
+templateEntity.typeMismatch.long={0} has to be an absolute number (without comma's)
+templateEntity.typeMismatch.double={0} must be a number
+templateEntity.typeMismatch.integer={0} must be a number
+templateEntity.typeMismatch.string={0} must be a text (maximum 255 characters)
+templateEntity.tooLong.string={0} may contain at most 255 characters
 templateEntity.typeMismatch.templateFieldListItem=Property {0} must be of type TemplateFieldListItem and is currently of type {1}
-templateEntity.typeMismatch.float=Property {0} must be of type Float and is currently of type {1}
-templateEntity.typeMismatch.double=Property {0} must be of type Double and is currently of type {1}
-templateEntity.typeMismatch.date=Property {0} must be of type Date and is currently of type {1}
-templateEntity.typeMismatch.term=Property {0} must be of type Term and is currently of type {1}
-
+templateEntity.typeMismatch.date={0} must be a date
+templateEntity.typeMismatch.term={0} must be an ontology term
 event.endTime.greaterThanStartTime=End time should be greater than or equal to the Start Time

trunk/grails-app/i18n/messages_nl.properties

@@ -54 +54 @@
 typeMismatch.java.math.BigDecimal=Attribuut {0} is geen geldig nummer
 typeMismatch.java.math.BigInteger=Attribuut {0} is geen geldig nummer
+
+# Generic error messages
+nullable={0} is verplicht en mag niet leeg zijn
+select.not.selected=Je moet een {0} kiezen
+select.not.selected.or.add=Je moet een {0} kiezen, of er een toevoegen als hij nog niet bestaat
+
+
+# Template entity meesages
+templateEntity.typeMismatch.long={0} moet een absoluut getal zijn (zonder komma's)
+templateEntity.typeMismatch.double={0} moet een getal zijn
+templateEntity.typeMismatch.integer={0} moet een getal zijn
+templateEntity.typeMismatch.string={0} moest een tekst zijn (maximum 255 karakters)
+templateEntity.tooLong.string={0} maar maar 255 karakters bevatten
+templateEntity.typeMismatch.templateFieldListItem={0} moet van het type TemplateFieldListItem zijn en momenteel is het een {1} instantie
+templateEntity.typeMismatch.date={0} moet een datum zijn
+templateEntity.typeMismatch.term={0} must ontology term zijn
+event.endTime.greaterThanStartTime=de eindtijd moet groter of gelijk zijn aan de begin tijd

trunk/grails-app/views/wizard/common/_error.gsp

@@ -27 +27 @@
                 // mark error fields
                 <g:each in="${wizardErrors}" var="error">
-                var element = $("input:[name='${error.key}'], input:[name='${error.key.toLowerCase().replaceAll("([^a-z0-9])","_")}'], select:[name='${error.key}'], select:[name='${error.key.toLowerCase().replaceAll("([^a-z0-9])","_")}']");
+                var element = $("input:[name='${error.key}'], input:[name='${error.key.toLowerCase().replaceAll("([^a-z0-9])","_")}'], select:[name='${error.key}'], select:[name='${error.key.toLowerCase().replaceAll("([^a-z0-9])","_")}'], textarea:[name='${error.key}'], textarea:[name='${error.key.toLowerCase().replaceAll("([^a-z0-9])","_")}']");
                  <g:if test="${error.value['dynamic']}">
                 element.addClass('error');