Merge pull request #11 from openactive/feature/restructure

Fixes openactive/data-model-validator#215

.gitignore

@@ -74,3 +74,6 @@ typings/
 
 # OSX
 .DS_Store
+
+# Editor
+.idea

.npmignore

@@ -0,0 +1,16 @@
+# Tests
+spec
+src/**/*[sS]pec.js
+
+# Build scripts
+scripts
+
+# CI
+.travis.yml
+.nvmrc
+
+# Linters
+.eslintrc*
+
+# Editor settings
+.editorconfig

package.json

@@ -31,7 +31,7 @@
   "scripts": {
     "build": "node scripts/build.js",
     "lint": "eslint \"src/**/*.js\"",
-    "prepublish": "npm run build",
+    "prepare": "npm run build",
     "pretest": "npm run build && npm run lint",
     "test": "npm run test-no-lint",
     "test-no-lint": "jasmine"

scripts/build.js

@@ -11,7 +11,7 @@ const specs = {};
 const contexts = {};
 
 for (const version of uniqueVersions) {
-  const specPath = path.join(__dirname, '..', 'src', version);
+  const specPath = path.join(__dirname, '..', 'versions', version);
   const spec = {
     models: {},
     rpde: {},
@@ -34,7 +34,7 @@ for (const version of uniqueVersions) {
   }
 
   specs[version] = spec;
-  contexts[version] = generateContext(version);
+  contexts[version] = generateContext(version, spec.meta);
 }
 
 fs.writeFileSync(

scripts/generateContext.js

@@ -4,20 +4,10 @@ const path = require('path');
 const getMetaData = require('../src/getMetaData');
 const derivePrefix = require('../src/helpers/derivePrefix');
 const deriveSingularTypes = require('../src/helpers/deriveSingularTypes');
-const versions = require('../src/versions');
+const deriveVersion = require('../src/helpers/deriveVersion');
 
-const generateContext = (version) => {
-  let localVersion = version;
-  if (typeof localVersion === 'undefined') {
-    localVersion = 'latest';
-  }
-  if (typeof versions[localVersion] === 'undefined') {
-    throw Error('Invalid specification version supplied');
-  }
-
-  const specVersion = versions[localVersion];
-
-  const metaData = getMetaData(specVersion);
+const generateContext = (version, metaData) => {
+  const specVersion = deriveVersion(version);
 
   const context = {
     concepts: {
@@ -30,11 +20,11 @@ const generateContext = (version) => {
   const newModels = {};
   const newFields = {};
 
-  const files = fs.readdirSync(path.join(__dirname, '..', 'src', specVersion, 'models'));
+  const files = fs.readdirSync(path.join(__dirname, '..', 'versions', specVersion, 'models'));
 
   for (const file of files) {
     if (file !== 'model_list.json') {
-      const jsonPath = path.join(__dirname, '..', 'src', specVersion, 'models', file);
+      const jsonPath = path.join(__dirname, '..', 'versions', specVersion, 'models', file);
       const data = fs.readFileSync(jsonPath, 'utf8');
       const model = JSON.parse(data);
 

scripts/generateGraph.js

@@ -10,20 +10,10 @@ const path = require('path');
 const getMetaData = require('../src/getMetaData');
 const derivePrefix = require('../src/helpers/derivePrefix');
 const deriveSingularTypes = require('../src/helpers/deriveSingularTypes');
-const versions = require('../src/versions');
+const deriveVersion = require('../src/helpers/deriveVersion');
 
-const getGraph = (version) => {
-  let localVersion = version;
-  if (typeof localVersion === 'undefined') {
-    localVersion = 'latest';
-  }
-  if (typeof versions[localVersion] === 'undefined') {
-    throw Error('Invalid specification version supplied');
-  }
-
-  const specVersion = versions[localVersion];
-
-  const metaData = getMetaData(specVersion);
+const getGraph = (version, metaData) => {
+  const specVersion = deriveVersion(version);
   const extraData = {
     '@id': metaData.namespaces[metaData.openActivePrefix],
     'dc:date': (new Date()).toISOString().replace(/T.*$/, ''),
@@ -33,10 +23,10 @@ const getGraph = (version) => {
     rdfs_classes: [],
     rdfs_properties: [],
   };
-  const files = fs.readdirSync(path.join(__dirname, '..', 'src', specVersion, 'models'));
+  const files = fs.readdirSync(path.join(__dirname, '..', 'versions', specVersion, 'models'));
   for (const file of files) {
     if (file !== 'model_list.json') {
-      const jsonPath = path.join(__dirname, '..', 'src', specVersion, 'models', file);
+      const jsonPath = path.join(__dirname, '..', 'versions', specVersion, 'models', file);
       const data = fs.readFileSync(jsonPath, 'utf8');
       const model = JSON.parse(data);
 

src/getContext.js

@@ -1,18 +1,12 @@
 const contexts = require('./dist/contexts');
-const versions = require('./versions');
+const deriveVersion = require('./helpers/deriveVersion');
 
 const getContext = (version) => {
-  let localVersion = version;
-  if (typeof localVersion === 'undefined') {
-    localVersion = 'latest';
-  }
-  if (
-    typeof versions[localVersion] === 'undefined'
-    || typeof contexts[versions[localVersion]] === 'undefined'
-  ) {
+  const specVersion = deriveVersion(version);
+  if (typeof contexts[specVersion] === 'undefined') {
     throw Error('Invalid specification version supplied');
   }
-  return contexts[versions[localVersion]];
+  return contexts[specVersion];
 };
 
 module.exports = getContext;

src/getFullyQualifiedProperty.js

@@ -1,17 +1,10 @@
 const getContext = require('./getContext');
-const versions = require('./versions');
+const deriveVersion = require('./helpers/deriveVersion');
 
 const KEYWORD_REGEX = /^@(context|id|value|language|type|container|list|set|reverse|index|base|vocab|graph)$/;
 
 const getFullyQualifiedProperty = (value, version, contexts = []) => {
-  let localVersion = version;
-  if (typeof localVersion === 'undefined') {
-    localVersion = 'latest';
-  }
-  if (typeof versions[localVersion] === 'undefined') {
-    throw Error(`Invalid specification version '${localVersion}' supplied`);
-  }
-  const specVersion = versions[localVersion];
+  const specVersion = deriveVersion(version);
 
   let contextsArg = contexts;
   // Sort the contexts

src/getMetaData.js

@@ -1,19 +1,15 @@
 const specs = require('./dist/specs');
-const versions = require('./versions');
+const deriveVersion = require('./helpers/deriveVersion');
 
 const getMetaData = (version) => {
-  let localVersion = version;
-  if (typeof localVersion === 'undefined') {
-    localVersion = 'latest';
-  }
+  const specVersion = deriveVersion(version);
   if (
-    typeof versions[localVersion] === 'undefined'
-    || typeof specs[versions[localVersion]] === 'undefined'
-    || typeof specs[versions[localVersion]].meta === 'undefined'
+    typeof specs[specVersion] === 'undefined'
+    || typeof specs[specVersion].meta === 'undefined'
   ) {
-    throw Error('Invalid specification version supplied');
+    throw Error(`Invalid specification version "${specVersion}" supplied`);
   }
-  return specs[versions[localVersion]].meta;
+  return specs[specVersion].meta;
 };
 
 module.exports = getMetaData;

src/helpers/deriveVersion.js

@@ -0,0 +1,18 @@
+const versions = require('../versions');
+
+const deriveVersion = (version) => {
+  let localVersion = version;
+  if (typeof localVersion === 'undefined') {
+    localVersion = 'latest';
+  }
+  if (Object.values(versions).indexOf(localVersion) >= 0) {
+    return localVersion;
+  }
+  if (typeof versions[localVersion] !== 'undefined') {
+    return versions[localVersion];
+  }
+
+  throw Error(`Invalid specification version "${version}" supplied`);
+};
+
+module.exports = deriveVersion;

src/helpers/loadModelCheckArgs.js

@@ -1,17 +1,10 @@
-const versions = require('../versions');
+const deriveVersion = require('./deriveVersion');
 
 const loadModelCheckArgs = (name, version) => {
   if (!name.match(/^[A-Za-z]+$/) || name === 'model_list') {
     throw Error('Invalid model name supplied');
   }
-  let localVersion = version;
-  if (typeof localVersion === 'undefined') {
-    localVersion = 'latest';
-  }
-  if (typeof versions[localVersion] === 'undefined') {
-    throw Error('Invalid specification version supplied');
-  }
-  return versions[localVersion];
+  return deriveVersion(version);
 };
 
 module.exports = loadModelCheckArgs;

src/loadModel.js

@@ -13,7 +13,7 @@ const loadModel = (name, version) => {
     || typeof specs[specVersion][jsonKey] === 'undefined'
     || typeof specs[specVersion][jsonKey][name] === 'undefined'
   ) {
-    throw Error('Invalid model name supplied');
+    throw Error(`Invalid model name "${name}" supplied`);
   }
   let model = Object.assign({}, specs[specVersion][jsonKey][name]);
   if (

src/loadModelFromFile.js

@@ -7,9 +7,9 @@ const loadModelFromFile = (name, version) => {
   const specVersion = loadModelCheckArgs(name, version);
   let jsonPath;
   if (name === 'FeedItem' || name === 'FeedPage') {
-    jsonPath = path.join(__dirname, specVersion, 'rpde', `${name}.json`);
+    jsonPath = path.join(__dirname, '..', 'versions', specVersion, 'rpde', `${name}.json`);
   } else {
-    jsonPath = path.join(__dirname, specVersion, 'models', `${name}.json`);
+    jsonPath = path.join(__dirname, '..', 'versions', specVersion, 'models', `${name}.json`);
   }
   const data = fs.readFileSync(jsonPath, 'utf8');
   let model = JSON.parse(data);

src/models-spec.js

@@ -12,8 +12,8 @@ describe('models', () => {
   const uniqueVersions = [...new Set(Object.values(versions))];
   for (const version of uniqueVersions) {
     const files = [
-      ...fs.readdirSync(path.join(__dirname, version, 'models')),
-      ...fs.readdirSync(path.join(__dirname, version, 'rpde')),
+      ...fs.readdirSync(path.join(__dirname, '..', 'versions', version, 'models')),
+      ...fs.readdirSync(path.join(__dirname, '..', 'versions', version, 'rpde')),
     ];
     const metaData = getMetaData(version);
     for (const file of files) {
@@ -22,7 +22,7 @@ describe('models', () => {
         if (file.match(/^Feed/)) {
           dir = 'rpde';
         }
-        const filePath = path.join(__dirname, version, dir, file);
+        const filePath = path.join(__dirname, '..', 'versions', version, dir, file);
         const data = fs.readFileSync(filePath, 'utf8');
         let jsonData;
         const readJson = () => { jsonData = JSON.parse(data); };

src/versions.js

@@ -1,4 +1,4 @@
 module.exports = {
-  latest: '2.0',
-  '2.0': '2.0',
+  latest: '2.x',
+  '2.0': '2.x',
 };