Initial commit

sandrokeil · sandrokeil · commit 868a33379c1a · 2020-08-07T09:16:33.000+02:00
diff --git a/.docheader b/.docheader
@@ -0,0 +1,5 @@
+/**
+ * @see       https://github.com/open-code-modeling/php-code-generator-transformator for the canonical source repository
+ * @copyright https://github.com/open-code-modeling/php-code-generator-transformator/blob/master/COPYRIGHT.md
+ * @license   https://github.com/open-code-modeling/php-code-generator-transformator/blob/master/LICENSE.md MIT License
+ */
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,8 @@
+.env
+app.env
+.phpunit.result.cache
+build/*
+vendor/
+composer.lock
+.idea
+.php_cs.cache
diff --git a/.php_cs b/.php_cs
@@ -0,0 +1,10 @@
+<?php
+
+$config = new Prooph\CS\Config\Prooph();
+$config->getFinder()->in(__DIR__);
+
+$cacheDir = getenv('TRAVIS') ? getenv('HOME') . '/.php-cs-fixer' : __DIR__;
+
+$config->setCacheFile($cacheDir . '/.php_cs.cache');
+
+return $config;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1 @@
+# Changelog
diff --git a/COPYRIGHT.md b/COPYRIGHT.md
@@ -0,0 +1 @@
+Copyright (c) 2020 Sandro Keil
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2020 Sandro Keil
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,9 @@
+# PHP Code Generator Transformator
+
+Transformator for PHP Code Generator. Can be used standalone in a workflow or by a Cartridge.
+
+## Installation
+
+```bash
+$ composer require open-code-modeling/php-code-generator-transformator --dev
+```
diff --git a/composer.json b/composer.json
@@ -0,0 +1,71 @@
+{
+    "name": "open-code-modeling/php-code-generator-transformator",
+    "description": "Open Code Modeling PHP Code Generator Transformator",
+    "license": "MIT",
+    "type": "library",
+    "authors": [
+        {
+            "name": "Sandro Keil",
+            "homepage": "https://sandro-keil.de",
+            "role": "maintainer"
+        }
+    ],
+    "support": {
+        "issues": "https://github.com/open-code-modeling/php-code-generator-transformator/issues",
+        "source": "https://github.com/open-code-modeling/php-code-generator-transformator"
+    },
+    "autoload": {
+        "psr-4": {
+            "OpenCodeModeling\\CodeGenerator\\Transformator\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "OpenCodeModelingTest\\CodeGenerator\\Transformator\\": "tests/"
+        }
+    },
+    "require": {
+        "ext-dom": "*"
+    },
+    "require-dev": {
+        "open-code-modeling/php-code-generator": "*",
+        "phpspec/prophecy-phpunit": "^2.0",
+        "phpstan/phpstan": "^0.12.33",
+        "phpstan/phpstan-strict-rules": "^0.12.4",
+        "phpunit/phpunit": "^9.2.6",
+        "prooph/php-cs-fixer-config": "^0.3",
+        "roave/security-advisories": "dev-master",
+        "squizlabs/php_codesniffer": "^3.4"
+    },
+    "suggest": {
+        "open-code-modeling/php-code-generator": "To use the static factory methods for Code Generator workflow configuration"
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "scripts": {
+        "check": [
+            "@cs",
+            "@docheader",
+            "@test"
+        ],
+        "docheader": "vendor/bin/docheader check src/ tests/",
+        "cs": "php-cs-fixer fix src -v --diff --dry-run",
+        "cs-fix": "php-cs-fixer fix src -v --diff",
+        "test": "vendor/bin/phpunit",
+        "analyse": "php vendor/bin/phpstan.phar analyse --no-interaction"
+    },
+    "config": {
+        "sort-packages": true,
+        "platform": {
+        }
+    },
+    "archive": {
+        "exclude": [
+            ".coveralls.yml",
+            ".travis.yml",
+            "build",
+            "phpunit.xml*",
+            "tests"
+        ]
+    }
+}
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -0,0 +1,6 @@
+parameters:
+  level: 5
+  paths:
+    - src/
+  excludes_analyse:
+    - src/PhpCodeSniffer.php
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+        colors="true"
+        cacheResult="true"
+        stopOnFailure="false"
+        convertErrorsToExceptions="true"
+        convertNoticesToExceptions="true"
+        convertWarningsToExceptions="true"
+        backupGlobals="false"
+        backupStaticAttributes="false"
+        failOnRisky="true"
+        failOnWarning="true"
+>
+    <testsuite name="Open Code Modeling Code Generator Transformator - Test Suite">
+        <directory suffix=".php">./tests</directory>
+    </testsuite>
+
+    <filter>
+        <whitelist>
+            <directory>./src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>
diff --git a/src/CodeListMiddleware.php b/src/CodeListMiddleware.php
@@ -0,0 +1,54 @@
+<?php
+
+/**
+ * @see       https://github.com/open-code-modeling/php-code-generator-transformator for the canonical source repository
+ * @copyright https://github.com/open-code-modeling/php-code-generator-transformator/blob/master/COPYRIGHT.md
+ * @license   https://github.com/open-code-modeling/php-code-generator-transformator/blob/master/LICENSE.md MIT License
+ */
+
+declare(strict_types=1);
+
+namespace OpenCodeModeling\CodeGenerator\Transformator;
+
+use OpenCodeModeling\CodeGenerator\Transformator\Exception\RuntimeException;
+use OpenCodeModeling\CodeGenerator\Workflow;
+
+class CodeListMiddleware
+{
+    /**
+     * @var callable
+     **/
+    private $component;
+
+    public function __construct(callable $stringMiddleware)
+    {
+        $this->component = $stringMiddleware;
+    }
+
+    public function __invoke(array $codeList): array
+    {
+        foreach ($codeList as $name => &$info) {
+            if (! isset($info['code']) || ! isset($info['filename'])) {
+                throw new RuntimeException(
+                    'Invalid code list info provided. Need array with key "code" and "filename".'
+                );
+            }
+
+            $info['code'] = ($this->component)($info['code']);
+        }
+
+        return $codeList;
+    }
+
+    public static function workflowComponentDescription(
+        callable $component,
+        string $inputCodeList,
+        string $output
+    ): Workflow\Description {
+        return new Workflow\ComponentDescriptionWithSlot(
+            new self($component),
+            $output,
+            $inputCodeList
+        );
+    }
+}
diff --git a/src/CodeListToFiles.php b/src/CodeListToFiles.php
@@ -0,0 +1,51 @@
+<?php
+
+/**
+ * @see       https://github.com/open-code-modeling/php-code-generator-transformator for the canonical source repository
+ * @copyright https://github.com/open-code-modeling/php-code-generator-transformator/blob/master/COPYRIGHT.md
+ * @license   https://github.com/open-code-modeling/php-code-generator-transformator/blob/master/LICENSE.md MIT License
+ */
+
+declare(strict_types=1);
+
+namespace OpenCodeModeling\CodeGenerator\Transformator;
+
+use OpenCodeModeling\CodeGenerator\Transformator\Exception\RuntimeException;
+use OpenCodeModeling\CodeGenerator\Workflow;
+use OpenCodeModeling\CodeGenerator\Workflow\ComponentDescriptionWithInputSlotOnly;
+
+class CodeListToFiles
+{
+    /**
+     * @var StringToFile
+     **/
+    private $stringToFile;
+
+    public function __construct(StringToFile $stringToFile)
+    {
+        $this->stringToFile = $stringToFile;
+    }
+
+    public function __invoke(array $codeList): void
+    {
+        foreach ($codeList as $name => $info) {
+            if (! isset($info['code']) || ! isset($info['filename'])) {
+                throw new RuntimeException(
+                    'Invalid code list info provided. Need array with key "code" and "filename".'
+                );
+            }
+
+            ($this->stringToFile)($info['code'], $info['filename']);
+        }
+    }
+
+    public static function workflowComponentDescription(
+        StringToFile $stringToFile,
+        string $inputCodeList
+    ): Workflow\Description {
+        return new ComponentDescriptionWithInputSlotOnly(
+            new self($stringToFile),
+            $inputCodeList
+        );
+    }
+}
diff --git a/src/Exception/CouldNotReadFile.php b/src/Exception/CouldNotReadFile.php
@@ -0,0 +1,21 @@
+<?php
+
+/**
+ * @see       https://github.com/open-code-modeling/php-code-generator-transformator for the canonical source repository
+ * @copyright https://github.com/open-code-modeling/php-code-generator-transformator/blob/master/COPYRIGHT.md
+ * @license   https://github.com/open-code-modeling/php-code-generator-transformator/blob/master/LICENSE.md MIT License
+ */
+
+declare(strict_types=1);
+
+namespace OpenCodeModeling\CodeGenerator\Transformator\Exception;
+
+class CouldNotReadFile extends RuntimeException
+{
+    public static function withFile(string $file): self
+    {
+        return new self(
+            \sprintf('Could not read file "%s".', $file)
+        );
+    }
+}
diff --git a/src/Exception/RuntimeException.php b/src/Exception/RuntimeException.php
@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * @see       https://github.com/open-code-modeling/php-code-generator-transformator for the canonical source repository
+ * @copyright https://github.com/open-code-modeling/php-code-generator-transformator/blob/master/COPYRIGHT.md
+ * @license   https://github.com/open-code-modeling/php-code-generator-transformator/blob/master/LICENSE.md MIT License
+ */
+
+declare(strict_types=1);
+
+namespace OpenCodeModeling\CodeGenerator\Transformator\Exception;
+
+use RuntimeException as BaseRuntimeException;
+
+class RuntimeException extends BaseRuntimeException implements TransformatorException
+{
+}
diff --git a/src/Exception/TransformatorException.php b/src/Exception/TransformatorException.php
@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * @see       https://github.com/open-code-modeling/php-code-generator-transformator for the canonical source repository
+ * @copyright https://github.com/open-code-modeling/php-code-generator-transformator/blob/master/COPYRIGHT.md
+ * @license   https://github.com/open-code-modeling/php-code-generator-transformator/blob/master/LICENSE.md MIT License
+ */
+
+declare(strict_types=1);
+
+namespace OpenCodeModeling\CodeGenerator\Transformator\Exception;
+
+/**
+ * Base exception interface
+ *
+ * All exceptions must implements this exception to catch exceptions of this library
+ */
+interface TransformatorException
+{
+}
diff --git a/src/FileToDomDocument.php b/src/FileToDomDocument.php
@@ -0,0 +1,46 @@
+<?php
+
+/**
+ * @see       https://github.com/open-code-modeling/php-code-generator-transformator for the canonical source repository
+ * @copyright https://github.com/open-code-modeling/php-code-generator-transformator/blob/master/COPYRIGHT.md
+ * @license   https://github.com/open-code-modeling/php-code-generator-transformator/blob/master/LICENSE.md MIT License
+ */
+
+declare(strict_types=1);
+
+namespace OpenCodeModeling\CodeGenerator\Transformator;
+
+use DOMDocument;
+use OpenCodeModeling\CodeGenerator\Transformator\Exception\RuntimeException;
+use OpenCodeModeling\CodeGenerator\Workflow;
+
+/**
+ * Loads a XML file with DOM. This is needed for xsl:include for instance.
+ */
+final class FileToDomDocument
+{
+    public function __invoke(string $file): DOMDocument
+    {
+        // TODO file check / error handling
+        $dom = new DOMDocument();
+
+        if (false === $dom->load($file)) {
+            throw new RuntimeException(
+                \sprintf('Error loading XML file "%s"', $file)
+            );
+        }
+
+        return $dom;
+    }
+
+    public static function workflowComponentDescription(
+        string $inputFile,
+        string $output
+    ): Workflow\Description {
+        return new Workflow\ComponentDescriptionWithSlot(
+            new self(),
+            $output,
+            $inputFile
+        );
+    }
+}
diff --git a/src/PhpCodeSniffer.php b/src/PhpCodeSniffer.php
diff --git a/src/StringMiddleware.php b/src/StringMiddleware.php
diff --git a/src/StringToFile.php b/src/StringToFile.php
