velocious 1.0.1 → 1.0.3

package/README.md

@@ -0,0 +1,36 @@
+# README
+
+This is still work in progress.
+
+* Concurrent multi threadded web server
+* Database framework ala Rails
+* Database models ala Rails
+* Database models that work almost the same in frontend and backend
+* Migrations ala Rails
+* Controllers and views ala Rails
+
+# Setup
+
+Make a new NPM project.
+```bash
+mkdir project
+cd project
+npm install velocious
+npx velocious init
+```
+
+# Migrations
+
+```bash
+npx velocious db:g:migration create_tasks
+```
+
+```bash
+npx velocious db:migrate
+```
+
+# Testing
+
+```bash
+npm test
+```

package/bin/velocious.mjs

@@ -0,0 +1,8 @@
+#!/usr/bin/node
+
+import Cli from "../src/cli/index.mjs"
+
+const processArgs = process.argv.slice(2)
+const cli = new Cli({processArgs})
+
+cli.execute()

package/index.mjs

@@ -0,0 +1,21 @@
+import Application from "./src/application.mjs"
+import Cli from "./src/cli/index.mjs"
+import Configuration from "./src/configuration.mjs"
+import Controller from "./src/controller.mjs"
+import Database from "./src/database/index.mjs"
+import DatabasePool from "./src/database/pool/index.mjs"
+import HttpServer from "./src/http-server/index.mjs"
+import Routes from "./src/routes/index.mjs"
+import Spec from "./src/spec/index.mjs"
+
+export {
+  Application,
+  Cli,
+  Configuration,
+  Controller,
+  Database,
+  DatabasePool,
+  HttpServer,
+  Routes,
+  Spec
+}

package/package.json

@@ -1,10 +1,15 @@
 {
+  "bin": {
+    "velocious": "bin/velocious.mjs"
+  },
   "name": "velocious",
-  "version": "1.0.1",
-  "main": "index.cjs",
+  "version": "1.0.3",
+  "main": "index.mjs",
   "scripts": {
-    "test": "jasmine"
+    "test": "jasmine",
+    "velocious": "asd"
   },
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/kaspernj/velocious.git"
@@ -17,13 +22,16 @@
   "homepage": "https://github.com/kaspernj/velocious#readme",
   "description": "",
   "devDependencies": {
-    "jasmine": "^4.0.2",
-    "node-fetch": "^2.6.1"
+    "jasmine": "^5.0.2",
+    "mysql": "^2.18.1",
+    "node-fetch": "^3.3.1"
   },
   "dependencies": {
-    "diggerize": "^1.0.3",
+    "diggerize": "^1.0.5",
     "ejs": "^3.1.6",
     "escape-string-regexp": "^1.0.5",
-    "inflection": "^1.13.2"
+    "incorporator": "^1.0.2",
+    "inflection": "^3.0.0",
+    "strftime": "^0.10.2"
   }
 }

package/peak_flow.yml

@@ -1,17 +1,24 @@
+before_install:
+  - sudo mkdir -p /etc/apt/keyrings
+  - curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
+  - echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_20.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list
+  - sudo apt-get update
+  - sudo apt-get install -y nodejs
 before_script:
-  - cp spec/dummy/config/databases.peakflow.json spec/dummy/config/databases.json
+  - cp spec/dummy/src/config/configuration.peakflow.mjs spec/dummy/src/config/configuration.mjs
   - npm install
-  - wait-for-it mysql:3306
+  - wait-for-it mariadb:3306
 services:
-  mysql:
+  mariadb:
     environment:
       MYSQL_USER: peakflow
       MYSQL_PASSWORD: password
       MYSQL_ROOT_PASSWORD: password
       MYSQL_DATABASE: velocious_test
-    image: mysql:8.0.22
+    image: mariadb:latest
     expose:
       - 3306
-    mem_limit: 2048m
+    mem_limit: 4096m
+    restart_policy: on-failure
 script:
   - npm test

package/spec/cli/commands/db/create-spec.mjs

@@ -0,0 +1,25 @@
+import Cli from "../../../../src/cli/index.mjs"
+import dummyDirectory from "../../../dummy/dummy-directory.mjs"
+
+describe("Cli - Commands - db:create", () => {
+  it("generates SQL to create a new database", async () => {
+    const cli = new Cli({
+      directory: dummyDirectory(),
+      processArgs: ["db:create"],
+      testing: true
+    })
+    const result = await cli.execute()
+
+    expect(result).toEqual(
+      [
+        {
+          databaseName: 'velocious_test',
+          sql: 'CREATE DATABASE IF NOT EXISTS velocious_test'
+        },
+        {
+          createSchemaMigrationsTableSql: 'CREATE TABLE IF NOT EXISTS schema_migrations (`version` varchar(255) PRIMARY KEY)'
+        }
+      ]
+    )
+  })
+})

package/spec/cli/commands/db/migrate-spec.mjs

@@ -0,0 +1,37 @@
+import Cli from "../../../../src/cli/index.mjs"
+import dummyDirectory from "../../../dummy/dummy-directory.mjs"
+
+describe("Cli - Commands - db:migrate", () => {
+  it("runs migrations", async () => {
+    const directory = dummyDirectory()
+    const cli = new Cli({
+      directory,
+      processArgs: ["db:migrate"],
+      testing: true
+    })
+
+    await cli.loadConfiguration()
+
+    const db = cli.configuration.getDatabasePool()
+
+    await db.withConnection(async () => {
+      await db.query("DROP TABLE IF EXISTS tasks")
+      await db.query("DROP TABLE IF EXISTS projects")
+    })
+
+    await cli.execute()
+
+    let tablesResult
+
+    await db.withConnection(async () => {
+      tablesResult = await db.query("SHOW TABLES")
+    })
+
+    expect(tablesResult).toEqual(
+      [
+        {Tables_in_velocious_test: "projects"},
+        {Tables_in_velocious_test: "tasks"}
+      ]
+    )
+  })
+})

package/spec/cli/commands/destroy/migration-spec.mjs

@@ -0,0 +1,15 @@
+import Cli from "../../../../src/cli/index.mjs"
+import dummyDirectory from "../../../dummy/dummy-directory.mjs"
+
+describe("Cli - destroy - migration", () => {
+  it("destroys an existing migration", async () => {
+    const cli = new Cli({
+      directory: dummyDirectory(),
+      processArgs: ["d:migration", "create-tasks"],
+      testing: true
+    })
+    const result = await cli.execute()
+
+    expect(result.destroyed).toEqual(["create-tasks"])
+  })
+})

package/spec/cli/commands/generate/migration-spec.mjs

@@ -0,0 +1,18 @@
+import Cli from "../../../../src/cli/index.mjs"
+import dummyDirectory from "../../../dummy/dummy-directory.mjs"
+
+describe("Cli - generate - migration", () => {
+  it("generates a new migration", async () => {
+    const cli = new Cli({
+      directory: dummyDirectory(),
+      processArgs: ["g:migration", "create-tasks"],
+      testing: true
+    })
+    const result = await cli.execute()
+
+    expect(result.migrationName).toEqual("create-tasks")
+    expect(result.migrationNameCamelized).toEqual("CreateTasks")
+    expect(result.migrationNumber).toMatch(/^\d+$/)
+    expect(result.migrationPath).toMatch(/-create-tasks\.mjs$/)
+  })
+})

package/spec/cli/commands/init-spec.mjs

@@ -0,0 +1,19 @@
+import Cli from "../../../src/cli/index.mjs"
+import dummyDirectory from "../../dummy/dummy-directory.mjs"
+
+describe("Cli - Commands - init", () => {
+  it("inits files and dirs", async () => {
+    const cli = new Cli({
+      directory: dummyDirectory(),
+      processArgs: ["init"],
+      testing: true
+    })
+    const result = await cli.execute()
+
+    expect(result.fileMappings.length).toEqual(2)
+    expect(result.fileMappings[0].source).toContain("/src/templates/configuration.mjs")
+    expect(result.fileMappings[0].target).toContain("/spec/dummy/src/config/configuration.mjs")
+    expect(result.fileMappings[1].source).toContain("/src/templates/routes.mjs")
+    expect(result.fileMappings[1].target).toContain("/spec/dummy/src/config/routes.mjs")
+  })
+})

package/spec/cli/commands/test/test-files-finder-spec.mjs

@@ -0,0 +1,12 @@
+import TestFilesFinder from "../../../../src/cli/commands/test/test-files-finder.mjs"
+
+describe("Cli - Commands - test - TestFilesFinder", () => {
+  it("finds the correct test files", async () => {
+    const testFilesFinder = new TestFilesFinder({directory: process.cwd(), processArgs: ["test"]})
+    const testFiles = await testFilesFinder.findTestFiles()
+
+    const sampleTestFilePath = `${process.cwd()}/spec/cli/commands/destroy/migration-spec.mjs`
+
+    expect(testFiles.includes(sampleTestFilePath)).toBe(true)
+  })
+})

package/spec/database/connection/drivers/mysql/{query-parser-spec.cjs → query-parser-spec.mjs}

@@ -1,13 +1,17 @@
-const {Database: {Handler, Query}} = require("../../../../../index.cjs")
-const MysqlQueryParser = require("../../../../../src/database/connection/drivers/mysql/query-parser.cjs")
+import Database from "../../../../../src/database/index.mjs"
+import MysqlQueryParser from "../../../../../src/database/drivers/mysql/query-parser.mjs"
 
-const FromTable = require("../../../../../src/database/query/from-table.cjs")
-const SelectTableAndColumn = require("../../../../../src/database/query/select-table-and-column.cjs")
+import FromTable from "../../../../../src/database/query/from-table.mjs"
+import SelectTableAndColumn from "../../../../../src/database/query/select-table-and-column.mjs"
+
+import MysqlDriverClass from "../../../../../src/database/drivers/mysql/index.mjs"
+
+const mysqlDriver = new MysqlDriverClass()
 
 describe("database - connection - drivers - mysql - query parser", () => {
   it("generates sql with selects, joins and orders", () => {
-    const handler = new Handler()
-    const query = new Query({handler})
+    const handler = new Database.Handler()
+    const query = new Database.Query({driver: mysqlDriver, handler})
       .select(["tasks.id", "tasks.name"])
       .from("tasks")
       .joins("LEFT JOIN projects ON projects.id = tasks.project_id")
@@ -18,8 +22,8 @@ describe("database - connection - drivers - mysql - query parser", () => {
   })
 
   it("generates sql with selects, joins and orders", () => {
-    const handler = new Handler()
-    const query = new Query({handler})
+    const handler = new Database.Handler()
+    const query = new Database.Query({driver: mysqlDriver, handler})
       .select([
         new SelectTableAndColumn({tableName: "tasks", columnName: "id"}),
         new SelectTableAndColumn({tableName: "tasks", columnName: "name"})

package/spec/database/drivers/mysql/connection-spec.mjs

@@ -0,0 +1,21 @@
+import Database from "../../../../src/database/index.mjs"
+import configuration from "../../../dummy/src/config/configuration.mjs"
+import {digg} from "diggerize"
+
+const mysqlConfig = digg(configuration, "database", "default", "master")
+const Mysql = Database.Drivers.Mysql
+
+describe("Database - Drivers - Mysql - Connection", () => {
+  it("connects", async () => {
+    const mysql = new Mysql(mysqlConfig)
+
+    await mysql.connect()
+
+    const result = await mysql.query("SELECT \"1\" AS test1, \"2\" AS test2")
+
+    expect(result).toEqual([{
+      test1: "1",
+      test2: "2"
+    }])
+  })
+})

package/spec/database/record/create-spec.mjs

@@ -0,0 +1,14 @@
+import Dummy from "../../dummy/index.mjs"
+import Task from "../../dummy/src/models/task.mjs"
+
+describe("Record - create", () => {
+  it("creates a new simple record", async () => {
+    await Dummy.run(async () => {
+      const task = new Task({name: "Test task"})
+
+      await task.save()
+
+      expect(task.id()).not.toBeUndefined()
+    })
+  })
+})

package/spec/database/record/destroy-spec.mjs

@@ -0,0 +1,17 @@
+import Dummy from "../../dummy/index.mjs"
+import Task from "../../dummy/src/models/task.mjs"
+
+describe("Record - destroy", () => {
+  it("destroys a record", async () => {
+    await Dummy.run(async () => {
+      const task = new Task({name: "Test task"})
+
+      await task.save()
+      await task.destroy()
+
+      const foundTask = await Task.where({id: task.id()}).first()
+
+      expect(foundTask).toEqual(undefined)
+    })
+  })
+})

package/spec/database/record/find-spec.mjs

@@ -0,0 +1,29 @@
+import Dummy from "../../dummy/index.mjs"
+import RecordNotFoundError from "../../../src/database/record/record-not-found-error.mjs"
+import Task from "../../dummy/src/models/task.mjs"
+
+describe("Record - find", () => {
+  it("finds an existing record", async () => {
+    await Dummy.run(async () => {
+      const task = new Task({name: "Test task"})
+
+      await task.save()
+
+      const foundTask = await Task.find(task.id())
+
+      expect(foundTask.readAttribute("name")).toEqual("Test task")
+    })
+  })
+
+  it("raises an error when a record isn't found", async () => {
+    await Dummy.run(async () => {
+      try {
+        await Task.find(123)
+        throw new Error("Didn't expect to reach this")
+      } catch (error) {
+        expect(error.message).toEqual("Couldn't find Task with 'id'=123")
+        expect(error.constructor.name).toEqual("RecordNotFoundError")
+      }
+    })
+  })
+})

package/spec/database/record/update-spec.mjs

@@ -0,0 +1,15 @@
+import Dummy from "../../dummy/index.mjs"
+import Task from "../../dummy/src/models/task.mjs"
+
+describe("Record - update", () => {
+  it("updates a record", async () => {
+    await Dummy.run(async () => {
+      const task = new Task({name: "Test task"})
+
+      await task.save()
+      await task.update({name: "Updated name"})
+
+      expect(task.readAttribute("name")).toEqual("Updated name")
+    })
+  })
+})

package/spec/dummy/dummy-directory.mjs

@@ -0,0 +1,11 @@
+import {dirname} from "path"
+import {fileURLToPath} from "url"
+
+const dummyDirectory = () => {
+  const __filename = fileURLToPath(import.meta.url)
+  const __dirname = dirname(__filename)
+
+  return __dirname
+}
+
+export default dummyDirectory

package/spec/dummy/index.mjs

@@ -0,0 +1,63 @@
+import Application from "../../src/application.mjs"
+import dummyConfiguration from "./src/config/configuration.mjs"
+
+export default class Dummy {
+  static current() {
+    if (!global.velociousDummy) {
+      global.velociousDummy = new Dummy()
+    }
+
+    return global.velociousDummy
+  }
+
+  static async prepare() {
+    const db = dummyConfiguration.getDatabasePool()
+
+    await db.withConnection(async () => {
+      await db.query("DROP TABLE IF EXISTS tasks")
+      await db.query("CREATE TABLE tasks (id MEDIUMINT NOT NULL AUTO_INCREMENT, name VARCHAR(255), description TEXT, PRIMARY KEY (id))")
+    })
+  }
+
+  static async run(callback) {
+    await this.current().run(callback)
+  }
+
+  async run(callback) {
+    await dummyConfiguration.getDatabasePool().withConnection(async () => {
+      await this.start()
+
+      try {
+        await Dummy.prepare()
+        await callback()
+      } finally {
+        await this.stop()
+      }
+    })
+  }
+
+  async start() {
+    if (!dummyConfiguration.isDatabasePoolInitialized()) await dummyConfiguration.initializeDatabasePool()
+
+    this.application = new Application({
+      configuration: dummyConfiguration,
+      databases: {
+        default: {
+          host: "mysql",
+          username: "user",
+          password: ""
+        }
+      },
+      httpServer: {port: 3006}
+    })
+
+    await this.application.initialize()
+    await this.application.startHttpServer()
+  }
+
+  async stop() {
+    if (this.application.isActive()) {
+      await this.application.stop()
+    }
+  }
+}

package/spec/dummy/src/config/configuration.example.mjs

@@ -0,0 +1,19 @@
+import Configuration from "../../../../src/configuration.mjs"
+import dummyDirectory from "../../dummy-directory.mjs"
+
+const configuration = new Configuration({
+  database: {
+    default: {
+      master: {
+        type: "mysql",
+        host: "mariadb",
+        username: "username",
+        password: "password",
+        database: "velocious_test"
+      }
+    }
+  },
+  directory: dummyDirectory()
+})
+
+export default configuration

package/spec/dummy/src/config/configuration.peakflow.mjs

@@ -0,0 +1,20 @@
+import Configuration from "../../../../src/configuration.mjs"
+import dummyDirectory from "../../dummy-directory.mjs"
+
+const configuration = new Configuration({
+  database: {
+    default: {
+      master: {
+        type: "mysql",
+        host: "mariadb",
+        username: "peakflow",
+        password: "password",
+        database: "velocious_test",
+        useDatabase: "velocious_test"
+      }
+    }
+  },
+  directory: dummyDirectory()
+})
+
+export default configuration

package/spec/dummy/src/{routes.cjs → config/routes.mjs}

@@ -1,4 +1,5 @@
-const Routes = require("../../../src/routes/index.cjs")
+import Routes from "../../../../src/routes/index.mjs"
+
 const routes = new Routes()
 
 routes.draw((route) => {
@@ -7,4 +8,4 @@ routes.draw((route) => {
   })
 })
 
-module.exports = {routes}
+export default {routes}

package/spec/dummy/src/database/migrations/20230728075328-create-projects.mjs

@@ -0,0 +1,11 @@
+import Migration from "../../../../../src/database/migration/index.mjs"
+
+export default class CreateProjects extends Migration {
+  async change() {
+    await this.createTable("projects", (table) => {
+      table.bigint("id", {autoIncrement: true, primaryKey: true})
+      table.string("name", {maxLength: 100, null: false})
+      table.timestamps()
+    })
+  }
+}

package/spec/dummy/src/database/migrations/20230728075329-create-tasks.mjs

@@ -0,0 +1,13 @@
+import Migration from "../../../../../src/database/migration/index.mjs"
+
+export default class CreateTasks extends Migration {
+  async change() {
+    await this.createTable("tasks", (table) => {
+      table.bigint("id", {autoIncrement: true, primaryKey: true})
+      table.references("project")
+      table.string("name")
+      table.text("description")
+      table.timestamps()
+    })
+  }
+}

package/spec/dummy/src/models/task.mjs

@@ -0,0 +1,4 @@
+import Database from "../../../../src/database/index.mjs"
+
+export default class Task extends Database.Record {
+}

package/spec/dummy/src/routes/tasks/controller.mjs

@@ -0,0 +1,26 @@
+import Controller from "../../../../../src/controller.mjs"
+import {digg} from "diggerize"
+import Task from "../../models/task.mjs"
+
+export default class TasksController extends Controller {
+  index() {
+    this.viewParams.numbers = [1, 2, 3, 4, 5]
+    this.render()
+  }
+
+  async show() {
+    const taskId = digg(params, "id")
+    const task = await Task.find(taskId)
+
+    this.viewParams.task = task
+    this.render()
+  }
+
+  async create() {
+    const task = new Task(this.params().task)
+
+    await task.save()
+
+    this.render({json: {status: "success"}})
+  }
+}

package/spec/http-server/{client-spec.cjs → client-spec.mjs}

@@ -1,17 +1,14 @@
-const Client = require("../../src/http-server/client/index.cjs")
-const Configuration = require("../../src/configuration.cjs")
-const {digg} = require("diggerize")
-const path = require("path")
+import Client from "../../src/http-server/client/index.mjs"
+import {digg} from "diggerize"
+import dummyConfiguration from "../dummy/src/config/configuration.mjs"
 
 describe("http server - client", () => {
-  it("spawns a request for each that it is fed", () => {
-    const dummyDirectory = path.join(__dirname, "../dummy")
-    const configuration = new Configuration({
-      directory: dummyDirectory
-    })
+  it("spawns a request for each that it is fed", async () => {
+    await dummyConfiguration.initialize()
+
     const client = new Client({
       clientCount: 0,
-      configuration
+      configuration: dummyConfiguration
     })
 
     const strings = [

package/spec/http-server/{get-spec.cjs → get-spec.mjs}

@@ -1,5 +1,5 @@
-const fetch = require("node-fetch")
-const Dummy = require("../dummy/index.cjs")
+import fetch from "node-fetch"
+import Dummy from "../dummy/index.mjs"
 
 describe("HttpServer", () => {
   it("handles get requests", async () => {