Merge 0a8702a into d5e88f2

talyssonoc · Aug 27, 2019 · e140408 · e140408
2 parents d5e88f2 + 0a8702a
commit e140408
Show file tree

Hide file tree

Showing 70 changed files with 1,194 additions and 977 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -4,19 +4,21 @@
     "es6": true,
     "mocha": true
   },
-  "extends": "eslint:recommended",
-  "plugins": [
-    "mocha"
-  ],
+  "extends": ["eslint:recommended", "prettier"],
+  "plugins": ["mocha"],
   "rules": {
     "comma-spacing": ["error", { "before": false, "after": true }],
     "complexity": ["error", 4],
     "indent": ["error", 2],
     "linebreak-style": ["error", "unix"],
-    "object-shorthand": ["error", "always", { "avoidQuotes": true,  "avoidExplicitReturnArrows": true }],
+    "object-shorthand": [
+      "error",
+      "always",
+      { "avoidQuotes": true, "avoidExplicitReturnArrows": true }
+    ],
     "mocha/no-exclusive-tests": "error",
     "mocha/no-skipped-tests": "error",
-    "quotes": ["error", "single"],
+    "quotes": ["error", "single", { "avoidEscape": true }],
     "semi": ["error", "always"]
   }
 }
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1 @@
+/dist
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,8 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true,
+  "arrowParens": "always",
+  "endOfLine": "lf"
+}
diff --git a/dist/structure.js b/dist/structure.js
@@ -304,7 +304,10 @@ return /******/ (function(modules) { // webpackBootstrap
 
 	    joiSchema = equalOption(typeDescriptor, { initial: joiSchema });
 
-	    return mapToJoi(typeDescriptor, { initial: joiSchema, mappings: this.joiMappings });
+	    return mapToJoi(typeDescriptor, {
+	      initial: joiSchema,
+	      mappings: this.joiMappings
+	    });
 	  }
 	};
 
@@ -447,7 +450,10 @@ return /******/ (function(modules) { // webpackBootstrap
 
 	    joiSchema = equalOption(typeDescriptor, { initial: joiSchema });
 
-	    return mapToJoi(typeDescriptor, { initial: joiSchema, mappings: this.joiMappings });
+	    return mapToJoi(typeDescriptor, {
+	      initial: joiSchema,
+	      mappings: this.joiMappings
+	    });
 	  }
 	};
 
@@ -471,7 +477,10 @@ return /******/ (function(modules) { // webpackBootstrap
 
 	    joiSchema = equalOption(typeDescriptor, { initial: joiSchema });
 
-	    return mapToJoi(typeDescriptor, { initial: joiSchema, mappings: this.joiMappings });
+	    return mapToJoi(typeDescriptor, {
+	      initial: joiSchema,
+	      mappings: this.joiMappings
+	    });
 	  }
 	};
 
@@ -500,7 +509,10 @@ return /******/ (function(modules) { // webpackBootstrap
 
 	    joiSchema = equalOption(typeDescriptor, { initial: joiSchema });
 
-	    return mapToJoi(typeDescriptor, { initial: joiSchema, mappings: this.joiMappings });
+	    return mapToJoi(typeDescriptor, {
+	      initial: joiSchema,
+	      mappings: this.joiMappings
+	    });
 	  }
 	};
 
@@ -594,7 +606,10 @@ return /******/ (function(modules) { // webpackBootstrap
 
 	  joiSchema = joiSchema.sparse(canBeSparse);
 
-	  joiSchema = mapToJoi(typeDescriptor, { initial: joiSchema, mappings: joiMappings });
+	  joiSchema = mapToJoi(typeDescriptor, {
+	    initial: joiSchema,
+	    mappings: joiMappings
+	  });
 
 	  return joiSchema;
 	};
@@ -841,25 +856,28 @@ return /******/ (function(modules) { // webpackBootstrap
 
 	'use strict';
 
-	module.exports = {
-	  classAsSecondParam: function classAsSecondParam(ErroneousPassedClass) {
-	    return new Error('You passed the structure class as the second parameter of attributes(). The expected usage is `attributes(schema)(' + (ErroneousPassedClass.name || 'StructureClass') + ')`.');
-	  },
-	  nonObjectAttributes: function nonObjectAttributes() {
-	    return new TypeError('#attributes can\'t be set to a non-object.');
-	  },
-	  arrayOrIterable: function arrayOrIterable() {
-	    return new TypeError('Value must be iterable or array-like.');
-	  },
-	  missingDynamicType: function missingDynamicType(attributeName) {
-	    return new Error('Missing dynamic type for attribute: ' + attributeName + '.');
-	  },
-	  invalidType: function invalidType(attributeName) {
-	    return new TypeError('Attribute type must be a constructor or the name of a dynamic type: ' + attributeName + '.');
-	  },
-	  invalidAttributes: function invalidAttributes(errors, StructureValidationError) {
-	    return new StructureValidationError(errors);
-	  }
+	exports.classAsSecondParam = function (ErroneousPassedClass) {
+	  return new Error('You passed the structure class as the second parameter of attributes(). The expected usage is `attributes(schema)(' + (ErroneousPassedClass.name || 'StructureClass') + ')`.');
+	};
+
+	exports.nonObjectAttributes = function () {
+	  return new TypeError("#attributes can't be set to a non-object.");
+	};
+
+	exports.arrayOrIterable = function () {
+	  return new TypeError('Value must be iterable or array-like.');
+	};
+
+	exports.missingDynamicType = function (attributeName) {
+	  return new Error('Missing dynamic type for attribute: ' + attributeName + '.');
+	};
+
+	exports.invalidType = function (attributeName) {
+	  return new TypeError('Attribute type must be a constructor or the name of a dynamic type: ' + attributeName + '.');
+	};
+
+	exports.invalidAttributes = function (errors, StructureValidationError) {
+	  return new StructureValidationError(errors);
 	};
 
 /***/ },

diff --git a/package.json b/package.json
@@ -36,7 +36,8 @@
     "lint": "eslint {src,test,benchmark}/**/*.js",
     "benchmark": "node benchmark/benchmark.js",
     "prepublish": "npm run build",
-    "coveralls": "npm run coverage && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"
+    "coveralls": "npm run coverage && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage",
+    "format": "prettier --write {src,test}/**/*.js"
   },
   "dependencies": {
     "joi": "^10.2.0",
@@ -52,6 +53,7 @@
     "chai": "^4.1.2",
     "coveralls": "^2.11.15",
     "eslint": "^4.19.1",
+    "eslint-config-prettier": "^6.1.0",
     "eslint-plugin-mocha": "^5.0.0",
     "istanbul": "^0.4.5",
     "joi-browser": "^10.0.6",
@@ -63,6 +65,7 @@
     "karma-sourcemap-loader": "^0.3.7",
     "karma-webpack": "^2.0.1",
     "mocha": "^3.1.0",
+    "prettier": "^1.18.2",
     "proxy-polyfill": "^0.1.6",
     "sinon": "^7.2.4",
     "webpack": "^1.13.3"

diff --git a/src/attributes/decorator.js b/src/attributes/decorator.js
@@ -7,13 +7,13 @@ const Errors = require('../errors');
 const { SCHEMA } = require('../symbols');
 const {
   attributeDescriptorFor,
-  attributesDescriptorFor
+  attributesDescriptorFor,
 } = require('./descriptors');
 
 const define = Object.defineProperty;
 
 function attributesDecorator(schema, schemaOptions = {}) {
-  if(typeof schemaOptions !== 'object') {
+  if (typeof schemaOptions !== 'object') {
     throw Errors.classAsSecondParam(schemaOptions);
   }
 
@@ -26,34 +26,44 @@ function attributesDecorator(schema, schemaOptions = {}) {
         Initialization.initialize(schema, passedAttributes, instance);
 
         return instance;
-      }
+      },
     });
 
-    define(WrapperClass, 'buildStrict', StrictMode.buildStrictDescriptorFor(WrapperClass, schemaOptions));
+    define(WrapperClass, 'buildStrict', StrictMode.buildStrictDescriptorFor(
+      WrapperClass,
+      schemaOptions
+    ));
 
-    if(WrapperClass[SCHEMA]) {
+    if (WrapperClass[SCHEMA]) {
       schema = Object.assign({}, WrapperClass[SCHEMA], schema);
     }
 
     schema = Schema.normalize(schema, schemaOptions);
 
     define(WrapperClass, SCHEMA, {
-      value: schema
+      value: schema,
     });
 
     define(WrapperClass, 'validate', Validation.staticDescriptorFor(schema));
 
     define(WrapperClass.prototype, SCHEMA, {
-      value: schema
+      value: schema,
     });
 
-    define(WrapperClass.prototype, 'attributes', attributesDescriptorFor(schema));
+    define(WrapperClass.prototype, 'attributes', attributesDescriptorFor(
+      schema
+    ));
 
     Object.keys(schema).forEach((attr) => {
-      define(WrapperClass.prototype, attr, attributeDescriptorFor(attr, schema));
+      define(WrapperClass.prototype, attr, attributeDescriptorFor(
+        attr,
+        schema
+      ));
     });
 
-    define(WrapperClass.prototype, 'validate', Validation.descriptorFor(schema));
+    define(WrapperClass.prototype, 'validate', Validation.descriptorFor(
+      schema
+    ));
 
     define(WrapperClass.prototype, 'toJSON', Serialization.descriptor);
 

diff --git a/src/attributes/descriptors.js b/src/attributes/descriptors.js
@@ -2,7 +2,10 @@ const { isObject } = require('lodash');
 const Errors = require('../errors');
 const { ATTRIBUTES } = require('../symbols');
 
-exports.attributeDescriptorFor = function attributeDescriptorFor(attributeName, schema) {
+exports.attributeDescriptorFor = function attributeDescriptorFor(
+  attributeName,
+  schema
+) {
   return {
     enumerable: true,
 
@@ -12,7 +15,7 @@ exports.attributeDescriptorFor = function attributeDescriptorFor(attributeName,
 
     set(value) {
       this.attributes[attributeName] = schema[attributeName].coerce(value);
-    }
+    },
   };
 };
 
@@ -23,24 +26,24 @@ exports.attributesDescriptorFor = function attributesDescriptorFor(schema) {
     },
 
     set(newAttributes) {
-      if(!isObject(newAttributes)) {
+      if (!isObject(newAttributes)) {
         throw Errors.nonObjectAttributes();
       }
 
       const attributes = coerceAttributes(newAttributes, schema);
 
       Object.defineProperty(this, ATTRIBUTES, {
         configurable: true,
-        value: attributes
+        value: attributes,
       });
-    }
+    },
   };
 };
 
 function coerceAttributes(newAttributes, schema) {
   const attributes = Object.create(null);
 
-  for(let attrName in schema) {
+  for (let attrName in schema) {
     attributes[attrName] = schema[attrName].coerce(newAttributes[attrName]);
   }
 

diff --git a/src/coercion/array.js b/src/coercion/array.js
@@ -3,7 +3,7 @@ const getType = require('../typeResolver');
 
 module.exports = function arrayCoercionFor(typeDescriptor, itemTypeDescriptor) {
   return function coerceArray(rawValue) {
-    if(rawValue === undefined) {
+    if (rawValue === undefined) {
       return;
     }
 
@@ -18,7 +18,7 @@ module.exports = function arrayCoercionFor(typeDescriptor, itemTypeDescriptor) {
 };
 
 function validateIfIterable(value) {
-  if(!isIterable(value)) {
+  if (!isIterable(value)) {
     throw Errors.arrayOrIterable();
   }
 }
@@ -28,7 +28,7 @@ function isIterable(value) {
 }
 
 function extractItems(iterable) {
-  if(!Array.isArray(iterable) && iterable[Symbol.iterator]) {
+  if (!Array.isArray(iterable) && iterable[Symbol.iterator]) {
     return Array(...iterable);
   }
 
@@ -41,7 +41,7 @@ function createInstance(typeDescriptor) {
 }
 
 function fillInstance(instance, items, itemTypeDescriptor) {
-  for(let i = 0; i < items.length; i++) {
+  for (let i = 0; i < items.length; i++) {
     instance.push(coerceItem(itemTypeDescriptor, items[i]));
   }
 

diff --git a/src/coercion/boolean.js b/src/coercion/boolean.js
@@ -6,5 +6,5 @@ module.exports = {
   nullValue: false,
   coerce(value) {
     return this.type(value);
-  }
+  },
 };
diff --git a/src/coercion/coercion.js b/src/coercion/coercion.js
@@ -1,22 +1,20 @@
 const { isFunction, curryRight } = require('lodash');
 
-exports.execute = curryRight(
-  function(value, coercion, typeDescriptor) {
-    if(value === undefined) {
-      return;
-    }
-
-    if (value === null) {
-      return getNullableValue(coercion, typeDescriptor);
-    }
+exports.execute = curryRight(function(value, coercion, typeDescriptor) {
+  if (value === undefined) {
+    return;
+  }
 
-    if (coercion.isCoerced(value, typeDescriptor)) {
-      return value;
-    }
+  if (value === null) {
+    return getNullableValue(coercion, typeDescriptor);
+  }
 
-    return coercion.coerce(value, typeDescriptor);
+  if (coercion.isCoerced(value, typeDescriptor)) {
+    return value;
   }
-);
+
+  return coercion.coerce(value, typeDescriptor);
+});
 
 function getNullableValue(coercion, typeDescriptor) {
   return needsNullableInitialization(typeDescriptor)
@@ -29,5 +27,7 @@ function needsNullableInitialization(typeDescriptor) {
 }
 
 function getNullValue(coercion) {
-  return isFunction(coercion.nullValue) ? coercion.nullValue() : coercion.nullValue;
+  return isFunction(coercion.nullValue)
+    ? coercion.nullValue()
+    : coercion.nullValue;
 }
diff --git a/src/coercion/date.js b/src/coercion/date.js
@@ -6,5 +6,5 @@ module.exports = {
   nullValue: () => new Date(null),
   coerce(value) {
     return new this.type(value);
-  }
+  },
 };
diff --git a/src/coercion/generic.js b/src/coercion/generic.js
@@ -8,5 +8,5 @@ module.exports = {
     const type = getType(typeDescriptor);
 
     return new type(value);
-  }
+  },
 };