add TypeSpec::toString() and a bunch of unit tests to go along with it (#34)

* add TypeSpec::toString()

Tests still in progress; many specs don't have tests yet.

* Update FIXME codes

* Make coerce(coerce(x)) a no-op for Maps

* Add Vector test, based on Map test; fix bugs

* SetSpec::toString() and don't change in coerceType if unneeded

* Require 4.30, test on 4.30 and latest LTS

* add tests for dict, keyset, and vec

* Use fully-qualified name of dict/keyset/vec in toString()

Otherwise they need to special-cased in any codegen in a namespace;
using the fully-qualified name allows simply prefixing them with a `\` -
however codegen can choose to special-case them for readability rather
than being required to special-case for correctness.

* use Traversable::class

* Fix and test ShapeSpec

also fix up KeyedTraversableSpec while I'm here

Author: fredemmott

.travis.yml

@@ -2,7 +2,8 @@ sudo: required
 language: generic
 services: docker
 env:
-- HHVM_VERSION=4.20-latest
+- HHVM_VERSION=4.30-latest
+- HHVM_VERSION=4.32-latest
 - HHVM_VERSION=latest
 - HHVM_VERSION=nightly
 install:

composer.json

@@ -4,7 +4,7 @@
   "license": "MIT",
   "keywords": ["hack", "TypeAssert" ],
   "require": {
-    "hhvm": "^4.20",
+    "hhvm": "^4.30",
     "hhvm/hsl": "^4.0"
   },
   "extra": {

src/TypeSpec.hack

@@ -15,6 +15,7 @@ abstract class TypeSpec<+T> {
 
   abstract public function coerceType(mixed $value): T;
   abstract public function assertType(mixed $value): T;
+  abstract public function toString(): string;
 
   public function isOptional(): bool {
     return false;

src/TypeSpec/__Private/ArrayKeySpec.hack

@@ -15,4 +15,9 @@ final class ArrayKeySpec extends UnionSpec<arraykey> {
   public function __construct() {
     parent::__construct('arraykey', new StringSpec(), new IntSpec());
   }
+
+  <<__Override>>
+  public function toString(): string {
+    return 'arraykey';
+  }
 }

src/TypeSpec/__Private/BoolSpec.hack

@@ -35,4 +35,9 @@ final class BoolSpec extends TypeSpec<bool> {
     }
     throw IncorrectTypeException::withValue($this->getTrace(), 'bool', $value);
   }
+
+  <<__Override>>
+  public function toString(): string {
+    return 'bool';
+  }
 }

src/TypeSpec/__Private/ClassnameSpec.hack

@@ -28,4 +28,9 @@ final class ClassnameSpec<Tinner, T as classname<Tinner>> extends TypeSpec<T> {
     throw
       IncorrectTypeException::withValue($this->getTrace(), $this->what, $value);
   }
+
+  <<__Override>>
+  public function toString(): string {
+    return 'classname<\\'.$this->what.'>';
+  }
 }

src/TypeSpec/__Private/DictLikeArraySpec.hack

@@ -13,7 +13,7 @@ namespace Facebook\TypeSpec\__Private;
 use type Facebook\TypeAssert\{IncorrectTypeException, TypeCoercionException};
 use type Facebook\TypeSpec\TypeSpec;
 
-use namespace HH\Lib\Dict;
+use namespace HH\Lib\{Dict, Str};
 
 final class DictLikeArraySpec<Tk as arraykey, Tv>
   extends TypeSpec<array<Tk, Tv>> {
@@ -65,4 +65,13 @@ final class DictLikeArraySpec<Tk as arraykey, Tv>
     )
       |> /* HH_IGNORE_ERROR[4007] PHP array cast */ (array)$$;
   }
+
+  <<__Override>>
+  public function toString(): string {
+    return Str\format(
+      'array<%s, %s>',
+      $this->tsk->toString(),
+      $this->tsv->toString(),
+    );
+  }
 }

src/TypeSpec/__Private/DictSpec.hack

@@ -12,7 +12,7 @@ namespace Facebook\TypeSpec\__Private;
 
 use type Facebook\TypeAssert\{IncorrectTypeException, TypeCoercionException};
 use type Facebook\TypeSpec\TypeSpec;
-use namespace HH\Lib\Dict;
+use namespace HH\Lib\{Dict, Str};
 
 final class DictSpec<Tk as arraykey, Tv> extends TypeSpec<dict<Tk, Tv>> {
 
@@ -61,4 +61,14 @@ final class DictSpec<Tk as arraykey, Tv> extends TypeSpec<dict<Tk, Tv>> {
       ($k, $_v) ==> $this->tsk->withTrace($kt)->assertType($k),
     );
   }
+
+  <<__Override>>
+  public function toString(): string {
+    return Str\format(
+      '%s<%s, %s>',
+      dict::class,
+      $this->tsk->toString(),
+      $this->tsv->toString(),
+    );
+  }
 }

src/TypeSpec/__Private/EnumSpec.hack

@@ -42,4 +42,9 @@ final class
       throw IncorrectTypeException::withValue($this->getTrace(), $what, $value);
     }
   }
+
+  <<__Override>>
+  public function toString(): string {
+    return $this->what;
+  }
 }

src/TypeSpec/__Private/FloatSpec.hack

@@ -62,4 +62,9 @@ final class FloatSpec extends TypeSpec<float> {
     }
     throw IncorrectTypeException::withValue($this->getTrace(), 'float', $value);
   }
+
+  <<__Override>>
+  public function toString(): string {
+    return 'float';
+  }
 }