tests(phpcs): Fix doc comment, spacing and default value rules (#1069)

Dylan203 · web-flow · commit 0c3669468a01 · 2020-08-17T12:42:42.000+02:00
diff --git a/examples/graphql_example/src/Plugin/GraphQL/DataProducer/QueryArticles.php b/examples/graphql_example/src/Plugin/GraphQL/DataProducer/QueryArticles.php
@@ -62,7 +62,6 @@ public static function create(ContainerInterface $container, array $configuratio
    *   The plugin id.
    * @param mixed $pluginDefinition
    *   The plugin definition.
-   *
    * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityManager
    *
    * @codeCoverageIgnore
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -7,14 +7,6 @@
 
   <rule ref="Drupal">
     <!-- TODO: those rules are disabled for now until we fix the coding standards for them. -->
-    <exclude name="Generic.Functions.OpeningFunctionBraceKernighanRitchie.ContentAfterBrace"/>
-    <exclude name="Generic.Functions.OpeningFunctionBraceKernighanRitchie.SpaceBeforeBrace"/>
-    <exclude name="PEAR.Functions.ValidDefaultValue.NotAtEnd"/>
-    <exclude name="PSR2.Namespaces.NamespaceDeclaration.BlankLineAfter"/>
-    <exclude name="PSR2.Namespaces.UseDeclaration.SpaceAfterLastUse"/>
-    <exclude name="Squiz.Functions.FunctionDeclarationArgumentSpacing.SpaceBeforeComma"/>
-    <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.SpaceAfterFunction"/>
-    <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.SpaceBeforeBrace"/>
     <exclude name="Drupal.Arrays.Array.CommaLastItem"/>
     <exclude name="Drupal.Arrays.Array.LongLineDeclaration"/>
     <exclude name="Drupal.Arrays.DisallowLongArraySyntax.Found"/>
@@ -23,11 +15,7 @@
     <exclude name="Drupal.Classes.PropertyDeclaration.ScopeMissing"/>
     <exclude name="Drupal.Classes.UnusedUseStatement.UnusedUse"/>
     <exclude name="Drupal.Commenting.ClassComment.Missing"/>
-    <exclude name="Drupal.Commenting.DataTypeNamespace.DataTypeNamespace"/>
     <exclude name="Drupal.Commenting.DocComment.MissingShort"/>
-    <exclude name="Drupal.Commenting.DocComment.ParamGroup"/>
-    <exclude name="Drupal.Commenting.DocComment.ShortFullStop"/>
-    <exclude name="Drupal.Commenting.DocComment.SpacingAfter"/>
     <exclude name="Drupal.Commenting.FunctionComment.MissingParamComment"/>
     <exclude name="Drupal.Commenting.FunctionComment.MissingParamType"/>
     <exclude name="Drupal.Commenting.FunctionComment.MissingReturnComment"/>
diff --git a/src/Annotation/PersistedQuery.php b/src/Annotation/PersistedQuery.php
@@ -2,7 +2,6 @@
 
 namespace Drupal\graphql\Annotation;
 
-
 use Doctrine\Common\Annotations\AnnotationException;
 use Drupal\Component\Annotation\Plugin;
 
diff --git a/src/Controller/ServerListBuilder.php b/src/Controller/ServerListBuilder.php
@@ -7,7 +7,7 @@
 use Drupal\Core\Url;
 
 /**
- * Class ServerListBuilder
+ * Class ServerListBuilder.
  *
  * @package Drupal\graphql\Controller
  *
diff --git a/src/Entity/ServerInterface.php b/src/Entity/ServerInterface.php
@@ -23,7 +23,7 @@ public function executeOperation(OperationParams $operation);
   public function executeBatch(array $operations);
 
   /**
-   * Retrieves the server configuration
+   * Retrieves the server configuration.
    *
    * @return \GraphQL\Server\ServerConfig
    *   The server configuration.
@@ -33,7 +33,7 @@ public function configuration();
   /**
    * Adds a Persisted Query plugin instance to the persisted queries set.
    *
-   * @param PersistedQueryPluginInterface $queryPlugin
+   * @param \Drupal\graphql\Plugin\PersistedQueryPluginInterface $queryPlugin
    */
   public function addPersistedQueryInstance(PersistedQueryPluginInterface $queryPlugin);
 
diff --git a/src/Form/PersistedQueriesForm.php b/src/Form/PersistedQueriesForm.php
@@ -14,7 +14,7 @@
 class PersistedQueriesForm extends EntityForm {
 
   /**
-   * @var PersistedQueryPluginManager
+   * @var \Drupal\graphql\Plugin\PersistedQueryPluginManager
    */
   protected $persistedQueryPluginManager;
 
@@ -183,7 +183,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
   /**
    * Returns an array with all the available persisted query plugins.
    *
-   * @return PersistedQueryPluginInterface[]
+   * @return \Drupal\graphql\Plugin\PersistedQueryPluginInterface[]
    */
   protected function getAllPersistedQueryPlugins() {
     $plugins = [];
diff --git a/src/GraphQL/Execution/Executor.php b/src/GraphQL/Execution/Executor.php
@@ -251,7 +251,7 @@ protected function doExecuteUncached() {
     $event = new OperationEvent($this->context);
     $this->dispatcher->dispatch(OperationEvent::GRAPHQL_OPERATION_BEFORE, $event);
 
-    return $executor->doExecute()->then(function ($result)  {
+    return $executor->doExecute()->then(function ($result) {
       $event = new OperationEvent($this->context, $result);
       $this->dispatcher->dispatch(OperationEvent::GRAPHQL_OPERATION_AFTER, $event);
 
diff --git a/src/GraphQL/ResolverBuilder.php b/src/GraphQL/ResolverBuilder.php
@@ -43,7 +43,7 @@ public function compose(ResolverInterface ...$resolvers) {
   }
 
   /**
-   * @param ResolverInterface $callback
+   * @param \Drupal\graphql\GraphQL\Resolver\ResolverInterface $callback
    *
    * @return \Drupal\graphql\GraphQL\Resolver\Tap
    */
@@ -52,7 +52,7 @@ public function tap(ResolverInterface $callback) {
   }
 
   /**
-   * @param ResolverInterface $callback
+   * @param \Drupal\graphql\GraphQL\Resolver\ResolverInterface $callback
    *
    * @return \Drupal\graphql\GraphQL\Resolver\Map
    */
diff --git a/src/GraphQL/Utility/Introspection.php b/src/GraphQL/Utility/Introspection.php
@@ -16,7 +16,6 @@ class Introspection {
    *
    * @return array
    *   The introspection result as an array.
-   *
    */
   public function introspect(ServerInterface $server) {
     $operation = new OperationParams();
diff --git a/src/GraphQL/Utility/JsonHelper.php b/src/GraphQL/Utility/JsonHelper.php
@@ -14,7 +14,7 @@ class JsonHelper {
    *   The decoded values.
    */
   public static function decodeParams(array $values = []) {
-    return array_map(function($value) {
+    return array_map(function ($value) {
       if (!is_string($value)) {
         return $value;
       }
diff --git a/src/PermissionProvider.php b/src/PermissionProvider.php
@@ -9,7 +9,7 @@ class PermissionProvider {
   use StringTranslationTrait;
 
   /**
-   * The entity type manager service
+   * The entity type manager service.
    *
    * @var \Drupal\Core\Authentication\AuthenticationCollectorInterface
    */
diff --git a/src/Plugin/GraphQL/DataProducer/DataProducerProxy.php b/src/Plugin/GraphQL/DataProducer/DataProducerProxy.php
@@ -179,7 +179,7 @@ public function resolve($value, $args, ResolveContext $context, ResolveInfo $inf
    * @throws \Exception
    */
   protected function prepare($value, $args, ResolveContext $context, ResolveInfo $info, FieldContext $field) {
-    /** @var DataProducerPluginInterface $plugin */
+    /** @var \Drupal\graphql\Plugin\DataProducerPluginInterface $plugin */
     $plugin = $this->pluginManager->createInstance($this->id, $this->config);
     $contexts = $plugin->getContextDefinitions();
 
diff --git a/src/Plugin/GraphQL/DataProducer/Entity/EntityRendered.php b/src/Plugin/GraphQL/DataProducer/Entity/EntityRendered.php
@@ -100,14 +100,14 @@ public function __construct(
    *
    * @return string
    */
-  public function resolve(EntityInterface $entity, $mode = NULL, RefinableCacheableDependencyInterface $metadata) {
+  public function resolve(EntityInterface $entity, $mode, RefinableCacheableDependencyInterface $metadata) {
     $mode = $mode ?? 'full';
     $builder = $this->entityTypeManager->getViewBuilder($entity->getEntityTypeId());
     $view = $builder->view($entity, $mode, $entity->language()->getId());
 
     $context = new RenderContext();
     /** @var \GraphQL\Executor\ExecutionResult|\GraphQL\Executor\ExecutionResult[] $result */
-    $result = $this->renderer->executeInRenderContext($context, function() use ($view) {
+    $result = $this->renderer->executeInRenderContext($context, function () use ($view) {
       return $this->renderer->render($view);
     });
 
diff --git a/src/Plugin/GraphQL/DataProducer/Entity/EntityTranslations.php b/src/Plugin/GraphQL/DataProducer/Entity/EntityTranslations.php
@@ -95,7 +95,7 @@ public function __construct(array $configuration, $pluginId, $pluginDefinition,
    *
    * @return array|null
    */
-  public function resolve(EntityInterface $entity, ?bool $access , ?AccountInterface $accessUser, ?string $accessOperation) {
+  public function resolve(EntityInterface $entity, ?bool $access, ?AccountInterface $accessUser, ?string $accessOperation) {
     if ($entity instanceof TranslatableInterface && $entity->isTranslatable()) {
       $languages = $entity->getTranslationLanguages();
 
diff --git a/src/Plugin/GraphQL/DataProducer/Field/EntityReference.php b/src/Plugin/GraphQL/DataProducer/Field/EntityReference.php
@@ -141,7 +141,7 @@ public function __construct(
    *
    * @return \GraphQL\Deferred|null
    */
-  public function resolve(EntityInterface $entity, $field, $language = NULL, ?array $bundles, ?bool $access, ?AccountInterface $accessUser, ?string $accessOperation, FieldContext $context) {
+  public function resolve(EntityInterface $entity, $field, $language, ?array $bundles, ?bool $access, ?AccountInterface $accessUser, ?string $accessOperation, FieldContext $context) {
     if (!$entity instanceof FieldableEntityInterface || !$entity->hasField($field)) {
       return NULL;
     }
diff --git a/src/Plugin/GraphQL/DataProducer/Menu/MenuTree/MenuTreeSubtree.php b/src/Plugin/GraphQL/DataProducer/Menu/MenuTree/MenuTreeSubtree.php
@@ -32,7 +32,7 @@ class MenuTreeSubtree extends DataProducerPluginBase {
    * @return mixed
    */
   public function resolve(MenuLinkTreeElement $element) {
-    return array_filter($element->subtree, function(MenuLinkTreeElement $item) {
+    return array_filter($element->subtree, function (MenuLinkTreeElement $item) {
       if ($item->link instanceof MenuLinkInterface) {
         return $item->link->isEnabled();
       }
diff --git a/src/Plugin/GraphQL/DataProducer/Routing/RouteEntity.php b/src/Plugin/GraphQL/DataProducer/Routing/RouteEntity.php
@@ -14,7 +14,6 @@
 use GraphQL\Deferred;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
-
 /**
  * @DataProducer(
  *   id = "route_entity",
@@ -98,7 +97,7 @@ public function __construct(
   /**
    * {@inheritdoc}
    */
-  public function resolve($url, $language = NULL, FieldContext $context) {
+  public function resolve($url, $language, FieldContext $context) {
     if ($url instanceof Url) {
       list(, $type) = explode('.', $url->getRouteName());
       $parameters = $url->getRouteParameters();
diff --git a/src/Plugin/GraphQL/DataProducer/TypedData/PropertyPath.php b/src/Plugin/GraphQL/DataProducer/TypedData/PropertyPath.php
@@ -45,7 +45,7 @@ class PropertyPath extends DataProducerPluginBase {
    *
    * @return mixed
    */
-  public function resolve($path, $value, $type = NULL, RefinableCacheableDependencyInterface $metadata) {
+  public function resolve($path, $value, $type, RefinableCacheableDependencyInterface $metadata) {
     if (!($value instanceof TypedDataInterface) && !empty($type)) {
       $manager = $this->getTypedDataManager();
       $definition = $manager->createDataDefinition($type);
diff --git a/src/Plugin/MenuLink/Deriver/ExplorerMenuLinkDeriver.php b/src/Plugin/MenuLink/Deriver/ExplorerMenuLinkDeriver.php
@@ -6,7 +6,7 @@
 use Drupal\graphql\Entity\Server;
 
 /**
- * Class ExplorerMenuLinkDeriver
+ * Class ExplorerMenuLinkDeriver.
  *
  * @package Drupal\graphql\Plugin\MenuLink\Deriver
  *
diff --git a/src/Plugin/MenuLink/Deriver/VoyagerMenuLinkDeriver.php b/src/Plugin/MenuLink/Deriver/VoyagerMenuLinkDeriver.php
@@ -6,7 +6,7 @@
 use Drupal\graphql\Entity\Server;
 
 /**
- * Class VoyagerMenuLinkDeriver
+ * Class VoyagerMenuLinkDeriver.
  *
  * @package Drupal\graphql\Plugin\MenuLink\Deriver
  *
diff --git a/src/Plugin/SchemaExtensionPluginManager.php b/src/Plugin/SchemaExtensionPluginManager.php
@@ -7,7 +7,7 @@
 use Drupal\Core\Plugin\DefaultPluginManager;
 
 /**
- * Class SchemaExtensionPluginManager
+ * Class SchemaExtensionPluginManager.
  *
  * @package Drupal\graphql\Plugin
  *
diff --git a/src/Plugin/SchemaPluginManager.php b/src/Plugin/SchemaPluginManager.php
@@ -7,7 +7,7 @@
 use Drupal\Core\Plugin\DefaultPluginManager;
 
 /**
- * Class SchemaPluginManager
+ * Class SchemaPluginManager.
  *
  * @package Drupal\graphql\Plugin
  *
diff --git a/tests/src/Kernel/DataProducer/EntityTest.php b/tests/src/Kernel/DataProducer/EntityTest.php
@@ -21,7 +21,7 @@
 class EntityTest extends GraphQLTestBase {
 
   /**
-   * @var NodeInterface
+   * @var \Drupal\node\NodeInterface
    */
   protected $node;
 
diff --git a/tests/src/Kernel/Framework/ResultCacheTest.php b/tests/src/Kernel/Framework/ResultCacheTest.php
@@ -330,7 +330,7 @@ function ($a, $b, $c, $d, FieldContext $field) use ($renderer) {
         ];
 
         $renderContext = new RenderContext();
-        $value = $renderer->executeInRenderContext($renderContext, function () use ($renderer, $el){
+        $value = $renderer->executeInRenderContext($renderContext, function () use ($renderer, $el) {
           return $renderer->render($el)->__toString();
         });
 
@@ -352,7 +352,7 @@ function ($a, $b, $c, $d, FieldContext $field) use ($renderer) {
         ];
 
         $renderContext = new RenderContext();
-        $value = $renderer->executeInRenderContext($renderContext, function () use ($renderer, $el){
+        $value = $renderer->executeInRenderContext($renderContext, function () use ($renderer, $el) {
           return $renderer->render($el)->__toString();
         });
 

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,6 @@ public static function create(ContainerInterface $container, array $configuratio`
`62`	`62`	`* The plugin id.`
`63`	`63`	`* @param mixed $pluginDefinition`
`64`	`64`	`* The plugin definition.`
`65`		`- *`
`66`	`65`	`* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityManager`
`67`	`66`	`*`
`68`	`67`	`* @codeCoverageIgnore`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`use Drupal\Core\Url;`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * Class ServerListBuilder`
	`10`	`+ * Class ServerListBuilder.`
`11`	`11`	`*`
`12`	`12`	`* @package Drupal\graphql\Controller`
`13`	`13`	`*`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public function compose(ResolverInterface ...$resolvers) {`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`/**`
`46`		`- * @param ResolverInterface $callback`
	`46`	`+ * @param \Drupal\graphql\GraphQL\Resolver\ResolverInterface $callback`
`47`	`47`	`*`
`48`	`48`	`* @return \Drupal\graphql\GraphQL\Resolver\Tap`
`49`	`49`	`*/`
`@@ -52,7 +52,7 @@ public function tap(ResolverInterface $callback) {`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`/**`
`55`		`- * @param ResolverInterface $callback`
	`55`	`+ * @param \Drupal\graphql\GraphQL\Resolver\ResolverInterface $callback`
`56`	`56`	`*`
`57`	`57`	`* @return \Drupal\graphql\GraphQL\Resolver\Map`
`58`	`58`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,6 @@ class Introspection {`
`16`	`16`	`*`
`17`	`17`	`* @return array`
`18`	`18`	`* The introspection result as an array.`
`19`		`- *`
`20`	`19`	`*/`
`21`	`20`	`public function introspect(ServerInterface $server) {`
`22`	`21`	`$operation = new OperationParams();`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ class JsonHelper {`
`14`	`14`	`* The decoded values.`
`15`	`15`	`*/`
`16`	`16`	`public static function decodeParams(array $values = []) {`
`17`		`- return array_map(function($value) {`
	`17`	`+ return array_map(function ($value) {`
`18`	`18`	`if (!is_string($value)) {`
`19`	`19`	`return $value;`
`20`	`20`	`}`