Merge branch 'master' into help-pages

Author: th3james

.gitignore

@@ -10,3 +10,4 @@ server/config/development.json
 server/config/seeds
 client/test/tests.coffee
 client/test/tests.js
+client/src/templates/templates.js

README.md

@@ -63,9 +63,11 @@ In **development**, supervisor is used to handle exceptions:
 
 `cd server/ && npm start`
 
-#### Compile coffeescripts
+#### Asset compilation
 
-`cd client && grunt watch`
+*For more info, check out the [asset README](client/README.md).*
+
+`cd client && grunt && grunt watch`
 
 #### Logging in
 
@@ -105,9 +107,11 @@ generates data in the same format as the indicator data backup in
 
 * `cd server/ && npm run-script production`
 
-#### Compile coffeescripts
+#### Asset compilation
+
+*For more info, check out the [asset README](client/README.md).*
 
-`cd client && grunt watch`
+`cd client && grunt`
 
 #### Authentication and logging in
 

client/.bowerrc

@@ -5,8 +5,11 @@ module.exports = (grunt) ->
     clean:
       options:
         force: true
-      dist: [
-        'dist/',
+      ephemeral: [
+        'src/templates/templates.js',
+        'test/tests.js'
+      ]
+      all: [
         '../server/public/css',
         '../server/public/font',
         '../server/public/images',
@@ -16,8 +19,8 @@ module.exports = (grunt) ->
 
     coffee:
       source:
-        src: 'dist/js/application.coffee'
-        dest: 'dist/js/application.js'
+        src: '../server/public/js/application.coffee'
+        dest: '../server/public/js/application.js'
         ext: '.js'
       test:
         src: 'test/tests.coffee'
@@ -27,64 +30,70 @@ module.exports = (grunt) ->
     concat:
       source:
         src: grunt.file.readJSON('src/compile_manifest.json')
-        dest: 'dist/js/application.coffee'
-      dist:
-        src: ['dist/js/templates.js', 'dist/js/application.js']
-        dest: 'dist/js/application.js'
+        dest: '../server/public/js/application.coffee'
       test:
         src: ['test/src/helpers.coffee', 'test/src/**/*.coffee']
         dest: 'test/tests.coffee'
 
     handlebars:
       source:
         files:
-          'dist/js/templates.js': ['src/templates/**/*.hbs']
+          'src/templates/templates.js': ['src/templates/**/*.hbs']
         options:
           namespace: 'Handlebars.templates'
           processName: (filename) ->
             filename.replace(/^src\/templates\//, '')
 
     copy:
-      dist:
+      libs:
         files: [
           expand: true
           cwd: 'src/images/'
-          dest: 'dist/images'
+          dest: '../server/public/images'
           src: '**/*'
         ,
           expand: true
           cwd: 'src/vendor/'
-          dest: 'dist/'
+          dest: '../server/public/'
           src: ['**/*']
         ]
-      release:
+      test:
         files: [
-          expand: true
-          cwd: 'dist/'
-          dest: '../server/public'
-          src: ['**/*']
-        ,
           expand: true
           cwd: 'test/'
           dest: '../server/public/js'
           src: 'tests.js'
         ]
+      templates:
+        files: [
+          expand: true
+          cwd: 'src/templates/'
+          src: 'templates.js'
+          dest: '../server/public/js'
+        ]
 
     sass:
       dist:
         files:
-          'dist/css/main.css': 'src/sass/main.scss'
-          'dist/css/report.css': 'src/sass/report.scss'
-          'dist/css/dashboard.css': 'src/sass/dashboard.scss'
-          'dist/css/about.css': 'src/sass/about.scss'
-          'dist/css/indicator.css': 'src/sass/indicator.scss'
-          'dist/css/theme.css': 'src/sass/theme.scss'
-          'dist/css/login.css': 'src/sass/login.scss'
-          'dist/css/rtl_overrides.css': 'src/sass/rtl_overrides.scss'
+          '../server/public/css/main.css': 'src/css/main.scss'
+          '../server/public/css/report.css': 'src/css/report.scss'
+          '../server/public/css/dashboard.css': 'src/css/dashboard.scss'
+          '../server/public/css/about.css': 'src/css/about.scss'
+          '../server/public/css/indicator.css': 'src/css/indicator.scss'
+          '../server/public/css/theme.css': 'src/css/theme.scss'
+          '../server/public/css/login.css': 'src/css/login.scss'
+          '../server/public/css/rtl_overrides.css': 'src/css/rtl_overrides.scss'
 
     watch:
-      files: ['src/**/*', 'test/src/**/*'],
-      tasks: 'default'
+      source:
+        files: ['src/**/*.coffee']
+        tasks: 'concat:source'
+      templates:
+        files: ['src/**/*.hbs']
+        tasks: 'templates'
+      tests:
+        files: ['test/src/**/*.coffee']
+        tasks: 'tests'
   )
 
   grunt.loadNpmTasks('grunt-contrib-coffee')
@@ -95,4 +104,9 @@ module.exports = (grunt) ->
   grunt.loadNpmTasks('grunt-contrib-copy')
   grunt.loadNpmTasks('grunt-sass')
 
-  grunt.registerTask('default', ['clean', 'concat:source', 'coffee:source', 'handlebars', 'concat:dist', 'sass', 'concat:test', 'coffee:test', 'copy:dist', 'copy:release'])
+  grunt.registerTask('templates', ['handlebars', 'copy:templates'])
+  grunt.registerTask('source', ['concat:source', 'coffee:source'])
+  grunt.registerTask('tests', ['concat:test', 'coffee:test', 'copy:test'])
+
+  grunt.registerTask('default', ['templates', 'source', 'tests', 'sass',
+    'copy:libs', 'copy:test', 'clean:ephemeral'])

client/Gruntfile.coffee

@@ -0,0 +1,27 @@
+# NRT Client Source
+
+## Asset Compilation
+
+Grunt is used to compile, combine and copy assets for use in the NRT
+server application. In production and development it is used for
+slightly different purposes.
+
+## `grunt`
+Concatenates and compiles everything you need to run the application.
+
+* concatenates Coffeescript files in to an `application.coffee`, then compiles them to javascript
+* compiles Handlebars templates and concatenates them in to an includable `templates.js` file.
+* concatenates and compiles SASS
+* copies libraries to the server `public/` directory.
+
+## `grunt watch`
+For use in development, `grunt watch` watches your files for changes,
+and concatenates them when that happens.
+
+It differs from the above in that rather than compiling coffeescript and SASS,
+it leaves simply concatenates them, then expects the coffeescript and node-sass
+middlewares to perform the compilation. This leads to better performance when 
+working in development.
+
+These middlewares are disabled in production (for speed), meaning this task alone
+will not work, and you must run `grunt` on it's own.

client/README.md

@@ -21,6 +21,23 @@ exports.createApp = ->
 
   bindRoutesForApp = require('./route_bindings.coffee')
 
+  if app.get('env') isnt 'production'
+    sass = require('node-sass')
+    app.use sass.middleware(
+      src: path.join(__dirname, "..", "client", "src")
+      dest: path.join(__dirname, 'public')
+      debug: true
+    )
+
+    coffee = require('coffee-middleware')
+    app.use coffee(
+      src: path.join(__dirname, "public")
+      compress: true
+      force: true
+      debug: true
+      encodeSrc: false
+    )
+
   app.use express.static(path.join(__dirname, "public"))
 
   app.engine "hbs", hbs.express3(

client/src/sass/_charts.scss renamed to client/src/css/_charts.scss

@@ -6,7 +6,7 @@
   "scripts": {
     "test": "NODE_ENV=test mocha test/**/*.coffee test/**/**/*.coffee --compilers coffee:coffee-script --require coffee-script --ui qunit --reporter spec",
     "test-debug": "NODE_ENV=test mocha test/**/*.coffee --compilers coffee:coffee-script --require coffee-script --ui qunit --reporter spec --debug",
-    "start": "supervisor -e 'node,js,json,coffee,hbs' ./bin/server.js",
+    "start": "supervisor -e 'node,js,json,coffee,hbs' -i ./public ./bin/server.js",
     "debug": "node --debug ./bin/server.js",
     "development": "echo 'Please use `npm start` to run the server in development mode'",
     "production": "NODE_ENV=production node ./bin/server.js",
@@ -43,7 +43,9 @@
     "connect-mongo": "~0.3.3",
     "connect-flash": "~0.1.1",
     "range_check": "0.0.4",
-    "libxmljs": "~0.8.1"
+    "libxmljs": "~0.8.1",
+    "node-sass": "~0.8.1",
+    "coffee-middleware": "~0.2.1"
   },
   "devDependencies": {
     "Faker": "0.5.11",

client/src/sass/_font-awesome.scss renamed to client/src/css/_font-awesome.scss

@@ -15,6 +15,7 @@
   <script src="/js/lib/esri-leaflet.js"></script>
   <script src="/js/lib/medium-editor.min.js"></script>
   <script src="/js/lib/Chart.min.js"></script>
+  <script src="/js/templates.js"></script>
   <script src="/js/application.js"></script>
 {{/contentFor}}
 

client/src/sass/_indicator_selector.scss renamed to client/src/css/_indicator_selector.scss

@@ -6,6 +6,7 @@
   <script src="/js/lib/backbone-relational.js"></script>
   <script src="/js/lib/handlebars.js"></script>
   <script src="/js/lib/diorama.js"></script>
+  <script src="/js/templates.js"></script>
   <script src="/js/application.js"></script>
 
   <script type="text/javascript">

client/src/sass/_mixins.scss renamed to client/src/css/_mixins.scss

@@ -12,6 +12,7 @@
   <script src="/js/lib/leaflet.js"></script>
   <script src="/js/lib/jquery.sortable.min.js"></script>
   <script src="/js/lib/medium-editor.min.js"></script>
+  <script src="/js/templates.js"></script>
   <script src="/js/application.js"></script>
 
   <script type="text/javascript">

client/src/sass/_reset.scss renamed to client/src/css/_reset.scss

@@ -31,6 +31,7 @@
     <script src="/js/lib/marked.js"></script>
     <script src="/js/lib/i18next.min.js"></script>
     <script src="/js/lib/Chart.min.js"></script>
+    <script src="/js/templates.js"></script>
     <script src="/js/application.js"></script>
 
     <script>

client/src/sass/_section-navigation.scss renamed to client/src/css/_section-navigation.scss

@@ -41,6 +41,7 @@
   <script src="/js/lib/backbone-relational.js"></script>
   <script src="/js/lib/handlebars.js"></script>
   <script src="/js/lib/diorama.js"></script>
+  <script src="/js/templates.js"></script>
   <script src="/js/application.js"></script>
 {{/contentFor}}
 

client/src/sass/_tooltip.scss renamed to client/src/css/_tooltip.scss

@@ -12,6 +12,7 @@
   <script src="/js/lib/handlebars.js"></script>
   <script src="/js/lib/diorama.js"></script>
   <script src="/js/lib/medium-editor.min.js"></script>
+  <script src="/js/templates.js"></script>
   <script src="/js/application.js"></script>
 {{/contentFor}}