merge pull request

Author: limcheekin

JqueryValidationUiGrailsPlugin.groovy

@@ -1,4 +1,4 @@
-/* Copyright 2010-2012 the original author or authors.
+/* Copyright 2010 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@
 */
 class JqueryValidationUiGrailsPlugin {
     // the plugin version
-    def version = "1.2.4"
+    def version = "1.2.4-SNAPSHOT"
     // the version or versions of Grails the plugin is designed for
     def grailsVersion = "1.2.2 > *"
     // the other plugins this plugin depends on
@@ -31,13 +31,14 @@ class JqueryValidationUiGrailsPlugin {
             "grails-app/views/error.gsp"
     ]
 
+	def license = "APACHE"
     def author = "Lim Chee Kin"
     def authorEmail = "[email protected]"
-    // Additional developers
-    def developers = [
-     [name:"Brian Saville", email:"[email protected]"],
-        ]
-            
+	// Additional developers
+	def developers = [
+		[name:"Brian Saville", email:"[email protected]"],
+	]
+	
     def title = "JQuery Validation UI Plugin - Client Side Validation without writing JavaScript"
     def description = '''\
 Grails Validation mechanism is great, I like it! 
@@ -52,19 +53,19 @@ JQuery Validation plugin as it's validation engine, it had it's own solution kno
 The JQuery Validation UI Plugin will bring Javascript Validator, Remote Constraints, jQuery Validation plugin and [qTip (jQuery tooltip plugin)|http://craigsworks.com/projects/qtip_new/] under the same root and 
 deliver solution more than the jQuery Validation Engine. In short, when someone ask you what is JQuery Validation UI Plugin, just show them the following code block:
 {code}
-Javascript Validator + Remote Constraints + Custom Constraints + jQuery Validation plugin + qTip 
+Javascript Validator + Remote Constraints + jQuery Validation plugin + qTip 
 > jQuery Validation Engine
 {code}
 
- * Source code: http://github.com/limcheekin/jquery-validation-ui
+ * Source code: http://code.google.com/p/jquery-validation-ui-plugin/
  * Documentation: http://limcheekin.github.com/jquery-validation-ui
- * Support: https://github.com/limcheekin/jquery-validation-ui/issues
+ * Support: https://github.com/limcheekin/jquery-validation-ui/issues 
  ** Older bugs available here: http://code.google.com/p/jquery-validation-ui-plugin/issues/list
  * Discussion Forum: http://groups.google.com/group/jquery-validation-ui-plugin
 '''
 
     // URL to the plugin's documentation
     def documentation = "http://limcheekin.github.com/jquery-validation-ui"
-    def issueManagement = [ system:"GitHub", url:"http://github.com/limcheekin/jquery-validation-ui/issues" ]
-    def scm = [ url:"http://github.com/limcheekin/jquery-validation-ui" ]
+	def issueManagement = [ system:"GitHub", url:"http://github.com/limcheekin/jquery-validation-ui/issues" ]
+	def scm = [ url:"http://github.com/limcheekin/jquery-validation-ui" ]
 }

application.properties

@@ -1,6 +1,6 @@
 #Grails Metadata file
-#Fri Mar 18 23:20:01 GMT+08:00 2011
-app.grails.version=1.3.7
+#Sun Jan 15 13:02:11 GMT+08:00 2012
+app.grails.version=2.0.0
 app.name=jquery-validation-ui
-plugins.hibernate=1.3.7
-plugins.tomcat=1.3.7
+plugins.hibernate=2.0.0
+plugins.tomcat=2.0.0

grails-app/conf/BuildConfig.groovy

@@ -2,11 +2,18 @@ grails.project.class.dir = "target/classes"
 grails.project.test.class.dir = "target/test-classes"
 grails.project.test.reports.dir = "target/test-reports"
 //grails.project.war.file = "target/${appName}-${appVersion}.war"
+
+// Disable SVN handling with release plugin
+grails.release.scm.enabled = false
+// Default repo to release is grailsCentral
+grails.project.repos.default = "grailsCentral"
+
 grails.project.dependency.resolution = {
     // inherit Grails' default dependencies
     inherits("global") {
         // uncomment to disable ehcache
         // excludes 'ehcache'
+		excludes 'xml-apis'
     }
     log "warn" // log level of Ivy resolver, either 'error', 'warn', 'info', 'debug' or 'verbose'
     repositories {
@@ -27,6 +34,13 @@ grails.project.dependency.resolution = {
         // specify dependencies here under either 'build', 'compile', 'runtime', 'test' or 'provided' scopes eg.
 
         // runtime 'mysql:mysql-connector-java:5.1.5'
+		build("xom:xom:1.2.5") {
+			export = false
+		}
+        compile("org.tmatesoft.svnkit:svnkit:1.3.5") {
+            excludes "jna", "trilead-ssh2", "sqljet"
+			export = false
+        }
     }
 	plugins {
 		compile(":constraints:0.6.0")
@@ -39,5 +53,16 @@ grails.project.dependency.resolution = {
 		compile(":webxml:1.4.1") {
 			export = false
 		}
+		build(":new-doc:0.3.2") {
+			export = false
+			excludes "xom"
+		}
+		build(":release:1.0.1") {
+			export = false
+			excludes "svn"
+		}
+		build(':svn:1.0.2') {
+			export = false
+		}
 	}
 }

src/docs/guide/appendices.gdoc

@@ -0,0 +1 @@
+This section contains miscellaneous housekeeping items and additional reference material.

src/docs/guide/appendices/releaseNotes.gdoc

@@ -0,0 +1,36 @@
+h4. 11-Jan-2012 1.2.3
+* Fixed Issue [#19|http://code.google.com/p/jquery-validation-ui-plugin/issues/detail?id=19]: Allow overriding of submitHandler in generated validation block.
+* Fixed Issue [#20|http://code.google.com/p/jquery-validation-ui-plugin/issues/detail?id=20]: Add module definitions to use with the resources plugin.
+* First published with the project code at GitHub.
+* Converted documentation to Grails Docs (no longer at Google Code).
+
+h4. 21-May-2011 1.2.2
+* Fixed Issue [#12|http://code.google.com/p/jquery-validation-ui-plugin/issues/detail?id=12]: Unique validation doesn't work for update.
+
+h4. 18-Mar-2011 1.2.1
+* Fixed Issue [#9|http://code.google.com/p/jquery-validation-ui-plugin/issues/detail?id=9]: Validation matches [a-zA-Z]+ doesn't support single character
+* Fixed Issue [#10|http://code.google.com/p/jquery-validation-ui-plugin/issues/detail?id=10]: In java.lang.Bigdecimal also throw an error for unique and range.
+* Fixed Issue [#11|http://code.google.com/p/jquery-validation-ui-plugin/issues/detail?id=11]: Type mismatch custom error message not working.
+
+h4. 18-Feb-2011 1.2
+* Implemented 3 new custom constraints from jquery validation additional methods: alphanumeric, letterswithbasicpunc and lettersonly. (@jqueryValidation.additionalMethods@ in @Config.groovy@ needs to set to @true@ to use these new custom constraints.)
+
+h4. 03-Jan-2011 1.1.1
+* Fixed issue [#2|http://code.google.com/p/jquery-validation-ui-plugin/issues/detail?id=2]. Unable to submit the form when remote AJAX validation such as unique and validator constraints enabled.
+
+h4. 30-Dec-2010 1.1
+* Support Grails 1.2.2+.
+* Support extensibility by the [custom constraints|http://github.com/geofflane/grails-constraints] plugin
+* Implemented 2 custom constraints: phone and phoneUS (International and US phone number validation).
+* Updated person sample application to demo the phone constraints.
+
+h4. 22-Dec-2010 1.0.1
+* Make custom taglib work with [freemarker-tags|http://www.grails.org/plugin/freemarker-tags] plugin
+
+h4. 15-Dec-2010 1.0
+* Support All Standard Grails Constraints
+* Display Validation Messages on Right or Top
+* Display both server-side and client-side validation messages using tooltip (qTip) and same styles.
+* Internationalization Support
+* Remote AJAX Validation Support for unique, validator constraints
+* Type Validation Support

src/docs/guide/appendices/sitesUsing.gdoc

@@ -0,0 +1,2 @@
+* [ProcessCanvas.com|http://www.processcanvas.com/] - Create online workflow in minutes.
+* Personal Information System of India e-Government.

src/docs/guide/appendices/todo.gdoc

@@ -0,0 +1,6 @@
+* Validation message (qTip) support with JQuery UI themes
+* Support [JQuery UI tooltip|http://wiki.jqueryui.com/w/page/12138112/Tooltip] after it is released.
+
+We welcome your feedback and would like to hear about your comments to the project. You are invited to join the project discussion 
+on [GitHub|http://github.com/limcheekin/jquery-validation-ui/issues] or on  
+[Google Code|http://groups.google.com/group/jquery-validation-ui-plugin].  See you there!

src/docs/guide/overview.gdoc

@@ -0,0 +1,19 @@
+Grails [Validation|http://grails.org/doc/latest/guide/7.%20Validation.html] mechanism is great, I like it!  However, it is just a server side validation 
+solution.  To build a comprehensive validation solution and highly interactive web application it has one missing important piece... Yes! It is client 
+side validation solution that support all standard Grails constraints.  Similar grails plugins such as [Javascript Validator|http://www.grails.org/plugin/javascript-validator]
+and [Remote Constraints|http://grails.org/plugin/remote-constraints] attempt to address this problem, but the outcome is less than satisfactory in my opinion. 
+I like the solution and [demo|http://www.position-relative.net/creation/formValidator/] published in the blog post titled 
+[A jQuery inline form validation, because validation is a mess|http://www.position-absolute.com/articles/jquery-form-validator-because-form-validation-is-a-mess/], 
+but unluckily it is not using the excellent [JQuery Validation plugin|http://bassistance.de/jquery-plugins/jquery-plugin-validation/] as it's validation engine.  
+It had it's own solution known as [jQuery Validation Engine|https://github.com/posabsolute/jQuery-Validation-Engine].
+
+The JQuery Validation UI Plugin brings Javascript Validator, Remote Constraints, [Custom Constraints|http://grails.org/plugin/constraints], jQuery Validation 
+plugin, and [qTip (jQuery tooltip plugin)|http://craigsworks.com/projects/qtip_new/] under the same root and delivers a solution that is more than the jQuery Validation Engine. 
+In short, when someone asks you what the JQuery Validation UI Plugin is, just show them the following code block: 
+
+{code}
+Javascript Validator + Remote Constraints + Custom Constraints + jQuery Validation plugin + qTip 
+> jQuery Validation Engine
+{code}
+
+I like the Grails's slogan: *"The search is really over!"*

src/docs/guide/overview/installation.gdoc

@@ -0,0 +1,16 @@
+Install the plugin into your project with the following command:
+
+{code}
+grails install-plugin jquery-validation-ui
+{code}
+
+Alternatively, declare a plugin dependency in the @grails-app/conf/BuildConfig.groovy@ file:
+
+{code}
+plugins {
+	compile(\":jquery-validation-ui:latest.release\")
+}
+{code}
+
+{note}Replace @latest.release@ above with the latest version number, or put it in your BuildConfig verbatim and compile
+your application and the latest version will be installed automatically.{note}

src/docs/guide/overview/sampleApplication.gdoc

@@ -0,0 +1,10 @@
+If you are interested in the sample codes and screen shots I mentioned above, you can run the sample application in your own machine by installing
+it to your project using the following command:
+
+{code}
+grails install-sampleapp
+{code}
+
+{note}If the sample application of previous version of the plugin was installed, re-installing the sample application will not update the messages.properties file, 
+please update it manually by referring to the updated one 
+[here|http://github.com/limcheekin/jquery-validation-ui/blob/master/src/sample-app/grails-app/i18n/messages.properties].{note}

src/docs/guide/toc.yml

@@ -0,0 +1,15 @@
+overview:
+  title: Overview
+  installation: Installation
+  sampleApplication: Person Sample Application
+usage:
+  title: Usage
+  configuration: Configuration
+  resourcesModules: Resources Plugin Modules
+  tags: Tags
+  features: Features
+appendices:
+  title: Appendices
+  releaseNotes: Release Notes
+  sitesUsing: Sites Using This Plugin
+  todo: To Do

src/docs/guide/usage.gdoc

@@ -0,0 +1 @@
+This section describes the usage of the jQuery Validation UI plugin.

src/docs/guide/usage/configuration.gdoc

@@ -0,0 +1,109 @@
+After the plugin installed into your project, the following configurations will be appended to your project's @Config.groovy@ file:
+
+{code}
+// Added by the JQuery Validation plugin:
+jqueryValidation.packed = true
+jqueryValidation.cdn = false  // false or "microsoft"
+jqueryValidation.additionalMethods = false
+
+
+// Added by the JQuery Validation UI plugin:
+jqueryValidationUi {
+        errorClass = 'error'
+        validClass = 'valid'
+        onsubmit = true
+        renderErrorsOnTop = false
+        
+        qTip {
+          packed = true
+          classes = 'ui-tooltip-red ui-tooltip-shadow ui-tooltip-rounded'  
+        }
+        
+        /*
+          Grails constraints to JQuery Validation rules mapping for client side validation.
+          Constraint not found in the ConstraintsMap will trigger remote AJAX validation.
+        */
+        StringConstraintsMap = [
+                blank:'required', // inverse: blank=false, required=true
+                creditCard:'creditcard',
+                email:'email',
+                inList:'inList',
+                minSize:'minlength',
+                maxSize:'maxlength',
+                size:'rangelength',
+                matches:'matches',
+                notEqual:'notEqual',
+                url:'url',
+                nullable:'required',
+                unique:'unique',
+                validator:'validator'
+        ]
+        
+        // Long, Integer, Short, Float, Double, BigInteger, BigDecimal
+        NumberConstraintsMap = [
+                min:'min',
+                max:'max',
+                range:'range',
+                notEqual:'notEqual',
+                nullable:'required',
+                inList:'inList',
+                unique:'unique',
+                validator:'validator'
+        ]
+        
+        CollectionConstraintsMap = [
+                minSize:'minlength',
+                maxSize:'maxlength',
+                size:'rangelength',
+                nullable:'required',
+                validator:'validator'
+        ]
+        
+        DateConstraintsMap = [
+                min:'minDate',
+                max:'maxDate',
+                range:'rangeDate',
+                notEqual:'notEqual',
+                nullable:'required',
+                inList:'inList',
+                unique:'unique',
+                validator:'validator'
+        ]
+        
+        ObjectConstraintsMap = [
+                nullable:'required',
+                validator:'validator'
+        ]
+
+        CustomConstraintsMap = [
+                phone:'true',
+                phoneUS:'true'
+        ]
+}
+{code}
+
+The first section is configuration of the dependent plugin - JQuery Validation. You can find out more about the description of 
+it's configuration at it's [project page|http://www.grails.org/plugin/jquery-validation].
+
+The second section is configuration items of the JQuery Validation UI plugin:
+* *errorClass* - This class used by JQuery Validation library to create error labels, to look for existing error labels and to add it to invalid elements.
+* *validClass* - This class is added to an element by JQuery Validation library after it was validated and considered valid.
+* *onsubmit = true|false* - Default is @true@. JQuery Validation library validates the form on submit. Set to @false@ to use only other events for validation. The following code trigger validation and submit the form if all inputs are valid:
+{code}
+if ($('form:first').validate().form()) {
+   $('form:first').submit();
+}
+{code}
+* *renderErrorsOnTop = true|false* - Default is @false@. Validation messages will display on the right of input element. Set to @true@ to display all validation messages on the top of the form.
+* *qTip.packed = true|false* - Default is @true@. Set to @false@ to view a readable .js file for development purpose.
+* *qTip.classes* - Specify the styles of qTip. Refer to qTip style [documentation|http://craigsworks.com/projects/qtip2/docs/style/].
+
+Client side validation enabled by JQuery Validation using Constraints Map, these Constraints Maps specify how Grails constraints map to JQuery Validation 
+rules such as @StringConstraintsMap@, @NumberConstraintsMap@, @CollectionConstraintsMap@, @DateConstraintsMap@ and @ObjectConstraintsMap@ (@ObjectConstraintsMap@ is 
+catch-all map if the property is not belongs to any other Constraints Maps). Refer to 
+[JQuery Validation documentation|http://docs.jquery.com/Plugins/Validation#List_of_built-in_Validation_methods] for built-in validation rules supported by the library and 
+[additional rules|http://github.com/limcheekin/jquery-validation-ui/blob/master/web-app/js/jquery-validation-ui/grails-validation-methods.js] 
+written for this plugin.
+
+{note}@CustomConstraintsMap@ configuration supported since 1.1 released. If previous version of the plugin was installed, upgrade to 1.1 version will not update 
+your Config.groovy file, please update it manually. Please see Extensibility in the [features|guide:features] section for more information.{note}