nodester 0.2.0 → 0.2.1

package/Readme.md

@@ -1,9 +1,12 @@
 # nodester
->  A robust and flexible boilerplate framework that makes iterative development easy.
 
 [![NPM version](https://img.shields.io/npm/v/nodester)](https://www.npmjs.com/package/nodester)
 [![License](https://img.shields.io/npm/l/nodester)](https://www.npmjs.com/package/nodester)
 
+> **nodester** is a modern and versatile Node.js framework designed to streamline the development of robust and scalable web applications.
+
+**nodester Query Language (NQL):** The main reason of nodester's existence is the [nodester Query Language (NQL)](docs/Queries.md), an extension of standard REST API syntax, it lets you craft complex queries with hierarchical associations.
+
 
 ## Installation
 
@@ -18,7 +21,6 @@ npm install -S nodester
 
 - [Usage](#usage)
 - [Documentation](#documentation)
-- [Extending App](#extending-application-functionality)
 - [Philosophy](#philosophy)
 - [License](#license)
 - [Copyright](#copyright)
@@ -47,10 +49,11 @@ app.listen(8080, function() {
 [Core concepts documentation ➡️](docs/CoreConcepts.md)
 
 
-### Queries & Querying - Nodester Query Language (NQR)
-One of the main power points of nodester is it's query language. It's an extension of a REST API syntaxis for a broader integration with a database SQL. Read more about it in the documentation:
+### Queries & Querying - Nodester Query Language (NQL)
+The true strength of nodester lies in its query language. Serving as an extension of standard REST API syntax, it brings many aspects of SQL into REST requests, providing developers with a simple yet potent tool for expressive and efficient data querying.
 
-[NQR documentaion ➡️](docs/Queries.md)
+Read more about it in the documentation:
+[NQL documentaion ➡️](docs/Queries.md)
 
 
 ### Database
@@ -70,7 +73,7 @@ The Philosophy of `nodester` is to provide a developer with a tool that can buil
 
 ### Goal
 
-The goal of `nodester` is to be a robust and flexible framework that makes development in iteratations easy, and further scale possible.
+The goal of `nodester` is to be a robust and flexible framework that makes development in iteratations easy, while laying the foundation for seamless scalability in the future.
 
 
 ## LICENSE

package/lib/application/index.js

@@ -134,6 +134,17 @@ module.exports = class NodesterApplication extends Emitter {
 		return this._router.isLocked;
 	}
 
+	/**
+	 * Indicates whether app is awaiting requests.
+	 *
+	 * @return {Boolean} isListening
+	 *
+	 * @api public
+	 */
+	get isListening() {
+		return this._isListening;
+	}
+
 	// Getters\
 
 	/*

package/lib/middlewares/ql/sequelize/interpreter/QueryLexer.js

@@ -222,6 +222,13 @@ module.exports = class QueryLexer {
 					const model = token;
 					tree.use(model) ?? tree.include(model);
 
+					// Last token (model) was included,
+					// now jump to root and proceed to collect next token (model).
+					tree.node.resetActiveParam();
+					tree.upToRoot();
+
+					tree.node.activeParam = 'includes';
+
 					token = '';
 					continue;
 				}
@@ -403,7 +410,7 @@ module.exports = class QueryLexer {
 					const err = MissingCharError(i+1, ')');
 					throw err;
 				}
-
+				
 				this.setNodeParam(tree.node, token, value);
 
 				// If end of subquery:

package/lib/query/traverse.js

@@ -261,11 +261,12 @@ function traverse(queryNode, filter=null, model=null) {
 
 
 	// Includes:
-	// 	If requested includes are not available:
+	// 	Validate, if requested includes are available:
 	for (let include of includes) {
 		const includeName = include.model;
+
 		if (rootModelAssociations[includeName] === undefined) {
-			const err = new NQueryError(`No include named '${ includeName }'.`);
+			const err = new NQueryError(`No include named '${ includeName }'`);
 			err.status = httpCodes.NOT_ACCEPTABLE;
 			Error.captureStackTrace(err, traverse);
 			throw err;
@@ -300,7 +301,7 @@ function _traverseIncludes(includes, model, filter, resultQuery) {
 
 		// If no such association:
 		if (!association) {
-			const err = new NQueryError(`No include named '${ includeName }'.`);
+			const err = new NQueryError(`No include named '${ includeName }'`);
 			err.status = httpCodes.NOT_ACCEPTABLE;
 			Error.captureStackTrace(err, _traverseIncludes);
 			throw err;

package/lib/structures/Filter.js

@@ -97,7 +97,8 @@ module.exports = class NodesterFilter {
 				}
 
 				// If singular association:
-				if (['HasMany', 'HasOne'].indexOf(association.associationType) === -1) {
+				// Fix of "Only HasMany associations support include.separate"
+				if ('HasMany' !== association.associationType) {
 					// Empty bounds.
 					includeFilter.noBounds = true;
 				}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodester",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "A boilerplate framework for Node.js",
   "exports": {
     ".": "./lib/application/index.js",

package/tests/index.test.js

@@ -27,13 +27,13 @@ describe('nodester application', () => {
 	test('Application start', () => {
 		app.listen(PORT, function() {
 			expect(app.port).toBe(PORT);
-			expect(app.router._middlewares.isLocked).toBe(true);
-			expect(app.router._middlewares.length).toBe(2);
+			expect(app.isLocked).toBe(true);
+			expect(app.isListening).toBe(true);
+			expect(app.middlewaresStack.length).toBe(4);
 
 			app.stop();
 
-			expect(app.router._middlewares.length).toBe(0);
-			expect(app.router._middlewares.isLocked).toBe(false);
+			expect(app.isLocked).toBe(false);
 			expect(app.isListening).toBe(false);
 		});
 	});

package/tests/nql.test.js

@@ -49,6 +49,9 @@ describe('nodester Query Language', () => {
 
 		// Like simple.
 		'title=like(some_text)',
+
+		// Subinclude and isolated Horizontal.
+		'in=comments.user,likes',
 	];
 
 	it('query "Simple where"', () => {
@@ -262,7 +265,6 @@ describe('nodester Query Language', () => {
 
 		expect(result).toMatchObject(expected);
 	});
-	
 
 	test('Token "Like" simple', () => {
 		const lexer = new QueryLexer( queryStrings[14] );
@@ -274,4 +276,19 @@ describe('nodester Query Language', () => {
 
 		expect(result).toMatchObject(expected);
 	});
+
+	it('query "Subinclude and isolated Horizontal"', () => {
+		const lexer = new QueryLexer( queryStrings[15] );
+		result = lexer.query;
+
+		const tree = new ModelsTree();
+		tree.include('comments').use('comments');
+		tree.include('user');
+		tree.up();
+		tree.include('likes');
+		const expected = tree.root.toObject();
+
+		expect(result).toMatchObject(expected);
+	});
+
 });