Wrote unit tests and added more validation for config entries & more output messages.

Author: rotexdegba

.gitignore

@@ -40,3 +40,5 @@ index.php
 
 /tests/DbFiles/blog.sqlite
 *.sqlite
+
+/tests/test-files/file-with-two-lines.txt

bin/generate-leanorm-classes.php

@@ -52,6 +52,16 @@
     echo "************************************************" . PHP_EOL;
     echo "Successfully loaded LeanOrm Cli .............."    . PHP_EOL;
     echo "************************************************" . PHP_EOL . PHP_EOL;
+    
+    if($tableOrViewNameIfAny === '') {
+        
+        echo "Classes will be generated for all tables and views (apart from tables & views specified to be skipped in the config file)." . PHP_EOL . PHP_EOL;
+        
+    } else {
+        
+        echo "Classes will be generated for only `{$tableOrViewNameIfAny}` (as long as it's not specified to be skipped in the config file)." . PHP_EOL . PHP_EOL;
+    }
+    
     $code = $command($tableOrViewNameIfAny);
     exit($code);
 

src/FileIoUtils.php

@@ -1,10 +1,8 @@
 <?php
 declare(strict_types=1);
-
 namespace LeanOrmCli;
 
 /**
- * 
  * This code was lifted from https://github.com/atlasphp/Atlas.Cli/blob/2.x/src/Fsio.php
  */
 class FileIoUtils {

src/OrmClassesGenerator.php

@@ -33,21 +33,6 @@ class OrmClassesGenerator {
      */
     public const TEMPLATE_RECORD_FILE_NAME = 'TypeRecord.php.tpl';
 
-    /**
-     * @var string
-     */
-    public const DEFAULT_COLLECTION_CLASS_TO_EXTEND = '\\LeanOrm\\Model\\Collection';
-
-    /**
-     * @var string
-     */
-    public const DEFAULT_MODEL_CLASS_TO_EXTEND = '\\LeanOrm\\Model';
-
-    /**
-     * @var string
-     */
-    public const DEFAULT_RECORD_CLASS_TO_EXTEND = '\\LeanOrm\\Model\\Record';
-
     protected array $defaultConfig = [];
 
     protected string $defaultTemplatesDirectory = '';
@@ -85,12 +70,14 @@ public function __construct(array $config) {
 
             throw new \Exception('`pdo` entry is missing in config!');
 
-        } elseif (!is_array($this->config['pdo'])) {
+        } elseif (!is_array($this->config['pdo']) && !($this->config['pdo'] instanceof \PDO)) {
 
-            throw new \Exception('`pdo` entry in config is not an array!');
+            throw new \Exception('`pdo` entry in config is not an array & is also not a PDO instance!');
         }
 
-        $this->pdo = new \PDO(...$this->config['pdo']);
+        $this->pdo = ($this->config['pdo'] instanceof \PDO)
+                        ? $this->config['pdo']
+                        : new \PDO(...$this->config['pdo']);
 
         // fill config with defaults
         foreach ($this->defaultConfig as $key=>$val) {
@@ -100,68 +87,83 @@ public function __construct(array $config) {
                 $this->config[$key] = $val;
             }
         }
+        
+        ////////////////////////////////////////////////////////////////////////
+        // VALIDATE THE REMAINING ENTRIES IN THE CONFIG
+        ////////////////////////////////////////////////////////////////////////
+        
+        if(!is_string($this->config['namespace']) && $this->config['namespace']!== null) {
+
+            throw new \Exception('`namespace` entry in config is not a string!');
+        }
 
         if(!is_string($this->config['directory'])) {
 
             throw new \Exception('`directory` entry in config is not a string!');
         }
+        
+        if(!FileIoUtils::isDir($this->config['directory'])) {
 
-        $this->destinationDirectory  = $this->config['directory'];
+            throw new \Exception('`directory` entry in config is not a valid directory!');
+        }
 
-        if(OtherUtils::isNonEmptyString($this->config['custom_templates_directory'])) {
+        $this->destinationDirectory  = $this->config['directory'];
 
+        if(
+            OtherUtils::isNonEmptyString($this->config['custom_templates_directory'])
+        ) {
             if(!FileIoUtils::isDir($this->config['custom_templates_directory'])) {
 
                 throw new \Exception('`custom_templates_directory` entry in config is not a valid directory!');
             } 
 
             $this->customTemplatesDirectory = $this->config['custom_templates_directory'];
+            
+        } elseif (
+            !is_string($this->config['custom_templates_directory'])    
+            && $this->config['custom_templates_directory'] !== null
+        ) {
+            throw new \Exception('`custom_templates_directory` entry in config is not a string!');
         }
-
+        
         if(!is_array($this->config['tables_to_skip'])) {
 
-            $this->config['tables_to_skip'] = [];
+            throw new \Exception('`tables_to_skip` entry in config is not an array of strings (names of tables & views to skip)!');
         }
+        
+        if(!is_string($this->config['collection_class_to_extend'])) {
 
-        if(!OtherUtils::isNonEmptyString($this->config['collection_class_to_extend'])) {
-
-            $this->config['collection_class_to_extend'] = static::DEFAULT_COLLECTION_CLASS_TO_EXTEND;
+            throw new \Exception('`collection_class_to_extend` entry in config is not a string!');
         }
+        
+        if(!is_string($this->config['model_class_to_extend'])) {
 
-        if(!OtherUtils::isNonEmptyString($this->config['model_class_to_extend'])) {
-
-            $this->config['model_class_to_extend'] = static::DEFAULT_MODEL_CLASS_TO_EXTEND;
+            throw new \Exception('`model_class_to_extend` entry in config is not a string!');
         }
+        
+        if(!is_string($this->config['record_class_to_extend'])) {
 
-        if(!OtherUtils::isNonEmptyString($this->config['record_class_to_extend'])) {
-
-            $this->config['record_class_to_extend'] = static::DEFAULT_RECORD_CLASS_TO_EXTEND;
+            throw new \Exception('`record_class_to_extend` entry in config is not a string!');
         }
+        
+        if(!is_string($this->config['created_timestamp_column_name']) && $this->config['created_timestamp_column_name']!== null) {
 
-        if(
-            $this->config['created_timestamp_column_name'] !== null
-            && !OtherUtils::isNonEmptyString($this->config['created_timestamp_column_name'])
-        ) {
-            $this->config['created_timestamp_column_name'] = null;
+            throw new \Exception('`created_timestamp_column_name` entry in config is not a string!');
         }
+        
+        if(!is_string($this->config['updated_timestamp_column_name']) && $this->config['updated_timestamp_column_name']!== null) {
 
-        if(
-            $this->config['updated_timestamp_column_name'] !== null
-            && !OtherUtils::isNonEmptyString($this->config['updated_timestamp_column_name'])
-        ) {
-            $this->config['updated_timestamp_column_name'] = null;
+            throw new \Exception('`updated_timestamp_column_name` entry in config is not a string!');
         }
-
+        
         if(!is_callable($this->config['table_name_to_record_class_prefix_transformer'])) {
 
-            $this->config['table_name_to_record_class_prefix_transformer'] =
-                    $this->defaultConfig['table_name_to_record_class_prefix_transformer'];
+            throw new \Exception('`table_name_to_record_class_prefix_transformer` entry in config is not a callable!');
         }
-
+        
         if(!is_callable($this->config['table_name_to_collection_and_model_class_prefix_transformer'])) {
 
-            $this->config['table_name_to_collection_and_model_class_prefix_transformer'] =
-                    $this->defaultConfig['table_name_to_collection_and_model_class_prefix_transformer'];
+            throw new \Exception('`table_name_to_collection_and_model_class_prefix_transformer` entry in config is not a callable!');
         }
     }
 

src/SchemaUtils.php

@@ -116,7 +116,7 @@ public static function getCurrentConnectionInfo(\PDO $pdo): string {
 
             } catch (\Exception $e) {
 
-                $result .= "`{$key}`: " . 'Unsupported attribute for the current PDO driver';
+                $result .= "`{$key}`: " . 'Unsupported attribute for the current PDO driver'.PHP_EOL;
                 continue;
             }