@onehat/data 1.7.2 → 1.7.6

package/cypress/integration/Entity.spec.js

@@ -77,6 +77,9 @@ describe('Entity', function() {
 
 			entity.markSaved();
 			expect(entity.isTempId).to.be.false;
+
+			entity.isTempId = true;
+			expect(entity.isTempId).to.be.true;
 		});
 	
 		it('clone', function() {
@@ -522,6 +525,7 @@ describe('Entity', function() {
 			entity.bar = 'Test';
 			entity.markSaved();
 			expect(entity.isTempId).to.be.false;
+			expect(entity.isStaged).to.be.false;
 
 			expect(entity.isPersisted).to.be.true;
 			const expected = {
@@ -554,6 +558,16 @@ describe('Entity', function() {
 			this.entity.undelete();
 			expect(this.entity.isDeleted).to.be.false;
 		});
+
+		it('markStaged, stage', function() {
+			expect(this.entity.isStaged).to.be.false;
+
+			this.entity.stage();
+			expect(this.entity.isStaged).to.be.true;
+
+			this.entity.markStaged(false);
+			expect(this.entity.isStaged).to.be.false;
+		});
 	});
 
 	describe('events', function() {

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

@@ -12,6 +12,11 @@ describe('Repository Base', function() {
 					{ name: 'key', type: 'int' },
 					{ name: 'value' },
 				],
+				associations: {
+					hasMany: [
+						'bar'
+					],
+				},
 			},
 			repository: 'null',
 		});
@@ -63,6 +68,43 @@ describe('Repository Base', function() {
 			})
 			expect(repository.id).to.be.not.eq('foo');
 		});
+
+		it('_createMethods', async function() {
+
+			// There is no test method by default
+			expect(this.repository.testMethod).to.not.exist;
+
+			// Set up custom repository with testMethod
+			const schema1 = new Schema({
+					name: 'baz',
+					model: {
+						idProperty: 'key',
+						displayProperty: 'value',
+						properties: [
+							{ name: 'key', type: 'int' },
+							{ name: 'value' },
+						],
+					},
+					repository: {
+						type: 'null',
+						methods: {
+							testMethod: function() {
+								this.bar = 'test me';
+							},
+						},
+					},
+				}),
+				repository = new this.Repository({
+					schema: schema1,
+					data: [],
+				});
+			await repository.initialize();
+			schema1.setBoundRepository(repository);
+
+			// Perform testMethod test
+			repository.testMethod();
+			expect(repository.bar).to.be.eq('test me');
+		});
 	});
 
 	describe('loading', function() {
@@ -608,8 +650,12 @@ describe('Repository Base', function() {
 		it('getNonPersisted', async function() {
 			this.repository.setAutoSave(false);
 			const entity = await this.repository.add({ value: 'six' }),
-				nonPersisted = this.repository.getNonPersisted();
+				entities = this.repository.entities;
 
+			let nonPersisted = this.repository.getNonPersisted();
+			expect(_.isEqual(entity, nonPersisted[0])).to.be.true;
+			
+			nonPersisted = this.repository.getNonPersisted(entities);
 			expect(_.isEqual(entity, nonPersisted[0])).to.be.true;
 		});
 
@@ -648,6 +694,15 @@ describe('Repository Base', function() {
 			expect(_.isEqual(entity, deleted[0])).to.be.true;
 		});
 
+		it('getStaged', function() {
+			this.repository.setAutoSave(false);
+			const entity = this.repository.getByIx(0);
+			
+			entity.isStaged = true;	
+			const staged = this.repository.getStaged();
+			expect(_.isEqual(entity, staged[0])).to.be.true;
+		});
+
 		it('isInRepository, hasId', function() {
 			this.repository.setAutoSave(false);
 			const id = 1,
@@ -678,6 +733,9 @@ describe('Repository Base', function() {
 			this.repository.add({ value: 'six' });
 			
 			expect(didFire).to.be.true;
+
+			// TODO: Need comprehensive test of save(), not just event firing
+
 		});
 
 		it('save by entity', async function() {

package/package.json

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

package/src/Entity.js

@@ -117,6 +117,12 @@ class Entity extends EventEmitter {
 		 */
 		this.isDeleted = false;
 
+		/**
+		 * @member {boolean} isStaged - Whether this object has been marked for saving
+		 * @private
+		 */
+		this.isStaged = false;
+
 		/**
 		 * @member {boolean} isDestroyed - Whether this object has been destroyed
 		 * @private
@@ -165,12 +171,11 @@ class Entity extends EventEmitter {
 			throw Error('this._createMethods is no longer valid. Entity has been destroyed.');
 		}
 		const methodDefinitions = this.schema.entity.methods;
-		if (_.isEmpty(methodDefinitions)) {
-			return;
+		if (!_.isEmpty(methodDefinitions)) {
+			_.each(methodDefinitions, (method, name) => {
+				this[name] = method; // NOTE: Methods must be defined in schema as "function() {}", not as "() => {}" so "this" will be assigned correctly
+			});
 		}
-		_.each(methodDefinitions, (method, name) => {
-			this[name] = method; // NOTE: Methods must be defined in schema as "function() {}", not as "() => {}" so "this" will be assigned correctly
-		});
 	}
 
 	/**
@@ -774,6 +779,14 @@ class Entity extends EventEmitter {
 		return this.getIdProperty().isTempId;
 	}
 
+	/**
+	 * Marks this Entity's idProperty's isTempId field
+	 * @return {boolean} isTempId
+	 */
+	set isTempId(bool) {
+		this.getIdProperty().isTempId = bool;
+	}
+
 	/**
 	 * Gets the "Display" Property object for this Entity.
 	 * This is the Property whose value can easily identify the whole Entity itself.
@@ -1050,6 +1063,7 @@ class Entity extends EventEmitter {
 		this.getIdProperty().isTempId = false;
 		this._originalData = this._getReconstructedOriginalData();
 		this._originalDataParsed = this.getParsedValues();
+		this.markStaged(false);
 	}
 
 	/**
@@ -1095,6 +1109,24 @@ class Entity extends EventEmitter {
 		this.emit('undelete', this._proxy);
 	}
 
+	/**
+	 * Marks an entity as having been staged for saving.
+	 * @param {boolean} bool - How it should be marked. Defaults to true.
+	 */
+	markStaged = (bool = true) => {
+		if (this.isDestroyed) {
+			throw Error('this.markStaged is no longer valid. Entity has been destroyed.');
+		}
+		this.isStaged = bool;
+	}
+
+	/**
+	 * Convenience function.
+	 */
+	stage = () => {
+		this.markStaged(true);
+	}
+
 	/**
 	 * Destroy this object.
 	 * - Removes all circular references to parent objects

package/src/Repository/Ajax.js

@@ -238,9 +238,10 @@ class AjaxRepository extends Repository {
 			matches = name.match(re),
 			paramsToChange = isBaseParam ? this._baseParams : this._params;
 		
+		let first, second;
 		if (matches) { // name has array notation like 'conditions[username]'
-			const first = matches[1],
-				second = matches[2];
+			first = matches[1],
+			second = matches[2];
 			if (paramsToChange && !paramsToChange.hasOwnProperty(first)) {
 				paramsToChange[first] = [];
 			}

package/src/Repository/Repository.js

@@ -265,10 +265,28 @@ export default class Repository extends EventEmitter {
 			await this.sort();
 		}
 
+		this._createMethods();
+
 		this.isInitialized = true;
 		this.emit('initialize');
 	}
 
+	/**
+	 * Creates the methods for this Repository, based on Schema.
+	 * @private
+	 */
+	_createMethods = () => {
+		if (this.isDestroyed) {
+			throw Error('this._createMethods is no longer valid. Repository has been destroyed.');
+		}
+		const methodDefinitions = this.schema.repository.methods;
+		if (!_.isEmpty(methodDefinitions)) {
+			_.each(methodDefinitions, (method, name) => {
+				this[name] = method; // NOTE: Methods must be defined in schema as "function() {}", not as "() => {}" so "this" will be assigned correctly
+			});
+		}
+	}
+
 
 	//     __                    __
 	//    / /   ____  ____ _____/ /
@@ -1117,52 +1135,163 @@ export default class Repository extends EventEmitter {
 
 	/**
 	 * Get all phantom (unsaved) Entities
+	 * @param {array} entities - Array of entities to filter. Optional. Defaults to this.entities
 	 * @return {Entity[]} Array of phantom Entities, or []
 	 */
-	getPhantom = () => {
+	getPhantom = (entities = null) => {
 		if (this.isDestroyed) {
 			throw Error('this.getPhantom is no longer valid. Repository has been destroyed.');
 		}
-		return _.filter(this.entities, (entity) => entity.isPhantom);
+		if (!entities) {
+			entities = this.entities;
+		}
+		return _.filter(this.entities, entity => entity.isPhantom);
 	}
 
 	/**
 	 * Get all Entities not yet persisted to a storage medium
+	 * @param {array} entities - Array of entities to filter. Optional. Defaults to this.entities
 	 * @return {Entity[]} Array of dirty Entities, or []
 	 */
-	getNonPersisted = () => {
+	getNonPersisted = (entities = null) => {
 		if (this.isDestroyed) {
 			throw Error('this.getDirty is no longer valid. Repository has been destroyed.');
 		}
-		return _.filter(this.entities, (entity) => {
-			return !entity.isPersisted;
-		});
+		if (!entities) {
+			entities = this.entities;
+		}
+		return _.filter(this.entities, entity => !entity.isPersisted);
 	}
 
 	/**
 	 * Get all dirty (having unsaved changes) Entities
+	 * @param {array} entities - Array of entities to filter. Optional. Defaults to this.entities
 	 * @return {Entity[]} Array of dirty Entities, or []
 	 */
-	getDirty = () => {
+	getDirty = (entities = null) => {
 		if (this.isDestroyed) {
 			throw Error('this.getDirty is no longer valid. Repository has been destroyed.');
 		}
-		return _.filter(this.entities, (entity) => {
-			return entity.isDirty;
-		});
+		if (!entities) {
+			entities = this.entities;
+		}
+		return _.filter(entities, entity => entity.isDirty);
 	}
 
 	/**
 	 * Get all deleted Entities
+	 * @param {array} entities - Array of entities to filter. Optional. Defaults to this.entities
 	 * @return {Entity[]} Array of deleted Entities, or []
 	 */
-	getDeleted = () => {
+	getDeleted = (entities = null) => {
 		if (this.isDestroyed) {
 			throw Error('this.getDeleted is no longer valid. Repository has been destroyed.');
 		}
-		return _.filter(this.entities, (entity) => {
-			return entity.isDeleted;
-		});
+		if (!entities) {
+			entities = this.entities;
+		}
+		return _.filter(entities, entity => entity.isDeleted);
+	}
+
+	/**
+	 * Get all staged Entities
+	 * @param {array} entities - Array of entities to filter. Optional. Defaults to this.entities
+	 * @return {Entity[]} Array of deleted Entities, or []
+	 */
+	getStaged = (entities = null) => {
+		if (this.isDestroyed) {
+			throw Error('this.getStaged is no longer valid. Repository has been destroyed.');
+		}
+		if (!entities) {
+			entities = this.entities;
+		}
+		return _.filter(entities, entity => entity.isStaged);
+	}
+
+	/**
+	 * Gets the Schema object
+	 * @return {Schema} schema
+	 */
+	getSchema = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getSchema is no longer valid. Entity has been destroyed.');
+		}
+		return this.schema;
+	}
+
+	/**
+	 * 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 oneHatData = this.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;
+	}
+
+	/**
+	 * Gets the Schema object
+	 * @return {Schema} schema
+	 */
+	getSchema = () => {
+		if (this.isDestroyed) {
+			throw Error('this.getSchema is no longer valid. Entity has been destroyed.');
+		}
+		return this.schema;
+	}
+
+	/**
+	 * 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 oneHatData = this.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;
 	}
 
 	/**
@@ -1210,8 +1339,9 @@ export default class Repository extends EventEmitter {
 	 * this.entities until all operations have completed. We leave it to subclasses
 	 * to implement that.
 	 * @param {object} entity - Optional single entity to save (instead of doing a batch operation on everything)
+	 * @param {boolean} useStaged - Save only the staged items, not all
 	 */
-	save = async (entity = null) => {
+	save = async (entity = null, useStaged = false) => {
 		if (this.isDestroyed) {
 			throw Error('this.save is no longer valid. Repository has been destroyed.');
 		}
@@ -1254,6 +1384,9 @@ export default class Repository extends EventEmitter {
 				switch(operation) {
 					case 'add':
 						entities = this.getNonPersisted();
+						if (useStaged) {
+							entities = this.getStaged(entities);
+						}
 						if (_.size(entities) > 0) {
 							if (this.combineBatch) {
 
@@ -1278,6 +1411,9 @@ export default class Repository extends EventEmitter {
 						break;
 					case 'edit':
 						entities = this.getDirty();
+						if (useStaged) {
+							entities = this.getStaged(entities);
+						}
 						if (_.size(entities) > 0) {
 							if (this.combineBatch) {
 
@@ -1302,6 +1438,9 @@ export default class Repository extends EventEmitter {
 						break;
 					case 'delete':
 						entities = this.getDeleted();
+						if (useStaged) {
+							entities = this.getStaged(entities);
+						}
 						if (_.size(entities) > 0) {
 							if (this.combineBatch) {
 
@@ -1459,7 +1598,7 @@ export default class Repository extends EventEmitter {
 	 * Mainly used for phantom Entities
 	 * Helper for delete()
 	 */
-	 removeEntity = async (entity) => {
+	removeEntity = async (entity) => {
 		this.entities = _.filter(this.entities, e => e !== entity);
 		entity.destroy();
 	}