Merge pull request #245 from php-school/ns-functions

Namespace functions

Author: AydinHassan

app/config.php

@@ -15,6 +15,7 @@
 use function DI\create;
 use function DI\factory;
 use Kadet\Highlighter\KeyLighter;
+use function PhpSchool\PhpWorkshop\canonicalise_path;
 use function PhpSchool\PhpWorkshop\Event\containerListener;
 use Psr\Container\ContainerInterface;
 use League\CommonMark\DocParser;

composer.json

@@ -36,7 +36,7 @@
     "require-dev": {
         "phpunit/phpunit": "^8.5",
         "composer/composer": "^2.0",
-        "squizlabs/php_codesniffer": "^3.4",
+        "squizlabs/php_codesniffer": "^3.7",
         "phpstan/phpstan": "^1.8",
         "phpstan/extension-installer": "^1.0",
         "yoast/phpunit-polyfills": "^0.2.0"

composer.lock

@@ -4,6 +4,8 @@
 
 namespace PhpSchool\PhpWorkshop\Exception;
 
+use function PhpSchool\PhpWorkshop\canonicalise_path;
+
 class ProblemFileDoesNotExistException extends \RuntimeException
 {
     public static function fromFile(string $file): self

src/Exception/ProblemFileDoesNotExistException.php

@@ -21,7 +21,7 @@
 use PhpSchool\PhpWorkshop\UserState;
 use PhpSchool\PhpWorkshop\Result\FailureInterface;
 
-use function mb_str_pad;
+use function PhpSchool\PhpWorkshop\mb_str_pad;
 
 /**
  * Renderer which renders a `PhpSchool\PhpWorkshop\ResultAggregator` and writes it to the output.

src/ResultRenderer/ResultsRenderer.php

@@ -31,6 +31,8 @@
 use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Process\Process;
 
+use function PhpSchool\PhpWorkshop\collect;
+
 abstract class WorkshopExerciseTest extends TestCase
 {
     /**

src/TestUtils/WorkshopExerciseTest.php

@@ -2,93 +2,76 @@
 
 declare(strict_types=1);
 
+namespace PhpSchool\PhpWorkshop;
+
 use PhpSchool\PhpWorkshop\Utils\Collection;
 use PhpSchool\PhpWorkshop\Utils\StringUtils;
 
-if (!function_exists('mb_str_pad')) {
-
-    /**
-     * @param string $input
-     * @param int $padLength
-     * @param string $padString
-     * @param int $padType
-     * @return string
-     */
-    function mb_str_pad(string $input, int $padLength, string $padString = ' ', int $padType = STR_PAD_RIGHT): string
-    {
-        $diff = strlen($input) - mb_strlen($input);
-        return str_pad($input, $padLength + $diff, $padString, $padType);
-    }
+/**
+ * @param string $input
+ * @param int $padLength
+ * @param string $padString
+ * @param int $padType
+ * @return string
+ */
+function mb_str_pad(string $input, int $padLength, string $padString = ' ', int $padType = STR_PAD_RIGHT): string
+{
+    $diff = strlen($input) - mb_strlen($input);
+    return str_pad($input, $padLength + $diff, $padString, $padType);
 }
 
-if (!function_exists('camel_case_to_kebab_case')) {
-
-    /**
-     * @param string $string
-     * @return string
-     */
-    function camel_case_to_kebab_case(string $string): string
-    {
-        return (string) preg_replace_callback('/[A-Z]/', function ($matches) {
-            return '-' . strtolower($matches[0]);
-        }, $string);
-    }
+/**
+ * @param string $string
+ * @return string
+ */
+function camel_case_to_kebab_case(string $string): string
+{
+    return (string) preg_replace_callback('/[A-Z]/', function ($matches) {
+        return '-' . strtolower($matches[0]);
+    }, $string);
 }
 
-if (!function_exists('canonicalise_path')) {
-
-    /**
-     * @param string $path
-     * @return string
-     */
-    function canonicalise_path(string $path): string
-    {
-        return StringUtils::canonicalisePath($path);
-    }
+/**
+ * @param string $path
+ * @return string
+ */
+function canonicalise_path(string $path): string
+{
+    return StringUtils::canonicalisePath($path);
 }
 
-if (!function_exists('pluralise')) {
-
-    /**
-     * @param string $string
-     * @param array<mixed> $items
-     * @param string[] ...$args
-     * @return string
-     */
-    function pluralise(string $string, array $items, string ...$args): string
-    {
-        return StringUtils::pluralise($string, $items, ...$args);
-    }
+/**
+ * @param string $string
+ * @param array<mixed> $items
+ * @param string[] ...$args
+ * @return string
+ */
+function pluralise(string $string, array $items, string ...$args): string
+{
+    return StringUtils::pluralise($string, $items, ...$args);
 }
 
-if (!function_exists('collect')) {
-
-    /**
-     * @template TKey of array-key
-     * @template T
-     * @param array<TKey, T> $array
-     * @return Collection<TKey, T>
-     */
-    function collect(array $array): Collection
-    {
-        /** @var Collection<TKey, T> $collection */
-        $collection = new Collection($array);
-        return $collection;
-    }
+/**
+ * @template TKey of array-key
+ * @template T
+ * @param array<TKey, T> $array
+ * @return Collection<TKey, T>
+ */
+function collect(array $array): Collection
+{
+    /** @var Collection<TKey, T> $collection */
+    $collection = new Collection($array);
+    return $collection;
 }
 
-
-if (!function_exists('any')) {
-
-    /**
-     * @param array<mixed> $values
-     * @param callable $cb
-     * @return bool
-     */
-    function any(array $values, callable $cb): bool
-    {
-        return array_reduce($values, function (bool $carry, $value) use ($cb) {
-            return $carry || $cb($value);
-        }, false);
-    }
+/**
+ * @param array<mixed> $values
+ * @param callable $cb
+ * @return bool
+ */
+function any(array $values, callable $cb): bool
+{
+    return array_reduce($values, function (bool $carry, $value) use ($cb) {
+        return $carry || $cb($value);
+    }, false);
 }

src/functions.php

@@ -4,6 +4,10 @@
 
 use PHPUnit\Framework\TestCase;
 
+use function PhpSchool\PhpWorkshop\any;
+use function PhpSchool\PhpWorkshop\camel_case_to_kebab_case;
+use function PhpSchool\PhpWorkshop\mb_str_pad;
+
 class FunctionsTest extends TestCase
 {
     /**

test/FunctionsTest.php

@@ -23,6 +23,8 @@
 use PhpSchool\PhpWorkshop\UserState;
 use PHPUnit\Framework\TestCase;
 
+use function PhpSchool\PhpWorkshop\camel_case_to_kebab_case;
+
 class ResultsRendererTest extends BaseTest
 {
     public function testRenderIndividualResult(): void