Add plato reports

Author: yllieth

Gruntfile.js

@@ -32,7 +32,8 @@ module.exports = function(grunt) {
     // remove previous builds
     clean: {
       dist: ['dist'],
-      docs: ['docs/.git']
+      docs: ['docs/.git'],
+      plato: ['docs/plato']
     },
 
     // build all model files into a single js file
@@ -64,6 +65,7 @@ module.exports = function(grunt) {
         startPage: '/api',
         titleLink: '/api',
         bestMatch: true,
+        navTemplate: 'docs/header.html',
         analytics: {
           account: 'UA-63397194-1',
           domainName: 'http://yllieth.github.io/predicsis_ml_sdk-javascript'
@@ -79,6 +81,20 @@ module.exports = function(grunt) {
       }
     },
 
+    // code maintainability reports
+    plato: {
+      lib: {
+        options: {
+          jshint: grunt.file.readJSON('.jshintrc'),
+          title: "PredicSis ML SDK - angularJS",
+          recurse: true
+        },
+        files: {
+          'docs/plato': ['lib/']
+        }
+      }
+    },
+
     // remove comments
     uglify: {
       options: {
@@ -113,7 +129,7 @@ module.exports = function(grunt) {
     if (target === 'deploy') {
       grunt.task.run(['buildcontrol:github', 'clean:docs']);
     } else {
-      grunt.task.run(['ngdocs']);
+      grunt.task.run(['ngdocs', 'plato']);
     }
   });
 

docs/header.html

@@ -0,0 +1,16 @@
+<header class="header">
+  <div class="navbar navbar-fixed-top">
+    <div class="navbar-inner">
+      <div class="container">
+        <a class="brand">PredicSis ML SDK</a>
+        <ul class="nav">
+          <li ng-repeat="(url, name) in sections" ng-class="{active: isActivePath(url)}">
+            <a ng-href="{{url}}"><i class="icon-book icon-white"></i> {{name}}</a>
+          </li>
+          <li><a href="http://yllieth.github.io/predicsis_ml_sdk-javascript/plato/index.html"><i class="icon-bar-chart icon-white"></i> Plato reports</a></li>
+        </ul>
+        <%= navContent %>
+      </div>
+    </div>
+  </div>
+</header>

docs/index.html

@@ -18,16 +18,16 @@
     // before the base attribute is added, causing 404 and terribly slow loading of the docs app.
     (function() {
       var indexFile = (location.pathname.match(/\/(index[^\.]*\.html)/) || ['', ''])[1],
-          origin, baseUrl, rUrl = /(#!\/|api|index[^\.]*\.html).*$/,
+          origin, baseUrl, rUrl = /(\/?#!\/.*|\/(api)\/?(\?.*)*|\/index[^\.]*\.html.*)$/,
           headEl = document.getElementsByTagName('head')[0],
           sync = true;
 
       if (location.href.slice(0, 7) == 'file://') {
-        baseUrl = location.href.replace(rUrl, indexFile);
+        baseUrl = location.href.replace(rUrl, '/' + indexFile);
       } else {
         origin = location.origin || (window.location.protocol + "//" + window.location.hostname +
                                     (window.location.port ? ':' + window.location.port: ''));
-        baseUrl = origin + location.href.substr(origin.length).replace(rUrl, indexFile);
+        baseUrl = origin + location.href.substr(origin.length).replace(rUrl, '/' + indexFile);
       }
 
       addTag('base', {href: baseUrl});
@@ -103,7 +103,23 @@
               <a ng-href="{{url}}"><i class="icon-book icon-white"></i> {{name}}</a>
             </li>
           </ul>
-          
+          <header class="header">
+  <div class="navbar navbar-fixed-top">
+    <div class="navbar-inner">
+      <div class="container">
+        <a class="brand">PredicSis ML SDK</a>
+        <ul class="nav">
+          <li ng-repeat="(url, name) in sections" ng-class="{active: isActivePath(url)}">
+            <a ng-href="{{url}}"><i class="icon-book icon-white"></i> {{name}}</a>
+          </li>
+          <li><a href="http://yllieth.github.io/predicsis_ml_sdk-javascript/plato/index.html"><i class="icon-bar-chart icon-white"></i> Plato reports</a></li>
+        </ul>
+        
+      </div>
+    </div>
+  </div>
+</header>
+
         </div>
       </div>
     </div>

docs/js/docs-setup.js

@@ -9,7 +9,16 @@ NG_DOCS={
       "shortName": "predicsis.jsSDK.helpers.uploadHelper",
       "type": "service",
       "moduleName": "predicsis.jsSDK.helpers",
-      "keywords": "$injector $rootscope abort aborting accepts active api boolean cancel cancelled create credential currently datasets delay destination details emitted endpoint error event events file fileapi finished fired folder format function getcredentials handled helpers html5 identifier indicating initialized instance internally iso jssdk list method null number object objects parameter performed predicsis process progress properties raises request required resolved resource running s3 security sending service set single size source sources starting storage storageservice timestamp updated upload uploaded uploadhelper uploadid values xmlhttprequest"
+      "keywords": "$injector $rootscope abort aborting accepts active api boolean cancel cancelled create credential currently datasets delay destination details emitted endpoint error event events file fileapi finished fired folder format function getcredentials handled helpers html5 identifier indicating initialized instance internally iso jssdk list method null number object objects parameter performed predicsis process progress properties raises request required resolved resource running s3 security sending service set single size source sources starting storage storageservice swift timestamp updated upload uploaded uploadhelper uploadid values xmlhttprequest"
+    },
+    {
+      "section": "api",
+      "id": "predicsis.jsSDK.models.Datafiles",
+      "shortName": "predicsis.jsSDK.models.Datafiles",
+      "type": "service",
+      "moduleName": "predicsis.jsSDK.models",
+      "shortDescription": "",
+      "keywords": "$q amazonaws api assign badge changing class colspan concretely convenience csv data data_file data_files datafileid datafiles dataset datasetid documentation download example fetch file filename files function getsignedurl hello http https identifier ids jssdk kml-api links list location method methods_all methods_download methods_get methods_getsignedurl models output predicsis raw resolved restangular s3 s3-us-west-2 service signed signed_url single size type url"
     },
     {
       "section": "api",
@@ -18,7 +27,7 @@ NG_DOCS={
       "type": "service",
       "moduleName": "predicsis.jsSDK.models",
       "shortDescription": "",
-      "keywords": "$classifier_id $dataset_id $header $injector $main_modality $modalities_set_id $name $q $separator api async awesome aws badge build changes child children children_dataset_ids class classifier classifier_id colspan considered create created created_at createfromupload creation csv data_file datafile dataset dataset_id dataset_name datasets defined delete description destfolder destroy dictionary dictionary_ids differents distinction documentation escape examples existing fetch file filename filenames finished function generated_dictionaries_ids generation getchildren going haschildren header https identified identifier instance ischild isformatted isparent isscore istestpart istrainpart job_ids jobs jssdk key learned learned_learning_dataset learning learning-dataset learning_dataset learning_dataset_with_model length list main_modality method methods_all methods_create methods_delete methods_get methods_getchildren methods_haschildren methods_ischild methods_isformatted methods_isparent methods_isscore methods_istestpart methods_istrainpart methods_split methods_update modalities_set_id model models named nb_of_lines negative newly note null original original_source_id orphan paradox parameters params parent parent_dataset_id parent_dictionary patch permanently positive post predicsis preview ratio remove removed removedependencies request requested required requires resources restangular result rules s3 s3_url sampling score scoreset scoring scoring_dataset separator service set single size source source_ids sources split string subset subsets tabulation tells test tested tested_learning_dataset testing train true type update updated updated_at upload uploaded url user_id view"
+      "keywords": "$classifier_id $dataset_id $header $injector $main_modality $modalities_set_id $name $q $separator api array async automatically awesome aws badge based behaviour build changes checking child children children_dataset_ids children_ids class classifier classifier_id colspan compilation compute considered create created created_at createfromupload creation csv data_file datafile dataset dataset_id dataset_ids dataset_name datasetid datasets defined delete description destfolder destroy deterministic dictionaries dictionary dictionary_ids dictionaryid differents distinction documentation equal escape examples existing fetch fetched file filename filenames finished function functions generated_dictionaries_ids generation generator getchildren going good haschildren header https identified identifier insignificant instance ischild isformatted isparent isscore issue istestpart istrainpart job_ids jobs jssdk key learned learned_learning_dataset learning learning_dataset learning_dataset_with_model length linked list ll lot main_modality method methods_all methods_create methods_delete methods_get methods_getchildren methods_haschildren methods_ischild methods_isformatted methods_isparent methods_isscore methods_istestpart methods_istrainpart methods_split methods_update modalities_set_id model models multiple named nb_of_lines negative newly non-deterministic note null object original original_source_id orphan os paradox parameter parameters params parent parent_dataset_id parent_dictionary patch pathname permanently positive post predicsis preview provide random ratio remove removed removedependencies request requested required requires resources restangular result return risk rocks rules s3 sampling score scoreset scoring scoring_dataset selected separator service set single solve source source_ids sources split splits string subset subsets swift tabulation target tells test tested tested_learning_dataset testing time train trains true undefined update updated updated_at upload uploaded user_id view"
     },
     {
       "section": "api",

docs/partials/api/predicsis.jsSDK.helpers.uploadHelper.html

@@ -1,4 +1,4 @@
-<a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/edit/master/lib/helper/uploadHelper.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/e41f592/lib/helper/uploadHelper.js#L8" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">uploadHelper</code>
+<a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/edit/master/lib/helper/uploadHelper.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/a33a891/lib/helper/uploadHelper.js#L8" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">uploadHelper</code>
 <div><span class="hint">service in module <code ng:non-bindable="">predicsis.jsSDK.helpers</code>
 </span>
 </div>
@@ -13,7 +13,7 @@
 </div></li>
 </ul>
 <div class="member method"><h2 id="methods">Methods</h2>
-<ul class="methods"><li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/e41f592/lib/helper/uploadHelper.js#L178" class="view-source icon-eye-open"> </a><h3 id="methods_all">all()</h3>
+<ul class="methods"><li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/a33a891/lib/helper/uploadHelper.js#L172" class="view-source icon-eye-open"> </a><h3 id="methods_all">all()</h3>
 <div class="all"><div class="all-page"><p>list all currently uploaded datasets</p>
 </div><h5 id="methods_all_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-array">Array</a></td><td><div class="all-page"><p>List of active upload objects. An active upload has the following properties:</p>
 <ul>
@@ -25,14 +25,15 @@
   <li>isUploading</li>
   <li>created_at</li>
   <li>cancelUpload</li>
-</ul></div></td></tr></table></div>
+</ul>
+</div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/e41f592/lib/helper/uploadHelper.js#L213" class="view-source icon-eye-open"> </a><h3 id="methods_cancel">cancel(uploadId)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/a33a891/lib/helper/uploadHelper.js#L207" class="view-source icon-eye-open"> </a><h3 id="methods_cancel">cancel(uploadId)</h3>
 <div class="cancel"><div class="cancel-page"><p>Abort a single upload</p>
 </div><h5 id="methods_cancel_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>uploadId</td><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="cancel-page"><p>Id of the upload to stop</p>
 </div></td></tr></tbody></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/e41f592/lib/helper/uploadHelper.js#L202" class="view-source icon-eye-open"> </a><h3 id="methods_get">get(uploadId)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/a33a891/lib/helper/uploadHelper.js#L196" class="view-source icon-eye-open"> </a><h3 id="methods_get">get(uploadId)</h3>
 <div class="get"><div class="get-page"><p>get an active upload</p>
 </div><h5 id="methods_get_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>uploadId</td><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="get-page"><p>An upload identifier looks like <timestamp>_<filename></p>
 </div></td></tr></tbody></table><h5 id="methods_get_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="get-page"><p>An upload object with the following properties:</p>
@@ -45,9 +46,10 @@
   <li>isUploading</li>
   <li>created_at</li>
   <li>cancelUpload</li>
-</ul></div></td></tr></table></div>
+</ul>
+</div></td></tr></table></div>
 </li>
-<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/e41f592/lib/helper/uploadHelper.js#L131" class="view-source icon-eye-open"> </a><h3 id="methods_upload">upload(file, storageService)</h3>
+<li><a href="https://github.com/yllieth/predicsis_ml_sdk-javascript/blob/a33a891/lib/helper/uploadHelper.js#L118" class="view-source icon-eye-open"> </a><h3 id="methods_upload">upload(file, storageService)</h3>
 <div class="upload"><div class="upload-page"><p>upload a file
 The upload method raises the following events during the upload process:</p>
 <ul>
@@ -109,7 +111,7 @@
 destination folder is handled by the API and its <code>Sources.getCredentials</code> request.</p>
 </div><h5 id="methods_upload_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>file</td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="upload-page"><p>html5 File instance</p>
 </div></td></tr><tr><td>storageService</td><td><a href="" class="label type-hint type-hint-string">String=s3</a></td><td><div class="upload-page"><p>Name of PredicSis&#39; storage service.
-The API only accepts one of the following values: s3.</p>
+The API only accepts one of the following values: s3, swift.</p>
 </div></td></tr></tbody></table></div>
 </li>
 </ul>