Merge pull request #221 from telefonicaid/task/adaptation-to-TIDs-Nod…

…e-app-guidelines

Adaptation to TID's Node app guidelines and linting

.gitignore

@@ -1,18 +1,18 @@
-# Node modules #
-/node_modules
+/node_modules/
+/.idea/
+/doc/
+/coverage/
+/site
+/report/
+/.c9revisions/
+/.settings/
 
-# Logs #
-/log
-
-# Temporal directory #
-/temp
-
-# Database #
-/data
-
-# Specific files #
+.settings
+.classpath
+.project
+.metadata
 npm-debug.log
 
-# JetBrains IDEs #
-## Directory-based project format:
-.idea/
+/data/
+/log/
+/temp/

.gjslintrc

@@ -0,0 +1,9 @@
+--jsdoc
+--summary
+--beep
+--check_html
+--nomultiprocess
+--debug_indentation
+--time
+--max_line_length=120
+

.jshintrc

@@ -0,0 +1,18 @@
+{
+	"curly": true,
+	"eqeqeq": true,
+	"immed": true,
+	"latedef": true,
+	"newcap": true,
+	"noarg": true,
+	"noempty": true,
+	"quotmark": "single",
+	"undef": true,
+	"unused": true,
+	"trailing": true,
+	"maxparams": 4,
+	"maxdepth": 4,
+	"camelcase": true,
+	"maxlen": 120,
+	"node": true
+}

CHANGES_NEXT_RELEASE

@@ -0,0 +1 @@
+- [TASK] Adaptation to TID's Node app guidelines

Dockerfile

@@ -5,12 +5,12 @@ MAINTAINER Germán Toro del Valle <[email protected]>
 RUN mkdir /github && mkdir /github/telefonicaid
 
 WORKDIR /github/telefonicaid
-RUN git clone https://github.com/telefonicaid/IoT-STH.git
+RUN git clone https://github.com/telefonicaid/fiware-sth-comet.git
 
-WORKDIR  /github/telefonicaid/IoT-STH
+WORKDIR  /github/telefonicaid/fiware-sth-comet
 RUN git fetch && git checkout release/0.1.0 && npm install
 
 EXPOSE 8666
 
-WORKDIR /github/telefonicaid/IoT-STH
+WORKDIR /github/telefonicaid/fiware-sth-comet
 CMD ["npm", "start"]

Gruntfile.js

@@ -0,0 +1,281 @@
+'use strict';
+
+/**
+ * Grunt tasks definitions
+ *
+ * @param {Object} grunt
+ */
+module.exports = function(grunt) {
+
+    // Project configuration.
+    grunt.initConfig({
+        pkgFile: 'package.json',
+        pkg: grunt.file.readJSON('package.json'),
+
+        clean: {
+            reportTest: ['report/test'],
+            reportLint: ['report/lint'],
+            reportCoverage: ['report/coverage'],
+            siteCoverage: ['site/coverage'],
+            siteDoc: ['site/doc'],
+            siteReport: ['site/report']
+        },
+
+        mkdir: {
+            reportTest: {
+                options: {
+                    create: ['<%= clean.reportTest[0] %>']
+                }
+            },
+            reportLint: {
+                options: {
+                    create: ['<%= clean.reportLint[0] %>']
+                }
+            },
+            reportCoverage: {
+                options: {
+                    create: ['<%= clean.reportCoverage[0] %>']
+                }
+            },
+            siteCoverage: {
+                options: {
+                    create: ['<%= clean.siteCoverage[0] %>']
+                }
+            },
+            siteDoc: {
+                options: {
+                    create: ['<%= clean.siteDoc[0] %>']
+                }
+            },
+            siteReport: {
+                options: {
+                    create: ['<%= clean.siteReport[0] %>']
+                }
+            }
+        },
+
+        jshint: {
+            gruntfile: {
+                src: 'Gruntfile.js',
+                options: {
+                    jshintrc: '.jshintrc'
+                }
+            },
+            lib: {
+                src: ['lib/**/*.js'],
+                options: {
+                    jshintrc: 'lib/.jshintrc'
+                }
+            },
+            test: {
+                src: ['test/**/*.js'],
+                options: {
+                    jshintrc: 'test/.jshintrc'
+                }
+            },
+            reportGruntfile: {
+                src: 'Gruntfile.js',
+                options: {
+                    reporter: 'checkstyle',
+                    reporterOutput: '<%= clean.reportLint[0] %>/jshint-gruntfile.xml',
+                    jshintrc: '.jshintrc'
+                }
+            },
+            reportLib: {
+                src: 'lib/**/*.js',
+                options: {
+                    reporter: 'checkstyle',
+                    reporterOutput: '<%= clean.reportLint[0] %>/jshint-lib.xml',
+                    jshintrc: 'lib/.jshintrc'
+                }
+            },
+            reportTest: {
+                src: 'test/**/*.js',
+                options: {
+                    reporter: 'checkstyle',
+                    reporterOutput: '<%= clean.reportLint[0] %>/jshint-test.xml',
+                    jshintrc: 'test/.jshintrc'
+                }
+            }
+        },
+
+        watch: {
+            gruntfile: {
+                files: '<%= jshint.gruntfile.src %>',
+                tasks: ['jshint:gruntfile']
+            },
+            lib: {
+                files: '<%= jshint.lib.src %>',
+                tasks: ['jshint:lib', 'test']
+            },
+            test: {
+                files: '<%= jshint.test.src %>',
+                tasks: ['jshint:test', 'test']
+            }
+        },
+
+        mochaTest: {
+            unit: {
+                options: {
+                    ui: 'bdd',
+                    reporter: 'spec'
+                },
+                src: [
+                    'tools/mocha-globals.js',
+                    '<%= jshint.test.src %>'
+                ]
+            },
+            unitReport: {
+                options: {
+                    ui: 'bdd',
+                    reporter: 'tap',
+                    quiet: true,
+                    captureFile: '<%= clean.reportTest[0] %>/unit_tests.tap'
+                },
+                src: [
+                    'tools/mocha-globals.js',
+                    '<%= jshint.test.src %>'
+                ]
+            }
+        },
+
+        githubPages: {
+            target: {
+                options: {
+                    commitMessage: 'UPDATE Doc'
+                },
+                src: 'site'
+            }
+        },
+
+        dox: {
+            options: {
+                title: 'sth documentation'
+            },
+            files: {
+                src: ['<%= jshint.lib.src %>'],
+                dest: '<%= clean.siteDoc[0] %>'
+            }
+        },
+
+        exec: {
+            istanbul: {
+                cmd:
+                    'bash -c "./node_modules/.bin/istanbul cover --root lib/ --dir <%= clean.siteCoverage[0] %>' +
+                    ' --preload-sources  -- \\"`npm root -g`/grunt-cli/bin/grunt\\" test && ' +
+                    './node_modules/.bin/istanbul report --dir <%= clean.siteCoverage[0] %> text-summary"'
+            },
+            istanbulCobertura: {
+                cmd:
+                    'bash -c "./node_modules/.bin/istanbul report --dir <%= clean.siteCoverage[0] %> cobertura && ' +
+                    'mv <%= clean.siteCoverage[0] %>/cobertura-coverage.xml <%= clean.reportCoverage[0] %>"'
+            },
+            githubPagesInit: {
+                cmd: 'bash tools/github-pages.sh'
+            }
+        },
+
+        plato: {
+            options: {
+                jshint: grunt.file.readJSON('.jshintrc')
+            },
+            lib: {
+                files: {
+                    '<%= clean.siteReport[0] %>': '<%= jshint.lib.src %>'
+                }
+            }
+        },
+
+        githooks: {
+          all: {
+            'pre-commit': 'lint test'
+          }
+        },
+
+        gjslint: {
+            options: {
+                reporter: {
+                    name: 'console'
+                },
+                flags: [
+                    '--flagfile .gjslintrc' //use flag file'
+                ],
+                force: false
+            },
+            gruntfile: {
+                src: '<%= jshint.gruntfile.src %>'
+            },
+            lib: {
+                src: '<%= jshint.lib.src %>'
+            },
+            test: {
+                src: '<%= jshint.test.src %>'
+            },
+            report: {
+                options: {
+                    reporter: {
+                        name: 'gjslint_xml',
+                        dest: '<%= clean.reportLint[0] %>/gjslint.xml'
+                    },
+                    flags: [
+                        '--flagfile .gjslintrc'
+                    ],
+                    force: false
+                },
+                src: ['<%= jshint.gruntfile.src %>', '<%= jshint.lib.src %>', '<%= jshint.test.src %>']
+            }
+        }
+    });
+
+    // These plugins provide necessary tasks.
+    grunt.loadNpmTasks('grunt-contrib-clean');
+    grunt.loadNpmTasks('grunt-contrib-jshint');
+    grunt.loadNpmTasks('grunt-contrib-watch');
+    grunt.loadNpmTasks('grunt-mocha-test');
+    grunt.loadNpmTasks('grunt-github-pages');
+    grunt.loadNpmTasks('grunt-exec');
+    grunt.loadNpmTasks('grunt-plato');
+    grunt.loadNpmTasks('grunt-gjslint');
+    grunt.loadNpmTasks('grunt-dox');
+    grunt.loadNpmTasks('grunt-mkdir');
+    grunt.loadNpmTasks('grunt-githooks');
+
+    grunt.loadTasks('tools/tasks');
+
+    grunt.registerTask('init-pages', ['exec:githubPagesInit']);
+
+    grunt.registerTask('test', 'Run tests', ['mochaTest:unit']);
+
+    grunt.registerTask('test-report', 'Generate tests reports',
+        ['clean:reportTest', 'mkdir:reportTest', 'mochaTest:unitReport']);
+
+    grunt.registerTask('coverage', 'Print coverage report',
+        ['clean:siteCoverage', 'exec:istanbul']);
+
+    grunt.registerTask('coverage-report', 'Generate Cobertura report',
+        ['clean:reportCoverage', 'mkdir:reportCoverage', 'coverage', 'exec:istanbulCobertura']);
+
+    grunt.registerTask('complexity', 'Generate code complexity reports', ['plato']);
+
+    grunt.registerTask('doc', 'Generate source code JSDoc', ['dox']);
+
+    grunt.registerTask('lint-jshint', 'Check source code style with JsHint',
+        ['jshint:gruntfile', 'jshint:lib', 'jshint:test']);
+
+    grunt.registerTask('lint-gjslint', 'Check source code style with Google Closure Linter',
+        ['gjslint:gruntfile', 'gjslint:lib', 'gjslint:test']);
+
+    grunt.registerTask('lint', 'Check source code style', ['lint-jshint', 'lint-gjslint']);
+
+    grunt.registerTask('lint-report', 'Generate checkstyle reports',
+        ['clean:reportLint', 'mkdir:reportLint', 'jshint:reportGruntfile', 'jshint:reportLib',
+        'jshint:reportTest', 'gjslint:report']);
+
+    grunt.registerTask('site', ['doc', 'coverage', 'complexity', 'githubPages']);
+
+    grunt.registerTask('init-dev-env', ['githooks']);
+
+    // Default task.
+    grunt.registerTask('default', ['lint-jshint', 'test']);
+
+};

README.md

@@ -1,5 +1,7 @@
 #<a id="section0"></a> Short Time Historic (aka. Comet)
 
+[![Join the chat at https://gitter.im/telefonicaid/fiware-sth-comet](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/telefonicaid/fiware-sth-comet?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 * [Introduction] (#section1)
     * [Why Comet?] (#section1.1)
     * [Consuming raw data] (#section1.2)