Merge pull request #4 from CodingCarlos/develop

Start with testing. Also, a lot of bugfixes.

Author: CodingCarlos

README.md

@@ -1,4 +1,10 @@
 # modelate
+![shieldsIO](https://img.shields.io/github/issues/CodingCarlos/modelate.svg)
+![shieldsIO](https://img.shields.io/github/release/CodingCarlos/modelate.svg)
+![shieldsIO](https://img.shields.io/github/license/CodingCarlos/modelate.svg)
+![shieldsIO](https://img.shields.io/david/CodingCarlos/modelate.svg)
+[![Build Status](https://travis-ci.org/CodingCarlos/modelate.svg?branch=master)](https://travis-ci.org/CodingCarlos/modelate)
+
 A data modeling tool for NodeJS. It's 100% database agnostic, and 100% customizable.
 
 # How does it work?
@@ -60,7 +66,7 @@ Check data length. It uses default .length param, so it's valid for so much type
 ```javascript
 {
 	length: {
-    eq: Number,		// Exact allowed value
+		eq: Number,		// Exact allowed value
 		max: Number,	// Maximum allowed value
 		min: Number		// Minimum allowed value
 	}
@@ -93,11 +99,11 @@ Use a custom function to check at your own criteria. The only necessary thing is
 The function might look like this: 
 ```javascript
 function is42(value) {
-  var allowed = [42, '42', 'cuarenta y dos', 'fourty two', 'the answer to the life the universe and everything'];
-  if(allowedValues.indexOf(value) === -1) {
-    return false;
-  }
-  return true;
+	var allowed = [42, '42', 'cuarenta y dos', 'fourty two', 'the answer to the life the universe and everything'];
+	if (allowedValues.indexOf(value) === -1) {
+		return false;
+	}
+	return true;
 }
 ```
 
@@ -145,13 +151,57 @@ var geopoint = Modelate('Geopoint').set({
 
 // Now, you can validate Geopoint objects ^^
 var myGeopoint = {
-	name: 'Batman Symbol'
+	name: 'Batman Symbol',
 	coords: {
 		lat: 26.357896,
 		long: 127.783809
 	}
-}
+};
 
 var batman = geopoint.modelate(myGeopoint);
 console.log(batman);
 ```
+
+# Tests
+
+I'm currently adding tests to this code. I'm using Jasmine, and saving tests in `/spec` folder.
+
+To run tests, just execute:
+```
+npm test
+```
+
+First time you run tests, you might need to install Jasmine, and other possible test dependencies. To do it fastly, just execute:
+```
+npm install
+```
+
+And now you can run tests ^^
+
+## Test coverage:
+Master version might not have the last test updates. Check out the `develop` branch to see the last updates. Also, the actual test coverage (in `develop` branch) is fully referenced in #3 issue.
+
+ - [ ] Core
+	 - [x] Exported module
+	 - [x] Model
+	 - [x] Modelate
+	 - [ ] Validate
+ - [ ] Validators
+	 - [ ] Type
+	 - [ ] Length
+	 - [ ] Value
+	 - [ ] Custom function
+	 - [ ] Date
+	 - [ ] Model
+
+# Contribute
+You can use this code as you like. If you find a bug, or want to ask for a feature, just open an issue, and we'll do our best. If you can fix it, do a pull request to dev branch, and we promise to review it as fast as possible to merge it.
+
+If you are new on this open source world, here is a short guide about how to make a pull request to contribute:
+
+ 1. Fork then clone `git clone git@github.com:your-username/modelate.git` **CodingCarlos/modelate** repository.
+ 2. Create a new branch in **your personal forked repo**, with a name similar to your edits, such as `fix-whatever`.
+ 3. Make your edits inside your new branch.
+ 4. Commit them and push them back to **your personal github fork**.
+ 5. Make a new Pull Request on the **CodingCarlos/modelate** repo. Point your branch to the `dev` `CodingCarlos/modelate`'s branch and submit.
+ 6. We will do my best to review and accept the code as soon as possible.

examples/chat.js

@@ -7,80 +7,78 @@ var userModel = {
 		type: 'string',
 		length: {		// For now, length do nothng.
 			max: 10,
-			min: 1
+			min: 1,
 		},
 		value: {
-			eq: 'Paco'
-		}
+			eq: 'Paco',
+		},
 	},
 	surname: {
 		type: 'string',
 		length: {		// For now, length do nothng.
 			max: 3,
-			min: 1
+			min: 1,
 		},
 		value: {
-			contains: 'os'
-		}
+			contains: 'os',
+		},
 	},
 	age: {
 		type: 'number',
 		value: {
 			max: 95,
-			min: 18
-		}
+			min: 18,
+		},
 	},
 	dni: {
 		type: 'string',
 		value: {
 			max: 95,
-			min: 18
+			min: 18,
 		},
 		func: function startOnFive(value) {
-			if(value.charAt(0) === '5') {
+			if (value.charAt(0) === '5') {
 				return true;
 			}
 
 			return false;
-		}
-	}
+		},
+	},
 };
-var User = Modelate('User').set(userModel);
+Modelate('User').set(userModel);
 
 // Modelate a user
 var myUserData = {
 	name: 'Paco',
 	surname: 'santos',
 	age: 19,
 	dni: '51402430A',
-	unexpected: 'property'
+	unexpected: 'property',
 };
-// var myUser = User.modelate(myUserData);
-// console.log(myUser);	
 
 var messageModel = {
 	user: {
 		type: 'object',
-		model: 'User'
+		model: 'User',
 	},
 	date: {
-		date: true
+		date: true,
 	},
 	message: {
 		type: 'string',
 		length: {
 			min: 1,
-			max: 255
-		}
-	}
+			max: 255,
+		},
+	},
 };
 var Message = Modelate('Message').set(messageModel);
 
 // Modelate a message
 var myMessageData = {
 	message: 'Using models inside models. Crazy.',
 	date: new Date(),
-	user: myUserData
+	user: myUserData,
 };
 var myMessage = Message.modelate(myMessageData);
-console.log(myMessage);	
+console.log(myMessage);

examples/user.js

@@ -6,51 +6,51 @@ var model = {
 		type: 'string',
 		length: {		// For now, length do nothng.
 			max: 10,
-			min: 1
+			min: 1,
 		},
 		value: {
-			eq: 'Paco'
-		}
+			eq: 'Paco',
+		},
 	},
 	surname: {
 		type: 'string',
 		length: {		// For now, length do nothng.
 			max: 3,
-			min: 1
+			min: 1,
 		},
 		value: {
-			contains: 'os'
-		}
+			contains: 'os',
+		},
 	},
 	age: {
 		type: 'number',
 		value: {
 			max: 95,
-			min: 18
-		}
+			min: 18,
+		},
 	},
 	dni: {
 		type: 'string',
 		value: {
 			max: 95,
-			min: 18
+			min: 18,
 		},
 		func: function startOnFive(value) {
-			if(value.charAt(0) === '5') {
+			if (value.charAt(0) === '5') {
 				return true;
 			}
 
 			return false;
-		}
-	}
+		},
+	},
 };
 var user = Modelate('User').set(model);
 
 var data = {
 	name: 'Paco',
 	surname: 'santos',
 	age: 19,
-	dni: '51402430A'
+	dni: '51402430A',
 };
 var result = user.modelate(data);
 

lib/model.js

@@ -1,21 +1,26 @@
 const models = {};
 
-function model(data) {
+function model(data, modelName) {
+	if(!data || (!this.modelName && !modelName) || typeof data !== 'object') {
+		return this;
+	}
+
 	// ToDo: Validate model
 	// ToDo: Check if model already exists to merge instead of set
-	
-	models[this.modelName] = data;
+	var name = this.modelName || modelName;
+	models[name] = data;
 
 	return this;
 }
 
-function get() {
-	return models[this.modelName];
+function get(modelName) {
+	var name = this.modelName || modelName;
+	return models[name] || {};
 }
 
 
 module.exports = {
 	models: models,
 	add: model,
-	get: get
+	get: get,
 };

lib/modelate.js

@@ -8,17 +8,17 @@ const validate = require('./validate').check;
  *	Options might be:
  *	 - model: {Object} A model to use (instead of this.modelName)
  *	@param data {Object} The data to validate
- *	@param opts {Object} Options for the modelate. 
+ *	@param opts {Object} Options for the modelate.
  */
 function modelate(data, opts) {
-	if (!this.modelName && opts && !opts.model) {
+	if ((!this.modelName && !(opts && !opts.model)) || !data || typeof data !== 'object') {
 		return {};
 	}
 
-	const model = opts && opts.model || models[this.modelName];
-	const result = util.clone(model);
+	const model = (opts && opts.model) || models[this.modelName];
+	const result = util.clone(model) || {};
 
-	for (let prop in model) {
+	for (const prop in model) {
 		if (validate(data[prop], model[prop])) {
 			result[prop] = data[prop];
 		} else {