Various new traits

.gitignore

@@ -0,0 +1 @@
+vendor

composer.json

@@ -10,7 +10,9 @@
         }
     ],
     "require": {
-        "php": "^8"
+        "php": "^8",
+        "drupal/core-utility": "^10 || ^11",
+        "symfony/validator": "^5 || ^6 || ^7"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,

src/Traits/AssertViolationsTrait.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PNX\DrupalTestUtils\Traits;
+
+use Symfony\Component\Validator\ConstraintViolation;
+use Symfony\Component\Validator\ConstraintViolationListInterface;
+
+/**
+ * Defines a trait for asserting violations.
+ */
+trait AssertViolationsTrait {
+
+  /**
+   * Asserts that the expected violations were found.
+   *
+   * @param array $expected
+   *   Expected violation messages keyed by propery paths.
+   * @param \Symfony\Component\Validator\ConstraintViolationListInterface $violations
+   *   A list of violations.
+   */
+  protected static function assertViolations(array $expected, ConstraintViolationListInterface $violations): void {
+    $list = [];
+    foreach ($violations as $violation) {
+      \assert($violation instanceof ConstraintViolation);
+      $list[$violation->getPropertyPath()] = \strip_tags((string) $violation->getMessage());
+    }
+    self::assertEquals($expected, $list);
+  }
+
+  /**
+   * Asserts that an expected violation exists.
+   *
+   * @param string $expected_violation
+   *   Expected violation message.
+   * @param \Symfony\Component\Validator\ConstraintViolationListInterface $violations
+   *   A list of violations.
+   */
+  protected static function assertViolationExists(string $expected_violation, ConstraintViolationListInterface $violations): void {
+    $list = [];
+    foreach ($violations as $violation) {
+      \assert($violation instanceof ConstraintViolation);
+      $list[$violation->getPropertyPath()] = \strip_tags((string) $violation->getMessage());
+    }
+    self::assertContains($expected_violation, $list);
+  }
+
+}

src/Traits/RandomValuesTrait.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PNX\DrupalTestUtils\Traits;
+
+use Drupal\Component\Utility\Random;
+use Symfony\Component\Validator\ConstraintViolation;
+
+/**
+ * Additional random value generation methods.
+ */
+trait RandomValuesTrait {
+
+  /**
+   * Generates a random URL.
+   *
+   * @return string
+   *   Random URL.
+   */
+  protected function randomUrl(): string {
+    $random = new Random();
+    return \sprintf('https://%s.com/%s', $random->name(), $random->name());
+  }
+
+  /**
+   * Generates a random email.
+   *
+   * @return string
+   *   Random email.
+   */
+  protected function randomEmail(): string {
+    $random = new Random();
+    return \sprintf('%s@%s.com', $random->name(), $random->name());
+  }
+
+  /**
+   * Generates a random lat lon pair.
+   */
+  protected function randomLatLonPair(): string {
+    $lon = $this->randomPoint(-180, 180);
+    $lat = $this->randomPoint(-84, 84);
+    return \sprintf('POINT(%s %s)', $lon, $lat);
+  }
+
+  /**
+   * Generates a random lat/lon point.
+   */
+  private function randomPoint(int $min, int $max): float {
+    $number = \mt_rand($min, $max);
+    $decimals = \mt_rand(1, \pow(10, 5)) / \pow(10, 5);
+    return \round($number + $decimals, 5);
+  }
+
+  /**
+   * Generates a random address.
+   *
+   * @return string
+   *   Address.
+   */
+  public function randomAddress(): string {
+    $random = new Random();
+    return \sprintf('%d %s St, %s, %d', \rand(1, 200), $random->name(), $random->name(), \rand(2000, 2999));
+  }
+
+}

src/Traits/SpinTrait.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PNX\DrupalTestUtils\Traits;
+
+/**
+ * Defines a trait for executing a callable until it passes.
+ */
+trait SpinTrait {
+
+  /**
+   * Executes a callable until it returns TRUE.
+   *
+   * Executes executing a task until a condition is met.
+   *
+   * @param callable $lambda
+   *   Callable to evaluate until TRUE or count is reached.
+   * @param int $count
+   *   (optional) Number of times to try, defaults to 10.
+   * @param bool $throw
+   *   (optional) Throw, TRUE to throw if the condition is not met.
+   *
+   * @return bool
+   *   TRUE if lambda evaluated true.
+   *
+   * @throws \Exception
+   *   When the condition is not met.
+   */
+  protected function spin(callable $lambda, $count = 10, $throw = TRUE): bool {
+    $passes = 0;
+    while ($passes < $count) {
+      try {
+        if ($lambda($this)) {
+          return TRUE;
+        }
+      }
+      catch (\Exception $e) {
+        // Do nothing.
+      }
+
+      \usleep(500000);
+      $passes++;
+    }
+    // Max reached.
+    if ($throw) {
+      throw new \Exception(\sprintf('Condition was not met after %d attempts', $count));
+    }
+    return FALSE;
+  }
+
+}