refactor: rename ensure<X> to assert<X>

Author: jankapunkt

index.js

@@ -20,10 +20,11 @@ const rules = {
 
 /**
  * Ensure the value is a string.
+ * @private
  * @param s {any} the value to be checked
  * @throws {TypeError} if the value is not a string
  */
-const ensureString = (s) => {
+const assertString = (s) => {
   const t = typeof s;
   if (t !== 'string') {
     throw new TypeError('Value must be a string');
@@ -45,7 +46,7 @@ const isFormat = {
    */
 
   nchar: function(value) {
-    ensureString(value);
+    assertString(value);
     return rules.NCHAR.test(value);
   },
 
@@ -58,7 +59,7 @@ const isFormat = {
    */
 
   nqchar: function(value) {
-    ensureString(value);
+    assertString(value);
     return rules.NQCHAR.test(value);
   },
 
@@ -71,7 +72,7 @@ const isFormat = {
    */
 
   nqschar: function(value) {
-    ensureString(value);
+    assertString(value);
     return rules.NQSCHAR.test(value);
   },
 
@@ -85,7 +86,7 @@ const isFormat = {
    */
 
   uchar: function(value) {
-    ensureString(value);
+    assertString(value);
     // manually test \u10000-\u10FFFF
     if (rules.UNICODECHARNOCRLF.test(value)) {
       return true;
@@ -102,7 +103,7 @@ const isFormat = {
    * @return {boolean} true, if valid, otherwise false
    */
   uri: function(value) {
-    ensureString(value);
+    assertString(value);
     return rules.URI.test(value);
   },
 
@@ -115,7 +116,7 @@ const isFormat = {
    */
 
   vschar: function(value) {
-    ensureString(value);
+    assertString(value);
     return rules.VSCHAR.test(value);
   }
 };

test/formats.test.js

@@ -17,7 +17,7 @@ function runRanges (ranges, fn, expected) {
   });
 }
 
-const ensureValidFormat = (fn) => {
+const assertValidFormat = (fn) => {
   const invalid = [null, undefined, 123, 0x00, Infinity, {}, [], true, false, () => {}, Symbol('test')];
   invalid.forEach(value => {
     try {
@@ -35,7 +35,7 @@ describe('Validator', function () {
 
   describe('is', function () {
     it('validates if a value matches a unicode character (nchar)', function () {
-      ensureValidFormat(isFormat.nchar);
+      assertValidFormat(isFormat.nchar);
 
       const validRanges = [
         [45, 46], // \u002D \u002E
@@ -60,7 +60,7 @@ describe('Validator', function () {
     });
 
     it('validates if a value matches a unicode character, including exclamation marks (nqchar)', function () {
-      ensureValidFormat(isFormat.nqchar);
+      assertValidFormat(isFormat.nqchar);
 
       const validRanges = [
         [33, 33], // \u0021
@@ -81,7 +81,7 @@ describe('Validator', function () {
     });
 
     it('validates if a value matches a unicode character, including exclamation marks and spaces (nqschar)', function () {
-      ensureValidFormat(isFormat.nqschar);
+      assertValidFormat(isFormat.nqschar);
 
       const validRanges = [
         [32, 33], // \u0020-\u0021
@@ -102,7 +102,7 @@ describe('Validator', function () {
     });
 
     it('validates if a value matches a unicode character excluding the carriage return and linefeed characters (uchar)', function () {
-      ensureValidFormat(isFormat.uchar);
+      assertValidFormat(isFormat.uchar);
 
       this.timeout(60000);
       const validRanges = [
@@ -127,7 +127,7 @@ describe('Validator', function () {
     });
 
     it('validates if a value matches generic URIs (uri)', function () {
-      ensureValidFormat(isFormat.uri);
+      assertValidFormat(isFormat.uri);
 
       ['aa:', 'http:', 'https:'].forEach(function (uri) {
         isFormat.uri(uri).should.equal(true);
@@ -141,7 +141,7 @@ describe('Validator', function () {
     });
 
     it('validates if a value matches against the printable set of unicode characters (vschar)', function () {
-      ensureValidFormat(isFormat.vschar);
+      assertValidFormat(isFormat.vschar);
 
       const validRanges = [
         [32, 126] // \u0020-\u007E