alchemymvc 1.3.4 → 1.3.5

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2018 Jelle De Loecker <jelle@develry.be>
+Copyright (c) 2013-2023 Jelle De Loecker <jelle@elevenways.be>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/README.md

@@ -1,5 +1,5 @@
 <h1 align="center">
-  <img src="https://protoblast.develry.be/media/static/alchemy-small.png" width=30 alt="Alchemy logo"/>
+  <img src="https://protoblast.elevenways.be/media/static/alchemy-small.png" width=30 alt="Alchemy logo"/>
   <b>Alchemy</b>
 </h1>
 <div align="center">
@@ -8,24 +8,14 @@
     <img src="https://travis-ci.org/11ways/alchemy.svg?branch=master" alt="Mac/Linux Build Status" />
   </a>
 
-  <!-- CI - AppVeyor -->
-  <a href="https://ci.appveyor.com/project/skerit/alchemy">
-    <img src="https://img.shields.io/appveyor/ci/skerit/alchemy/master.svg?label=Windows" alt="Windows Build status" />
-  </a>
-
   <!-- Coverage - Codecov -->
   <a href="https://codecov.io/gh/11ways/alchemy">
     <img src="https://img.shields.io/codecov/c/github/11ways/alchemy/master.svg" alt="Codecov Coverage report" />
   </a>
 
   <!-- DM - Snyk -->
-  <a href="https://snyk.io/test/github/skerit/alchemy?targetFile=package.json">
-    <img src="https://snyk.io/test/github/skerit/alchemy/badge.svg?targetFile=package.json" alt="Known Vulnerabilities" />
-  </a>
-
-  <!-- DM - David -->
-  <a href="https://david-dm.org/skerit/alchemy">
-    <img src="https://david-dm.org/skerit/alchemy/status.svg" alt="Dependency Status" />
+  <a href="https://snyk.io/test/github/11ways/alchemy?targetFile=package.json">
+    <img src="https://snyk.io/test/github/11ways/alchemy/badge.svg?targetFile=package.json" alt="Known Vulnerabilities" />
   </a>
 </div>
 
@@ -69,55 +59,8 @@ Just installing the npm package can be done like this:
 
 # Quick start guide
 
-Alchemy makes heavy use of the **Protoblast** utility library, which extends the native objects with many new methods.
-Especially the `Function.inherits()` method is interesting, as that is the basis for the Alchemy class system.
-You can find extensive documentation on the library here: [https://protoblast.develry.be](https://protoblast.develry.be)
-
-## File structure
-
-All of your project code should go into an `app` directory.
-That directory can contain many subdirectories. Most of those files are auto-required on boot.
-
-The directories (and some of their basic files) are:
-
-* **assets**:
-  * **images**: Static images
-  * **scripts**: Client-side only javascript files. Accessible through `/scripts/` url.
-  * **stylesheets**: SCSS and LESS stylesheet files. Accessible through `/stylesheets/` url.
-* **config**:
-  * **bootstrap.js**: Place where all plugins should be loaded
-  * **default.js**: Default configuration
-  * **local.js**: Configuration file that overrides all others. Is required for the `environment` definition. Should not be checked into git.
-  * **prefixes.js**: Place to define which prefixes (locales/languages) are used on the site
-  * **routes.js**: Routes should be defined here
-* **controller**:
-  * **app_controller.js**: Basic controller instance your other controllers should inherit from
-* **element**:
-  * **app_element.js**: Basic custom element your other custom elements should inherit from.
-* **helper**:
-  * **app_helper.js**: Basic helper your other helpers should inherit from.
-* **lib**:
-  * Put classes here that are only needed on the server.
-* **model**:
-  * **app_model.js**: Basic model your other models should inherit from.
-* **public**:
-  * Files put in here will be publicly available under the `/public/` url.
-* **root**:
-  * Files put in here will be publicly available under the root url (So `/`)
-* **view**:
-  * Template files go in here, preferably with a `.hwk` extension, though regular `.ejs` files also work.
-
-## Code convention
-
-### Naming:
-
-* Class names are written using upper camel case: **MyClassName**
-* Method names are written using lower camel case: **myMethodName**
-* Property names and variables are written using snake case: **my_property_name**
-
-### Whitespaces
-
-* Tabs are used for indentations, spaces are used for positioning.
+You can find all the documentation on [https://alchemy.elevenways.be](https://alchemy.elevenways.be)
+
 
 ## Base class
 

package/lib/app/assets/stylesheets/alchemy-info.less

@@ -25,6 +25,8 @@ body {
 .row {
 	display: flex;
 	margin-bottom: 2rem;
+	flex-flow: wrap;
+	gap: 2rem;
 }
 
 .col {
@@ -32,10 +34,6 @@ body {
 	background: #E8F3F8;
 }
 
-.col:not(:last-child) {
-	margin-right: 2rem;
-}
-
 .header-image {
 	box-shadow: #000 1px 1px 3px;
 	background: #0B486B;
@@ -56,6 +54,17 @@ body {
 	}
 }
 
+tr:nth-child(even) {
+	td {
+		background-color: rgba(100, 100, 100, 0.1);
+	}
+}
+
+td {
+	vertical-align: top;
+	padding: 1rem 0.2rem;
+}
+
 .package-description {
 	max-width: 350px;
 }
@@ -72,6 +81,10 @@ body {
 			margin-top: 0;
 		}
 	}
+
+	@media screen and (max-width: 1500px)  {
+		padding: 2rem 1rem;
+	}
 }
 
 .engine {
@@ -129,13 +142,18 @@ li.failed::before {
 }
 
 .settings {
-	max-width: 50%;
 
 	th {
 		text-align: left;
 		border-bottom: 1px solid black;
 	}
 
+	table {
+		width: 100%;
+	}
+}
+
+.table-wrap {
 	table {
 		width: 100%;
 	}

package/lib/app/controller/alchemy_info_controller.js

@@ -17,7 +17,7 @@ var Info = Function.inherits('Alchemy.Controller.App', function AlchemyInfo(cond
  *
  * @author   Jelle De Loecker       <jelle@elevenways.be>
  * @since    0.2.0
- * @version  0.2.0
+ * @version  1.3.5
  */
 Info.setMethod(function setInfoVariables() {
 
@@ -30,7 +30,7 @@ Info.setMethod(function setInfoVariables() {
 	Object.each(Datasource.get(), function eachDatasource(datasource, key) {
 		data_sources[key] = {
 			type: datasource.constructor.name,
-			error: datasource.connectionError
+			error: datasource.connection_error
 		};
 	});
 

package/lib/app/helper/socket_helper.js

@@ -311,16 +311,16 @@ Client.setMethod(function createStream() {
 /**
  * Make the actual connection
  *
- * @author    Jelle De Loecker   <jelle@develry.be>
+ * @author    Jelle De Loecker   <jelle@elevenways.be>
  * @since     0.2.0
- * @version   1.0.5
+ * @version   1.3.5
  *
  * @param    {Function} callback
  */
 Client.setMethod(function connect(address, data, callback) {
 
-	var that = this,
-	    ioServer,
+	let that = this,
+	    io_client,
 	    serverstream,
 	    config = {},
 	    server;
@@ -339,9 +339,9 @@ Client.setMethod(function connect(address, data, callback) {
 	}
 
 	if (typeof io != 'undefined') {
-		ioServer = io;
+		io_client = io;
 	} else if (typeof alchemy != 'undefined') {
-		ioServer = alchemy.use('socket.io-client');
+		io_client = alchemy.use('socket.io-client');
 	} else {
 		return callback(new Error('Could not find socket.io client library'));
 	}
@@ -362,11 +362,19 @@ Client.setMethod(function connect(address, data, callback) {
 		config.reconnection = false;
 	}
 
+	if (Blast.isNode) {
+		let msgpack_parser = alchemy.use('socket.io-msgpack-parser');
+
+		if (msgpack_parser) {
+			config.parser = msgpack_parser;
+		}
+	}
+
 	// Create the connection to the server
 	if (address) {
-		server = ioServer.connect(address, config);
+		server = io_client(address, config);
 	} else {
-		server = ioServer.connect(config);
+		server = io_client(config);
 	}
 
 	if (Blast.isNode) {

package/lib/app/view/alchemy/info.hwk

@@ -5,6 +5,8 @@
 		<% set_title('Alchemy Info Page') %>
 		<% this.foundation({protoblast: true}) %>
 		<% style('alchemy-info') %>
+		<meta charset="UTF-8">
+		<meta name="viewport" content="width=device-width, initial-scale=1.0">
 	</head>
 	<body>
 
@@ -64,11 +66,25 @@
 				<div class="row">
 					<article class="plugins col">
 						<h1>Plugins</h1>
-						<ul>
-							{% each plugins as plugin %}
+						{% with plugins as plugin %}
+
+							{% none %}
+								<p class="none">No plugins are loaded</p>
+							{% /none %}
+
+							{% all %}
+								<ul>
+							{% /all %}
+
+							{% each %}
 								<li>{{ plugin }}</li>
 							{% /each %}
-						</ul>
+
+							{% all %}
+								</ul>
+							{% /all %}
+
+						{% /with %}
 					</article>
 
 					<article class="settings col">

package/lib/core/socket.js

@@ -1,7 +1,8 @@
 'use strict';
 
-var types     = alchemy.shared('Socket.types'),
+let msgpack_parser,
     iostream,
+    types     = alchemy.shared('Socket.types'),
     path      = alchemy.use('path'),
     fs        = alchemy.use('fs');
 
@@ -10,16 +11,12 @@ var types     = alchemy.shared('Socket.types'),
  * 
  * Create the socket.io listener
  *
- * @author        Jelle De Loecker   <jelle@develry.be>
+ * @author        Jelle De Loecker   <jelle@elevenways.be>
  * @since         0.1.0
- * @version       1.1.3
+ * @version       1.3.5
  */
 alchemy.sputnik.add(function socket() {
 
-	var clientPath,
-	    streamPath,
-	    io;
-
 	if (!alchemy.settings.websockets) {
 		log.info('Websockets have been disabled');
 		return;
@@ -31,36 +28,50 @@ alchemy.sputnik.add(function socket() {
 		}
 	}
 
-	io = alchemy.use('socket.io');
+	const socket_io = alchemy.use('socket.io');
 
-	if (!io) {
+	if (!socket_io) {
 		return log.error('Could not load socket.io!');
 	}
 
 	iostream = alchemy.use('socket.io-stream');
+	msgpack_parser = alchemy.use('socket.io-msgpack-parser');
+
+	let socket_io_options = {
+		serveClient : false,
+	};
+
+	if (msgpack_parser) {
+		socket_io_options.parser = msgpack_parser;
+	}
 
 	// Create the Socket.io listener
-	alchemy.io = io.listen(alchemy.server, {serveClient: false});
+	alchemy.io = socket_io(alchemy.server, socket_io_options);
 
 	// Get the core client path
-	clientPath = path.dirname(alchemy.findModule('socket.io-client').module_path);
-	clientPath = path.resolve(clientPath, '..', 'dist', 'socket.io.slim.js');
+	let client_path = alchemy.findModule('socket.io-client').module_dir;
+
+	if (msgpack_parser) {
+		client_path = path.join(client_path, 'dist', 'socket.io.msgpack.min.js');
+	} else {
+		client_path = path.join(client_path, 'dist', 'socket.io.min.js');
+	}
 
 	// Get the stream client path
-	streamPath = path.dirname(alchemy.findModule('@11ways/socket.io-stream').module_path);
-	streamPath = path.resolve(streamPath, 'socket.io-stream.js');
+	let stream_path = path.dirname(alchemy.findModule('@11ways/socket.io-stream').module_path);
+	stream_path = path.resolve(stream_path, 'socket.io-stream.js');
 
 	// Serve the socket io core file
 	Router.use('/scripts/socket.io.js', function getSocketIo(req, res, next) {
-		alchemy.minifyScript(clientPath, function gotMinifiedPath(err, mpath) {
-			req.conduit.serveFile(mpath || clientPath);
+		alchemy.minifyScript(client_path, function gotMinifiedPath(err, mpath) {
+			req.conduit.serveFile(mpath || client_path);
 		});
 	});
 
 	// Serve the socket io stream file
 	Router.use('/scripts/socket.io-stream.js', function getSocketStream(req, res, next) {
-		alchemy.minifyScript(streamPath, function gotMinifiedPath(err, mpath) {
-			req.conduit.serveFile(mpath || streamPath);
+		alchemy.minifyScript(stream_path, function gotMinifiedPath(err, mpath) {
+			req.conduit.serveFile(mpath || stream_path);
 		});
 	});
 

package/lib/stages.js

@@ -381,7 +381,7 @@ alchemy.sputnik.add(function routes() {
  *
  * @author        Jelle De Loecker   <jelle@develry.be>
  * @since         0.0.1
- * @version       1.1.2
+ * @version       1.3.5
  */
 alchemy.sputnik.add(function start_server() {
 
@@ -429,7 +429,8 @@ alchemy.sputnik.add(function start_server() {
 	// The actual `requests` listener is defined in the 'http' stage
 	alchemy.server.listen(listen_target, function areListening(){
 
-		var address = alchemy.server.address();
+		let address = alchemy.server.address();
+		let url = alchemy.settings.url;
 
 		if (typeof address == 'string') {
 			settings.socket = address;
@@ -439,19 +440,19 @@ alchemy.sputnik.add(function start_server() {
 			if (settings.socketfile_chmod) {
 				fs.chmodSync(address, settings.socketfile_chmod);
 			}
-
 		} else {
 			// Get the actual server port
 			settings.port = address.port;
 			log.info('HTTP server listening on port', settings.port);
-		}
-
-		if (alchemy.settings.url) {
-			let url = alchemy.settings.url;
 
-			url = alchemy.colors.bg.getRgb(1, 0, 1) + alchemy.colors.fg.getRgb(5, 3, 0) + ' ' + url + ' ' + alchemy.colors.reset;
+			if (!url) {
+				url = 'http://localhost:' + address.port;
+			}
+		}
 
-			log.info('Served at »»', url, '««');
+		if (url) {
+			let pretty_url = alchemy.colors.bg.getRgb(1, 0, 1) + alchemy.colors.fg.getRgb(5, 3, 0) + ' ' + url + ' ' + alchemy.colors.reset;
+			log.info('Served at »»', pretty_url, '««');
 		}
 
 		// If this process is a child, tell the parent we're ready

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "alchemymvc",
 	"description": "MVC framework for Node.js",
-	"version": "1.3.4",
+	"version": "1.3.5",
 	"author": "Jelle De Loecker <jelle@elevenways.be>",
 	"keywords": [
 		"alchemy",
@@ -20,7 +20,7 @@
 		"body-parser"      : "~1.19.2",
 		"bson"             : "~4.6.1",
 		"chokidar"         : "~3.5.3",
-		"formidable"       : "~2.0.1",
+		"formidable"       : "~2.1.1",
 		"graceful-fs"      : "~4.2.9",
 		"hawkejs"          : "~2.3.4",
 		"jsondiffpatch"    : "~0.4.1",
@@ -33,10 +33,10 @@
 		"postcss"          : "~8.4.6",
 		"protoblast"       : "~0.8.3",
 		"semver"           : "~7.3.5",
-		"socket.io"        : "~2.4.0",
+		"socket.io"        : "~4.6.0",
 		"@11ways/socket.io-stream" : "~0.9.2",
 		"sputnik"          : "~0.1.0",
-		"terser"           : "~5.10.0",
+		"terser"           : "~5.16.3",
 		"toobusy-js"       : "~0.5.1",
 		"useragent"        : "~2.3.0"
 	},
@@ -50,12 +50,13 @@
 		"sass"             : "~1.53.0",
 		"sass-embedded"    : "~1.53.0",
 		"nodent-compiler"  : "~3.2.13",
-		"socket.io-client" : "~2.4.0"
+		"socket.io-client" : "~4.6.0",
+		"socket.io-msgpack-parser": "~3.0.2"
 	},
 	"devDependencies": {
 		"codecov"                 : "~3.8.1",
 		"istanbul-lib-instrument" : "~4.0.3",
-		"mocha"                   : "~8.3.2",
+		"mocha"                   : "~10.2.0",
 		"mongo-unit"              : "~3.2.0",
 		"nyc"                     : "^15.1.0",
 		"puppeteer"               : "~19.0.0",