Merge pull request #80 from lode/improving-linting

Author: lode

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: test
+on:
+  pull_request:
+    paths:
+      - "**.php"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.draft == false
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.3'
+
+      - name: Setup Composer
+        uses: ramsey/composer-install@v3
+        with:
+            composer-options: "--no-scripts"
+
+      - name: Run phpunit
+        run: ./vendor/bin/phpunit

examples/bootstrap_examples.php

@@ -3,9 +3,12 @@
 use alsvanzelf\jsonapi\Document;
 use alsvanzelf\jsonapi\ResourceDocument;
 use alsvanzelf\jsonapi\interfaces\ExtensionInterface;
+use alsvanzelf\jsonapi\interfaces\HasAttributesInterface;
+use alsvanzelf\jsonapi\interfaces\HasExtensionMembersInterface;
 use alsvanzelf\jsonapi\interfaces\ProfileInterface;
 use alsvanzelf\jsonapi\interfaces\ResourceInterface;
 use alsvanzelf\jsonapi\objects\ResourceIdentifierObject;
+use alsvanzelf\jsonapi\objects\ResourceObject;
 
 ini_set('display_errors', 1);
 error_reporting(-1);
@@ -55,7 +58,7 @@ class ExampleDataset {
 
 	public static function getRecord($type, $id) {
 		if (!isset(self::$records[$type][$id])) {
-			throw new Exception('sorry, we have a limited dataset');
+			throw new \Exception('sorry, we have a limited dataset');
 		}
 
 		return self::$records[$type][$id];
@@ -121,6 +124,10 @@ public function getNamespace() {
 	 */
 
 	public function setVersion(ResourceInterface $resource, $version) {
+		if ($resource instanceof HasExtensionMembersInterface === false) {
+			throw new \Exception('resource doesn\'t have extension members');
+		}
+		
 		if ($resource instanceof ResourceDocument) {
 			$resource->getResource()->addExtensionMember($this, 'id', $version);
 		}
@@ -143,9 +150,12 @@ public function getOfficialLink() {
 	 * optionally helpers for the specific profile
 	 */
 
+	/**
+	 * @param ResourceInterface&HasAttributesInterface $resource
+	 */
 	public function setTimestamps(ResourceInterface $resource, ?\DateTimeInterface $created=null, ?\DateTimeInterface $updated=null) {
-		if ($resource instanceof ResourceIdentifierObject) {
-			throw new Exception('cannot add attributes to identifier objects');
+		if ($resource instanceof HasAttributesInterface === false) {
+			throw new \Exception('cannot add attributes to identifier objects');
 		}
 
 		$timestamps = [];
@@ -156,6 +166,6 @@ public function setTimestamps(ResourceInterface $resource, ?\DateTimeInterface $
 			$timestamps['updated'] = $updated->format(\DateTime::ISO8601);
 		}
 
-		$resource->add('timestamps', $timestamps);
+		$resource->addAttribute('timestamps', $timestamps);
 	}
 }

examples/errors_exception_native.php

@@ -13,7 +13,7 @@
  */
 
 try {
-	throw new Exception('unknown user', 404);
+	throw new \Exception('unknown user', 404);
 }
 catch (Exception $e) {
 	$options = [

examples/relationships.php

@@ -78,7 +78,7 @@
 $custom_relation = [
 	'data' => ['cus' => 'tom'],
 ];
-$jsonapi->add_relation('custom', $custom_relation);
+$jsonapi->addRelationship('custom', $custom_relation);
 
 /**
  * sending the response

phpstan.bonus.neon

@@ -3,7 +3,7 @@ includes:
 	- vendor/phpstan/phpstan/conf/bleedingEdge.neon
 
 parameters:
-	level: 9
+	level: 10
 
 	treatPhpDocTypesAsCertain: true
 

phpstan.neon

@@ -1,6 +1,6 @@
 parameters:
 	# slowly increase
-	level: 1
+	level: 4
 	paths:
 		- src/
 		- tests/
@@ -14,9 +14,11 @@ parameters:
 		- src/resource.php
 		- src/response.php
 
+	treatPhpDocTypesAsCertain: false
+	
 	strictRules:
 		allRules: false
-
+	
 	reportUnmatchedIgnoredErrors: true
 	ignoreErrors:
 		# add cases to ignore because they are too much work for now

script/fix

@@ -81,7 +81,6 @@ if test "$HAS_TYPE" = 1; then
 		$CONSOLE_PREFIX ./vendor/bin/phpcbf $EXTRA_ARGUMENTS $FILE_FILTER
 
 	elif test "$TYPE" = "rector"; then
-		echo "${T_WARNING}Rector might not produce correct results until phpstan is on level 4 on the main branch${T_RESET}"
 		$CONSOLE_PREFIX ./vendor/bin/rector process $EXTRA_ARGUMENTS $FILE_FILTER
 
 	else
@@ -93,7 +92,6 @@ else
 	echo -e "${T_BOLD}Running fixes on the changed files (not only git-diff) between the base and the head branch${T_RESET}\n"
 
 	echo "${T_INFO}Fixing refactors (rector)${T_RESET}"
-	echo "${T_WARNING}Rector might not produce correct results until phpstan is on level 4 on the main branch${T_RESET}"
 	$CONSOLE_PREFIX ./vendor/bin/rector process $FILE_FILTER || true
 
 	echo "${T_INFO}Fixing coding standards (phpcs)${T_RESET}"

script/lint

@@ -120,7 +120,6 @@ if test "$HAS_TYPE" = 1; then
 		fi
 
 	elif test "$TYPE" = "rector"; then
-		echo "${T_WARNING}Rector might not produce correct results until phpstan is on level 4 on the main branch${T_RESET}"
 		$CONSOLE_PREFIX ./vendor/bin/rector process --dry-run $EXTRA_ARGUMENTS $FILE_FILTER
 
 	else
@@ -161,7 +160,6 @@ else
 	echo -e '\n'
 
 	echo "${T_INFO}Checking refactors (rector)${T_RESET}"
-	echo "${T_WARNING}Rector might not produce correct results until phpstan is on level 4 on the main branch${T_RESET}"
 	$CONSOLE_PREFIX ./vendor/bin/rector process --memory-limit=4g --dry-run $FILE_FILTER 2> /dev/null \
 		&& echo "${T_SUCCESS}Success${T_RESET}"
 

src/CollectionDocument.php

@@ -9,8 +9,8 @@
 use alsvanzelf\jsonapi\interfaces\RecursiveResourceContainerInterface;
 use alsvanzelf\jsonapi\interfaces\ResourceContainerInterface;
 use alsvanzelf\jsonapi\interfaces\ResourceInterface;
-use alsvanzelf\jsonapi\objects\ResourceObject;
 use alsvanzelf\jsonapi\objects\ResourceIdentifierObject;
+use alsvanzelf\jsonapi\objects\ResourceObject;
 
 /**
  * this document is a set of Resources
@@ -63,9 +63,6 @@ public function add($type, $id, array $attributes=[]) {
 		}
 	}
 
-	/**
-	 * @inheritDoc
-	 */
 	public function setPaginationLinks($previousHref=null, $nextHref=null, $firstHref=null, $lastHref=null) {
 		if ($previousHref !== null) {
 			$this->addLink('prev', $previousHref);
@@ -115,9 +112,6 @@ public function addResource(ResourceInterface $resource, array $options=[]) {
 	 * DocumentInterface
 	 */
 
-	/**
-	 * @inheritDoc
-	 */
 	public function toArray() {
 		$array = parent::toArray();
 
@@ -133,9 +127,6 @@ public function toArray() {
 	 * ResourceContainerInterface
 	 */
 
-	/**
-	 * @inheritDoc
-	 */
 	public function getContainedResources() {
 		return $this->resources;
 	}

src/DataDocument.php

@@ -58,9 +58,6 @@ public function addIncludedResourceObject(ResourceObject ...$resourceObjects) {
 	 * DocumentInterface
 	 */
 
-	/**
-	 * @inheritDoc
-	 */
 	public function toArray() {
 		$array = parent::toArray();