From 57f93f7d0ff22db8a43a571556d19629cb8517d1 Mon Sep 17 00:00:00 2001
From: jsimmer <jsimmer@zynga.com>
Date: Wed, 11 Apr 2018 23:21:50 +0000
Subject: [PATCH] Added FileType box

---
 src/Zynga/Framework/Type/V1/FileType/Box.hh   | 23 +++++++++++++++
 .../Framework/Type/V1/FileType/BoxFactory.hh  | 29 +++++++++++++++++++
 .../Type/V1/FileType/BoxFactoryTest.hh        | 28 ++++++++++++++++++
 .../Framework/Type/V1/FileType/BoxTest.hh     | 18 ++++++++++++
 .../Type/V1/FileType/Enum/FileType.hh         | 10 +++++++
 .../Exception/UnknownFileTypeException.hh     | 10 +++++++
 6 files changed, 118 insertions(+)
 create mode 100644 src/Zynga/Framework/Type/V1/FileType/Box.hh
 create mode 100644 src/Zynga/Framework/Type/V1/FileType/BoxFactory.hh
 create mode 100644 src/Zynga/Framework/Type/V1/FileType/BoxFactoryTest.hh
 create mode 100644 src/Zynga/Framework/Type/V1/FileType/BoxTest.hh
 create mode 100644 src/Zynga/Framework/Type/V1/FileType/Enum/FileType.hh
 create mode 100644 src/Zynga/Framework/Type/V1/FileType/Exception/UnknownFileTypeException.hh

diff --git a/src/Zynga/Framework/Type/V1/FileType/Box.hh b/src/Zynga/Framework/Type/V1/FileType/Box.hh
new file mode 100644
index 0000000..88160bf
--- /dev/null
+++ b/src/Zynga/Framework/Type/V1/FileType/Box.hh
@@ -0,0 +1,23 @@
+<?hh // strict
+
+namespace Zynga\Framework\Type\V1\FileType;
+
+use Zynga\Framework\Type\V1\StringBox;
+use Zynga\Framework\Type\V1\FileType\BoxFactory as FileTypeBoxFactory;
+use Zynga\Framework\Type\V1\FileType\Exception\UnknownFileTypeException;
+
+/**
+ * Representation of a file type
+ */
+class Box extends StringBox {
+
+  <<__Override>>
+  protected function importFromString(string $value): bool {
+      if (FileTypeBoxFactory::isValidValue($value)) {
+        return parent::importFromString($value);
+      }
+
+      throw new UnknownFileTypeException('value='.$value);
+  }
+
+}
diff --git a/src/Zynga/Framework/Type/V1/FileType/BoxFactory.hh b/src/Zynga/Framework/Type/V1/FileType/BoxFactory.hh
new file mode 100644
index 0000000..d80ebe6
--- /dev/null
+++ b/src/Zynga/Framework/Type/V1/FileType/BoxFactory.hh
@@ -0,0 +1,29 @@
+<?hh // strict
+
+namespace Zynga\Framework\Type\V1\FileType;
+
+use Zynga\Framework\Type\V1\FileType\Box as FileTypeBox;
+use Zynga\Framework\Type\V1\FileType\Enum\FileType as FileTypeEnum;
+
+/**
+ * Generates and validates file types
+ */
+class BoxFactory {
+
+  public static function json(): FileTypeBox {
+    $value = new FileTypeBox();
+    $value->set(FileTypeEnum::JSON);
+    return $value;
+  }
+
+  public static function csv(): FileTypeBox {
+    $value = new FileTypeBox();
+    $value->set(FileTypeEnum::CSV);
+    return $value;
+  }
+
+  public static function isValidValue(string $value): bool {
+    return FileTypeEnum::coerce($value) !== null;
+  }
+
+}
diff --git a/src/Zynga/Framework/Type/V1/FileType/BoxFactoryTest.hh b/src/Zynga/Framework/Type/V1/FileType/BoxFactoryTest.hh
new file mode 100644
index 0000000..83a9444
--- /dev/null
+++ b/src/Zynga/Framework/Type/V1/FileType/BoxFactoryTest.hh
@@ -0,0 +1,28 @@
+<?hh // strict
+
+namespace Zynga\Framework\Type\V1\FileType;
+
+use Zynga\Framework\Testing\TestCase\V2\Base as ZyngaTestCase;
+use Zynga\Framework\Type\V1\FileType\BoxFactory;
+use Zynga\Framework\Type\V1\FileType\Enum\FileType as FileTypeEnum;
+
+class BoxFactoryTest extends ZyngaTestCase {
+
+  public function testJsonReturnsValidType(): void {
+    $this->assertEquals((string)FileTypeEnum::JSON, BoxFactory::json()->get());
+  }
+
+  public function testCsvReturnsValidType(): void {
+    $this->assertEquals((string)FileTypeEnum::CSV, BoxFactory::csv()->get());
+  }
+
+  public function testIsValidValueReturnsFalseCorrectly(): void {
+    $this->assertFalse(BoxFactory::isValidValue('pumpernickel'));
+  }
+
+  public function testIsValidValueReturnsTrueCorrectly(): void {
+    $this->assertTrue(BoxFactory::isValidValue((string)FileTypeEnum::JSON));
+    $this->assertTrue(BoxFactory::isValidValue((string)FileTypeEnum::CSV));
+  }
+
+}
diff --git a/src/Zynga/Framework/Type/V1/FileType/BoxTest.hh b/src/Zynga/Framework/Type/V1/FileType/BoxTest.hh
new file mode 100644
index 0000000..51f1fae
--- /dev/null
+++ b/src/Zynga/Framework/Type/V1/FileType/BoxTest.hh
@@ -0,0 +1,18 @@
+<?hh // strict
+
+namespace Zynga\Framework\Type\V1\FileType;
+
+use Zynga\Framework\Testing\TestCase\V2\Base as ZyngaTestCase;
+use Zynga\Framework\Type\V1\FileType\BoxFactory;
+use Zynga\Framework\Type\V1\FileType\Box as FileTypeBox;
+use Zynga\Framework\Type\V1\FileType\Exception\UnknownFileTypeException;
+
+class BoxTest extends ZyngaTestCase {
+
+  public function testInvalidSetThrowsUnknownFileTypeException(): void {
+    $fileType = new FileTypeBox();
+    $this->expectException(UnknownFileTypeException::class);
+    $fileType->set('pumpernickel');
+  }
+
+}
diff --git a/src/Zynga/Framework/Type/V1/FileType/Enum/FileType.hh b/src/Zynga/Framework/Type/V1/FileType/Enum/FileType.hh
new file mode 100644
index 0000000..2ff75c6
--- /dev/null
+++ b/src/Zynga/Framework/Type/V1/FileType/Enum/FileType.hh
@@ -0,0 +1,10 @@
+<?hh // strict
+
+namespace Zynga\Framework\Type\V1\FileType\Enum;
+
+enum FileType : string as string {
+  // @codeCoverageIgnoreStart
+  JSON = 'json';
+  CSV = 'csv';
+  // @codeCoverageIgnoreEnd
+}
diff --git a/src/Zynga/Framework/Type/V1/FileType/Exception/UnknownFileTypeException.hh b/src/Zynga/Framework/Type/V1/FileType/Exception/UnknownFileTypeException.hh
new file mode 100644
index 0000000..b45589b
--- /dev/null
+++ b/src/Zynga/Framework/Type/V1/FileType/Exception/UnknownFileTypeException.hh
@@ -0,0 +1,10 @@
+<?hh // strict
+
+namespace Zynga\Framework\Type\V1\FileType\Exception;
+
+use Zynga\Framework\Exception\V1\Exception as BaseException;
+
+/**
+ * Representation that an unknown file type was attempted to be used
+ */
+class UnknownFileTypeException extends BaseException {}