major refactoring

Use RequireJS, eliminate the formdesigner singleton with controller,
model, and ui having tangled inter-references including a bunch of event
soup, in favor of well-defined coponents using events only for loose
coupling.

See https://gist.github.com/mwhite/10e42de5b24b3437a610 for additional
explanation.

This removes the recently added duplicate ID renaming on save, in favor
of, when the nodeID property is changed via a widget change,
short-circuiting the change if a sibling has the same nodeID, and then
behaving similarly to when the XPath editor has unsaved changes until
you've finished entering a valid nodeID.  In service of this, the
"unsaved changes" short-circuiting now fires on several other events
besides selecting a node:

- adding a question
- saving the form
- selecting any tools menu item
- moving a question

Currently these are all done explicitly, although it might be possible
to have fewer locations where the check is called by putting it in e.g.
beforeSerialize().

This also manages all of the media uploader dependencies using
RequireJS.

Fixes:

 - #59: use RequireJS
 - #84: choice icon in tree should change when moving from single to
   multiple answer or vice versa

Author: Mike White

.gitignore

@@ -1,11 +1,6 @@
 /bower_components
-/dist/*.map
-/dist/*.tmp.css
-/dist/vellum.css
-/dist/vellum.js
-/js/node_modules
 /node_modules
-/src/less/*.css
+/dist/*
 
 npm-debug.log
 *~

Gruntfile.js

@@ -1,109 +1,24 @@
-var fs = require('fs'),
-    exec = require('child_process').exec,
-    _ = require('underscore');
-
 module.exports = function (grunt) {
-    _.each([
-        'grunt-contrib-concat',
-        'grunt-contrib-cssmin',
-        'grunt-contrib-less',
-        'grunt-contrib-uglify',
-        'grunt-image-embed',
-    ], grunt.loadNpmTasks);
+    grunt.loadNpmTasks('grunt-exec');
 
     grunt.registerTask('dist', [
-        'less',
-        'imageEmbed',
-        'concat:css', 
-        'cssmin',
-        'concat:js',
-        'uglify'
+        'exec:dist'
+    ]);
+
+    grunt.registerTask('dist-min', [
+        'exec:dist-min'
     ]);
 
     grunt.initConfig({
-        less: {
-            main: {
-                files: {
-                    "src/less/main.css": "src/less/main.less"
-                }
-            }
-        },
-        imageEmbed: {
+        exec: {
             dist: {
-                src: [
-                    "src/js/lib/jstree/default/style.css",
-                    "src/css/redmond/jquery-ui-1.8.14.custom.css"
-                ],
-                dest: "dist/image-embedded.tmp.css"
-            }
-        },
-        concat: {
-            css: {
-                nonull: true,
-                src: [
-                    'src/js/lib/codemirror/codemirror.css',
-                    'src/js/lib/fancybox/jquery.fancybox-1.3.4.css',
-                    'dist/image-embedded.tmp.css',
-                    'src/less/main.css'
-                ],
-                dest: 'dist/vellum.css'
-            },
-            js: {
-                nonull: true,
-                options: {
-                    separator: ';'
-                },
-                src: [
-                    'bower_components/xpath/lib/biginteger.js',
-                    'bower_components/xpath/lib/schemeNumber.js',
-                    'bower_components/xpath/models.js',
-                    'bower_components/xpath/xpath.js',
-
-                    'src/js/lib/jstree/jquery.jstree.js',
-                    'bower_components/bootstrap-better-typeahead/js/bootstrap-better-typeahead.js',
-                    'src/js/lib/fancybox/jquery.fancybox-1.3.4.js',
-                    'src/js/lib/sha1.js',
-                    'src/js/lib/diff_match_patch.js',
-                    'bower_components/XMLWriter/XMLWriter.js',
-                    'src/js/lib/codemirror/codemirror.js',
-                    'src/js/lib/codemirror/xml.js',
-                    'node_modules/classy/classy.js',
-                    'src/js/formdesigner.javarosa.js',
-                    'src/js/formdesigner.ignoreButRetain.js',
-                    'src/js/formdesigner.lock.js',
-                    'src/js/window.js',
-                    'src/js/util.js',
-                    'src/js/multimedia.js',
-                    'src/js/widgets.js',
-                    'src/js/model.js',
-                    'src/js/controller.js',
-                    'src/js/ui.js',
-                    'src/js/itemset.js'
-                ],
-                dest: 'dist/vellum.js'
-            }
-        },
-        cssmin: {
-            combine: {
-                files: {
-                    'dist/vellum.min.css': ['dist/vellum.css']
+                cmd: function () {
+                    return 'r.js -o build.js';
                 }
-            }
-        },
-        uglify: {
-            options: {
-                // the banner is inserted at the top of the output
-                banner: '/*! Vellum <%= grunt.template.today("dd-mm-yyyy") %> \n' +
-                        '    Copyright 2009-2014, Dimagi Inc., and individual contributors \n' +
-                        '    Released under the MIT License \n' +
-                        '    http://github.com/dimagi/Vellum */\n',
-                sourceMap: true,
-                preserveComments: false,
-                mangle: false
             },
-            dist: {
-                files: {
-                    'dist/vellum.min.js': ['dist/vellum.js']
+            "dist-min": {
+                cmd: function () {
+                    return 'r.js -o build-min.js';
                 }
             }
         }

LICENSE.TXT renamed to LICENSE.txt

@@ -11,35 +11,69 @@ Vellum is a JavaRosa [XForm](http://en.wikipedia.org/wiki/XForms) designer built
 Usage
 -----
 
-Vellum depends on jQuery, Underscore.js, and Bootstrap.  Other dependencies are
-bundled and included in `dist/vellum.js` and `dist/vellum.css`, but some
-additional dependencies that are part of [CommCare
-HQ](http://github.com/dimagi/commcare-hq) aren't well-defined yet.
-
-For an example of a minimal setup and usage of Vellum, including all known
-dependencies, see `tests/index.html`.
-
-For some additional configuration options, see
-[`form_designer.html`](https://github.com/dimagi/commcare-hq/blob/master/corehq/apps/app_manager/templates/app_manager/form_designer.html)
-in CommCare HQ.
-
-
-Contributing
-------------
-
 ### Setup
 
 Install dependencies:
 ```
-$ npm install -g bower
+$ npm install -g bower requirejs
 $ npm install
 ```
 
-Create build artifacts for each commit:
+There are three ways to load Vellum, depending on whether you want asychronous
+module loading, and whether jQuery, jQueryUI, and Bootstrap are already loaded
+on the page.
+
+Asynchronous, will use existing jQuery, jQueryUI, Boostrap (V2) plugins if present:
+```html
+<script src="bower_components/requirejs/require.js"></script>
+<script>
+    require.config({
+        baseUrl: '/path/to/vellum/src'
+    });
+</script>
+```
+
+Bundled with all dependencies:
 ```
 $ grunt dist
 ```
 
+```html
+<script src="dist/main.min.js"></script>
+<script>
+</script>
+```
+
+Bundled with all dependencies except jQuery, jQuery UI, and Bootstrap plugins,
+expects them already to be loaded:
+```
+$ grunt dist-min
+```
+
+```html
+<script src="dist/main.no-jquery.min.js"></script>
+<script>
+</script>
+```
+
+Finally, for all three:
+```javascript
+require(["main"], function ($) {
+    $("#formdesigner").vellum(options)
+});
+```
+
+
+### Options
+
+Todo
+
+
+Contributing
+------------
+
+### Tests
+
 Run tests in a browser:
 ```
 $ python -m SimpleHTTPServer
@@ -65,20 +99,3 @@ master always contains the latest stable version.
 [release](http://vellum-release.herokuapp.com), and
 [develop](http://vellum-develop.herokuapp.com) are automatically deployed for
 testing.
-
-
-Event Tracking
---------------
-
-If you have Google Analytics installed, Vellum will track events.
-
-
-Changelog
----------
-
-### 1.5.0
-
-- Added Ignore-but-retain and question locking plugins 
-- Fixed ability to Ctrl-F within source XML editor
-- Added testing infrastructure
-- Added Grunt build to generate JS and CSS

README.md

@@ -21,18 +21,24 @@
         "tests"
     ],
     "dependencies": {
+        "almond": "~0.2.9", 
         "underscore": "~1.5.2",
         "jquery": "==1.7",
         "jquery.ui": "1.8.16", 
+        "requirejs": "~2.1.11",
+        "requirejs-text": "~2.0.12",
+        "require-less": "*",
+        "require-css": "*",
+        "requirejs-tpl": "jfparadis/requirejs-tpl",
 
-        "XMLWriter": "alexandern/XMLWriter#314f56f53bdc3cb76bd12a7db837be6710e0236f",
+        "langcodes": "dimagi/langcodes",
+        "XMLWriter": "dimagi/XMLWriter",
         "classy": "mitsuhiko/classy#1.4",
         "xpath": "dimagi/js-xpath",
         "bootstrap-better-typeahead": "ptnplanet/Bootstrap-Better-Typeahead"
     },
     "devDependencies": {
-        "equivalent-xml-js": "theozaurus/equivalent-xml-js",
-        "less.js": "~1.3.3",
+        "equivalent-xml-js": "mwhite/equivalent-xml-js",
         "sinonjs": ">=1.6.0",
         "when": "~2.8.0",
         "chai": ">=1.5.0"

bower.json

@@ -1,5 +1,33 @@
-<html>
-    <head>
-        <meta http-equiv="refresh" content="0; url=tests/" />
-    </head>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <title>Vellum Test</title>
+
+    <!-- Mocha and test-only dependencies -->
+    <link href="node_modules/mocha/mocha.css" type="text/css" rel="stylesheet"></link>
+    <script src="node_modules/mocha/mocha.js"></script>
+    <script src="bower_components/chai/chai.js"></script>
+    <script src="bower_components/sinonjs/sinon.js"></script>
+
+    <script src="bower_components/equivalent-xml-js/src/equivalent-xml.js"></script>
+    <script src="bower_components/jquery.ui/tests/jquery.simulate.js"></script>
+    <script src="tests/utils.js"></script>
+
+
+    <!-- Runtime Dependencies -->
+    <link href="tests/lib/hqstyle-core.css" type="text/css" rel="stylesheet"></link>
+    <!--<script src="../src/js/saveButton.js"></script>-->
+    
+    <script data-main="tests/main" src="bower_components/requirejs/require.js"></script>
+  </head>
+
+  <body>
+
+    <div id="matrix">
+    </div>
+    
+    <!-- Tests and running -->
+    <script src="tests/formdesigner.ignoreButRetain.js"></script>
+    <script src="tests/formdesigner.lock.js"></script>
+    <script src="tests/itemset.js"></script>
+  </body>
 </html>

dist/.gitkeep

@@ -0,0 +1,2 @@
+YUI files contain the uploader and node-core modules from
+http://yuilibrary.com/yui/configurator/.