@base-framework/base 2.6.0 → 2.6.1

package/es6/modules/router/utils.js

@@ -0,0 +1,31 @@
+/**
+ * Utils
+ *
+ * These are some helper functions for the router.
+ */
+export const Utils =
+{
+	/**
+	 * This will remove the begining and ending slashes from a url.
+	 *
+	 * @param {string} uri
+	 * @return {string}
+	 */
+	removeSlashes(uri)
+	{
+		if(typeof uri === 'string')
+		{
+			if(uri.substring(0, 1) === '/')
+			{
+				uri = uri.substring(1);
+			}
+
+			if(uri.substring(-1) === '/')
+			{
+				uri = uri.substring(0, uri.length - 1);
+			}
+		}
+
+		return uri;
+	}
+};

package/es6/modules/state/state-target.js

@@ -0,0 +1,91 @@
+
+ import {SimpleData} from '../data/data.js';
+ import {state} from './state.js';
+
+ /**
+ * StateTarget
+ *
+ * This will create a state target to track the state
+ * of an object.
+ * @class
+ * @augments SimpleData
+ */
+export class StateTarget extends SimpleData
+{
+	/**
+	 * @constructor
+	 * @param {string} id
+	 */
+	constructor(id)
+	{
+		super();
+		this.id = id;
+	}
+
+	/**
+	 * This will restore a state to the controller.
+	 */
+	restore()
+	{
+		state.restore(this.id, this);
+	}
+
+	/**
+	 * This will remove the target from the controller.
+	 */
+	remove()
+	{
+		state.remove(this.id);
+	}
+
+	/**
+	 * This will add an action to the target.
+	 *
+	 * @param {string} action
+	 * @param {*} state
+	 */
+	addAction(action, state)
+	{
+		if(typeof state !== 'undefined')
+		{
+			this.set(action, state);
+		}
+	}
+
+	/**
+	 * This will get the state of an action.
+	 *
+	 * @param {string} action
+	 * @return {*}
+	 */
+	getState(action)
+	{
+		return this.get(action);
+	}
+
+	/**
+	 * This will remove an action or a callBack
+	 * from an action. if no token is passed the
+	 * whole action is removed.
+	 *
+	 * @param {string} action
+	 * @param {string} [token]
+	 */
+	removeAction(action, token)
+	{
+		/* if we have a token then the token will be
+		the only item removed */
+		if(token)
+		{
+			this.off(action, token);
+		}
+		else
+		{
+			let actions = this.stage;
+			if(typeof actions[action] !== 'undefined')
+			{
+				delete actions[action];
+			}
+		}
+	}
+}

package/es6/modules/state/state.js

@@ -0,0 +1,171 @@
+
+ import {StateTarget} from './state-target.js';
+
+ /**
+ * StateController
+ *
+ * This will create a state controller that can
+ * add and remove targets, actions, and action
+ * subscriber callBack functions.
+ *
+ * @class
+ */
+class StateController
+{
+	/**
+	 * @constructor
+	 */
+	constructor()
+	{
+		this.targets = {};
+	}
+
+	/**
+	 * This will restore a state target.
+	 *
+	 * @param {string} id
+	 * @param {object} target
+	 */
+	restore(id, target)
+	{
+		this.targets[id] = target;
+	}
+
+	/**
+	 * This will get the state target.
+	 *
+	 * @param {string} id
+	 * @return {object}
+	 */
+	getTarget(id)
+	{
+		let targets = this.targets;
+		return (targets[id] || (targets[id] = new StateTarget(id)));
+	}
+
+	/**
+	 * This will get the state of an action.
+	 *
+	 * @param {string} targetId
+	 * @param {string} action
+	 */
+	getActionState(targetId, action)
+	{
+		const target = this.getTarget(targetId);
+		return target.get(action);
+	}
+
+	/**
+	 * This will add a new target.
+	 *
+	 * @param {string} targetId
+	 * @param {string} [action]
+	 * @param {*} [state] the primary action state
+	 * @return {object}
+	 */
+	add(targetId, action, state)
+	{
+		const target = this.getTarget(targetId);
+		if(action)
+		{
+			target.addAction(action, state);
+		}
+		return target;
+	}
+
+	/**
+	 * This will add a new action to a target.
+	 *
+	 * @param {string} targetId
+	 * @param {string} action
+	 * @param {string} [state]
+	 * @return {object}
+	 */
+	addAction(targetId, action, state)
+	{
+		return this.add(targetId, action, state);
+	}
+
+	/**
+	 * This will remove the action from a target.
+	 *
+	 * @param {string} targetId
+	 * @param {string} action
+	 * @param {string} [token]
+	 */
+	removeAction(targetId, action, token)
+	{
+		this.off(targetId, action, token);
+	}
+
+	/**
+	 * This will add a new subscriber to the action.
+	 *
+	 * @param {string} targetId
+	 * @param {string} action
+	 * @param {function} callBack
+	 * @return {string}
+	 */
+	on(targetId, action, callBack)
+	{
+		let target = this.getTarget(targetId);
+		if(action)
+		{
+			return target.on(action, callBack);
+		}
+		return false;
+	}
+
+	/**
+	 * This will remove a subscriber from an action.
+	 *
+	 * @param {string} targetId
+	 * @param {string} action
+	 * @param {string} token
+	 */
+	off(targetId, action, token)
+	{
+		this.remove(targetId, action, token);
+	}
+
+	/**
+	 * This will remove a target or action or callBack.
+	 *
+	 * @param {string} targetId
+	 * @param {string} [action]
+	 * @param {string} [token]
+	 */
+	remove(targetId, action, token)
+	{
+		let targets = this.targets,
+		target = targets[targetId];
+		if(!target)
+		{
+			return false;
+		}
+
+		if(action)
+		{
+			target.off(action, token);
+		}
+		else
+		{
+			delete targets[targetId];
+		}
+	}
+
+	/**
+	 * This will set the action state.
+	 *
+	 * @param {string} targetId
+	 * @param {string} action
+	 * @param {*} state
+	 */
+	set(targetId, action, state)
+	{
+		var target = this.getTarget(targetId);
+		target.set(action, state);
+	}
+}
+
+export const state = new StateController();

package/es6/package-lock.json

@@ -0,0 +1,13 @@
+{
+  "name": "Base Framework",
+  "version": "1.0.0",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "Base Framework",
+      "version": "1.0.0",
+      "license": "ISC"
+    }
+  }
+}

package/es6/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@base-framework/base",
+  "version": "2.6.0",
+  "description": "This is a javascript framework.",
+  "main": "base.min.js",
+  "scripts": {
+    "prepublishOnly" : "uglifyjs -o myfile.min.js myfile.js"
+  },
+  "keywords": [
+    "JavaScript",
+    "Framework",
+    "Base",
+    "ES6"
+  ],
+  "author": "Chris Durfee",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/chrisdurfee/base.git"
+  },
+  "bugs": {
+    "url": "https://github.com/chrisdurfee/base/issues"
+  },
+  "devDependencies": {
+    "uglify-js": "^3.17.0"
+  },
+  "homepage": "https://github.com/chrisdurfee/base#readme"
+}

package/es6/shared/objects.js

@@ -0,0 +1,99 @@
+
+export const Objects =
+{
+    /**
+	 * This will create a new object.
+	 *
+	 * @param {object} [object] An object to extend.
+	 * @return {object}
+	 */
+	createObject(object)
+	{
+		return Object.create(object);
+	},
+
+	/**
+	 * This will extend an object to another object.
+	 *
+	 * @param {(function|object)} sourceObj
+	 * @param {(function|object)} targetObj
+	 * @return {object}
+	 */
+	extendObject(sourceObj, targetObj)
+	{
+		if(typeof sourceObj === 'undefined' || typeof targetObj === 'undefined')
+		{
+			return false;
+		}
+
+		for(var property in sourceObj)
+		{
+			if(sourceObj.hasOwnProperty(property) && typeof targetObj[property] === 'undefined')
+			{
+				targetObj[property] = sourceObj[property];
+			}
+		}
+
+		return targetObj;
+	},
+
+	/**
+	 * This will clone an object.
+	 *
+	 * @param {object} obj
+	 * @return {object}
+	 */
+	cloneObject(obj)
+	{
+		if(!obj)
+		{
+			return {};
+		}
+
+		return JSON.parse(JSON.stringify(obj));
+	},
+
+	/**
+	 * This will get the class prototype.
+	 *
+	 * @param {(function|object)} object
+	 * @return {object}
+	 */
+	_getClassObject(object)
+	{
+		return (typeof object === 'function')? object.prototype : object;
+	},
+
+	/**
+	 * This will extend an object to another object.
+	 *
+	 * @param {(function|object)} sourceClass
+	 * @param {(function|object)} targetClass
+	 * @return {object}
+	 */
+	extendClass(sourceClass, targetClass)
+	{
+		/* if we are using a class constructor function
+		we want to get the class prototype object */
+		let source = this._getClassObject(sourceClass),
+		target = this._getClassObject(targetClass);
+
+		if(typeof source !== 'object' || typeof target !== 'object')
+		{
+			return false;
+		}
+
+		/* we want to create a new object and add the source
+		prototype to the new object */
+		let obj = Object.create(source);
+
+		/* we want to add any additional properties from the
+		target class to the new object */
+		for(var prop in target)
+		{
+			obj[prop] = target[prop];
+		}
+
+		return obj;
+	}
+};