fix: rename union and intersection, remove odds and ends

Author: jedwards1211

README.md

@@ -35,8 +35,8 @@ The validation errors are detailed. Adapted from the brilliant work in `flow-run
     - [`t.object`](#tobject)
     - [`t.record(t.string(), t.number())`](#trecordtstring-tnumber)
     - [`t.tuple(t.string(), t.number())`](#ttupletstring-tnumber)
-    - [`t.intersection(A, B)`](#tintersectiona-b)
-    - [`t.union(t.string(), t.number())`](#tuniontstring-tnumber)
+    - [`t.allOf(A, B)`](#tallofa-b)
+    - [`t.oneOf(t.string(), t.number())`](#toneoftstring-tnumber)
     - [`t.alias(name, type)`](#taliasname-type)
     - [`t.ref(() => typeAlias)`](#tref--typealias)
   - [`t.Type<T>`](#ttype)
@@ -264,20 +264,20 @@ A validator that requires the value to be `Record<string, number>`.
 A validator that requires the value to be `[string, number]`.
 Accepts a variable number of arguments.
 
-### `t.intersection(A, B)`
+### `t.allOf(A, B)`
 
 A validator that requires the value to be `A & B`. Accepts a variable number of arguments, though type generation is only overloaded up to 8 arguments. For example:
 
 ```ts
 const ThingType = t.simpleObject({ name: t.string() })
 const CommentedType = t.simpleObject({ comment: t.string() })
 
-const CommentedThingType = t.intersection(ThingType, CommentedType)
+const CommentedThingType = t.allOf(ThingType, CommentedType)
 
 CommentedThingType.assert({ name: 'foo', comment: 'sweet' })
 ```
 
-### `t.union(t.string(), t.number())`
+### `t.oneOf(t.string(), t.number())`
 
 A validator that requires the value to be `string | number`. Accepts a variable number of arguments, though type generation is only overloaded up to 8 arguments.
 

src/Validation.ts

@@ -1,25 +1,26 @@
 import Type from './types/Type'
-import makeJSONError from './errorReporting/makeJSONError'
 import { weakSetAdd, weakSetDelete, weakSetHas } from './cyclic'
 
 export type IdentifierPath = Array<string | number | symbol>
 
 export type ErrorTuple = [IdentifierPath, string, Type<any>]
 
 export default class Validation<T> {
-  input: T
+  readonly input: T
 
-  path: IdentifierPath = []
+  readonly path: IdentifierPath = []
 
-  prefix = ''
+  readonly prefix: string
 
-  errors: ErrorTuple[] = []
+  readonly errors: ErrorTuple[] = []
 
   // Tracks whether we're in validation of cyclic objects.
   cyclic: WeakMap<Type<any>, WeakSet<any>> = new WeakMap()
 
-  constructor(input: T) {
+  constructor(input: T, prefix = '', path?: IdentifierPath) {
     this.input = input
+    this.prefix = prefix
+    if (path) this.path.push(...path)
   }
 
   inCycle(type: Type<any>, input: any): boolean {
@@ -47,52 +48,8 @@ export default class Validation<T> {
     }
   }
 
-  hasErrors(path?: IdentifierPath): boolean {
-    if (path) {
-      for (const [candidate] of this.errors) {
-        if (matchPath(path, candidate)) {
-          return true
-        }
-      }
-      return false
-    } else {
-      return this.errors.length > 0
-    }
-  }
-
-  addError(
-    path: IdentifierPath,
-    expectedType: Type<any>,
-    message: string
-  ): this {
-    this.errors.push([path, message, expectedType])
-    return this
-  }
-
-  clearError(path: IdentifierPath | null | undefined): boolean {
-    let didClear = false
-    if (path) {
-      const errors = []
-      for (const error of this.errors) {
-        if (matchPath(path, error[0])) {
-          didClear = true
-        } else {
-          errors.push(error)
-        }
-      }
-      this.errors = errors
-    } else {
-      didClear = this.errors.length > 0
-      this.errors = []
-    }
-    return didClear
-  }
-
-  resolvePath(path: IdentifierPath): any {
-    return resolvePath(this.input, path)
-  }
-  toJSON(): any {
-    return makeJSONError(this)
+  hasErrors(): boolean {
+    return this.errors.length > 0
   }
 }
 
@@ -141,19 +98,3 @@ export function resolvePath(input: any, path: IdentifierPath): any {
   }
   return subject
 }
-
-export function matchPath(
-  path: IdentifierPath,
-  candidate: IdentifierPath
-): boolean {
-  const { length } = path
-  if (length > candidate.length) {
-    return false
-  }
-  for (let i = 0; i < length; i++) {
-    if (candidate[i] !== path[i]) {
-      return false
-    }
-  }
-  return true
-}

src/intersection.spec.ts renamed to src/allOf.spec.ts

@@ -2,8 +2,8 @@ import * as t from './'
 import { expect } from 'chai'
 import dedent from 'dedent-js'
 
-describe(`t.intersection`, function() {
-  const ObjectIntersection = t.intersection(
+describe(`t.allOf`, function() {
+  const ObjectIntersection = t.allOf(
     t.simpleObject({ foo: t.number() }, { exact: false }),
     t.simpleObject({ bar: t.string() }, { exact: false })
   )

src/errorMessages.ts

@@ -25,6 +25,7 @@ const errorMessages = {
   ERR_EXPECT_SYMBOL: 'must be a symbol',
   ERR_EXPECT_THIS: 'must be exactly this',
   ERR_EXPECT_VOID: 'must be undefined',
+  ERR_EXPECT_LENGTH: 'must have length of $0',
   ERR_INVALID_DATE: 'must be a valid date',
   ERR_MISSING_PROPERTY: 'must have property: $0',
   ERR_NO_INDEXER: 'is not one of the permitted indexer types',

src/errorReporting/keyToString.spec.ts

@@ -0,0 +1,15 @@
+import { keyToString } from './keyToString'
+import { expect } from 'chai'
+
+describe(`keyToString`, function() {
+  it(`formats symbol correctly`, function() {
+    expect(keyToString(Symbol('foo'))).to.equal('[Symbol(foo)]')
+  })
+  it(`formats number correctly`, function() {
+    expect(keyToString(2)).to.equal('2')
+  })
+  it(`formats non-identifiers correctly`, function() {
+    expect(keyToString('2pac')).to.equal('"2pac"')
+    expect(keyToString('-foobus-')).to.equal('"-foobus-"')
+  })
+})

src/errorReporting/keyToString.ts

@@ -0,0 +1,11 @@
+export function keyToString(key: string | number | symbol): string {
+  switch (typeof key) {
+    case 'symbol':
+      return `[${String(key)}]`
+    case 'number':
+      return String(key)
+    case 'string':
+      if (/^[_a-z][_a-z0-9]*$/i.test(key)) return key
+  }
+  return JSON.stringify(key)
+}

src/errorReporting/makeJSONError.ts

@@ -1,14 +1,4 @@
-export function keyToString(key: string | number | symbol): string {
-  switch (typeof key) {
-    case 'symbol':
-      return `[${String(key)}]`
-    case 'number':
-      return String(key)
-    case 'string':
-      if (/^[_a-z][_a-z0-9]*$/i.test(key)) return key
-  }
-  return JSON.stringify(key)
-}
+import { keyToString } from './keyToString'
 
 export default function typeOf(value: any): string {
   if (value == null) return String(value)

src/errorReporting/makeWarningMessage.ts

@@ -54,7 +54,7 @@ const DeployConfigType = t.object<{
    * The subnet ids for the Vpc.  Defaults to all available for VpcId
    */
 
-  Redis: t.union(
+  Redis: t.oneOf(
     t.object<{
       Type: any
       Host: any
@@ -73,7 +73,7 @@ const DeployConfigType = t.object<{
       AvailabilityZone: t.string(),
     })
   ),
-  DB: t.union(
+  DB: t.oneOf(
     t.object<{
       Type: any
       Host: any
@@ -235,7 +235,7 @@ const DeployConfigType = t.object<{
       LambdaFunctionName: t.optionalNullOr(t.string()),
     })
   ),
-  CloudFormationTemplateBucket: t.optionalNullOr(t.union(t.string(), t.null())),
+  CloudFormationTemplateBucket: t.optionalNullOr(t.oneOf(t.string(), t.null())),
   JCoreIOLink: t.optionalNullOr(t.string()),
   Superadmin: t.optionalNullOr(
     t.object<{