@researchdatabox/redbox-dev-tools 0.0.1 → 5.0.0-RC2

package/templates/hook-archetype/standard/test/support/globals.ts.hbs

@@ -0,0 +1,40 @@
+const { _ } = require('@researchdatabox/redbox-dev-tools/testing');
+
+type LogFn = (...args: unknown[]) => void;
+
+const noop: LogFn = () => undefined;
+
+function installHookTestGlobals(overrides: Record<string, unknown> = {}): void {
+  (global as any)._ = _;
+  (global as any).sails = {
+    config: {
+      appPath: process.cwd(),
+      appUrl: 'https://example.redbox.local',
+      http: {
+        rootContext: 'redbox'
+      },
+      brandingConfigurationDefaults: {},
+      reusableFormDefinitions: {},
+      ...overrides
+    },
+    log: {
+      trace: noop,
+      verbose: noop,
+      info: noop,
+      warn: noop,
+      error: noop,
+      debug: noop
+    },
+    services: {}
+  };
+}
+
+function clearHookTestGlobals(): void {
+  delete (global as any)._;
+  delete (global as any).sails;
+}
+
+module.exports = {
+  installHookTestGlobals,
+  clearHookTestGlobals
+};

package/templates/hook-archetype/standard/test/tsconfig.json.hbs

@@ -0,0 +1,8 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "types": ["node", "mocha", "chai"]
+  },
+  "include": ["./**/*.ts", "../src/**/*.ts"]
+}

package/templates/hook-archetype/standard/test/unit/.mocharc.cjs.hbs

@@ -0,0 +1,9 @@
+module.exports = {
+  require: ['ts-node/register'],
+  extension: ['ts'],
+  recursive: true,
+  timeout: '30s',
+  ui: 'bdd',
+  reporter: 'spec',
+  exit: true
+};

package/templates/hook-archetype/standard/test/unit/index.test.ts.hbs

@@ -0,0 +1,46 @@
+const { expect, firstValueFrom } = require('@researchdatabox/redbox-dev-tools/testing');
+const { clearHookTestGlobals, installHookTestGlobals } = require('../support/globals');
+
+const hookModulePath = require.resolve('../../dist/index.js');
+
+let hookModule;
+
+describe('hook entrypoint', function () {
+  beforeEach(() => {
+    installHookTestGlobals();
+    delete require.cache[hookModulePath];
+    hookModule = require(hookModulePath);
+  });
+
+  afterEach(() => {
+    clearHookTestGlobals();
+    delete require.cache[hookModulePath];
+  });
+
+  it('exports the standard hook registrations and aliases', async function () {
+    const config = hookModule.registerRedboxConfig();
+
+    expect(config).to.have.property('brandingConfigurationDefaults');
+    expect(config).to.have.property('reusableFormDefinitions');
+    expect(config.brandingConfigurationDefaults.menu).to.deep.equal({ items: [], showSearch: true });
+    expect(config.brandingConfigurationDefaults.homePanels).to.deep.equal({ panels: [] });
+    expect(hookModule.registerRedboxServices()).to.have.property('ExampleService');
+    expect(hookModule.registerRedboxControllers()).to.have.property('ExampleController');
+    expect(hookModule.registerRedboxFormConfigs()).to.have.property('generated-view-only');
+    expect(hookModule.registerRedboxMigrations()).to.deep.equal([]);
+    expect(hookModule.MigrationExports).to.equal(hookModule.registerRedboxMigrations());
+    expect(hookModule.registerFormConfig()).to.equal(hookModule.registerRedboxFormConfigs());
+
+    const result = await firstValueFrom(hookModule.registerRedboxServices().ExampleService.describe());
+    expect(result).to.deep.equal({ hook: '{{packageName}}', status: 'ready' });
+  });
+
+  it('keeps configure empty while config is provided through registerRedboxConfig', function () {
+    const hook = hookModule((global as any).sails);
+
+    hook.configure?.();
+
+    expect((global as any).sails.config.brandingConfigurationDefaults).to.deep.equal({});
+    expect((global as any).sails.config.reusableFormDefinitions).to.deep.equal({});
+  });
+});

package/templates/hook-archetype/standard/tsconfig.json.hbs

@@ -0,0 +1,15 @@
+{
+  "extends": "@researchdatabox/redbox-dev-tools/config/tsconfig.base.json",
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./dist",
+    "strict": true,
+    "allowUmdGlobalAccess": true,
+    "typeRoots": [
+      "./node_modules/@types"
+    ]
+  },
+  "include": ["src/**/*.ts", "src/**/*.d.ts"],
+  "exclude": ["dist/**/*.ts", "dist/**/*.d.ts"]
+}

package/templates/hook-archetype/standard/views/.gitkeep

@@ -0,0 +1 @@
+

package/templates/hook-archetype/standard/views/default/.gitkeep

@@ -0,0 +1 @@
+

package/testing.d.ts

@@ -0,0 +1 @@
+export * from './dist/testing';

package/testing.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('./dist/testing.js');

package/.travis.yml

@@ -1,23 +0,0 @@
-sudo: required
-services:
-- docker
-language: node_js
-node_js:
-- '8'
-env:
-  global:
-  - COMMIT=${TRAVIS_COMMIT::8}
-  - CXX=g++-4.9
-  - secure: g1WCGWA64MAgXY6X+1/XxKOab3ANBXq9aUJFE7HzIWvZ6xty/mTbHbz8cX16ltfMxHWyy4icFXsKxb4lEFS3Tj50osVFTbBRljG01kyzwT5S+gJPTmqaN0c/lV5pvaUNkg1bE3dHLIuZamunUk7kJIzgByeEVr5Of05H+/QRqycJx88aE91vhxOCODe268OypQZUOQ70BkIalvSIHunCYlrD5MflS+EmMs+eTet9mRNB4Wa2xDoymFQ4VS8QVA2XrSDpdFDKJyRW6AvfmUsJFr1yhZlwMSgZsHqAbyVqU28FbkmRHyFjxarxhGW3WACAPeYjLfzoyGE1DAkmRJFh2DIFa7xOCeI3e2lwN25qObN9ETlLPKTdxiOgQ9M74A7rpdem4wmu8Bws1Std04eAh03BXsFuTLHZ9sXtMHbNbyF+X2eLOBaw6r+OPxhSaxCrQa4ZNQI7HeY7Eb5GiJUje+q56Nsvzeo57qnbyfd6Brt7plNuaDBIFugE4twtjS7idE8asVf8KQBnsjF7Ef9tB+ouACHGo1Ne6ccNQ7KXqC4irpzjraqhRhXwUKcDhC/44hYTdAfboZlnE5QDxMNiDvMDTPGmp16rcx5/5QAgRzkdNQOe+RhY2UN99W7o8UORkuYKoNp5Vp42FT+ff7pXpH895TtkJVYGYj/szDdTe+4=
-jobs:
-  include:
-  - stage: Build the package
-    before_install: npm install
-    install: true
-    deploy:
-      provider: npm
-      email: dev@redboxresearchdata.com.au
-      api_key: "$NPM_API_KEY"
-      skip_cleanup: true
-      on:
-        tags: true

package/commands/initProject.js

@@ -1,129 +0,0 @@
-let request = require('request');
-let fs = require('fs');
-let fsextra = require('fs-extra');
-let process = require('process');
-let downloadRelease = require('download-github-release');
-let mustache = require('mustache');
-let inly = require('inly');
-
-class InitProject {
-
-    getHelp() {
-        const sections = [
-            {
-              header: 'ReDBox Dev Tools - Init Hook',
-              content: 'Initialises a hook project for use with ReDBox'
-            },
-            {
-              header: 'Usage',
-              content: '$ redbox-dev-tools init -p redbox-hook-name'
-            },
-            {
-              header: 'Available Flags',
-              optionList: [
-                {
-                  name: 'packageName',
-                  alias: 'p',
-                  typeLabel: '{underline name}',
-                  required: true,
-                  description: 'The NPM package name for the sails hook.'
-                }
-              ]
-            }
-          ]
-        return sections;
-    }
-    execute(options) {
-        this.repo = 'redbox-hook-template';
-        this.downloadProjectTemplate(options);
-    }
-
-    setPackageJson(options) {
-        let template = fs.readFileSync(options.packageName+"/package.json.mst", 'utf8')
-        let output = mustache.render(template, options);
-        fs.writeFileSync(options.packageName+'/package.json', output);
-    }
-
-    setIndexJs(options) {
-        let template = fs.readFileSync(options.packageName+"/index.js.mst", 'utf8')
-        let output = mustache.render(template, options);
-        fs.writeFileSync(options.packageName+"/index.js", output);
-    }
-
-    setDockerCompose(options) {
-        let template = fs.readFileSync(options.packageName+"/support/development/docker-compose.yml.mst", 'utf8')
-        let output = mustache.render(template, options);
-        fs.writeFileSync(options.packageName+"/support/development/docker-compose.yml", output);
-    }
-
-    filterRelease(release) {
-        return release.prerelease === false;
-    }
-
-    filterAsset(asset) {
-        return asset.name.indexOf('tgz') >= 0;;
-    }
-
-    extractTgz(options) {
-        let regex = `redboxresearchdata\-${this.repo}.*\.tgz`;
-        let re = new RegExp(regex,"g");
-        this.tgzFilename = "";
-        fs.mkdirSync(options.packageName);
-        fs.readdirSync(".").forEach(file => {
-            if(file.match(re)) {
-                this.tgzFilename = file;
-            }
-          })
-
-        let extract = inly(this.tgzFilename, options.packageName);
-        
-        extract.on('error', (error) => {
-            console.error(error);
-        });
-
-        let that = this;
-        extract.on('end', () => {
-            console.log("Initialising project");
-            //TODO: Find moustache templates and evaluate them rather than specifying each one
-            that.setPackageJson(options);
-            that.setIndexJs(options);
-            that.setDockerCompose(options);
-            that.tidyUp(options);
-            console.log("Initialisation complete.");
-        });
-    }
-
-   
-    tidyUp(options) {
-        fsextra.removeSync(this.tgzFilename);
-        fsextra.removeSync(options.packageName+"/index.js.mst");
-        fsextra.removeSync(options.packageName+"/package.json.mst");
-        fsextra.removeSync(options.packageName+"/support/development/docker-compose.yml.mst");
-    }
-
-    downloadProjectTemplate(options) {
-        let user = 'redbox-mint-contrib';
-        
-        let outputDir = ".";
-        let leaveZipped = false;
-
-        if (fs.existsSync(options.packageName)) {
-            //TODO: Improve the error message
-            console.error("Dir already exists");
-            process.exit(1);
-        }
-
-        let that = this;
-        downloadRelease(user, this.repo, outputDir, this.filterRelease, this.filterAsset, leaveZipped)
-            .then(function () {
-                that.extractTgz(options);
-            })
-            .catch(function (err) {
-                console.error(err.message);
-            });
-    }
-
-
-}
-
-module.exports = InitProject;

package/redbox-dev-tools

@@ -1,70 +0,0 @@
-#!/usr/bin/env node
-
-const commandLineArgs = require('command-line-args')
-const commandLineUsage = require('command-line-usage')
-let readlineSync = require('readline-sync');
-
-/* first - parse the main command */
-const mainDefinitions = [{
-  name: 'command',
-  defaultOption: true
-}]
-const mainOptions = commandLineArgs(mainDefinitions, {
-  stopAtFirstUnknown: true
-})
-const argv = mainOptions._unknown || []
-if (mainOptions.command === 'hook-init') {
-  const mergeDefinitions = [{
-    name: 'packageName',
-    alias: 'p'
-  }]
-
-  const mergeOptions = commandLineArgs(mergeDefinitions, {
-    argv
-  })
-
-  if (!mergeOptions.packageName) {
-    mergeOptions.packageName = readlineSync.question('What package name would you like to use for this hook? \n');
-  }
-  let InitProject = require('./commands/initProject');
-  let initProject = new InitProject();
-  initProject.execute(mergeOptions);
-} else if (mainOptions.command === 'help' || !mainOptions.command) {
-
-  if (mainOptions.command === 'help' && argv[0]) {
-    if(argv[0] == "init") {
-      let InitProject = require('./commands/initProject');
-      let initProject = new InitProject();
-      const sections =  initProject.getHelp();
-      const usage = commandLineUsage(sections)
-      console.log(usage);
-    }
-  } else {
-    const sections = [
-
-      {
-        header: 'ReDBox Dev Tools',
-        content: 'A set of tools aimed at developers working with the ReDBox platform'
-      },
-      {
-        header: 'Usage',
-        content: '$ redbox-dev-tools <command> <options>'
-      },
-      {
-        header: 'Available Commands',
-        content: [{
-            name: 'init',
-            summary: 'Initialises a hook code project ready for development'
-          },
-          {
-            name: 'help',
-            summary: 'Shows this help message or help for a specific command'
-          }
-        ]
-      }
-    ]
-
-    const usage = commandLineUsage(sections)
-    console.log(usage);
-  }
-}