Add psalm

b2pweb · Jun 21, 2021 · b639ff0 · b639ff0
1 parent 11bb99e
commit b639ff0
Show file tree

Hide file tree

Showing 19 changed files with 113 additions and 80 deletions.
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -80,8 +80,8 @@ jobs:
     - name: Run PHPCS
       run: composer run-script phpcs
 
-#    - name: Run type coverage
-#      run: composer run-script psalm
+    - name: Run type coverage
+      run: composer run-script psalm
 
 #    - name: Run Infection
 #      run: |

diff --git a/build/integration.sh b/build/integration.sh
diff --git a/composer.json b/composer.json
@@ -16,7 +16,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "~7.5",
-        "squizlabs/php_codesniffer": "~3.0"
+        "squizlabs/php_codesniffer": "~3.0",
+        "vimeo/psalm": "~4.0"
     },
     "extra": {
         "branch-alias": {
@@ -26,6 +27,7 @@
     "scripts": {
         "tests": "phpunit",
         "tests-with-coverage": "phpunit --coverage-clover coverage.xml",
-        "phpcs": "phpcs --standard=psr12 --tab-width=4 --exclude=Generic.Files.LineLength src/"
+        "phpcs": "phpcs --standard=psr12 --tab-width=4 --exclude=Generic.Files.LineLength src/",
+        "psalm": "psalm --shepherd"
     }
 }
diff --git a/psalm.xml b/psalm.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="6"
+    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" />
+            <file name="src/MongoDB/PrimeMongoDbServiceProvider.php" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>
diff --git a/src/MongoDB/Driver/MongoConnection.php b/src/MongoDB/Driver/MongoConnection.php
@@ -41,6 +41,7 @@
  * Connection for mongoDb
  *
  * @property Manager $_conn
+ * @method \Bdf\Prime\Configuration getConfiguration()
  */
 class MongoConnection extends Connection implements ConnectionInterface
 {
@@ -104,6 +105,8 @@ public function __construct($params, Driver $driver, Configuration $config = nul
     public function setName($name)
     {
         $this->name = $name;
+
+        return $this;
     }
 
     /**
@@ -176,9 +179,9 @@ public function select($query, array $bindings = [], array $types = [])
     /**
      * {@inheritdoc}
      */
-    public function insert($tableExpression, array $data, array $types = [])
+    public function insert($table, array $data, array $types = [])
     {
-        return $this->builder()->from($tableExpression)->insert($data);
+        return $this->builder()->from($table)->insert($data);
     }
 
     /**
@@ -237,15 +240,15 @@ public function executeWrite($collection, BulkWrite $query)
     /**
      * {@inheritdoc}
      */
-    public function executeQuery($query, array $params = [], $types = [], QueryCacheProfile $qcp = null)
+    public function executeQuery($sql, array $params = [], $types = [], QueryCacheProfile $qcp = null)
     {
         throw new \BadMethodCallException('Method ' . __METHOD__ . ' cannot be called on mongoDB connection');
     }
 
     /**
      * {@inheritdoc}
      */
-    public function executeUpdate($query, array $params = [], array $types = [])
+    public function executeUpdate($sql, array $params = [], array $types = [])
     {
         throw new \BadMethodCallException('Method ' . __METHOD__ . ' cannot be called on mongoDB connection');
     }
@@ -271,7 +274,7 @@ public function runCommand($command, $arguments = 1)
     /**
      * Run a command
      *
-     * @param string|array|Command $command
+     * @param string|array|Command|CommandInterface $command
      * @param mixed $arguments
      *
      * @return \MongoDB\Driver\Cursor
@@ -313,6 +316,8 @@ public function beginTransaction()
         }
 
         ++$this->transationLevel;
+
+        return true;
     }
 
     /**
@@ -352,6 +357,8 @@ public function commit()
         }
 
         --$this->transationLevel;
+
+        return true;
     }
 
     /**
@@ -382,6 +389,8 @@ public function rollBack()
         }
 
         --$this->transationLevel;
+
+        return true;
     }
 
     /**

diff --git a/src/MongoDB/Driver/MongoDriver.php b/src/MongoDB/Driver/MongoDriver.php
@@ -13,6 +13,8 @@ class MongoDriver implements Driver
 {
     /**
      * {@inheritdoc}
+     *
+     * @psalm-suppress InvalidReturnType
      */
     public function connect(array $params, $username = null, $password = null, array $driverOptions = [])
     {
@@ -28,6 +30,7 @@ public function connect(array $params, $username = null, $password = null, array
             unset($params['username'], $params['password']);
         }
 
+        /** @psalm-suppress InvalidReturnStatement */
         return new Manager($this->buildDsn($params), array_filter($params), $driverOptions);
     }
 

diff --git a/src/MongoDB/Driver/MongoPlatform.php b/src/MongoDB/Driver/MongoPlatform.php
@@ -2,6 +2,7 @@
 
 namespace Bdf\Prime\MongoDB\Driver;
 
+use BadMethodCallException;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Schema\Table;
 
@@ -17,37 +18,42 @@ class MongoPlatform extends AbstractPlatform
     /**
      * {@inheritdoc}
      */
-    public function getBooleanTypeDeclarationSQL(array $columnDef)
+    public function getBooleanTypeDeclarationSQL(array $column)
     {
+        throw new BadMethodCallException('Not supported');
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getIntegerTypeDeclarationSQL(array $columnDef)
+    public function getIntegerTypeDeclarationSQL(array $column)
     {
+        throw new BadMethodCallException('Not supported');
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getBigIntTypeDeclarationSQL(array $columnDef)
+    public function getBigIntTypeDeclarationSQL(array $column)
     {
+        throw new BadMethodCallException('Not supported');
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getSmallIntTypeDeclarationSQL(array $columnDef)
+    public function getSmallIntTypeDeclarationSQL(array $column)
     {
+        throw new BadMethodCallException('Not supported');
     }
 
     // phpcs:disable
     /**
      * {@inheritdoc}
      */
-    protected function _getCommonIntegerTypeDeclarationSQL(array $columnDef)
+    protected function _getCommonIntegerTypeDeclarationSQL(array $column)
     {
+        throw new BadMethodCallException('Not supported');
     }
     // phpcs:enable
 
@@ -56,20 +62,23 @@ protected function _getCommonIntegerTypeDeclarationSQL(array $columnDef)
      */
     protected function initializeDoctrineTypeMappings()
     {
+        throw new BadMethodCallException('Not supported');
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getClobTypeDeclarationSQL(array $field)
+    public function getClobTypeDeclarationSQL(array $column)
     {
+        throw new BadMethodCallException('Not supported');
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getBlobTypeDeclarationSQL(array $field)
+    public function getBlobTypeDeclarationSQL(array $column)
     {
+        throw new BadMethodCallException('Not supported');
     }
 
     /**
@@ -93,5 +102,6 @@ public function supportsSavepoints()
      */
     public function getCreateTableSQL(Table $table, $createFlags = self::CREATE_INDEXES)
     {
+        throw new BadMethodCallException('Not supported');
     }
 }
diff --git a/src/MongoDB/Driver/MongoSchemasManager.php b/src/MongoDB/Driver/MongoSchemasManager.php
@@ -2,6 +2,7 @@
 
 namespace Bdf\Prime\MongoDB\Driver;
 
+use BadMethodCallException;
 use Doctrine\DBAL\Schema\AbstractSchemaManager;
 
 /**
@@ -23,6 +24,7 @@ class MongoSchemasManager extends AbstractSchemaManager
      */
     protected function _getPortableTableColumnDefinition($tableColumn)
     {
+        throw new BadMethodCallException('Not supported');
     }
     // phpcs:enable
 

diff --git a/src/MongoDB/Driver/ResultSet/CursorResultSet.php b/src/MongoDB/Driver/ResultSet/CursorResultSet.php
@@ -63,7 +63,7 @@ public function fetchMode($mode, $options = null)
                 break;
 
             case self::FETCH_CLASS:
-                if (is_subclass_of($options, Unserializable::class)) {
+                if ($options && is_subclass_of($options, Unserializable::class)) {
                     $this->cursor->setTypeMap(['root' => $options]);
                     break;
                 }

diff --git a/src/MongoDB/Driver/ResultSet/WriteResultSet.php b/src/MongoDB/Driver/ResultSet/WriteResultSet.php
@@ -31,6 +31,7 @@ public function __construct(WriteResult $result)
      */
     public function fetchMode($mode, $options = null)
     {
+        return $this;
     }
 
     /**

diff --git a/src/MongoDB/Odm/MongoIdGenerator.php b/src/MongoDB/Odm/MongoIdGenerator.php
@@ -14,8 +14,8 @@ class MongoIdGenerator extends AbstractGenerator
     /**
      * {@inheritdoc}
      */
-    protected function doGenerate($primary, array &$data, ServiceLocator $serviceLocator)
+    protected function doGenerate($property, array &$data, ServiceLocator $serviceLocator)
     {
-        return $data[$primary] = new ObjectID();
+        return $data[$property] = new ObjectID();
     }
 }
diff --git a/src/MongoDB/Query/Aggregation/Pipeline.php b/src/MongoDB/Query/Aggregation/Pipeline.php
@@ -78,6 +78,8 @@ public function compiler()
 
     /**
      * {@inheritdoc}
+     *
+     * @param PipelineCompiler $compiler
      */
     public function setCompiler(CompilerInterface $compiler)
     {
@@ -100,7 +102,10 @@ public function connection()
     public function on(ConnectionInterface $connection)
     {
         $this->connection = $connection;
-        $this->compiler   = $connection->factory()->compiler(static::class);
+        /** @var PipelineCompiler */
+        $this->compiler = $connection->factory()->compiler(static::class);
+
+        return $this;
     }
 
     /**

diff --git a/src/MongoDB/Query/Aggregation/Stage/StageInterface.php b/src/MongoDB/Query/Aggregation/Stage/StageInterface.php
@@ -20,7 +20,7 @@ public function operator();
     /**
      * Get the stage operations in normalized form
      *
-     * @return array
+     * @return scalar|array
      */
     public function export();
 
@@ -30,7 +30,7 @@ public function export();
      * @param CompilableClause $clause
      * @param MongoGrammar $grammar
      *
-     * @return array
+     * @return scalar|array
      */
     public function compile(CompilableClause $clause, MongoGrammar $grammar);
 }
diff --git a/src/MongoDB/Query/Compiled/WriteQuery.php b/src/MongoDB/Query/Compiled/WriteQuery.php
@@ -168,6 +168,8 @@ public function merge(WriteQuery $query)
      */
     public function execute(MongoConnection $connection)
     {
+        // Psalm do not detect correct constructor signature
+        /** @psalm-suppress InvalidArgument */
         $bulk = new BulkWrite($this->options);
 
         foreach ($this->inserts as $insert) {