improve error message

Author: ecarriou

src/log.js

@@ -200,7 +200,9 @@ exports.invalidClassName = function invalidClassName(
  * @description Missing a property
  */
 exports.missingProperty = function missingProperty(propertyName) {
-  getLogger().warn("missing property '" + propertyName + "'");
+  getLogger().warn(
+    "missing property '" + propertyName + "' for a schema or a model"
+  );
 };
 
 /**
@@ -236,11 +238,7 @@ exports.invalidTypeImp = function invalidTypeImp(property, className) {
  */
 exports.missingPropertyImp = function missingPropertyImp(property, className) {
   getLogger().warn(
-    "missing property '" +
-      property +
-      "' for the definition of '" +
-      className +
-      "'"
+    "missing property '" + property + "' in the model '" + className + "'"
   );
 };
 
@@ -614,7 +612,7 @@ exports.behaviorNotUnique = function behaviorNotUnique(id, stateName) {
  */
 exports.invalidStateOn = function invalidStateOn(id, stateName) {
   getLogger().warn(
-    "try to add a behavior with an unkwown state '" +
+    "try to add a behavior to an unkwown state '" +
       stateName +
       "' on class '" +
       id +
@@ -715,7 +713,7 @@ exports.invalidChannelEvent = function invalidChannelEvent(
  * @param {String} id id of the component
  * @param {String} className class name of the component
  * @param {String} methodName name of the component
- * @description invalid parameter number for an action add with on method
+ * @description invalid parameter number for a behavior add with 'on' method
  */
 exports.invalidParamNumberMethodOn = function invalidParamNumberMethodOn(
   id,
@@ -728,7 +726,7 @@ exports.invalidParamNumberMethodOn = function invalidParamNumberMethodOn(
     classInfo = " (class '" + className + "')";
   }
   getLogger().warn(
-    "invalid number of parameters when adding an action on method '" +
+    "invalid number of parameters when adding a behavior on method '" +
       methodName +
       "' on component '" +
       id +
@@ -781,7 +779,11 @@ exports.invalidUseOfComponent = function invalidUseOfComponent(id) {
  * @description Try to add an invalid schema
  */
 exports.invalidSchema = function invalidSchema(name) {
-  getLogger().warn("the schema '" + name + "' is not valid");
+  getLogger().warn(
+    "the schema '" +
+      name +
+      "' is not valid, it has been removed from the metamodel"
+  );
 };
 
 /**
@@ -790,7 +792,11 @@ exports.invalidSchema = function invalidSchema(name) {
  * @description Try to add an invalid model
  */
 exports.invalidModel = function invalidModel(name) {
-  getLogger().warn("the model '" + name + "' is not valid");
+  getLogger().warn(
+    "the model '" +
+      name +
+      "' is not valid, it has been removed from the metamodel"
+  );
 };
 
 /**
@@ -1031,6 +1037,25 @@ exports.actionInvokeError = function actionInvokeError(
   }
 };
 
+/**
+ * @method invalidSchemaPropertyName
+ * @param {String} name name of the schema
+ * @param {String} propName name of the property
+ * @description Invalid name for the property of a schema
+ */
+exports.invalidSchemaPropertyName = function invalidSchemaPropertyName(
+  name,
+  propName
+) {
+  getLogger().warn(
+    "invalid name '" +
+      propName +
+      "' for schema '" +
+      name +
+      "': a name do not begin with '_'"
+  );
+};
+
 /**
  * @method invalidSchemaProperty
  * @param {String} name name of the schema

src/metamodel.js

@@ -52,6 +52,14 @@ var PROPERTY_TYPE = 'property';
 var LINK_TYPE = 'link';
 var COLLECTION_TYPE = 'collection';
 var internalTypes = ['property', 'collection', 'link', 'method', 'event'];
+var internalNames = [
+  '_id',
+  '_name',
+  '_inherit',
+  '_description',
+  '_class',
+  '_core'
+];
 var defaultTypes = [
   'boolean',
   'string',
@@ -76,6 +84,21 @@ var store = {
 
 /* Private methods */
 
+/**
+ * @method isInternalName
+ * @param {String} name
+ * @private
+ * @description is name an internal name
+ */
+function isInternalName(name) {
+  var result = true;
+
+  if (internalNames.indexOf(name) === -1) {
+    result = false;
+  }
+  return result;
+}
+
 /**
  * @method generateModels
  * @private
@@ -129,6 +152,13 @@ function generateModels() {
       model._description = schema._description;
     }
 
+    // check valid name
+    for (att in schema) {
+      if (!isInternalName(att) && att.indexOf('_') === 0) {
+        $log.invalidSchemaPropertyName(schema._name, att);
+      }
+    }
+
     //  set model default values
     for (att in schema) {
       switch (true) {
@@ -188,7 +218,7 @@ function generateModels() {
           };
           break;
         default:
-          if (att.indexOf('_') !== 0) {
+          if (!isInternalName(att)) {
             $log.invalidSchemaProperty(schema._name, att);
           }
           break;
@@ -1070,18 +1100,17 @@ function merge(source, target, all) {
 
 /**
  * @method schema
- * @param {JSON} importedSchema schema to add
- * @description Add a new schema
+ * @param {JSON} schema schema
+ * @description Add a new schema to the metamodel
  */
-exports.schema = function schema(importedSchema) {
+exports.schema = function schema(schema) {
   var id = null;
   var result = [];
-  var schema = null;
   var name = '';
   var mergedSchema = {};
   var schemas = [];
 
-  schema = JSON.parse(JSON.stringify(importedSchema));
+  schema = JSON.parse(JSON.stringify(schema));
   name = schema[NAME];
 
   if (typeof schema[ID] === 'undefined') {
@@ -1141,19 +1170,18 @@ exports.schema = function schema(importedSchema) {
 
 /**
  * @method model
- * @param {JSON} importedModel model to add
- * @description Add a new model
+ * @param {JSON} model model
+ * @description Add a new model to the metamodel
  */
-exports.model = function model(importedModel) {
-  var model = null;
+exports.model = function model(model) {
   var id = null;
   var result = [];
   var inherit = '';
   var name = '';
   var mergedModel = {};
   var models = [];
 
-  model = JSON.parse(JSON.stringify(importedModel));
+  model = JSON.parse(JSON.stringify(model));
   name = model[NAME];
 
   if (typeof model[ID] === 'undefined') {