Refactoring project to use an external

configuration.

Author: cyrilverloop

.gitignore

@@ -2,16 +2,14 @@
 /ci/phpunit/
 /ci/psalm/
 /ci/phpunit.xml
-/src/**/*.*
-!/src/Configuration/**/*.php
-!/src/Generator/**/*.php
-!/src/Parser/**/*.php
-!/src/CGCodeInterface.php
-/tests/**/*.*
-!/tests/Configuration/**/*.*
-!/tests/Generator/**/*.*
-!/tests/Parser/**/*.*
-!/tests/CGTestCase.php
+/src/Easy/**/*.*
+/src/Expert/**/*.*
+/src/Hard/**/*.*
+/src/Medium/**/*.*
+/tests/Easy/**/*.*
+/tests/Expert/**/*.*
+/tests/Hard/**/*.*
+/tests/Medium/**/*.*
 /tools/
 /var/cache/
 /vendor/

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+### Changed
+- Configurations, inputs, outputs and default codes are now in a separate project.
+- Default codes and tests are now generated in the `Easy`, `Medium`, `Hard` and `Expert` sub-directories
+of the `src` and `tests` directories.
+
 ## [4.2.0] - 2024-05-13
 ### Added
 - Community training medium configurations.

bin/generate-tests

@@ -9,7 +9,7 @@ echo "\nStarting generation.\n";
 
 $filesGenerator = new FilesGenerator(__DIR__ . '/../templates/');
 $filesGenerator->generate(
-    __DIR__ . '/../config/',
+    __DIR__ . '/../vendor/cyril-verloop/codingame-configuration/config/',
     __DIR__ . '/../src/',
     __DIR__ . '/../tests/'
 );

composer.json

@@ -23,7 +23,8 @@
         "php": "8.3.*",
         "twig/twig": "^3.7",
         "twig/string-extra": "^3.7",
-        "cyril-verloop/iterator": "^3.1"
+        "cyril-verloop/iterator": "^3.1",
+        "cyril-verloop/codingame-configuration": "^1.0"
     },
     "require-dev": {
         "mikey179/vfsstream": "^1.6"

composer.lock

@@ -4,8 +4,11 @@
 
 namespace CyrilVerloop\Codingame\Configuration;
 
-use CyrilVerloop\Codingame\Generator\GeneratorCodeConfiguration;
-use CyrilVerloop\Codingame\Generator\GeneratorTestConfiguration;
+use CyrilVerloop\Codingame\Configuration\TestConfigurations;
+use CyrilVerloop\Codingame\Generator\TestConfiguration as TCGenerator;
+use CyrilVerloop\Codingame\Generator\TestConfigurations as TCsGenerator;
+use CyrilVerloop\Codingame\Generator\CodeGeneratorConfiguration;
+use CyrilVerloop\Codingame\Generator\TestGeneratorConfiguration;
 use CyrilVerloop\Codingame\Parser\ParsedConfiguration;
 
 final class ConfigurationConvertor
@@ -16,51 +19,118 @@ final class ConfigurationConvertor
      * Returns the code configuration for the generator.
      * @param \CyrilVerloop\Codingame\Parser\ParsedConfiguration $parsedConfiguration the parsed configuration.
      * @param string $defaultCodeFile the file with the default code.
-     * @return \CyrilVerloop\Codingame\Generator\GeneratorCodeConfiguration the code configuration for the generator.
+     * @return \CyrilVerloop\Codingame\Generator\CodeGeneratorConfiguration the code configuration for the generator.
      * @throws \RuntimeException if the default code file is not readable.
      */
-    static function getGeneratorCodeConfiguration(
+    static function getCodeGeneratorConfiguration(
         ParsedConfiguration $parsedConfiguration,
         string $defaultCodeFile
-    ): GeneratorCodeConfiguration {
+    ): CodeGeneratorConfiguration {
 
         if (is_readable($defaultCodeFile) === false) {
             throw new \RuntimeException('defaultCodeFileNotReadable');
         }
 
         $defaultCode = file_get_contents($defaultCodeFile);
+
+        return new CodeGeneratorConfiguration(
+            self::convertPathToNamespace($parsedConfiguration->getPath()),
+            $parsedConfiguration->getName(),
+            $parsedConfiguration->getLink(),
+            self::adaptCodeForCodeGenerator($defaultCode)
+        );
+    }
+
+    /**
+     * Converts a path to a namespace.
+     * @param string $path the path.
+     * @return string the namespace.
+     */
+    private static function convertPathToNamespace(string $path): string
+    {
+        $explodedPath = explode('/', $path);
+
+        foreach ($explodedPath as $index => $pathSection) {
+            $explodedPath[$index] = ucfirst($pathSection);
+        }
+
+        return implode('\\', $explodedPath);
+    }
+
+    /**
+     * Adapts the code for the code generator.
+     * @param string $defaultCode the default code.
+     * @return string the adapted code.
+     */
+    private static function adaptCodeForCodeGenerator(string $defaultCode): string
+    {
+        // Removes the PHP open tag :
+        $openTagRemovedCode = preg_replace(
+            '/<\?php\n/',
+            '',
+            $defaultCode
+        );
+
+        // Changes "STDIN" to "$stdin" :
+        $changedStdinCode = preg_replace(
+            '/STDIN/',
+            '$stdin',
+            $openTagRemovedCode
+        );
+
+        // Adds indentation :
         $spaceAddedCode = preg_replace(
             '/\n/',
             "\n        ",
-            $defaultCode
+            $changedStdinCode
         );
-        $indentedDefaultCode = preg_replace(
+
+        // Removes indentation for empty lines :
+        return preg_replace(
             '/\n        \n/',
             "\n\n",
             $spaceAddedCode
         );
-
-        return new GeneratorCodeConfiguration(
-            $parsedConfiguration->getNamespace(),
-            $parsedConfiguration->getName(),
-            $parsedConfiguration->getLink(),
-            $indentedDefaultCode
-        );
     }
 
+
     /**
      * Returns the test configuration for the generator.
      * @param \CyrilVerloop\Codingame\Parser\ParsedConfiguration $parsedConfiguration the parsed configuration.
-     * @return \CyrilVerloop\Codingame\Generator\GeneratorTestConfiguration the test configuration for the generator.
+     * @return \CyrilVerloop\Codingame\Generator\TestGeneratorConfiguration the test configuration for the generator.
      */
-    static function getGeneratorTestConfiguration(
+    static function getTestGeneratorConfiguration(
         ParsedConfiguration $parsedConfiguration,
-    ): GeneratorTestConfiguration {
-        return new GeneratorTestConfiguration(
-            $parsedConfiguration->getNamespace(),
+    ): TestGeneratorConfiguration {
+        return new TestGeneratorConfiguration(
+            self::convertPathToNamespace($parsedConfiguration->getPath()),
             $parsedConfiguration->getName(),
-            $parsedConfiguration->getGroup(),
-            $parsedConfiguration->getTestConfigurations()
+            $parsedConfiguration->getAlphanumName(),
+            self::convertTestConfigurationsForGenerator($parsedConfiguration->getTestConfigurations())
         );
     }
+
+    /**
+     * Converts the tests configurations.
+     * @param TestConfigurations $testConfigurations the tests configurations.
+     * @return \CyrilVerloop\Codingame\Generator\TestConfigurations the tests configurations.
+     */
+    private static function convertTestConfigurationsForGenerator(
+        TestConfigurations $testConfigurations
+    ): TCsGenerator {
+        $tCsGenerator = new TCsGenerator();
+
+        foreach ($testConfigurations as $testConfiguration) {
+            $tCGenerator = new TCGenerator(
+                $testConfiguration->getName(),
+                $testConfiguration->getAlphanumName(),
+                ucfirst($testConfiguration->getAlphanumName()),
+                $testConfiguration->getFile()
+            );
+
+            $tCsGenerator->add($tCGenerator);
+        }
+
+        return $tCsGenerator;
+    }
 }

src/Configuration/ConfigurationConvertor.php

@@ -17,14 +17,9 @@ final class TestConfiguration
     private string $name;
 
     /**
-     * @var string the group.
+     * @var string the alphanumeric name.
      */
-    private string $group;
-
-    /**
-     * @var string the method.
-     */
-    private string $method;
+    private string $alphanumName;
 
     /**
      * @var string the file.
@@ -37,19 +32,16 @@ final class TestConfiguration
     /**
      * The constructor.
      * @param string $name the name.
-     * @param string $group the group.
-     * @param string $method the method.
+     * @param string $alphanumName the alphanumeric name.
      * @param string $file the file.
      */
     public function __construct(
         string $name,
-        string $group,
-        string $method,
+        string $alphanumName,
         string $file
     ) {
         $this->name = $name;
-        $this->group = $group;
-        $this->method = $method;
+        $this->alphanumName = $alphanumName;
         $this->file = $file;
     }
 
@@ -66,21 +58,12 @@ public function getName(): string
     }
 
     /**
-     * Returns the group.
-     * @return string the group.
-     */
-    public function getGroup(): string
-    {
-        return $this->group;
-    }
-
-    /**
-     * Returns the method.
-     * @return string the method.
+     * Returns the alphanumeric name.
+     * @return string the alphanumeric name.
      */
-    public function getMethod(): string
+    public function getAlphanumName(): string
     {
-        return $this->method;
+        return $this->alphanumName;
     }
 
     /**

src/Configuration/TestConfiguration.php

@@ -14,23 +14,23 @@ final class CGCodeGenerator extends FileGenerator
     /**
      * The template file name.
      */
-    private const TEMPLATE_FILE_NAME = 'CGCode.twig';
+    private const string TEMPLATE_FILE_NAME = 'CGCode.twig';
 
     /**
      * The php file name.
      */
-    private const PHP_FILE_NAME = 'CGCode.php';
+    private const string PHP_FILE_NAME = 'CGCode.php';
 
 
     // Methods :
 
     /**
      * Generates the code.
-     * @param \CyrilVerloop\Codingame\Generator\GeneratorCodeConfiguration $configuration the code configuration.
+     * @param \CyrilVerloop\Codingame\Generator\CodeGeneratorConfiguration $configuration the code configuration.
      * @param string $toPath the path where to put the generated code.
      */
     public function generate(
-        GeneratorCodeConfiguration $configuration,
+        CodeGeneratorConfiguration $configuration,
         string $toPath
     ): void {
         $codeFile = $toPath . self::PHP_FILE_NAME;

src/Generator/CGCodeGenerator.php

@@ -16,34 +16,34 @@ final class CGTestGenerator extends FileGenerator
     /**
      * The template file name.
      */
-    private const TEMPLATE_FILE_NAME = 'CGTest.twig';
+    private const string TEMPLATE_FILE_NAME = 'CGTest.twig';
 
     /**
      * The php file name.
      */
-    private const PHP_FILE_NAME = 'CGTest.php';
+    private const string PHP_FILE_NAME = 'CGTest.php';
 
     /**
      * The input path.
      */
-    private const INPUT_PATH = 'input' . DIRECTORY_SEPARATOR;
+    private const string INPUT_PATH = 'input' . DIRECTORY_SEPARATOR;
 
     /**
      * The output path.
      */
-    private const OUTPUT_PATH = 'output' . DIRECTORY_SEPARATOR;
+    private const string OUTPUT_PATH = 'output' . DIRECTORY_SEPARATOR;
 
 
     // Methods :
 
     /**
      * Generates the test.
-     * @param \CyrilVerloop\Codingame\Generator\GeneratorTestConfiguration $configuration the test configuration.
+     * @param \CyrilVerloop\Codingame\Generator\TestGeneratorConfiguration $configuration the test configuration.
      * @param string $fromPath the path where the config file is.
      * @param string $toPath the path where to put the generated test.
      */
     public function generate(
-        GeneratorTestConfiguration $configuration,
+        TestGeneratorConfiguration $configuration,
         string $fromPath,
         string $toPath
     ): void {