@onehat/data 1.6.6 → 1.6.10

package/cypress/fixtures/Definitions/GroupsUsers.js

@@ -42,7 +42,10 @@ const GroupsUsers = {
 		},
 	},
 
-	repository: 'onebuild',
+	repository: {
+		type: 'onebuild',
+		autoSave: false,
+	},
 
 };
 

package/cypress/integration/Entity.spec.js

@@ -137,6 +137,12 @@ describe('Entity', function() {
 			expect(this.entity.bar).to.be.eq('one');
 			expect(this.entity.isDirty).to.be.false;
 			expect(_.isEqual(this.entity.getParsedValues(), originalData)).to.be.true;
+
+			this.entity.delete();
+			expect(this.entity.isDeleted).to.be.true;
+
+			this.entity.reset();
+			expect(this.entity.isDeleted).to.be.false;
 		});
 
 		it('getMappedValue', function() {
@@ -533,6 +539,9 @@ describe('Entity', function() {
 		it('markDeleted', function() {
 			this.entity.markDeleted();
 			expect(this.entity.isDeleted).to.be.true;
+
+			this.entity.markDeleted(false);
+			expect(this.entity.isDeleted).to.be.false;
 		});
 
 		it('delete', function() {
@@ -540,6 +549,11 @@ describe('Entity', function() {
 			expect(this.entity.isDeleted).to.be.true;
 		});
 
+		it('undelete', function() {
+			this.entity.delete();
+			this.entity.undelete();
+			expect(this.entity.isDeleted).to.be.false;
+		});
 	});
 
 	describe('events', function() {
@@ -594,6 +608,20 @@ describe('Entity', function() {
 			expect(didFire).to.be.true;
 		});
 
+		it('undelete', function() {
+			this.entity.delete();
+			expect(this.entity.isDeleted).to.be.true;
+
+			let didFire = false;
+			this.entity.on('undelete', () => {
+				didFire = true;
+			});
+			this.entity.undelete();
+
+			expect(didFire).to.be.true;
+			expect(this.entity.isDeleted).to.be.false;
+		});
+
 		it('destroy', function() {
 			let didFire = false;
 			this.entity.on('destroy', () => {

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;
@@ -183,13 +189,35 @@ describe('OneHatData', function() {
 			oneHatData.createSchemas([
 				{ name: 'foo', },
 			]);
-			oneHatData.createBoundRepositories();
+			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();
@@ -264,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);
 
@@ -274,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() {
@@ -323,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();
@@ -349,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/Repository/Ajax.spec.js

@@ -111,6 +111,33 @@ describe('OneBuildRepository', function() {
 			await this.repository.add({ key: 6, value: 'six' });
 			expect(_.size(this.repository.entities)).to.be.eq(1);
 		});
+
+		it.only('sortInMemory', function() {
+
+			const repository = this.repository;
+
+			// Create two phantom records, out of order
+			repository.setAutoSave(false);
+			repository.add({ key: 5, value: 'Five', });
+			repository.add({ key: 4, value: 'One', });
+			repository.add({ key: 2, value: 'Two', });
+			repository.add({ key: 3, value: 'Three', });
+			repository.add({ key: 1, value: 'One', });
+
+			repository.sorters = [
+				{ name: 'value', direction: 'DESC', }, // 2,3,4,1,5
+				{ name: 'key', direction: 'ASC', }, // 2,3,1,4,5
+			];
+			repository.sortInMemory();
+
+			// Check that they are correct order
+			const entities = repository.entities;
+			expect(entities[0].key).to.be.eq(2);
+			expect(entities[1].key).to.be.eq(3);
+			expect(entities[2].key).to.be.eq(1);
+			expect(entities[3].key).to.be.eq(4);
+			expect(entities[4].key).to.be.eq(5);
+		});
 		
 	});
 

package/cypress/integration/Repository/Repository.spec.js

@@ -718,6 +718,10 @@ describe('Repository Base', function() {
 		// deleteById
 		// deleteDirty
 		// deletePhantom
+		// undeleteByIx
+		// undeleteByRange
+		// undeleteBy
+		// undeleteById
 
 	});
 

package/package.json

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

package/src/Entity.js

@@ -52,6 +52,7 @@ class Entity extends EventEmitter {
 			'reload',
 			'save',
 			'delete',
+			'undelete',
 			'destroy',
 		]);
 		
@@ -286,7 +287,7 @@ class Entity extends EventEmitter {
 
 	/**
 	 * Resets the Entity to a state as if it had just been created,
-	 * all based on _originalData.
+	 * Gets data to restore from _originalData.
 	 */
 	reset = () => {
 		if (this.isDestroyed) {
@@ -297,6 +298,10 @@ class Entity extends EventEmitter {
 		this._resetPropertyValues();
 		this._originalDataParsed = this.getParsedValues();
 
+		if (this.isDeleted) {
+			this.undelete();
+		}
+
 		this.emit('reset', this._proxy);
 	}
 
@@ -1047,18 +1052,17 @@ class Entity extends EventEmitter {
 
 	/**
 	 * Marks an entity as having been saved to storage medium.
+	 * @param {boolean} bool - How it should be marked. Defaults to true.
 	 */
-	markDeleted = () => {
+	markDeleted = (bool = true) => {
 		if (this.isDestroyed) {
 			throw Error('this.markDeleted is no longer valid. Entity has been destroyed.');
 		}
-		this.isDeleted = true;
+		this.isDeleted = bool;
 	}
 
 	/**
 	 * Tells the Repository to delete this entity from the storage medium.
-	 * @param {function} onSuccess - Optional function to execute when save operation successfully completes.
-	 * @param {function} onFailure - Optional function to execute when save operation successfully completes.
 	 * @fires delete
 	 */
 	delete = () => {
@@ -1072,6 +1076,23 @@ class Entity extends EventEmitter {
 		}
 	}
 
+	/**
+	 * Marks a deleted entity as undeleted.
+	 * Only works when autoSave is off for the containing repository
+	 * @fires delete
+	 */
+	undelete = () => {
+		if (this.isDestroyed) {
+			throw Error('this.undelete is no longer valid. Entity has been destroyed.');
+		}
+		const repository = this.getRepository();
+		if (repository && repository.autoSave) {
+			throw Error('Cannot undelete entities on an autoSave repository.');
+		}
+		this.markDeleted(false);
+		this.emit('undelete', this._proxy);
+	}
+
 	/**
 	 * Destroy this object.
 	 * - Removes all circular references to parent objects

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

@@ -653,6 +653,24 @@ class AjaxRepository extends Repository {
 		return this.reader.read(result);
 	}
 
+	/**
+	 * Sorts the items in the current page of memory
+	 * This is mainly used to sort isPhantom entities,
+	 * since the server normally sorts, and they haven't yet gone to server.
+	 */
+	sortInMemory = () => {
+		const sorters = this.sorters;
+		let sortNames = [],
+			sortDirections = [];
+		_.each(sorters, (sorter) => {
+			sortNames.push(sorter.name);
+			sortDirections.push(sorter.direction.toLowerCase());
+		});
+		let entities = this.entities;
+		entities = _.orderBy(entities, sortNames, sortDirections);
+		this.entities = entities;
+	}
+
 	/**
 	 * Helper for save.
 	 * Takes an array of Promises from axios. When they are all resolved,

package/src/Repository/Repository.js

@@ -1478,6 +1478,44 @@ export default class Repository extends EventEmitter {
 		await this.delete(this.getPhantom());
 	}
 
+	/**
+	 * Deletes a single Entity by its index (zero-indexed) on the current page
+	 * @param {integer} ix - Index
+	 * @return {object} entity - Entity
+	 */
+	undeleteByIx = async (ix) => {
+		await this.undelete(this.getByIx(ix));
+	}
+	
+	/**
+	 * Deletes multiple Entities by their range of indices 
+	 * (zero-indexed) on the current page
+	 * @param {integer} startIx - Index
+	 * @param {integer} endIx - Index (inclusive)
+	 * @return {array} entities - Array of Entities
+	 */
+	undeleteByRange = async (startIx, endIx) => {
+		await this.undelete(this.getByRange(startIx, endIx));
+	}
+
+	/**
+	 * Remove multiple Entities by supplied filter function
+	 * @param {function} fn - Filter function to apply to all entities
+	 * @return {Entity[]} Entities that passed through filter
+	 */
+	undeleteBy = async (filter) => {
+		await this.undelete(this.getBy(filter));
+	}
+
+	/**
+	 * Remove a single Entity by its id
+	 * @param {integer} id - id of record to retrieve
+	 * @return {Entity} The Entity with matching id
+	 */
+	undeleteById = async (id) => {
+		await this.undelete(this.getById(id));
+	}
+