Add psalm and rename Exception

parable-php · Mar 11, 2021 · 310fe04 · 310fe04
1 parent d687500
commit 310fe04
Show file tree

Hide file tree

Showing 23 changed files with 122 additions and 90 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -32,3 +32,6 @@ jobs:
 
     - name: Run test suite
       run: vendor/bin/phpunit tests
+
+    - name: Run static analysis
+      run: vendor/bin/psalm
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
+.DS_Store
 .idea
 composer.lock
 vendor
-coverage
+coverage
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Parable PHP ORM
 
+## 0.11.0
+- Added static analysis through psalm.
+- Renamed `Exception` to `OrmException` for clarity.
+
 ## 0.10.0
 
 _Changes_

diff --git a/Makefile b/Makefile
@@ -4,16 +4,20 @@ dependencies:
 		--no-plugins \
 		--no-scripts
 
+psalm:
+	vendor/bin/psalm --clear-cache
+	vendor/bin/psalm
+
 tests: dependencies
 	vendor/bin/phpunit --verbose tests
 
 coverage: dependencies
 	rm -rf ./coverage
-	vendor/bin/phpunit --coverage-html ./coverage tests
+	XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html ./coverage tests
 
 tests-clean:
 	vendor/bin/phpunit --verbose tests
 
 coverage-clean:
 	rm -rf ./coverage
-	vendor/bin/phpunit --coverage-html ./coverage tests
+	XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html ./coverage tests
diff --git a/composer.json b/composer.json
@@ -20,7 +20,8 @@
     "parable-php/query": "^0.4.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^8.0"
+    "phpunit/phpunit": "^8.0",
+    "vimeo/psalm": "^4.6"
   },
   "autoload": {
     "psr-4": {

diff --git a/psalm.xml b/psalm.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="4"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+
+    <issueHandlers>
+        <UnresolvableInclude errorLevel="suppress" />
+    </issueHandlers>
+</psalm>
diff --git a/src/AbstractEntity.php b/src/AbstractEntity.php
@@ -34,7 +34,7 @@ public static function fromDatabaseItem(Container $container, string $primaryKey
         $entity->validatePrimaryKeyExistsOnEntity($primaryKey);
 
         if (!isset($values[$primaryKey])) {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Could not set primary key '%s' on entity %s from database values",
                 $primaryKey,
                 static::class
@@ -47,7 +47,7 @@ public static function fromDatabaseItem(Container $container, string $primaryKey
 
         foreach ($values as $property => $value) {
             if (!property_exists($entity, $property)) {
-                throw new Exception(sprintf(
+                throw new OrmException(sprintf(
                     "Property '%s' does not exist on entity %s",
                     $property,
                     static::class
@@ -148,7 +148,7 @@ protected function getSetterForProperty(string $property): string
         }
 
         if (!method_exists($this, $setter)) {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Setter method '%s' not defined on entity %s",
                 $setter,
                 static::class
@@ -161,7 +161,7 @@ protected function getSetterForProperty(string $property): string
     protected function validatePrimaryKeyExistsOnEntity(string $key): void
     {
         if (!property_exists($this, $key)) {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Primary key property '%s' does not exist on entity %s",
                 $key,
                 static::class

diff --git a/src/AbstractRepository.php b/src/AbstractRepository.php
@@ -38,13 +38,13 @@ public function createEntityClass(): AbstractEntity
         $entityClass = $this->getEntityClass();
 
         if (!class_exists($entityClass)) {
-            throw new Exception(sprintf("Traits class '%s' does not exist.", $entityClass));
+            throw new OrmException(sprintf("Traits class '%s' does not exist.", $entityClass));
         }
 
         $entity = $this->container->build($this->getEntityClass());
 
         if (!($entity instanceof AbstractEntity)) {
-            throw new Exception(sprintf("Class '%s' does not extend AbstractEntity.", $entityClass));
+            throw new OrmException(sprintf("Class '%s' does not extend AbstractEntity.", $entityClass));
         }
 
         return $entity;
@@ -106,7 +106,7 @@ public function findUniqueBy(callable $callable): ?AbstractEntity
         $entities = $this->findBy($callable);
 
         if (count($entities) > 1) {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Found more than one of '%s'",
                 $this->getEntityClass()
             ));
@@ -269,7 +269,7 @@ public function clearDeferredDeletes(): void
     protected function getBuilder(): Builder
     {
         if (!$this->database->isConnected()) {
-            throw new Exception('Cannot use repository methods without database connection.');
+            throw new OrmException('Cannot use repository methods without database connection.');
         }
 
         if ($this->builder === null) {
@@ -328,7 +328,7 @@ protected function getPrimaryKeysFromEntities(array $entities): array
             $this->validateEntityCorrectClass($entity);
 
             if (!$this->isStored($entity)) {
-                throw new Exception('Cannot delete entity that is not stored.');
+                throw new OrmException('Cannot delete entity that is not stored.');
             }
 
             $primaryKeys[] = $entity->getPrimaryKey($this->getPrimaryKey());
@@ -351,7 +351,7 @@ protected function validateEntityCorrectClass(AbstractEntity $entity): void
             return;
         }
 
-        throw new Exception(sprintf(
+        throw new OrmException(sprintf(
             "Expected '%s', got '%s' instead. Cannot handle these classes.",
             $entityClass,
             get_class($entity)

diff --git a/src/Database.php b/src/Database.php
@@ -33,7 +33,7 @@ class Database
     public function setConnectionClass(string $connectionClass): void
     {
         if (!is_subclass_of($connectionClass, PDO::class)) {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Class %s does not extend PDO, which is required",
                 $connectionClass
             ));
@@ -119,7 +119,7 @@ public function setErrorMode(int $errorMode): void
             [PDO::ERRMODE_SILENT, PDO::ERRMODE_WARNING, PDO::ERRMODE_EXCEPTION],
             true
         )) {
-            throw new Exception(sprintf("Invalid error mode set: '%d'", $errorMode));
+            throw new OrmException(sprintf("Invalid error mode set: '%d'", $errorMode));
         }
 
         $this->errorMode = $errorMode;
@@ -181,13 +181,13 @@ protected function createConnectionByType(int $type): ?PDO
                 return $this->createSqliteConnection();
         }
 
-        throw new Exception(sprintf("Cannot create connection for invalid database type: '%d'", $type));
+        throw new OrmException(sprintf("Cannot create connection for invalid database type: '%d'", $type));
     }
 
     protected function createMySQLConnection(): PDO
     {
         if ($this->host === null) {
-            throw new Exception('MySQL requires a host.');
+            throw new OrmException('MySQL requires a host.');
         }
 
         $connection = $this->createConnection(...$this->buildMySQLConnectionValues());
@@ -216,11 +216,11 @@ protected function buildMySQLConnectionValues(): array
     protected function createSqliteConnection(): PDO
     {
         if ($this->databaseName === null) {
-            throw new Exception('Sqlite requires a database.');
+            throw new OrmException('Sqlite requires a database.');
         }
 
         if ($this->databaseName !== ':memory:' && !is_readable($this->databaseName)) {
-            throw new Exception(sprintf("Could not read Sqlite database: %s", $this->databaseName));
+            throw new OrmException(sprintf("Could not read Sqlite database: %s", $this->databaseName));
         }
 
         $dsn = sprintf('sqlite:%s', $this->databaseName);
@@ -241,7 +241,7 @@ public function query(string $query): array
         $pdoStatement = $this->connection->query($query, PDO::FETCH_ASSOC);
 
         if (!$pdoStatement) {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Could not perform query: '%s', reason: %s: '%s'",
                 $query,
                 $this->connection->errorCode() ?? 'unknown',

diff --git a/src/Exception.php → src/OrmException.php b/src/Exception.php → src/OrmException.php
@@ -2,6 +2,6 @@
 
 namespace Parable\Orm;
 
-class Exception extends \Exception
+class OrmException extends \Exception
 {
 }
diff --git a/src/PropertyTypes/BooleanPropertyTyper.php b/src/PropertyTypes/BooleanPropertyTyper.php
@@ -2,14 +2,14 @@
 
 namespace Parable\Orm\PropertyTypes;
 
-use Parable\Orm\Exception;
+use Parable\Orm\OrmException;
 
 class BooleanPropertyTyper implements PropertyTyper
 {
     public function type($value): bool
     {
         if ($value !== '1' && $value !== '0') {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Could not type '%s' as boolean",
                 $value
             ));
@@ -21,7 +21,7 @@ public function type($value): bool
     public function untype($value): string
     {
         if (!is_bool($value)) {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Could not untype '%s' from boolean",
                 $value
             ));

diff --git a/src/PropertyTypes/DatePropertyTyper.php b/src/PropertyTypes/DatePropertyTyper.php
@@ -5,7 +5,7 @@
 use DateTimeImmutable;
 use DateTimeInterface;
 use Parable\Orm\Database;
-use Parable\Orm\Exception;
+use Parable\Orm\OrmException;
 
 class DatePropertyTyper implements PropertyTyper
 {
@@ -14,7 +14,7 @@ public function type($value): DateTimeImmutable
         $date = DateTimeImmutable::createFromFormat(Database::DATE_SQL, $value);
 
         if ($date === false) {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Could not type '%s' as date with format %s",
                 $value,
                 Database::DATE_SQL
@@ -27,7 +27,7 @@ public function type($value): DateTimeImmutable
     public function untype($value): string
     {
         if (!($value instanceof DateTimeInterface)) {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Could not untype '%s' as date from DateTimeInterface with format %s",
                 $value,
                 Database::DATE_SQL

diff --git a/src/PropertyTypes/DateTimePropertyTyper.php b/src/PropertyTypes/DateTimePropertyTyper.php
@@ -5,7 +5,7 @@
 use DateTimeImmutable;
 use DateTimeInterface;
 use Parable\Orm\Database;
-use Parable\Orm\Exception;
+use Parable\Orm\OrmException;
 
 class DateTimePropertyTyper implements PropertyTyper
 {
@@ -14,7 +14,7 @@ public function type($value): DateTimeImmutable
         $datetime = DateTimeImmutable::createFromFormat(Database::DATETIME_SQL, $value);
 
         if ($datetime === false) {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Could not type '%s' as datetime with format %s",
                 $value,
                 Database::DATETIME_SQL
@@ -27,7 +27,7 @@ public function type($value): DateTimeImmutable
     public function untype($value): string
     {
         if (!($value instanceof DateTimeInterface)) {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Could not untype '%s' as datetime from DateTimeInterface with format %s",
                 $value,
                 Database::DATETIME_SQL

diff --git a/src/PropertyTypes/IntegerPropertyTyper.php b/src/PropertyTypes/IntegerPropertyTyper.php
@@ -2,14 +2,14 @@
 
 namespace Parable\Orm\PropertyTypes;
 
-use Parable\Orm\Exception;
+use Parable\Orm\OrmException;
 
 class IntegerPropertyTyper implements PropertyTyper
 {
     public function type($value): int
     {
         if (!is_numeric($value)) {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Could not type '%s' as integer",
                 $value
             ));
@@ -21,7 +21,7 @@ public function type($value): int
     public function untype($value): string
     {
         if (!is_int($value)) {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Could not untype '%s' from integer",
                 $value
             ));

diff --git a/src/PropertyTypes/TimePropertyTyper.php b/src/PropertyTypes/TimePropertyTyper.php
@@ -5,7 +5,7 @@
 use DateTimeImmutable;
 use DateTimeInterface;
 use Parable\Orm\Database;
-use Parable\Orm\Exception;
+use Parable\Orm\OrmException;
 
 class TimePropertyTyper implements PropertyTyper
 {
@@ -14,7 +14,7 @@ public function type($value): DateTimeImmutable
         $time = DateTimeImmutable::createFromFormat(Database::TIME_SQL, $value);
 
         if ($time === false) {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Could not type '%s' as time with format %s",
                 $value,
                 Database::TIME_SQL
@@ -27,7 +27,7 @@ public function type($value): DateTimeImmutable
     public function untype($value): string
     {
         if (!($value instanceof DateTimeInterface)) {
-            throw new Exception(sprintf(
+            throw new OrmException(sprintf(
                 "Could not untype '%s' as time from DateTimeInterface with format %s",
                 $value,
                 Database::TIME_SQL