Merge pull request #128 from FloEdelmann/patch-1

Link to Open Fixture Library

Author: peternewman

.travis-ci.sh

@@ -12,6 +12,8 @@ elif [[ $TASK = 'karma' ]]; then
     grunt --verbose unit-test
 elif [[ $TASK = 'js-lint' ]]; then
     grunt --verbose lint
+elif [[ $TASK = 'closure-compiler' ]]; then
+    grunt --verbose closure-compiler
 elif [[ $TASK = 'data-check' ]]; then
     ./tools/make_manufacturer_data.sh > data/manufacturer_data.py && git diff --exit-code data/manufacturer_data.py
 elif [[ $TASK = 'spellintian' ]]; then

.travis.yml

@@ -29,6 +29,7 @@ matrix:
       env: TASK="nosetests"
     - env: TASK="karma"
     - env: TASK="js-lint"
+    - env: TASK="closure-compiler"
     - env: TASK="data-check"
       addons:
         apt:

BUILD

@@ -1,5 +1,7 @@
 module.exports = function(grunt) {
   'use strict';
+  require('google-closure-compiler').grunt(grunt);
+
   grunt.initConfig({
     bower: {
       libs: {
@@ -94,6 +96,24 @@ module.exports = function(grunt) {
           atBegin: true
         }
       }
+    },
+    'closure-compiler': {
+      build: {
+        options: {
+          args: [
+            '--js', 'js_src/**.js',
+            '--js', '!js_src/rdm.js',
+            '--js', 'node_modules/google-closure-library/closure/**.js',
+            '--js', 'node_modules/google-closure-library/third_party/**.js',
+            '--js', '"!**_test.js"',
+            '--jscomp_warning', 'lintChecks',
+            '--entry_point', 'app.setup',
+            '--js_output_file', 'static/js/app.js',
+            '--dependency_mode', 'STRICT',
+            '--compilation_level', 'ADVANCED_OPTIMIZATIONS'
+          ]
+        }
+      }
     }
   });
   grunt.loadNpmTasks('grunt-karma');

Gruntfile.js

@@ -112,7 +112,7 @@ otherwise the files won't be compressed
 After changing `app.js`, you have to build the compiled Google Closure script by
 using:
 ```bash
-./BUILD
+grunt closure-compiler
 ```
 
 ### Running the App Engine locally

README.md

@@ -17,18 +17,18 @@
  * Copyright (C) 2011 Simon Newton
  */
 
+goog.provide('app.setup');
+
+goog.require('app.displayCommand');
 goog.require('goog.dom');
 goog.require('goog.events');
 goog.require('goog.ui.Component');
 goog.require('goog.ui.TableSorter');
-goog.require('app.MessageStructure');
-
-goog.provide('app.setup');
 
-var app = app || {}
 
-// Empty list, this is populated in the page
-app.SOFTWARE_VERSIONS = []
+// These are populated in the page
+app.SOFTWARE_VERSIONS = [];
+app.OPEN_FIXTURE_LIBRARY_MODEL_URL = null;
 
 /**
  * Sort hex values
@@ -37,7 +37,7 @@ app.SOFTWARE_VERSIONS = []
  * @return {number} Negative if a < b, 0 if a = b, and positive if a > b.
  */
 app.hexSort = function(a, b) {
-  return parseInt(a) - parseInt(b);
+  return parseInt(a, 16) - parseInt(b, 16);
 };
 
 
@@ -61,45 +61,52 @@ app.toHex = function(n, padding) {
 
 /**
  * Hide a node.
+ * @param {!Element} node The HTML element to hide.
  */
 app.hideNode = function(node) {
   node.style.display = 'none';
-}
+};
 
 /**
  * Show a block node
+ * @param {!Element} node The HTML element to show as a block.
  */
 app.showBlock = function(node) {
   node.style.display = 'block';
-}
+};
 
 /**
  * Show a inline node
+ * @param {!Element} node The HTML element to show inline.
  */
 app.showInline = function(node) {
   node.style.display = 'inline';
-}
+};
 
 /**
  * Show a table row
+ * @param {!Element} row The HTML element to show as a table row.
  */
 app.showRow = function(row) {
   row.style.display = 'table-row';
-}
+};
 
 
 /**
  * Create a TD node and set the innerHTML property
+ * @param {!string} text Inner HTML for the new table cell.
+ * @return {!Element} The created TD element.
  */
 app.newTD = function(text) {
   var td = goog.dom.createDom('td');
   td.innerHTML = text;
   return td;
-}
+};
 
 
 /**
  * Make the model table sortable
+ * @param {!string} table_id
  */
 app.makeModelTable = function(table_id) {
   var table = new goog.ui.TableSorter();
@@ -114,15 +121,28 @@ goog.exportSymbol('app.makeModelTable', app.makeModelTable);
 
 /**
  * Set the software versions
+ * @param {!Array.<Object>} version_info The software versions.
  */
 app.setSoftwareVersions = function(version_info) {
   app.SOFTWARE_VERSIONS = version_info;
 };
 goog.exportSymbol('app.setSoftwareVersions', app.setSoftwareVersions);
 
 
+/**
+ * Set the URL of the RDM lookup page in the Open Fixture library with the RDM IDs
+ * of this model so we can use it to link every personality.
+ * @param {!string} url The URL with query parameters for RDM manufacturer ID and RDM model ID.
+ */
+app.setOpenFixtureLibraryModelUrl = function(url) {
+  app.OPEN_FIXTURE_LIBRARY_MODEL_URL = url;
+};
+goog.exportSymbol('app.setOpenFixtureLibraryModelUrl', app.setOpenFixtureLibraryModelUrl);
+
+
 /**
  * Display info for the currently selected software version
+ * @param {?Element=} element
  */
 app.changeSoftwareVersion = function(element) {
   // default to displaying the first version
@@ -138,87 +158,97 @@ app.changeSoftwareVersion = function(element) {
   // DMX Personalities
   var personalities = software_version['personalities'];
   var personality_fieldset = goog.dom.$('model_personality_fieldset');
-  if (personalities && personalities.length) {
-    var tbody = goog.dom.$('model_personality_tbody');
-    goog.dom.removeChildren(tbody);
-    for (var i = 0; i < personalities.length; ++i) {
-      var personality = personalities[i];
-      var tr = goog.dom.createDom('tr');
-      // add the cells
-      goog.dom.appendChild(tr, app.newTD(personality['index']));
-      if ('slot_count' in personality) {
-        goog.dom.appendChild(tr, app.newTD(personality['slot_count']));
-      } else {
-        goog.dom.appendChild(tr, app.newTD('Unknown'));
+  if (personality_fieldset) {
+    if (personalities && personalities.length) {
+      var tbody = goog.dom.$('model_personality_tbody');
+      goog.dom.removeChildren(tbody);
+      for (var i = 0; i < personalities.length; ++i) {
+        var personality = personalities[i];
+        var oflLink = app.OPEN_FIXTURE_LIBRARY_MODEL_URL + '&amp;personalityIndex=' + personality['index'];
+
+        var tr = goog.dom.createDom('tr');
+        // add the cells
+        goog.dom.appendChild(tr, app.newTD(personality['index']));
+        if ('slot_count' in personality) {
+          goog.dom.appendChild(tr, app.newTD(personality['slot_count']));
+        } else {
+          goog.dom.appendChild(tr, app.newTD('Unknown'));
+        }
+        goog.dom.appendChild(tr, app.newTD(personality['description']));
+        goog.dom.appendChild(tr, app.newTD('<a href="' + oflLink + '">View in Open Fixture Library</a>'));
+        goog.dom.appendChild(tbody, tr);
       }
-      goog.dom.appendChild(tr, app.newTD(personality['description']));
-      goog.dom.appendChild(tbody, tr);
+      app.showBlock(personality_fieldset);
+    } else {
+      app.hideNode(personality_fieldset);
     }
-    app.showBlock(personality_fieldset);
-  } else {
-    app.hideNode(personality_fieldset);
   }
 
   // Sensors
   var sensors = software_version['sensors'];
   var sensor_fieldset = goog.dom.$('model_sensor_fieldset');
-  if (sensors && sensors.length) {
-    var tbody = goog.dom.$('model_sensor_tbody');
-    goog.dom.removeChildren(tbody);
-    for (var i = 0; i < sensors.length; ++i) {
-      var sensor = sensors[i];
-      var tr = goog.dom.createDom('tr');
-      // add the cells
-      goog.dom.appendChild(tr, app.newTD(sensor['index']));
-      goog.dom.appendChild(tr, app.newTD(sensor['description']));
-      var type_str = sensor['type_str'];
-      var sensor_type = '';
-      if (type_str) {
-        sensor_type = type_str + ' (0x' + app.toHex(sensor['type'], 2) + ')';
-      } else  {
-        sensor_type = app.toHex(sensor['type'], 2)
+  if (sensor_fieldset) {
+    if (sensors && sensors.length) {
+      var tbody = goog.dom.$('model_sensor_tbody');
+      goog.dom.removeChildren(tbody);
+      for (var i = 0; i < sensors.length; ++i) {
+        var sensor = sensors[i];
+        var tr = goog.dom.createDom('tr');
+        // add the cells
+        goog.dom.appendChild(tr, app.newTD(sensor['index']));
+        goog.dom.appendChild(tr, app.newTD(sensor['description']));
+        var type_str = sensor['type_str'];
+        var sensor_type = '';
+        if (type_str) {
+          sensor_type = type_str + ' (0x' + app.toHex(sensor['type'], 2) + ')';
+        } else  {
+          sensor_type = app.toHex(sensor['type'], 2);
+        }
+        goog.dom.appendChild(tr, app.newTD(sensor_type));
+        goog.dom.appendChild(tr, app.newTD(sensor['supports_recording']));
+        goog.dom.appendChild(tr, app.newTD(sensor['supports_min_max']));
+        goog.dom.appendChild(tbody, tr);
       }
-      goog.dom.appendChild(tr, app.newTD(sensor_type));
-      goog.dom.appendChild(tr, app.newTD(sensor['supports_recording']));
-      goog.dom.appendChild(tr, app.newTD(sensor['supports_min_max']));
-      goog.dom.appendChild(tbody, tr);
+      app.showBlock(sensor_fieldset);
+    } else {
+      app.hideNode(sensor_fieldset);
     }
-    app.showBlock(sensor_fieldset);
-  } else {
-    app.hideNode(sensor_fieldset);
   }
 
   // supported params
   var supported_params = software_version['supported_parameters'];
   var supported_params_fieldset = goog.dom.$('model_params_fieldset');
-  if (supported_params && supported_params.length) {
-    var supported_params_list = goog.dom.$('model_params_list');
-    goog.dom.removeChildren(supported_params_list);
-    for (var i = 0; i < supported_params.length; ++i) {
-      var param = supported_params[i];
-      var param_name = param['name'];
-      var li = goog.dom.createDom('li');
-      if (param_name) {
-        var a = goog.dom.createDom('a');
-        a.innerHTML = param_name + ' (0x' + app.toHex(param['id'], 4) + ')';
-        a.href = ('/pid/display?manufacturer=' + param['manufacturer_id'] +
-          '&pid=' + param['id']);
-        goog.dom.appendChild(li, a)
-      } else {
-        li.innerHTML = '0x' + app.toHex(param['id'], 4);
+  if (supported_params_fieldset) {
+    if (supported_params && supported_params.length) {
+      var supported_params_list = goog.dom.$('model_params_list');
+      goog.dom.removeChildren(supported_params_list);
+      for (var i = 0; i < supported_params.length; ++i) {
+        var param = supported_params[i];
+        var param_name = param['name'];
+        var li = goog.dom.createDom('li');
+        if (param_name) {
+          var a = goog.dom.createDom('a');
+          a.innerHTML = param_name + ' (0x' + app.toHex(param['id'], 4) + ')';
+          a.href = ('/pid/display?manufacturer=' + param['manufacturer_id'] +
+            '&pid=' + param['id']);
+          goog.dom.appendChild(li, a);
+        } else {
+          li.innerHTML = '0x' + app.toHex(param['id'], 4);
+        }
+        goog.dom.appendChild(supported_params_list, li);
       }
-      goog.dom.appendChild(supported_params_list, li);
+      app.showBlock(supported_params_fieldset);
+    } else {
+      app.hideNode(supported_params_fieldset);
     }
-    app.showBlock(supported_params_fieldset);
-  } else {
-    app.hideNode(supported_params_fieldset);
   }
 };
 goog.exportSymbol('app.changeSoftwareVersion', app.changeSoftwareVersion);
 
 
 /**
  * Display the latest version for the element.
+ * @param {!Element} element
  */
 app.setLatestVersion = function(element) {
   var index = 0;
@@ -232,12 +262,13 @@ app.setLatestVersion = function(element) {
   }
   element.selectedIndex = index;
   app.changeSoftwareVersion(element);
-}
+};
 goog.exportSymbol('app.setLatestVersion', app.setLatestVersion);
 
 
 /**
  * Make the pid table sortable
+ * @param {!string} table_id
  */
 app.makePIDTable = function(table_id) {
   var table = new goog.ui.TableSorter();
@@ -251,14 +282,3 @@ app.makePIDTable = function(table_id) {
   table.setSortFunction(5, goog.ui.TableSorter.alphaSort);
 };
 goog.exportSymbol('app.makePIDTable', app.makePIDTable);
-
-
-/**
- * Display a pid command
- */
-app.displayCommand = function(json, element_id) {
-  var msg_structure = new app.MessageStructure();
-  msg_structure.decorate(goog.dom.$(element_id));
-  msg_structure.update(json['items']);
-};
-goog.exportSymbol('app.displayCommand', app.displayCommand);