fable 3.0.18 → 3.0.21

package/gulpfile-config.json

@@ -0,0 +1,11 @@
+{
+	"EntrypointInputSourceFile": "./source/Fable-Browser-Shim.js",
+
+	"LibraryObjectName": "Fable",
+
+	"LibraryOutputFolder": "./dist/",
+
+	"LibraryUniminifiedFileName": "fable.compatible.js",
+
+	"LibraryMinifiedFileName": "fable.compatible.min.js"
+}

package/gulpfile-config_compatible.json

@@ -0,0 +1,11 @@
+{
+	"EntrypointInputSourceFile": "./source/Fable-Browser-Shim.js",
+
+	"LibraryObjectName": "Fable",
+
+	"LibraryOutputFolder": "./dist/",
+
+	"LibraryUniminifiedFileName": "fable.compatible.js",
+
+	"LibraryMinifiedFileName": "fable.compatible.min.js"
+}

package/gulpfile-config_default.json

@@ -0,0 +1,11 @@
+{
+	"EntrypointInputSourceFile": "./source/Fable-Browser-Shim.js",
+
+	"LibraryObjectName": "Fable",
+
+	"LibraryOutputFolder": "./dist/",
+
+	"LibraryUniminifiedFileName": "fable.js",
+
+	"LibraryMinifiedFileName": "fable.min.js"
+}

package/gulpfile.js

@@ -1,27 +1,108 @@
 'use strict';
 
-// We aren't abstracting this yet but here's the ... "Config"
-const _CONFIG = (
-	{
-		// The input source file that should be passed to browserify:
-		// (if you need to auto-instantiate an object, for instance)
-		EntrypointInputSourceFile: `${__dirname}/source/Fable-Browser-Shim.js`,
+/*
+  After hours of reading and trying various ways of using gulp-env, environment variables
+  and babel browesrslistrc / package.json environments it is clear that the state of using
+  these tools is a mess.  There are ways of getting it to work but none of them feel like
+  they will work well in the long term (all of the examples seem to be in bands of about
+  a year or two of working before the pattern changes entirely).
 
-		// The name of the packaged object to be passed to browserify:
-		// (browserify sets this to global scope and window.SOMEOBJECTNAMEHERE where SOMEOBJECTNAMEHERE is the string below)
-		LibraryObjectName: `Fable`,
+  WHY did we need such a crazy compatible version?  wkhtmltopdf is why.  It uses a very
+  old incompatible version of the QT browser.
 
-		// The folder to write the library files and maps out to:
-		LibraryOutputFolder: `${__dirname}/dist/`,
+  Therefore, we will use a very old and simple method.
 
-		// The name of the unminified version of the packaged library, for easy debugging:
-		LibraryUniminifiedFileName: `fable.js`,
+	1) There is a config file (gulpfile-config.json), documented here, describing the inputs and outputs for the build operation.
 
-		// The name of the minified version of the packaged library, for production release:
-		LibraryMinifiedFileName: `fable.min.js`
-	});
+		const _CONFIG = (
+			{
+				// The input source file that should be passed to browserify:
+				// (if you need to auto-instantiate an object, for instance)
+				EntrypointInputSourceFile: `${__dirname}/source/Fable-Browser-Shim.js`,
+
+				// The name of the packaged object to be passed to browserify:
+				// (browserify sets this to global scope and window.SOMEOBJECTNAMEHERE where SOMEOBJECTNAMEHERE is the string below)
+				LibraryObjectName: `Fable`,
+
+				// The folder to write the library files and maps out to:
+				LibraryOutputFolder: `${__dirname}/dist/`,
+
+				// The name of the unminified version of the packaged library, for easy debugging:
+				LibraryUniminifiedFileName: `fable.js`,
+
+				// The name of the minified version of the packaged library, for production release:
+				LibraryMinifiedFileName: `fable.min.js`
+			});
+
+	2) We are using a .browserslistrc file... this is what tells gulp-babel, through the
+	   magic of the @babel/preset-env library, how to transpile the library into a compatible
+	   enough format for our targets.
+
+	   For example as of writing this, there are two targets we want:
+
+			*	Modern browsers in the last five years, expressed as a .browserslistrc with the string "since 2018"
+			*	Very old janky browsers expressed as a .browserslistrc with the string "> 0.01%"
+				... which is interpreted as anything more than 0.01% of browsers in existence or something like that
+
+	3) Because we want multiple outputs, and, the tools do fine if we want one output but some of
+	   the toolchain doesn't like making different targets well, we're just going to have multiple
+	   configurations and .browserslistrc files.  So if our spec above says we need a ".browserslistrc"
+	   file and a "gulpfile-config.json", we're going to make the following two sets of configuration:
+
+			*	.browserslistrc_default, .gulpfile-config_default.json
+			*	.browserslistrc_compatible, .gulpfile-config_compatible.json
+
+	4) We will copy, synchronously, these files to where the rest of our toolchain expects
+	   them, before we begin the build.  This will be done by looking at the GULP_CUSTOM_BUILD_TARGET
+	   environment variable.  This allows us to create new targets to experiment by copying a couple files,
+	   jimmying the settings and setting an environment variable before running the pipeline.
+
+	5) We will run the toolchain and it will happily think it's just doing a single build and kinda work.
+
+ */
+// BEGINNING OF STEP 3 and STEP 4 ABOVE
+const libFS = require('fs');
+const _GULP_CUSTOM_BUILD_TARGET = (typeof(process.env.GULP_CUSTOM_BUILD_TARGET) == 'undefined') ? 'default' : process.env.GULP_CUSTOM_BUILD_TARGET;
+console.log(`--> Gulp custom build target set to: [${_GULP_CUSTOM_BUILD_TARGET}]`);
+const _GULP_CONFIG = `./gulpfile-config_${_GULP_CUSTOM_BUILD_TARGET}.json`;
+const _GULP_CONFIG_TARGET = `./gulpfile-config.json`;
+console.log(`   : Environment set gulp config [${_GULP_CONFIG}] will be copied to [${_GULP_CONFIG_TARGET}]`);
+if (!libFS.existsSync(`./${_GULP_CONFIG}`))
+{
+	console.log(`!!!> Enviromnent set gulp config doesn't exist!`);
+	process.exit(1);
+}
+else
+{
+	libFS.copyFileSync(_GULP_CONFIG, _GULP_CONFIG_TARGET);
+	console.log(`   > Environment Gulp Config copied`);
+}
+const _BROWSERSLISTRC = `./.browserslistrc_${_GULP_CUSTOM_BUILD_TARGET}`;
+const _BROWSERSLISTRC_TARGET = `./.browserslistrc`;
+console.log(`   : Environment set browserslistrc [${_BROWSERSLISTRC}] will be copied to [${_BROWSERSLISTRC_TARGET}]`);
+if (!libFS.existsSync(`./${_GULP_CONFIG}`))
+{
+	console.log(`!!!> Enviromnent set browserslistrc doesn't exist!`);
+	process.exit(1);
+}
+else
+{
+	libFS.copyFileSync(_BROWSERSLISTRC, _BROWSERSLISTRC_TARGET);
+	console.log(`   > Environment Gulp Config copied`);
+}
+console.log(`---> The browserslistrc compatibility set is: ${libFS.readFileSync(_BROWSERSLISTRC_TARGET, 'utf8')}`);
+// END OF STEP 3 and STEP 4 ABOVE
+
+
+// ---> Now load the config and get on with building <--- \\
+console.log(``);
+console.log(`---> Loading the gulp config...`);
+const _CONFIG = require('./gulpfile-config.json');
+console.log(`   > Building to [${_CONFIG.LibraryUniminifiedFileName}] and [${_CONFIG.LibraryMinifiedFileName}]`)
 
 // --->  Boilerplate Browser Uglification and Packaging  <--- \\
+console.log(``);
+console.log(`--> Gulp is taking over!`);
 
 const libBrowserify = require('browserify');
 const libGulp = require('gulp');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fable",
-  "version": "3.0.18",
+  "version": "3.0.21",
   "description": "An entity behavior management and API bundling library.",
   "main": "source/Fable.js",
   "scripts": {
@@ -8,6 +8,7 @@
     "coverage": "./node_modules/.bin/nyc --reporter=lcov --reporter=text-lcov ./node_modules/mocha/bin/_mocha -- -u tdd -R spec",
     "test": "./node_modules/.bin/mocha -u tdd -R spec",
     "build": "./node_modules/.bin/gulp build",
+    "build-compatible": "GULP_CUSTOM_BUILD_TARGET=compatible ./node_modules/.bin/gulp build",
     "docker-dev-build-image": "docker build ./ -f Dockerfile_LUXURYCode -t retold/fable:local",
     "docker-dev-run": "docker run -it -d --name retold-fable-dev -p 30001:8080 -v \"$PWD/.config:/home/coder/.config\"  -v \"$PWD:/home/coder/fable\" -u \"$(id -u):$(id -g)\" -e \"DOCKER_USER=$USER\" retold/fable:local"
   },
@@ -44,10 +45,13 @@
   },
   "homepage": "https://github.com/stevenvelozo/fable",
   "devDependencies": {
+    "@babel/core": "^7.21.5",
+    "@babel/preset-env": "^7.21.5",
     "browserify": "^17.0.0",
     "chai": "4.3.7",
     "gulp": "^4.0.2",
     "gulp-babel": "^8.0.0",
+    "gulp-env": "^0.4.0",
     "gulp-sourcemaps": "^3.0.0",
     "gulp-terser": "^2.1.0",
     "gulp-util": "^3.0.8",
@@ -59,6 +63,7 @@
   "dependencies": {
     "async.eachlimit": "^0.5.2",
     "async.waterfall": "^0.5.2",
+    "data-arithmatic": "^1.0.3",
     "fable-log": "^3.0.6",
     "fable-settings": "^3.0.3",
     "fable-uuid": "^3.0.2"

package/source/Fable-Service-DataArithmatic.js

@@ -0,0 +1,16 @@
+const libFableServiceBase = require('./Fable-ServiceProviderBase.js');
+const libDataArithmatic = require('data-arithmatic');
+
+class FableServiceDataArithmatic extends libFableServiceBase
+{
+	constructor(pFable, pOptions, pServiceHash)
+	{
+        super(pFable, pOptions, pServiceHash);
+
+        this.serviceType = 'DataArithmatic';
+
+        this._DataArithmaticLibrary = new libDataArithmatic();
+	}
+}
+
+module.exports = FableServiceDataArithmatic;

package/source/{Fable-Utility.js → Fable-Service-Utility.js}

@@ -1,12 +1,24 @@
+const libFableServiceBase = require('./Fable-ServiceProviderBase.js');
+
+
 // TODO: These are still pretty big -- consider the smaller polyfills
 const libAsyncWaterfall = require('async.waterfall');
 const libAsyncEachLimit = require('async.eachlimit');
 
-class FableUtility
+class FableServiceUtility extends libFableServiceBase
 {
-	constructor(pFable)
+	// Underscore and lodash have a behavior, _.template, which compiles a
+	// string-based template with code snippets into simple executable pieces,
+	// with the added twist of returning a precompiled function ready to go.
+	//
+	// NOTE: This does not implement underscore escape expressions
+	// NOTE: This does not implement underscore magic browser variable assignment
+	//
+	// This is an implementation of that.
+	// TODO: Make this use precedent, add configuration, add debugging.
+	constructor(pFable, pOptions, pServiceHash)
 	{
-		this.fable = pFable;
+        super(pFable, pOptions, pServiceHash);
 
 		this.templates = {};
 
@@ -68,4 +80,4 @@ class FableUtility
 	}
 }
 
-module.exports = FableUtility;
+module.exports = FableServiceUtility;

package/source/Fable.js

@@ -7,10 +7,11 @@ const libFableSettings = require('fable-settings');
 const libFableUUID = require('fable-uuid');
 const libFableLog = require('fable-log');
 
-const libFableUtility = require('./Fable-Utility.js');
 const libFableServiceManager = require('./Fable-ServiceManager.js');
 
+const libFableServiceDataArithmatic = require('./Fable-Service-DataArithmatic.js');
 const libFableServiceTemplate = require('./Fable-Service-Template.js');
+const libFableServiceUtility = require('./Fable-Service-Utility.js');
 
 const libFableOperation = require('./Fable-Operation.js');
 
@@ -28,9 +29,6 @@ class Fable
 		this.log = new libFableLog(this.settingsManager.settings);
 		this.log.initialize();
 
-		// Built-in utility belt functions
-		this.Utility = new libFableUtility(this);
-
 		// Built-in dependencies
 		this.Dependencies = (
 			{
@@ -42,8 +40,20 @@ class Fable
 
 		this.serviceManager = new libFableServiceManager(this);
 
+		// Initialize and instantiate the default baked-in Data Arithmatic service
+		this.serviceManager.addServiceType('DataArithmatic', libFableServiceDataArithmatic);
+		this.fable.serviceManager.instantiateServiceProvider('DataArithmatic', {}, 'Default-Service-DataArithmatic');
+		// This service is passing through the data arithmatic library
+		this.DataArithmatic = this.serviceManager.defaultServices.DataArithmatic._DataArithmaticLibrary;
+
+		// Initialize the template service
 		this.serviceManager.addServiceType('Template', libFableServiceTemplate);
 
+		// Initialize and instantiate the default baked-in Utility service
+		this.serviceManager.addServiceType('Utility', libFableServiceUtility)
+		this.fable.serviceManager.instantiateServiceProvider('Utility', {}, 'Default-Service-Utility');
+		this.Utility = this.serviceManager.defaultServices.Utility;
+
 		this.services = this.serviceManager.services;
 		this.defaultServices = this.serviceManager.defaultServices;
 	}

package/test/FableDataArithmatic_tests.js

@@ -0,0 +1,223 @@
+/**
+* Unit tests for Fable's DataArithmatic service
+*
+* @license     MIT
+*
+* @author      Steven Velozo <steven@velozo.com>
+*/
+
+var libFable = require('../source/Fable.js');
+
+var Chai = require("chai");
+var Expect = Chai.expect;
+
+suite
+(
+	'DataArithmatic String',
+	function()
+	{
+		setup (()=> {} );
+
+		suite
+		(
+			'Manipulate Strings',
+			()=>
+			{
+				test
+				(
+					'Reverse a String',
+					(fTestComplete)=>
+					{
+						let testFable = new libFable({LogStreams: false});
+						let _DataArithmatic = testFable.DataArithmatic;
+						Expect(_DataArithmatic
+							.stringReverse('Dogs'))
+							.to.equal('sgoD');
+						Expect(_DataArithmatic
+							.stringReverse('Florence and the Machine'))
+							.to.equal('enihcaM eht dna ecnerolF');
+						return fTestComplete();
+					}
+				)
+				test
+				(
+					'Insecure String Hash',
+					(fTestComplete)=>
+					{
+						let testFable = new libFable({LogStreams: false});
+						let _DataArithmatic = testFable.DataArithmatic;
+						Expect(_DataArithmatic
+							.insecureStringHash('Dogs'))
+							.to.equal('HSH2135767');
+						Expect(_DataArithmatic
+							.insecureStringHash('Dogs1'))
+							.to.equal('HSH66208826');
+						Expect(_DataArithmatic
+							.insecureStringHash('This string is longer'))
+							.to.equal('HSH53260210');
+						// This repeat is intentional, to ensure stable hash generation after multiple runs.
+						Expect(_DataArithmatic
+							.insecureStringHash('Dogs'))
+							.to.equal('HSH2135767');
+						return fTestComplete();
+					}
+				)
+				test
+				(
+					'Clean wrapping characters from a valid enclosure.',
+					(fTestComplete)=>
+					{
+						let testFable = new libFable({LogStreams: false});
+						let _DataArithmatic = testFable.DataArithmatic;
+						// Test the enclosure cleaning function
+						Expect(_DataArithmatic
+							.cleanEnclosureWrapCharacters('`', '`Dogs`'))
+							.to.equal('Dogs');
+						// Tests a cleaning where the enclosure is not wrapped with the expected character
+						Expect(_DataArithmatic
+							.cleanEnclosureWrapCharacters('"', '`Cats`'))
+							.to.equal('`Cats`');
+						// Tests a cleaning where the enclosure is not wrapped with the expected character
+						Expect(_DataArithmatic
+							.cleanEnclosureWrapCharacters('"', '"Dogs"'))
+							.to.equal('Dogs');
+						// Test cleaning an enclosure with multiple enclosures of the same type which are expected to stay intact
+						Expect(_DataArithmatic
+							.cleanEnclosureWrapCharacters('[', '[Array[with]weird other] Dogs in it['))
+							.to.equal('Array[with]weird other] Dogs in it');
+						// Test cleaning a string where the enclosure character is on one side but not the other
+						Expect(_DataArithmatic
+							.cleanEnclosureWrapCharacters('"', '"Dogs'))
+							.to.equal('"Dogs');
+						// Test cleaning a string where the enclosure character is on one side but not the other
+						Expect(_DataArithmatic
+							.cleanEnclosureWrapCharacters('"', 'Dogs"'))
+							.to.equal('Dogs"');
+						return fTestComplete();
+					}
+				);
+				test
+				(
+					'Test if a string starts with a given substring - Javascript Engine startsWith',
+					(fTestComplete)=>
+					{
+						let testFable = new libFable({LogStreams: false});
+						let _DataArithmatic = testFable.DataArithmatic;
+						Expect(_DataArithmatic
+							.stringStartsWith('Dogs', 'Do'))
+							.to.equal(true);
+						Expect(_DataArithmatic
+							.stringStartsWith('Bats', 'Bats'))
+							.to.equal(true);
+						Expect(_DataArithmatic
+							.stringStartsWith('Dogs', 'Dogs are cool'))
+							.to.equal(false);
+						Expect(_DataArithmatic
+							.stringStartsWith('Dogs', 'Cats'))
+							.to.equal(false);
+						return fTestComplete();
+					}
+				);
+				test
+				(
+					'Test if a string starts with a given substring - Internal startsWith',
+					(fTestComplete)=>
+					{
+						let testFable = new libFable({LogStreams: false});
+						let _DataArithmatic = testFable.DataArithmatic;
+						_DataArithmatic._UseEngineStringStartsWith = false;
+						Expect(_DataArithmatic
+							.stringStartsWith('Dogs', 'Do'))
+							.to.equal(true);
+						Expect(_DataArithmatic
+							.stringStartsWith('Bats', 'Bats'))
+							.to.equal(true);
+						Expect(_DataArithmatic
+							.stringStartsWith('Dogs', 'Dogs are cool'))
+							.to.equal(false);
+						Expect(_DataArithmatic
+							.stringStartsWith('Dogs', 'Cats'))
+							.to.equal(false);
+						return fTestComplete();
+					}
+				);
+				test
+				(
+					'Test if a string ends with a given substring - Javascript Engine endsWith',
+					(fTestComplete)=>
+					{
+						let testFable = new libFable({LogStreams: false});
+						let _DataArithmatic = testFable.DataArithmatic;
+						Expect(_DataArithmatic
+							.stringEndsWith('Dogs', 'gs'))
+							.to.equal(true);
+						Expect(_DataArithmatic
+							.stringEndsWith('Bats', 'Bats'))
+							.to.equal(true);
+						Expect(_DataArithmatic
+							.stringEndsWith('Dogs', 'Dogs are cool'))
+							.to.equal(false);
+						Expect(_DataArithmatic
+							.stringEndsWith('Dogs', 'Cats'))
+							.to.equal(false);
+						return fTestComplete();
+					}
+				);
+				test
+				(
+					'Test if a string ends with a given substring - Internal endsWith',
+					(fTestComplete)=>
+					{
+						let testFable = new libFable({LogStreams: false});
+						let _DataArithmatic = testFable.DataArithmatic;
+						_DataArithmatic._UseEngineStringEndsWith = false;
+						Expect(_DataArithmatic
+							.stringEndsWith('Dogs', 'gs'))
+							.to.equal(true);
+						Expect(_DataArithmatic
+							.stringEndsWith('Bats', 'Bats'))
+							.to.equal(true);
+						Expect(_DataArithmatic
+							.stringEndsWith('Dogs', 'Dogs are cool'))
+							.to.equal(false);
+						// We should be able to tell it a midpoint to "end" the string at
+						Expect(_DataArithmatic
+							.stringEndsWith('Start from a median point', 'median', 19))
+							.to.equal(true);
+						Expect(_DataArithmatic
+							.stringEndsWith('Start from a median point', 'median', 20))
+							.to.equal(false);
+						Expect(_DataArithmatic
+							.stringEndsWith('Dogs', 'Cats'))
+							.to.equal(false);
+						return fTestComplete();
+					}
+				);
+				test
+				(
+					'Test cleaning nonalpha characters from a string',
+					(fTestComplete)=>
+					{
+						let testFable = new libFable({LogStreams: false});
+						let _DataArithmatic = testFable.DataArithmatic;
+						Expect(_DataArithmatic
+							.cleanNonAlphaCharacters('Dogs'))
+							.to.equal('Dogs');
+						Expect(_DataArithmatic
+							.cleanNonAlphaCharacters('Dogs are cool'))
+							.to.equal('Dogs_are_cool');
+						Expect(_DataArithmatic
+							.cleanNonAlphaCharacters('Dogs are cool!'))
+							.to.equal('Dogs_are_cool_');
+						// Test cleaning with no character
+						_DataArithmatic._Value_Clean_formatterCleanNonAlpha = '';
+						Expect(_DataArithmatic
+							.cleanNonAlphaCharacters('Dogs are cool!'))
+							.to.equal('Dogsarecool');
+						return fTestComplete();
+					}
+				);
+			}
+		);
+	}
+);

package/test/Fable_tests.js

@@ -10,7 +10,6 @@ var libFable = require('../source/Fable.js');
 
 var Chai = require("chai");
 var Expect = Chai.expect;
-var Assert = Chai.assert;
 
 suite
 (