Update codesniffer for composer 2.0. (#93)

* Update codesniffer so builds pass. * Update formatting/comments to pass new codesniffer. * I like my TODO format better. * Force XDEBUG_MODE to coverage.
swichers · Dec 28, 2020 · 84ec385 · 84ec385
1 parent 3ea3849
commit 84ec385
Show file tree

Hide file tree

Showing 38 changed files with 214 additions and 171 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -19,7 +19,7 @@ install:
 
 script:
   - php vendor/bin/phpcs
-  - php vendor/bin/phpunit --coverage-clover ./build/logs/clover.xml
+  - XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-clover ./build/logs/clover.xml
 
 after_script:
   - php vendor/bin/codacycoverage clover ./build/logs/clover.xml
diff --git a/composer.json b/composer.json
@@ -21,9 +21,9 @@
     "symfony/dotenv": "^4.4"
   },
   "require-dev": {
-    "dealerdirect/phpcodesniffer-composer-installer": "^0.5.0 || ^0.6.0",
     "drupal/coder": "^8.3",
-    "phpunit/phpunit": "^8.5 || ^6.5"
+    "phpunit/phpunit": "^8.5 || ^6.5",
+    "dealerdirect/phpcodesniffer-composer-installer": "^0.7.1"
   },
   "config": {
     "platform": {

diff --git a/composer.lock b/composer.lock
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -18,6 +18,7 @@
 
   <rule ref="Drupal">
     <exclude name="Drupal.WhiteSpace.OpenTagNewline.BlankLine"/>
+    <exclude name="Drupal.Commenting.TodoComment.TodoFormat"/>
     <exclude name="Drupal.Commenting.Deprecated"/>
   </rule>
   <rule ref="DrupalPractice" />

diff --git a/src/Client.php b/src/Client.php
@@ -2,7 +2,6 @@
 
 namespace swichers\Acsf\Client;
 
-use Exception;
 use swichers\Acsf\Client\Discovery\ActionManagerInterface;
 use swichers\Acsf\Client\Discovery\EntityManagerInterface;
 use swichers\Acsf\Client\Endpoints\Action\ActionInterface;
@@ -214,7 +213,7 @@ public function testConnection($throwException = FALSE): bool {
         throw $x;
       }
     }
-    catch (Exception $x) {
+    catch (\Exception $x) {
       if ($throwException) {
         throw $x;
       }

diff --git a/src/ClientInterface.php b/src/ClientInterface.php
@@ -6,7 +6,7 @@
 use swichers\Acsf\Client\Endpoints\Entity\EntityInterface;
 
 /**
- * Interface ClientInterface.
+ * Contract for Clients.
  */
 interface ClientInterface {
 

diff --git a/src/Discovery/ActionManager.php b/src/Discovery/ActionManager.php
@@ -3,7 +3,7 @@
 namespace swichers\Acsf\Client\Discovery;
 
 /**
- * Class ActionManager.
+ * Manages Action endpoints.
  */
 class ActionManager extends Manager implements ActionManagerInterface {
 

diff --git a/src/Discovery/ActionManagerInterface.php b/src/Discovery/ActionManagerInterface.php
@@ -3,7 +3,7 @@
 namespace swichers\Acsf\Client\Discovery;
 
 /**
- * Interface ActionManagerInterface.
+ * Contract for action managers.
  */
 interface ActionManagerInterface extends ManagerInterface {
 

diff --git a/src/Discovery/Discoverer.php b/src/Discovery/Discoverer.php
@@ -3,11 +3,10 @@
 namespace swichers\Acsf\Client\Discovery;
 
 use Doctrine\Common\Annotations\Reader;
-use ReflectionClass;
 use Symfony\Component\Finder\Finder;
 
 /**
- * Class Discoverer.
+ * Dynamic Endpoint and Action discoverer.
  */
 class Discoverer implements DiscovererInterface {
 
@@ -102,7 +101,7 @@ protected function discoverItems(): void {
     foreach ($finder as $file) {
       $class = $this->namespace . '\\' . $file->getBasename('.php');
       $annotation = $this->annotationReader->getClassAnnotation(
-        new ReflectionClass($class),
+        new \ReflectionClass($class),
         $this->annotationClass
       );
       if (!$annotation) {

diff --git a/src/Discovery/DiscovererInterface.php b/src/Discovery/DiscovererInterface.php
@@ -3,7 +3,7 @@
 namespace swichers\Acsf\Client\Discovery;
 
 /**
- * Interface DiscovererInterface.
+ * Contract for discoverers.
  */
 interface DiscovererInterface {
 

diff --git a/src/Discovery/EntityManager.php b/src/Discovery/EntityManager.php
@@ -3,7 +3,7 @@
 namespace swichers\Acsf\Client\Discovery;
 
 /**
- * Class EntityManager.
+ * Manages Entity endpoints.
  */
 class EntityManager extends Manager implements EntityManagerInterface {
 

diff --git a/src/Discovery/EntityManagerInterface.php b/src/Discovery/EntityManagerInterface.php
@@ -3,7 +3,7 @@
 namespace swichers\Acsf\Client\Discovery;
 
 /**
- * Interface EntityManagerInterface.
+ * Contract for entity managers.
  */
 interface EntityManagerInterface extends ManagerInterface {
 

diff --git a/src/Discovery/Manager.php b/src/Discovery/Manager.php
@@ -6,7 +6,7 @@
 use swichers\Acsf\Client\Exceptions\MissingEndpointException;
 
 /**
- * Class Manager.
+ * Base manager for discovering entities and actions.
  */
 class Manager implements ManagerInterface {
 

diff --git a/src/Discovery/ManagerInterface.php b/src/Discovery/ManagerInterface.php
@@ -5,7 +5,7 @@
 use swichers\Acsf\Client\Endpoints\EndpointInterface;
 
 /**
- * Interface ManagerInterface.
+ * Contract for managers.
  */
 interface ManagerInterface {
 

diff --git a/src/Endpoints/EndpointInterface.php b/src/Endpoints/EndpointInterface.php
@@ -3,7 +3,7 @@
 namespace swichers\Acsf\Client\Endpoints;
 
 /**
- * Interface EndpointInterface.
+ * Contract for endpoint handlers.
  */
 interface EndpointInterface {
 

diff --git a/src/Endpoints/Entity/AbstractEntity.php b/src/Endpoints/Entity/AbstractEntity.php
@@ -5,7 +5,7 @@
 use swichers\Acsf\Client\ClientInterface;
 
 /**
- * Class AbstractEntity.
+ * Base Entity implementation.
  */
 abstract class AbstractEntity implements EntityInterface {