Some more RDM fixes (#297)

* fix "RDM personality index: null" in UI
* add RDM ID max bound to schema
* add HTML IDs to RDM modes and allow linking to it

Author: FloEdelmann

fixtures/schema.js

@@ -12,7 +12,7 @@ const schema = require('js-schema');
  * 
  * @type {string}
  */
-module.exports.VERSION = '2.1.0';
+module.exports.VERSION = '2.1.1';
 
 /**
  * see https://github.com/molnarg/js-schema
@@ -149,7 +149,7 @@ const Fixture = schema({
   '?comment': NonEmptyMultiLineString,
   '?manualURL': URL,
   '?rdm': schema({
-    'modelId': Number.min(0).step(1),
+    'modelId': Number.min(0).max(65535).step(1),
     '?softwareVersion': String,
     '*': Function
   }),
@@ -169,7 +169,7 @@ const Manufacturers = schema({
     'name': NonEmptyString,
     '?comment': NonEmptyMultiLineString,
     '?website': URL,
-    '?rdmId': Number.min(0).step(1),
+    '?rdmId': Number.min(0).max(65536).step(1),
     '*': Function
   })
 });

lib/create-github-pr.js

@@ -3,8 +3,6 @@ const fs = require('fs');
 const path = require('path');
 const env = require('node-env-file');
 
-const repository = process.env.NODE_ENV === 'production' ? 'open-fixture-library' : 'ofl-test';
-
 const github = new GitHubApi({
   debug: false,
   protocol: 'https',
@@ -19,6 +17,7 @@ const github = new GitHubApi({
 let branchName;
 let warnings;
 let changedFiles;
+let repository;
 
 /**
  * out parameter is an object like returned from the import plugins:
@@ -42,6 +41,8 @@ module.exports = function createPullRequest(out, callback) {
     env(envFile);
   }
 
+  repository = process.env.NODE_ENV === 'production' ? 'open-fixture-library' : 'ofl-test';  
+
   let userToken = process.env.GITHUB_USER_TOKEN;
   if (userToken === undefined) {
     console.error('.env file does not contain GITHUB_USER_TOKEN variable');
@@ -84,10 +85,6 @@ module.exports = function createPullRequest(out, callback) {
   .then(() => {
     console.log('done');
 
-    if (Object.keys(out.manufacturers).length === 0) {
-      return Promise.resolve();
-    }
-
     return addOrUpdateFile('fixtures/manufacturers.json', 'manufacturers.json', oldFileContent => {
       if (oldFileContent == null) {
         return prettyStringify(out.manufacturers);

main.js

@@ -142,6 +142,7 @@ app.get('/search', (request, response) => {
 app.get('/rdm', (request, response) => {
   const manufacturerId = request.query.manufacturerId;
   const modelId = request.query.modelId;
+  const personalityIndex = request.query.personalityIndex;
 
   if (manufacturerId === undefined || manufacturerId === '') {
     response.render('pages/rdm-lookup');
@@ -157,7 +158,8 @@ app.get('/rdm', (request, response) => {
     }
 
     if (modelId in register.rdm[manufacturerId].models) {
-      response.redirect(301, `/${manufacturer.key}/${manufacturer.models[modelId]}`);
+      const hash = (personalityIndex === undefined || personalityIndex === '') ? '' : `#rdm-personality-${personalityIndex}`;
+      response.redirect(301, `/${manufacturer.key}/${manufacturer.models[modelId]}${hash}`);
       return;
     }
   }

views/pages/rdm-lookup.js

@@ -10,11 +10,15 @@ module.exports = function(options) {
   str += '<form action="/rdm" method="get">';
   str += '<section><label>';
   str += '  <span class="label">Manufacturer ID</span>';
-  str += '  <span class="value"><input type="number" name="manufacturerId" min="0" step="1" required /></span>';
+  str += '  <span class="value"><input type="number" name="manufacturerId" min="0" max="65535" step="1" required /></span>';
   str += '</label></section>';
   str += '<section><label>';
   str += '  <span class="label">Model ID</span>';
-  str += '  <span class="value"><input type="number" name="modelId" min="0" step="1" /><span class="hint">Leave this field empty to find the manufacturer.</span></span>';
+  str += '  <span class="value"><input type="number" name="modelId" min="0" max="65535" step="1" /><span class="hint">Leave this field empty to find the manufacturer.</span></span>';
+  str += '</label></section>';
+  str += '<section><label>';
+  str += '  <span class="label">Personality index</span>';
+  str += '  <span class="value"><input type="number" name="personalityIndex" min="1" step="1" /><span class="hint">Optional</span></span>';
   str += '</label></section>';
   str += '<div class="button-bar">';
   str += '  <button type="submit" class="primary">Lookup fixture / manufacturer</button>';

views/pages/single_fixture.js

@@ -11,7 +11,7 @@ module.exports = function(options) {
   const {man, fix} = options;
 
   fixture = Fixture.fromRepository(man, fix);
-  
+
   options.title = `${fixture.manufacturer.name} ${fixture.name} - Open Fixture Library`;
 
   const githubRepoPath = 'https://github.com/' + (process.env.TRAVIS_REPO_SLUG || 'FloEdelmann/open-fixture-library');
@@ -104,7 +104,7 @@ function handleFixtureInfo() {
     str += `  <span class="value"><a href="${fixture.manualURL}" rel="nofollow">${fixture.manualURL}</a></span>`;
     str += '</section>';
   }
-  
+
   if (fixture.rdm !== null) {
     const rdmLink = `http://rdm.openlighting.org/model/display?manufacturer=${fixture.manufacturer.rdmId}&model=${fixture.rdm.modelId}`;
     const olaIcon = require('../includes/svg.js')({svgBasename: 'ola'});
@@ -255,11 +255,18 @@ function handlePhysicalData(physical) {
 }
 
 function handleMode(mode) {
-  let str = '<section class="fixture-mode card">';
+  let sectionId = '';
+  let rdmPersonalityIndexHint = '';
+  if (mode.rdmPersonalityIndex !== null) {
+    sectionId = ` id="rdm-personality-${mode.rdmPersonalityIndex}"`;
+    rdmPersonalityIndexHint = `<span class="hint">RDM personality index: ${mode.rdmPersonalityIndex}</span>`;
+  }
+
+  let str = `<section class="fixture-mode card"${sectionId}>`;
 
   const heading = mode.name + ' mode' + (mode.hasShortName ? ` <code>${mode.shortName}</code>` : '');
   str += `<h2>${heading}</h2>`;
-  str += `<span class="hint">RDM personality index: ${mode.rdmPersonalityIndex}</span>`;
+  str += rdmPersonalityIndexHint;
 
   if (mode.physicalOverride !== null) {
     str += '<h3>Physical overrides</h3>';
@@ -448,7 +455,7 @@ function handleSwitchingChannel(channel, mode) {
 
   let str = `<div>Switch depending on ${channel.triggerChannel.name}'s value (channel ${triggerChannelIndex}):</div>`;
   str += '<ol>';
-  
+
   for (const switchToChannelKey of Object.keys(channel.triggerRanges)) {
     const switchToChannel = fixture.getChannelByKey(switchToChannelKey);
 

views/scripts/fixture-editor.js

@@ -874,7 +874,7 @@ function submitFixture() {
   xhr.setRequestHeader('Content-Type', 'application/json');
   xhr.send(JSON.stringify(sendObject));
 
-  this.submit.rawData = '```\n' + JSON.stringify(sendObject, null, 2) + '\n```';
+  this.submit.rawData = '```json\n' + JSON.stringify(sendObject, null, 2) + '\n```';
   console.log(this.submit.rawData);
 }
 

views/stylesheets/content.scss

@@ -42,6 +42,19 @@
   &.orange {
     background: $orange-500;
   }
+
+  &:target {
+    animation: card-highlight 2s ease;
+  }
+}
+
+@keyframes card-highlight {
+  0% {
+    background-color: #fd0;
+  }
+  100% {
+    background-color: #fff;
+  }
 }
 
 .list {