Merge pull request #3 from petrknap/refactored

`FilterCommand` refactored to (external) `Filter`

Author: petrknap

.molireali

@@ -1,7 +1,7 @@
 authors
-composer PetrKnap\\FilterCommand
+composer PetrKnap\\ExternalFilter
 dockerfile php 8.2-cli
-docker-scripts petrknap/php-filter-command
+docker-scripts petrknap/php-external-filter
 donation
 github-templates
 github-workflow docker "composer ci-script"

README.md

@@ -5,16 +5,16 @@ Its primary role is to **facilitate filtering operations within a pipeline**,
 allowing for easy chaining and execution of executable filters.
 
 ```php
-namespace PetrKnap\FilterCommand;
+namespace PetrKnap\ExternalFilter;
 
 # echo '<?php echo "Hello!";' | php
-$data = (new FilterCommand('php'))->filter('<?php echo "Hello!";');
+$data = (new Filter('php'))->filter('<?php echo "Hello!";');
 
 echo $data;
 ```
 
 ---
 
-Run `composer require petrknap/filter-command` to install it.
+Run `composer require petrknap/external-filter` to install it.
 You can [support this project via donation](https://petrknap.github.io/donate.html).
 The project is licensed under [the terms of the `LGPL-3.0-or-later`](./COPYING.LESSER).

composer.json

@@ -2,12 +2,12 @@
   "WARNING": "This file is updated automatically. All keys will be overwritten, except of 'conflict', 'keywords', 'require', 'require-dev', 'scripts' and 'suggest'.",
   "autoload": {
     "psr-4": {
-      "PetrKnap\\FilterCommand\\": "src"
+      "PetrKnap\\ExternalFilter\\": "src"
     }
   },
   "autoload-dev": {
     "psr-4": {
-      "PetrKnap\\FilterCommand\\": "tests"
+      "PetrKnap\\ExternalFilter\\": "tests"
     }
   },
   "config": {
@@ -21,17 +21,17 @@
       "url": "https://petrknap.github.io/donate.html"
     }
   ],
-  "homepage": "https://github.com/petrknap/php-filter-command",
+  "homepage": "https://github.com/petrknap/php-external-filter",
   "keywords": [],
   "license": "LGPL-3.0-or-later",
-  "name": "petrknap/filter-command",
+  "name": "petrknap/external-filter",
   "require": {
     "php": ">=8.1",
-    "petrknap/shorts": "^2.0|^3.0",
     "symfony/process": "^4.0|^5.0|^6.0|^7.0"
   },
   "require-dev": {
     "nunomaduro/phpinsights": "^2.11",
+    "petrknap/shorts": "^3.0",
     "phpstan/phpstan": "^1.12",
     "squizlabs/php_codesniffer": "^3.7",
     "phpunit/phpunit": "^10.5"

src/Exception/CouldNotFilterData.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PetrKnap\FilterCommand\Exception;
+namespace PetrKnap\ExternalFilter\Exception;
 
 use Throwable;
 

src/Exception/Exception.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PetrKnap\ExternalFilter\Exception;
+
+interface FilterException extends Exception
+{
+}

src/Exception/FilterException.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace PetrKnap\FilterCommand;
+namespace PetrKnap\ExternalFilter;
 
 use Symfony\Component\Process\Exception\ProcessFailedException;
 use Symfony\Component\Process\Process;
 
-final class FilterCommand
+final class Filter
 {
     /**
      * @param non-empty-string $command
@@ -20,18 +20,18 @@ public function __construct(
     }
 
     /**
-     * @throws Exception\CouldNotFilterData
+     * @throws Exception\FilterException
      */
-    public function filter(string $data): string
+    public function filter(string $input): string
     {
         $process = new Process([
             $this->command,
             ...$this->options,
         ]);
-        $process->setInput($data);
+        $process->setInput($input);
         $process->run();
         if (!$process->isSuccessful()) {
-            throw new class (__METHOD__, $data, new ProcessFailedException($process)) extends Exception\CouldNotFilterData {
+            throw new class ($process) extends ProcessFailedException implements Exception\FilterException {
             };
         }
         return $process->getOutput();

src/FilterCommand.php renamed to src/Filter.php

@@ -2,27 +2,27 @@
 
 declare(strict_types=1);
 
-namespace PetrKnap\FilterCommand;
+namespace PetrKnap\ExternalFilter;
 
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
-final class FilterCommandTest extends TestCase
+final class FilterTest extends TestCase
 {
-    public function testFiltersInputByCommand(): void
+    public function testFilters(): void
     {
         self::assertSame(
             'test',
-            (new FilterCommand('php'))->filter('<?php echo "test";'),
+            (new Filter('php'))->filter('<?php echo "test";'),
         );
     }
 
     #[DataProvider('dataThrows')]
     public function testThrows(string $command, array $options, string $data): void
     {
-        self::expectException(Exception\CouldNotFilterData::class);
+        self::expectException(Exception\FilterException::class);
 
-        (new FilterCommand($command, $options))->filter($data);
+        (new Filter($command, $options))->filter($data);
     }
 
     public static function dataThrows(): array

tests/FilterCommandTest.php renamed to tests/FilterTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PetrKnap\FilterCommand;
+namespace PetrKnap\ExternalFilter;
 
 use PetrKnap\Shorts\PhpUnit\MarkdownFileTestInterface;
 use PetrKnap\Shorts\PhpUnit\MarkdownFileTestTrait;