nails-boilerplate 1.0.0 → 1.1.0

package/bin/lib/init.js

@@ -2,9 +2,7 @@
 // to the path
 import path from 'node:path';
 import fs from 'node:fs';
-// TODO: wrench is deprecated. check out node-fs-extra
-import wrench from 'wrench';
-// var wrench = require('wrench');
+import {copySync} from 'fs-extra/esm';
 import {exec} from 'child_process';
 // var exec = require('child_process').exec;
 var args = process.argv.slice(2);
@@ -51,12 +49,12 @@ function createApp( name ) {
         fs.writeFileSync(name + '/NAILS', '/* This marks the root of the NAILS app */');
         fs.closeSync(fd);
 
-        wrench.copyDirSyncRecursive(path.resolve(templateRoot, './server'), name + '/server');
-        wrench.copyDirSyncRecursive(path.resolve(templateRoot, './client'), name + '/client');
-        wrench.copyDirSyncRecursive(path.resolve(templateRoot, './config'), name + '/config');
-        wrench.copyDirSyncRecursive(path.resolve(templateRoot, './common'), name + '/common');
-        wrench.copyDirSyncRecursive(path.resolve(templateRoot, './spec'), name + '/spec');
-        wrench.copyDirSyncRecursive(path.resolve(templateRoot, './bin'), name + '/bin');
+        copySync(path.resolve(templateRoot, './server'), name + '/server');
+        copySync(path.resolve(templateRoot, './client'), name + '/client');
+        copySync(path.resolve(templateRoot, './config'), name + '/config');
+        copySync(path.resolve(templateRoot, './common'), name + '/common');
+        copySync(path.resolve(templateRoot, './spec'), name + '/spec');
+        copySync(path.resolve(templateRoot, './bin'), name + '/bin');
 
         checkWrites();
     });

package/lib/database_connector.js

@@ -0,0 +1,11 @@
+export default class DbConnector {
+  async connect() {
+    throw 'DbConnector#connect not implemented'
+  }
+  generateModelSuperclass() {
+    throw 'GenerateModelSuperclass not implemented'
+  }
+  async afterInitialization() {
+    console.warn("DbConnector#afterInitialization not implemented");
+  }
+}

package/lib/mongoose_connector.js

@@ -1,7 +1,8 @@
 // const mongoose = require('mongoose');
 import mongoose from 'mongoose';
+import DbConnector from './database_connector.js';
 
-class MongooseDbConnector {
+class MongooseDbConnector extends DbConnector{
   async connect(options) {
     if (options.uri) {
       this.connection = await mongoose.createConnection(options.uri/*, mongooseOptions*/).asPromise();

package/lib/nails.js

@@ -84,6 +84,8 @@ async function configure( app_config ) {
     console.log("Generating model superclass...");
     await DBConnector.connect(app_config.db);
     ModelV2.setConnector(DBConnector);
+    init_models_v2(app_config.config.MODELS_ROOT);
+    DBConnector.afterInitialization();
   } else {
     console.log("Instantiating DBConnector...");
     // Try to instantiate DBConnector
@@ -166,6 +168,27 @@ async function init_app_lib(superclass, abs_path) {
     });
 }
 
+async function init_models_v2(abs_path) {
+  if (!fs.existsSync(abs_path))
+    return console.log('Cannot initialize. Path not found.', abs_path);
+  if (fs.statSync(abs_path).isFile()) {
+    console.log('attempting to import:', abs_path);
+    // We just need to import each model once so the generateSuperclass
+    // method is called at least once for each model.
+    let modelClass = (await import(abs_path)).default;
+    console.log('imported model:', modelClass.name);
+    // // Constructor function was provided
+    // if (!superclass.isPrototypeOf(subclass))
+    //     return superclass.extend(subclass);
+    // ES6 Class was provided
+    return;
+  }
+  const directory_contents = fs.readdirSync(abs_path);
+  for (const rel_path of directory_contents) {
+      await init_models_v2(path.join(abs_path, rel_path));
+  };
+}
+
 // retrieves the connector object. If cannot
 // require the module with the same name,
 // try grabbing connector from lib

package/lib/sequelize_connector.js

@@ -0,0 +1,25 @@
+import DbConnector from './database_connector.js';
+import { Sequelize } from 'sequelize';
+// const { Sequelize } = require('sequelize');
+
+export default class SequelizeConnector extends DbConnector {
+  sequelize;
+
+  async connect(options) {
+    this.sequelize = new Sequelize(options.address);
+    try {
+      await this.sequelize.authenticate();
+      console.log('Connection has been established successfully.');
+    } catch (error) {
+      console.error('Unable to connect to the database:', error);
+    }
+  }
+
+  generateModelSuperclass(name, options) {
+    return this.sequelize.define(name, options);
+  }
+
+  async afterInitialization() {
+    this.sequelize.sync({alter: true});
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nails-boilerplate",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A node.js webserver scaffold",
   "type": "module",
   "main": "index.js",
@@ -31,14 +31,16 @@
     "ejs": "*",
     "express": "*",
     "express-ws": "*",
+    "fs-extra": "^11.3.2",
     "mime": "*",
     "mongodb": "^4.17.2",
     "mongodb-memory-server": "^8.16.0",
     "mongoose": "^6.13.0",
     "react": "*",
     "react-dom": "^16.13.1",
+    "sequelize": "^6.37.7",
     "showdown": "^2.1.0",
-    "wrench": "*"
+    "sqlite3": "^5.1.7"
   },
   "devDependencies": {
     "chai": "*",

package/spec/sequelize_connector.spec.js

@@ -0,0 +1,38 @@
+// import SequelizeConnector from '../lib/sequelize_connector.js';
+import assert from 'assert';
+import Model from '../lib/model_v2.js';
+import { DataTypes } from 'sequelize';
+import SequelizeConnectorUtil from './sequelize_connector.util.js';
+
+const TEST_SCHEMA = {
+  name: DataTypes.STRING,
+  favoriteColor: {
+    type: DataTypes.STRING,
+    defaultValue: 'green',
+  },
+  age: DataTypes.INTEGER,
+  cash: DataTypes.INTEGER,
+}
+let TestSequelizeModel = null;
+
+describe('ModelV2 using SequelizeConnector', function() {
+  let util;
+  beforeEach(async function() {
+    util = new SequelizeConnectorUtil();
+    let connector = await util.getTestConnector();
+    Model.setConnector(connector);
+    TestSequelizeModel =
+        class TestSequelizeModel extends new Model("TestSequelizeModel", TEST_SCHEMA) {
+        };
+    await connector.sequelize.sync({ force: true });
+  });
+
+  it("Should be able to create, save, and retrieve a model", async function() {
+    const MODEL_NAME = "First test model created";
+    const testModel = TestSequelizeModel.build({name: MODEL_NAME});
+    await testModel.save();
+    const models = await TestSequelizeModel.findAll();
+    assert(models.length == 1, "Should have one model");
+    assert(models[0].name == MODEL_NAME, "Name should be consistent");
+  });
+});

package/spec/sequelize_connector.util.js

@@ -0,0 +1,18 @@
+import SequelizeConnector from '../lib/sequelize_connector.js';
+
+class SequelizeConnectorUtil {
+  constructor() {
+  }
+
+  async getTestConnector() {
+    const dbConnector = new SequelizeConnector();
+    this.connection = await dbConnector.connect({address: 'sqlite::memory:'});
+    debugger;
+    return dbConnector;
+  }
+  async cleanup() {
+    debugger;
+  }
+}
+
+export default SequelizeConnectorUtil;

package/templates/bin/start.sh

@@ -0,0 +1,9 @@
+SCRIPT_DIR=$(dirname "$0")
+echo "Script directory (relative): $SCRIPT_DIR"
+
+
+SCRIPT_PATH=$(readlink -f "$0")
+SCRIPT_DIR=$(dirname "$SCRIPT_PATH")
+echo "Script directory (absolute, resolved): $SCRIPT_DIR"
+
+npm --prefix=$SCRIPT_DIR/.. start

package/templates/config/db.js

@@ -1,14 +1,22 @@
 export default {
-  //connector: 'sqlite3_connector.js',
+  /**
+   * For the sqlite3 connector. Unless a filename is defined, an in-memory
+   * database is used. In-memory databases are not persisted, and will be lost
+   * when the server is restarted.
+   */
+  // connector: 'sqlite3_connector.js',
+  // filename: ':memory:'
+
+  /** Mongoose Connector */
   // connector: 'mongoose_connector.js',
-  connector: 'mongoose_mem_connector.js',
-  //url: 'mongodb://localhost',
-  //port: '27017',
+  // url: 'mongodb://localhost',
+  // port: '27017',
 
-  database: 'development',
+  /** Mongoose Memory Server Connector */
+  // connector: 'mongoose_mem_connector.js',
+  // database: 'development',
 
-  // For the sqlite3 connector. Unless a filename is defined, an in-memory
-  // database is used. In-memory databases are not persisted, and will be lost
-  // when the server is restarted.
-  //filename: ':memory:'
+  /** Sequelize Connector */
+  connector: 'sequelize_connector.js',
+  address: 'sqlite::memory:',
 }

package/templates/package.json

@@ -4,6 +4,7 @@
     "description": "A basic nails application",
     "main": "server.js",
     "type": "module",
+    "bin": "./bin/start.sh",
     "scripts": {
         "test": "echo \"Error: no test specified\" && exit 1",
         "start": "vite build & node bin/server.js",
@@ -23,19 +24,20 @@
     },
     "dependencies": {
       "nails-boilerplate": ">=0.1.0",
+      "vite": "^6.3.5",
+      "@vitejs/plugin-legacy": "^6.1.1",
+      "@vitejs/plugin-react": "^4.7.0",
       "react": "^19.1.0",
       "react-dom": "^19.1.0",
-      "react-router-dom": "^7.7.0"
+      "react-router-dom": "^7.7.0",
+      "sequelize": "^6.37.7",
+      "@mui/material": "^7.3.1",
+      "@mui/icons-material": "^7.3.1"
     },
     "devDependencies": {
-      "vite": "^6.3.5",
       "vitest": "^3.2.4",
-      "@vitejs/plugin-legacy": "^6.1.1",
-      "@vitejs/plugin-react": "^4.7.0",
       "@emotion/react": "^11.14.0",
       "@emotion/styled": "^11.14.1",
-      "@mui/material": "^7.3.1",
-      "@mui/icons-material": "^7.3.1",
       "@mui/types": "^7.4.5"
     }
 }

package/templates/server/models/user.js

@@ -1,9 +1,18 @@
 import nails from "nails-boilerplate";
+import { DataTypes } from 'sequelize';
 const Model = nails.Model;
 
-const userSchema = {
-  name: String,
-  verified: Boolean,
-  email: String
-};
-export default class User extends new Model("User", {schema: userSchema}) {};
+const sequelizeUserSchema = {
+  name: DataTypes.STRING,
+  verified: DataTypes.BOOLEAN,
+  email: DataTypes.STRING
+}
+export default class User extends new Model("User", sequelizeUserSchema) {};
+
+/** If using a mongoose connector */
+// const mongooseUserSchema = {
+//   name: String,
+//   verified: Boolean,
+//   email: String
+// };
+// export default class User extends new Model("User", {schema: mongooseUserSchema}) {};