Refactor to support tests

Author: SalemC

src/Exceptions/InvalidModelException.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace SalemC\TypeScriptifyLaravelModels\Exceptions;
+
+use Exception;
+
+class InvalidModelException extends Exception {
+    /**
+     * Construct this class.
+     */
+    public function __construct() {
+        $this->message = 'That\'s not a valid Model!';
+    }
+}

src/Exceptions/UnsupportedDatabaseConnection.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace SalemC\TypeScriptifyLaravelModels\Exceptions;
+
+use Exception;
+
+class UnsupportedDatabaseConnection extends Exception {
+    /**
+     * Construct this class.
+     *
+     * @param array<string> $supportedDatabaseConnections The supported database connections.
+     */
+    public function __construct(array $supportedDatabaseConnections) {
+        $this->message = 'Your database connection is currently unsupported! The following database connections are supported: ' . implode(', ', $supportedDatabaseConnections);
+    }
+}

src/TypeScriptifyModel.php

@@ -2,7 +2,9 @@
 
 namespace SalemC\TypeScriptifyLaravelModels;
 
-use SalemC\TypeScriptifyLaravelModels\Utilities\ModelCollector\ModelCollector;
+use SalemC\TypeScriptifyLaravelModels\Exceptions\UnsupportedDatabaseConnection;
+use SalemC\TypeScriptifyLaravelModels\Exceptions\InvalidModelException;
+use SalemC\TypeScriptifyLaravelModels\Utilities\ModelCollector;
 
 use Illuminate\Database\Eloquent\Casts\AsStringable;
 use Illuminate\Database\Eloquent\Model;
@@ -34,6 +36,13 @@ final class TypeScriptifyModel {
      */
     private readonly Model $model;
 
+    /**
+     * The model collector.
+     *
+     * @var \SalemC\TypeScriptifyLaravelModels\Utilities\ModelCollector
+     */
+    private readonly ModelCollector $modelCollector;
+
     /**
      * The target model's foreign key constraits.
      *
@@ -58,24 +67,28 @@ final class TypeScriptifyModel {
     /**
      * @param string $fullyQualifiedModelName The fully qualified model class name.
      * @param ?array<string,string> $convertedModelsMap The map of `fully qualified model name => interface name` definitions this class can use instead of generating its own definitions.
+     * @param ?string $modelCollectorPath The path to be used for scanning for models.
      */
     public function __construct(
         private string $fullyQualifiedModelName,
-        private ?array &$convertedModelsMap = []
+        private ?array &$convertedModelsMap = [],
+        private ?string $modelCollectorPath = null,
     ) {
         // For consistency in comparisons that happen throughout the lifecycle of this class,
         // we need all fully qualified model names to have a leading \.
         $this->fullyQualifiedModelName = Str::of($fullyQualifiedModelName)->start('\\')->toString();
 
         if (!$this->hasValidModel()) {
-            throw new Exception('That\'s not a valid model!');
+            throw new InvalidModelException;
         }
 
         if (!$this->hasSupportedDatabaseConnection()) {
-            throw new Exception('Your database connection is currently unsupported! The following database connections are supported: ' . implode(', ', self::SUPPORTED_DATABASE_CONNECTIONS));
+            throw new UnsupportedDatabaseConnection(self::SUPPORTED_DATABASE_CONNECTIONS);
         }
 
-        $this->model = new $fullyQualifiedModelName;
+        $this->model = new ($this->fullyQualifiedModelName);
+
+        $this->modelCollector = new ModelCollector($this->modelCollectorPath ?? app_path());
 
         $this->modelForeignKeyConstraints = collect(
             Schema::getConnection()
@@ -214,11 +227,11 @@ private function mapDatabaseTypeToTypeScriptType(string $columnType): string {
             $columnType->startsWith('bigint') => 'number',
             $columnType->startsWith('double') => 'number',
             $columnType->startsWith('binary') => 'string',
-            $columnType->startsWith('bigint') => 'number',
             $columnType->startsWith('decimal') => 'number',
             $columnType->startsWith('integer') => 'number',
             $columnType->startsWith('varchar') => 'string',
             $columnType->startsWith('boolean') => 'boolean',
+            $columnType->startsWith('tinyint') => 'boolean',
             $columnType->startsWith('tinyblob') => 'string',
             $columnType->startsWith('tinytext') => 'string',
             $columnType->startsWith('longtext') => 'string',
@@ -277,7 +290,7 @@ private function convertForeignKeyToFullyQualifiedModelName(string $attribute):
             ->getForeignKeyConstraintForAttribute($attribute)
             ->getForeignTableName();
 
-        return ModelCollector::getModelsMappedByTable()[$foreignTableName];
+        return $this->modelCollector->getModelsMappedByTable()[$foreignTableName];
     }
 
     /**
@@ -302,7 +315,7 @@ private function getTypeScriptType(stdClass $columnSchema): string {
                 // as many interface definitions for relational attributes as we need.
                 // We pass our existing convertedModelsMap instance here to prevent this class
                 // mapping models we've already mapped in this current class instance.
-                $mappedType = (new self($fullyQualifiedRelatedModelName, $this->convertedModelsMap))
+                $mappedType = (new self($fullyQualifiedRelatedModelName, $this->convertedModelsMap, $this->modelCollectorPath))
                     ->includeHidden($this->includeHidden)
                     ->includeRelations($this->includeRelations)
                     ->generate();

src/Utilities/ModelCollector/ModelCollector.php renamed to src/Utilities/ModelCollector.php

@@ -1,10 +1,10 @@
 <?php
 
-namespace SalemC\TypeScriptifyLaravelModels\Utilities\ModelCollector;
+namespace SalemC\TypeScriptifyLaravelModels\Utilities;
 
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\File;
-use Illuminate\Container\Container;
+use Illuminate\Support\Str;
 
 use ReflectionClass;
 
@@ -14,32 +14,37 @@ final class ModelCollector {
      *
      * @var ?array
      */
-    private static ?array $modelsCache = null;
+    private ?array $modelsCache = null;
 
     /**
      * The cache for all models mapped by table.
      *
      * @var ?array
      */
-    private static ?array $modelsMappedByTableCache = null;
+    private ?array $modelsMappedByTableCache = null;
+
+    /**
+     * Construct this class.
+     *
+     * @param string $path The path to start scanning models at.
+     */
+    public function __construct(private readonly string $path) {
+        //
+    }
 
     /**
      * Get all existing models.
      *
      * @return array
      */
-    public static function getModels(): array {
-        return self::$modelsCache ??= collect(File::allFiles(app_path()))
+    public function getModels(): array {
+        return $this->modelsCache ??= collect(File::allFiles($this->path))
             ->map(function ($item) {
-                $path = $item->getRelativePathName();
-
-                $className = sprintf(
-                    '\%s%s',
-                    Container::getInstance()->getNamespace(),
-                    strtr(substr($path, 0, strrpos($path, '.')), '/', '\\')
-                );
-
-                return $className;
+                return Str::of($item->getContents())
+                    ->match('/namespace (.*);/')
+                    ->start('\\')
+                    ->finish('\\' . Str::of($item->getRelativePathName())->afterLast('\\')->beforeLast('.'))
+                    ->toString() ?? '\\';
             })->filter(function ($className) {
                 if (!class_exists($className)) return false;
 
@@ -54,8 +59,8 @@ public static function getModels(): array {
      *
      * @return array
      */
-    public static function getModelsMappedByTable(): array {
-        return self::$modelsMappedByTableCache ??= collect(self::getModels())
+    public function getModelsMappedByTable(): array {
+        return $this->modelsMappedByTableCache ??= collect($this->getModels())
             ->mapWithKeys(fn ($className) => [(new $className)->getTable() => $className])
             ->all();
     }