@onehat/data 1.6.3 → 1.6.7

package/cypress/fixtures/Definitions/GroupsUsers.js

@@ -25,9 +25,27 @@ const GroupsUsers = {
 			{ name: 'users__last_login',	mapping: 'user.last_login',	type: 'datetime' },
 		],
 
+		associations: {
+			hasOne: [
+				'Groups',
+				'Users',
+			],
+		},
+
+	},
+
+	entity: {
+		methods: {
+			testMethod: function() {
+				this.users__login_count = this.users__login_count +1;
+			},
+		},
 	},
 
-	repository: 'onebuild',
+	repository: {
+		type: 'onebuild',
+		autoSave: false,
+	},
 
 };
 

package/cypress/integration/Entity.spec.js

@@ -17,6 +17,13 @@ describe('Entity', function() {
 					{ name: 'baz', mapping: 'baz.test.val', type: 'bool', defaultValue: null, },
 				],
 			},
+			entity: {
+				methods: {
+					testMethod: function() {
+						this.bar = 'test me';
+					},
+				},
+			},
 		});
 		this.data = {
 			foo: 1,
@@ -71,7 +78,6 @@ describe('Entity', function() {
 			entity.markSaved();
 			expect(entity.isTempId).to.be.false;
 		});
-		
 	
 		it('clone', function() {
 			const entity = this.entity;
@@ -100,6 +106,11 @@ describe('Entity', function() {
 			expect(entity.properties.bar.name).to.be.eq('bar');
 			expect(entity.properties.baz.name).to.be.eq('baz');
 		});
+
+		it('_createMethods', function() {
+			this.entity.testMethod();
+			expect(this.entity.bar).to.be.eq('test me');
+		});
 		
 		it('loadOriginalData', function() {
 			const data = {

package/cypress/integration/OneHatData.spec.js

@@ -1,4 +1,10 @@
 import { OneHatData } from '../../src/OneHatData';
+import GroupsDefinition from '../fixtures/Definitions/Groups';
+import GroupsUsersDefinition from '../fixtures/Definitions/GroupsUsers';
+import UsersDefinition from '../fixtures/Definitions/Users';
+import groupsUserData from '../fixtures/Data/GroupsUser';
+import KeyValues from '../../src/Schema/KeyValues';
+
 
 // NOTE: Cypress can't handle async functions for beforeEach,
 // so we have to manually apply it to every test. Ugh!
@@ -110,7 +116,7 @@ describe('OneHatData', function() {
 		(async function() {
 			await beforeEach();
 
-			const repository = this.oneHatData.createRepository('bar');
+			const repository = await this.oneHatData.createRepository('bar');
 			expect(repository.id).to.be.not.eq(this.repository.id);
 
 			afterEach();
@@ -128,7 +134,7 @@ describe('OneHatData', function() {
 				{ name: 'baz', },
 			]);
 			const schemas = oneHatData.schemas;
-			oneHatData.createRepositories(schemas);
+			await oneHatData.createRepositories(schemas);
 	
 			const result = oneHatData.getAllRepositories();
 			expect(_.size(result)).to.be.eq(3);
@@ -147,7 +153,7 @@ describe('OneHatData', function() {
 				{ name: 'bar', },
 				{ name: 'baz', },
 			]);
-			oneHatData.createBoundRepositories();
+			await oneHatData.createBoundRepositories();
 	
 			const schemas = oneHatData.schemas;
 			let bound = 0;
@@ -175,6 +181,43 @@ describe('OneHatData', function() {
 		})();
 	});
 
+	it('hasRepository', function() {
+		(async function() {
+			await beforeEach();
+
+			const oneHatData = new OneHatData();
+			oneHatData.createSchemas([
+				{ name: 'foo', },
+			]);
+			await oneHatData.createBoundRepositories();
+			expect(oneHatData.hasRepository('foo')).to.be.true;
+
+			afterEach();
+		})();
+	});
+
+	it('Entity.getAssociatedRepository', function() {
+		(async function() {
+			await beforeEach();
+
+			const oneHatData = new OneHatData();
+
+			await oneHatData.createSchemas([
+				GroupsDefinition,
+				GroupsUsersDefinition,
+				UsersDefinition,
+			]);
+			await oneHatData.createBoundRepositories();
+			const GroupsUsers = oneHatData.getRepository('GroupsUsers');
+			const groupsUser = await GroupsUsers.add(groupsUserData);
+			const Users = groupsUser.getAssociatedRepository('Users');
+
+			expect(Users).to.be.not.null;
+
+			afterEach();
+		})();
+	});
+
 	it('hasRepositoryWithId', function() {
 		(async function() {
 			await beforeEach();
@@ -249,9 +292,9 @@ describe('OneHatData', function() {
 			await beforeEach();
 
 			const oneHatData = this.oneHatData;
-			oneHatData.createRepository('bar');
-			oneHatData.createRepository('bar');
-			oneHatData.createRepository('bar');
+			await oneHatData.createRepository('bar');
+			await oneHatData.createRepository('bar');
+			await oneHatData.createRepository('bar');
 			const result = oneHatData.getRepositoriesBySchema(this.schema);
 			expect(_.size(result)).to.be.eq(4);
 
@@ -259,22 +302,22 @@ describe('OneHatData', function() {
 		})();
 	});
 
-	it('createGlobalErrorHandler', function() {
-		(async function() {
-			await beforeEach();
+	// it('createGlobalErrorHandler', function() {
+	// 	(async function() {
+	// 		await beforeEach();
 
-			let message = '';
-			const oneHatData = this.oneHatData,
-				errorHandler = (a, b) => {
-					debugger;
-				};
-			oneHatData.createGlobalErrorHandler(errorHandler);
-			oneHatData.emitError();
-			expect(message).to.be.eq('Test here');
+	// 		let message = '';
+	// 		const oneHatData = this.oneHatData,
+	// 			errorHandler = (a, b) => {
+	// 				debugger;
+	// 			};
+	// 		oneHatData.createGlobalErrorHandler(errorHandler);
+	// 		oneHatData.emitError();
+	// 		expect(message).to.be.eq('Test here');
 
-			afterEach();
-		})();
-	});
+	// 		afterEach();
+	// 	})();
+	// });
 
 	it('setOptionsOnAllRepositories', function() {
 		(async function() {
@@ -308,14 +351,16 @@ describe('OneHatData', function() {
 			await beforeEach();
 
 			const oneHatData = new OneHatData();
-			const repositories = oneHatData.createSchemas([
+
+			await oneHatData.createSchemas([
 					{ name: 'foo', },
 					{ name: 'bar', },
 					{ name: 'baz', },
 				])
-				.createBoundRepositories()
-				.getAllRepositories();
-	
+				.createBoundRepositories();
+			
+			// NOTE: Can't chain getAllRepositories() because we have to wait for createBoundRepositories to finish
+			const repositories = oneHatData.getAllRepositories();
 			expect(_.size(repositories)).to.be.eq(3);
 
 			afterEach();
@@ -334,8 +379,8 @@ describe('OneHatData', function() {
 					{ key: '4', value: 'four', },
 					{ key: '5', value: 'five', },
 				],
-				repository = oneHatData.createRepository({
-					schema: 'KeyValues',
+				repository = await oneHatData.createRepository({
+					schema: KeyValues,
 					data,
 				});
 

package/cypress/integration/Property/Currency.spec.js

@@ -18,12 +18,45 @@ describe('CurrencyProperty', function() {
 		});
 
 		it('default value', function() {
-			const property = this.property,
-				rawValue = property.getDefaultValue();
-			property.pauseEvents();
-			property.setValue(rawValue);
-			property.resumeEvents();
 			expect(this.property.submitValue).to.be.eq('0.00');
+
+			const rawValue = this.property.getDefaultValue();
+			this.property.setValue(rawValue);
+			expect(this.property.submitValue).to.be.eq('0.00');
+		});
+
+		it('isZero', function() {
+			this.property.setValue('0.00');
+			expect(this.property.isZero).to.be.true;
+
+			this.property.setValue('0.01');
+			expect(this.property.isZero).to.be.false;
+
+			this.property.setValue('-0.01');
+			expect(this.property.isZero).to.be.false;
+
+			this.property.setValue(null);
+			expect(this.property.isZero).to.be.false;
+
+			this.property.setValue();
+			expect(this.property.isZero).to.be.false;
+		});
+
+		it('hasValue', function() {
+			this.property.setValue('0.00');
+			expect(this.property.hasValue).to.be.true;
+
+			this.property.setValue('0.01');
+			expect(this.property.hasValue).to.be.true;
+
+			this.property.setValue('-0.01');
+			expect(this.property.hasValue).to.be.true;
+
+			this.property.setValue(null);
+			expect(this.property.hasValue).to.be.false;
+
+			this.property.setValue();
+			expect(this.property.hasValue).to.be.false;
 		});
 		
 	});
@@ -41,8 +74,8 @@ describe('CurrencyProperty', function() {
 		});
 
 		it('numeric string', function() {
-			const parsed = this.property.parse('This is 1234 dollars.');
-			expect(parsed).to.be.eq(1234);
+			const parsed = this.property.parse('This is $1234.56 dollars.');
+			expect(parsed).to.be.eq(1234.56);
 		});
 
 		it('non-numeric string', function() {

package/cypress/integration/Schema.spec.js

@@ -10,6 +10,11 @@ describe('Schema', function() {
 	it('schema is valid', function() {
 		expect(this.schema instanceof Schema).to.be.true;
 		expect(this.schema.name).to.be.eq('GroupsUsers');
+		expect(this.schema.model.associations.hasOne).to.be.an('array');
+		expect(this.schema.model.associations.hasMany).to.be.an('array');
+		expect(this.schema.model.associations.belongsTo).to.be.an('array');
+		expect(this.schema.model.associations.belongsToMany).to.be.an('array');
+		expect(this.schema.entity.methods.testMethod).to.be.a('function');
 		expect(this.schema.repository.type).to.be.eq('onebuild');
 	});
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@onehat/data",
-	"version": "1.6.3",
+	"version": "1.6.7",
 	"description": "JS data modeling package with adapters for many storage mediums.",
 	"main": "src/index.js",
 	"type": "module",

package/src/Entity.js

@@ -150,10 +150,28 @@ class Entity extends EventEmitter {
 
 	initialize = () => {
 		this.properties = this._createProperties();
+		this._createMethods();
 		this.reset();
 		this.isInitialized = true;
 	}
 
+	/**
+	 * Creates the methods for this Entity, based on Schema.
+	 * @private
+	 */
+	_createMethods = () => {
+		if (this.isDestroyed) {
+			throw Error('this._createMethods is no longer valid. Entity has been destroyed.');
+		}
+		const methodDefinitions = this.schema.entity.methods;
+		if (_.isEmpty(methodDefinitions)) {
+			return;
+		}
+		_.each(methodDefinitions, (method, name) => {
+			this[name] = method; // NOTE: Methods must be defined in schema as "function() {}", not as "() => {}" so "this" will be assigned correctly
+		});
+	}
+
 	/**
 	 * Generates a new unique id and assigns it to this entity.
 	 */
@@ -380,6 +398,17 @@ class Entity extends EventEmitter {
 		return this.schema;
 	}
 
+	/**
+	 * Gets the Repository object
+	 * @return {Repository} repository
+	 */
+	getRepository = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getRepository is no longer valid. Entity has been destroyed.');
+		}
+		return this.repository;
+	}
+
 	/**
 	 * Alias for this.properties
 	 */
@@ -833,6 +862,43 @@ class Entity extends EventEmitter {
 		return this._originalData;
 	}
 
+	/**
+	 * Gets the associated Repository
+	 * @param {string} repositoryName - Name of the Repository to retrieve
+	 * @return {boolean} hasProperty
+	 */
+	getAssociatedRepository = (repositoryName) => {
+		if (this.isDestroyed) {
+			throw Error('this.getAssociatedRepository is no longer valid. Entity has been destroyed.');
+		}
+
+		const schema = this.getSchema();
+		if (!schema.model.associations.hasOne.includes(repositoryName) &&
+			!schema.model.associations.hasMany.includes(repositoryName) &&
+			!schema.model.associations.belongsTo.includes(repositoryName) &&
+			!schema.model.associations.belongsToMany.includes(repositoryName)
+			) {
+			throw Error(repositoryName + ' is not associated with this schema');
+		}
+
+		const repository = this.getRepository();
+		if (!repository) {
+			throw Error('No repository on this entity');
+		}
+
+		const oneHatData = repository.oneHatData;
+		if (!oneHatData) {
+			throw Error('No global oneHatData object');
+		}
+
+		const associatedRepository = oneHatData.getRepository(repositoryName);
+		if (!associatedRepository) {
+			throw Error('Repository ' + repositoryName + ' cannot be found');
+		}
+		
+		return associatedRepository;
+	}
+
 
 
 	//    _____      __  __

package/src/OneHatData.js

@@ -254,8 +254,8 @@ export class OneHatData extends EventEmitter {
 			}
 
 			// Apply the general config settings to each specific one
-			const localConfig = _.assign({}, generalConfig, config.local),
-				remoteConfig = _.assign({}, generalConfig, config.remote);
+			const localConfig = _.merge({}, generalConfig, config.local),
+				remoteConfig = _.merge({}, generalConfig, config.remote);
 			
 			// Actually create the local and remote repositories
 			config.local = await this.createRepository(localConfig);
@@ -263,7 +263,7 @@ export class OneHatData extends EventEmitter {
 		}
 
 		const Repository = this._repositoryTypes[config.type],
-			repository = new Repository(config);
+			repository = new Repository(config, this);
 		await repository.initialize();
 		
 		return repository;
@@ -442,6 +442,19 @@ export class OneHatData extends EventEmitter {
 		return schema.getBoundRepository();
 	}
 
+	/**
+	 * Checks whether the requested bound Repository exists.
+	 * @param {string} name - Name of Schema
+	 * @return {boolean} hasRepository
+	 */
+	hasRepository = (name) => {
+		if (this.isDestroyed) {
+			throw new Error('this.getRepository is no longer valid. OneHatData has been destroyed.');
+		}
+		const repository = this.getRepository(name);
+		return !!repository;
+	}
+
 	/**
 	 * Get Repositories by a filter function
 	 * @param {function} filter - Filter function

package/src/Property/Currency.js

@@ -64,6 +64,28 @@ export default class CurrencyProperty extends Property {
 		return this.parsedValue;
 	}
 
+	/**
+	 * Determines if a currency is equal to 0.00
+	 * Returns false if no value set.
+	 */
+	get isZero() {
+		if (this.isDestroyed) {
+			throw Error('this.isZero is no longer valid. Property has been destroyed.');
+		}
+		return this.parsedValue === 0;
+	}
+
+	/**
+	 * Determines if a currency has a non-null value
+	 */
+	get hasValue() {
+		if (this.isDestroyed) {
+			throw Error('this.hasValue is no longer valid. Property has been destroyed.');
+		}
+		console.log(this.parsedValue);
+		return !_.isNil(this.parsedValue);
+	}
+
 };
 
 CurrencyProperty.className = 'Currency';

package/src/Repository/Ajax.js

@@ -370,7 +370,7 @@ class AjaxRepository extends Repository {
 		}
 
 		const repository = this;
-		const data = _.assign({}, this._baseParams, this._params);
+		const data = _.merge({}, this._baseParams, this._params);
 		
 		return this._send(this.methods.get, this.api.get, data)
 					.then(result => {

package/src/Repository/Repository.js

@@ -23,7 +23,7 @@ export default class Repository extends EventEmitter {
 	 * - name {string} - Optional. Defaults to schema.name
 	 * - schema - Schema object
 	 */
-	constructor(config = {}) {
+	constructor(config = {}, oneHatData = null) {
 		super(...arguments);
 		
 		const { schema } = config;
@@ -214,6 +214,11 @@ export default class Repository extends EventEmitter {
 		 */
 		this.isDestroyed = false;
 
+		/**
+		 * @member {boolean} oneHatData - The global @onehat/data object
+		 */
+		this.oneHatData = oneHatData;
+
 		this.registerEvents([
 			'add',
 			'beforeSave',
@@ -1411,8 +1416,8 @@ export default class Repository extends EventEmitter {
 	 * Helper for delete()
 	 */
 	 removeEntity = async (entity) => {
-		 this.entities = _.filter(this.entities, e => e !== entity);
-		 entity.destroy();
+		this.entities = _.filter(this.entities, e => e !== entity);
+		entity.destroy();
 	}
 
 	/**

package/src/Schema/Schema.js

@@ -5,11 +5,12 @@ import _ from 'lodash';
 
 /**
  * Class represents the Schema definition for Model and Source
- * This is basically just a big config object, used to instantiate a Model and Source.
+ * This is basically just a big config object, used to instantiate an Entity, and Repository.
  * Usage:
  * - const schema = new Schema({
  * 		name: 'Users',
  * 		model: {},
+ * 		entity: {},
  * 		repository: {},
  * });
  * 
@@ -96,6 +97,10 @@ export default class Schema extends EventEmitter {
 					belongsToMany: [],
 				},
 			},
+			
+			entity: {
+				methods: {}, // NOTE: Methods must be defined as "function() {}", not as "() => {}" so "this" will be assigned correctly
+			},
 
 			/**
 			 * @member {object|string} repository - Config for Repository
@@ -104,7 +109,7 @@ export default class Schema extends EventEmitter {
 
 		};
 
-		this._originalConfig = _.assign({}, defaults, config);
+		this._originalConfig = _.merge({}, defaults, config);
 		_.merge(this, this._originalConfig);
 
 		/**