Add and configure PHPStan static code checks

.github/workflows/run-tests.yml → .github/workflows/run-checks.yml

@@ -1,4 +1,4 @@
-name: PHPUnit tests
+name: Checks
 
 on:
   push:
@@ -37,5 +37,8 @@ jobs:
       with:
         elasticsearch version: 7.17.1
 
+    - name: Run PHPStan checks
+      run: ./vendor/bin/phpstan
+
     - name: Run test suite
       run: ./vendor/bin/phpunit

README.md

@@ -1,6 +1,6 @@
 # elasticsearcher
 
-![Unit tests](https://github.com/madewithlove/elasticsearcher/actions/workflows/run-tests.yml/badge.svg)
+![checks](https://github.com/madewithlove/elasticsearcher/actions/workflows/run-checks.yml/badge.svg)
 
 This agnostic package is a lightweight wrapper on top of the [Elasticsearch PHP client](http://www.elastic.co/guide/en/elasticsearch/client/php-api/current/index.html).
 Its main goal is to allow for easier structuring of queries and indices in your application. It does not want to hide or replace

composer.json

@@ -18,6 +18,7 @@
 		"jdrieghe/array-helpers": "^0.2.0"
 	},
 	"require-dev": {
+		"phpstan/phpstan": "^1.5",
 		"phpunit/phpunit": "^9.5"
 	},
 	"extra": {

phpstan-ignore.neon

@@ -0,0 +1,2 @@
+parameters:
+    ignoreErrors: []

phpstan.neon

@@ -0,0 +1,10 @@
+includes:
+    - phpstan-ignore.neon
+
+parameters:
+    level: 1
+    paths:
+        - src
+        - tests
+    bootstrapFiles:
+        - tests/bootstrap.php

src/Abstracts/AbstractQuery.php

@@ -51,6 +51,11 @@ abstract class AbstractQuery
 	 */
 	protected $fragmentParser;
 
+    /**
+     * @var array
+     */
+    protected $types;
+
 	/**
 	 * Prepare the query. Add filters, sorting, ....
 	 */

src/Managers/IndicesManager.php

@@ -43,7 +43,7 @@ public function registerIndices(array $indices)
 	}
 
 	/**
-	 * @return AbstractIndex
+	 * @return void
 	 *
 	 * @param string $indexName
 	 */

tests/ElasticSearcherTestCase.php

@@ -20,7 +20,7 @@ class ElasticSearcherTestCase extends TestCase
 	 */
 	protected function setUp(): void
 	{
-		$env      = new Environment(
+		$env = new Environment(
 			['hosts' => [ELASTICSEARCH_HOST]]
 		);
 		$this->elasticSearcher = new ElasticSearcher($env);

tests/Fragments/Traits/SortableTraitTest.php

@@ -7,69 +7,68 @@ class SortableTraitTest extends ElasticSearcherTestCase
 	public function testSettingSortingFields()
 	{
 		$this->hasSort(
+            [
+                'name',
+                ['age' => ['order' => 'asc', 'mode' => 'avg']],
+                ['date' => 'asc'],
+            ],
 			[
 				'sort_fields' => [
 					'name',
 					'age' => ['order' => 'asc', 'mode' => 'avg'],
 					'date' => 'asc',
 				]
-			],
-			null,
-			[
-				'name',
-				['age' => ['order' => 'asc', 'mode' => 'avg']],
-				['date' => 'asc'],
 			]
 		);
 	}
 
 	public function testSortingAFieldWithoutPredefinedFields()
 	{
 		$this->hasSort(
+            [
+                ['date' => 'desc'],
+            ],
 			null,
-			['sort' => 'date', 'sort_direction' => 'desc'],
-			[
-				['date' => 'desc'],
-			]
+			['sort' => 'date', 'sort_direction' => 'desc']
 		);
 	}
 
 	public function testSortingAFieldFromPredefinedFields()
 	{
 		$this->hasSort(
+            [
+                ['date' => 'desc'],
+                ['name' => 'asc'],
+                ['age' => ['order' => 'asc', 'mode' => 'avg']],
+            ],
 			[
 				'sort_fields' => [
 					'name' => 'asc',
 					'age' => ['order' => 'asc', 'mode' => 'avg'],
 					'date' => 'asc',
 				]
 			],
-			['sort' => 'date', 'sort_direction' => 'desc'],
-			[
-				['date' => 'desc'],
-				['name' => 'asc'],
-				['age' => ['order' => 'asc', 'mode' => 'avg']],
-			]
+			['sort' => 'date', 'sort_direction' => 'desc']
 		);
 	}
 
 	public function testSortingAnUndefinedFieldWithPredefinedFields()
 	{
 		$this->hasSort(
+            [
+                ['email' => 'asc'],
+                ['name' => 'asc'],
+                ['age' => ['order' => 'asc', 'mode' => 'avg']],
+                ['date' => 'asc'],
+            ],
 			[
 				'sort_fields' => [
 					'name' => 'asc',
 					'age' => ['order' => 'asc', 'mode' => 'avg'],
 					'date' => 'asc',
 				]
 			],
-			['sort' => 'email', 'sort_direction' => 'asc'],
-			[
-				['email' => 'asc'],
-				['name' => 'asc'],
-				['age' => ['order' => 'asc', 'mode' => 'avg']],
-				['date' => 'asc'],
-			]
+			['sort' => 'email', 'sort_direction' => 'asc']
 		);
 	}
 
@@ -84,22 +83,22 @@ public function testSortingAFieldWithoutSortDirection()
 		];
 
 		$this->hasSort(
+            [
+                ['date' => 'desc'],
+                'name',
+                ['age' => ['order' => 'asc', 'mode' => 'avg']],
+            ],
 			$fields,
-			['sort' => 'date', 'sort_direction' => null],
-			[
-				['date' => 'desc'],
-				'name',
-				['age' => ['order' => 'asc', 'mode' => 'avg']],
-			]
+			['sort' => 'date', 'sort_direction' => null]
 		);
 		$this->hasSort(
+            [
+                ['age' => ['order' => 'asc', 'mode' => 'avg']],
+                'name',
+                ['date' => 'desc'],
+            ],
 			$fields,
-			['sort' => 'age', 'sort_direction' => null],
-			[
-				['age' => ['order' => 'asc', 'mode' => 'avg']],
-				'name',
-				['date' => 'desc'],
-			]
+			['sort' => 'age', 'sort_direction' => null]
 		);
 	}
 
@@ -114,37 +113,32 @@ public function testSortingAFieldWithoutPredefinedDirection()
 		];
 
 		$this->hasSort(
+            [
+                'name',
+                ['age' => ['order' => 'asc', 'mode' => 'avg']],
+                ['date' => 'desc'],
+            ],
 			[
 				'sort_fields' => [
 					'name',
 					'age' => ['order' => 'asc', 'mode' => 'avg'],
 					'date' => 'desc',
 				]
 			],
-			['sort' => 'name'],
-			[
-				'name',
-				['age' => ['order' => 'asc', 'mode' => 'avg']],
-				['date' => 'desc'],
-			]
+			['sort' => 'name']
 		);
 		$this->hasSort(
+            [
+                ['name' => 'desc'],
+                ['age' => ['order' => 'asc', 'mode' => 'avg']],
+                ['date' => 'desc'],
+            ],
 			$fields,
-			['sort' => 'name', 'sort_direction' => 'desc'],
-			[
-				['name' => 'desc'],
-				['age' => ['order' => 'asc', 'mode' => 'avg']],
-				['date' => 'desc'],
-			]
+			['sort' => 'name', 'sort_direction' => 'desc']
 		);
 	}
 
-	/**
-	 * @param null|array $predefinedFields
-	 * @param null|array $sortBy
-	 * @param array $expectedSort
-	 */
-	private function hasSort($predefinedFields = null, $sortBy = null, array $expectedSort)
+	private function hasSort(array $expectedSort, ?array $predefinedFields = null, ?array $sortBy = null)
 	{
 		$query = new SortedQuery($this->getElasticSearcher());
 		if ($predefinedFields) {

tests/dummy/Queries/BooksFrom2014Query.php

@@ -9,7 +9,7 @@ class BooksFrom2014Query extends AbstractQuery
 {
 	public function setup()
 	{
-		$this->searchIn('books', 'books');
+		$this->searchIn('books');
 
 		$this->set('query.bool.filter', [new TermQuery('year', 2014)]);
 	}

tests/dummy/Queries/CountMoviesFrom2014Query.php

@@ -9,7 +9,7 @@ class CountMoviesFrom2014Query extends AbstractQuery
 {
 	public function setup()
 	{
-		$this->searchIn('movies', 'movies');
+		$this->searchIn('movies');
 
 		$this->set('query.bool.filter', [new TermQuery('year', 2014)]);
 	}

tests/dummy/Queries/MovieWithIDXQuery.php

@@ -9,7 +9,7 @@ class MovieWithIDXQuery extends AbstractQuery
 {
 	public function setup()
 	{
-		$this->searchIn('movies', 'movies');
+		$this->searchIn('movies');
 
 		$this->set('query.bool.filter', [new IDFilter($this->getData('id'))]);
 	}

tests/dummy/Queries/MoviesFrom2014Query.php

@@ -9,7 +9,7 @@ class MoviesFrom2014Query extends AbstractQuery
 {
 	public function setup()
 	{
-		$this->searchIn('movies', 'movies');
+		$this->searchIn('movies');
 
 		$this->set('query.bool.filter', [new TermQuery('year', 2014)]);
 	}

tests/dummy/Queries/MoviesFromXYearQuery.php

@@ -9,7 +9,7 @@ class MoviesFromXYearQuery extends AbstractQuery
 {
 	public function setup()
 	{
-		$this->searchIn('movies', 'movies');
+		$this->searchIn('movies');
 
 		$body = array(
 			'query' => array(

tests/dummy/Queries/SortedQuery.php

@@ -15,7 +15,7 @@ public function setup()
 			$this->sort($fields);
 		}
 
-		if ($fieldName = $this->getData('sort')) {
+		if ($this->getData('sort')) {
 			$this->sortBy($this->getData('sort'), $this->getData('sort_direction'));
 		}
 	}