Upgrade all the stuff

Author: Andreas Frömer

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## [0.7.0] - 2020-02-16
+### Changed
+- Moved classes to different namespace (`SystemCtl` to `icanhazstring\Systemctl`)
+- Dropped support for PHP7.1
+- Dropped support for `symfony/process:^3.x`
+
+### Added
+- Added `CHANGELOG.md` and `MIGRATION.md`
+- Added support for `symfony/process:^4.4 || ^5.0`
+- Added code quality tools
+
+## Previous releases
+- No changelog available

MIGRATION.md

@@ -0,0 +1,5 @@
+# Migration
+
+## v0.6.x to 0.7.0
+The namespace `SystemCtl\` was moved to `icanhazstring\SystemCtl`.
+You can do a search/replace to move you implementation.

composer.json

@@ -3,14 +3,15 @@
     "description": "PHP wrapper for systemctl",
     "type": "library",
     "require": {
-        "php": "^7.3",
+        "php": "^7.2",
         "symfony/process": "^4.4 || ^5.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.0",
         "squizlabs/php_codesniffer": "^3.5",
         "codeclimate/php-test-reporter": "dev-master",
-        "slevomat/coding-standard": "^6.1"
+        "slevomat/coding-standard": "^6.1",
+        "phpstan/phpstan": "^0.12.10"
     },
     "autoload": {
         "psr-4": {
@@ -30,6 +31,7 @@
         }
     ],
     "scripts": {
+        "analyse": "vendor/bin/phpstan --no-progress",
         "test": "vendor/bin/phpunit",
         "cs": "vendor/bin/phpcs"
     }

phpstan.neon

@@ -0,0 +1,6 @@
+parameters:
+    inferPrivatePropertyTypeFromConstructor: true
+
+    level: max
+    paths:
+        - src/

src/Command/CommandDispatcherInterface.php

@@ -1,18 +1,18 @@
 <?php
 
-namespace SystemCtl\Command;
+namespace icanhazstring\SystemCtl\Command;
 
-use SystemCtl\Exception\CommandFailedException;
+use icanhazstring\SystemCtl\Exception\CommandFailedException;
 
 /**
  * Interface CommandDispatcherInterface
  *
- * @package SystemCtl\Command
+ * @package icanhazstring\SystemCtl\Command
  */
 interface CommandDispatcherInterface
 {
     /**
-     * Timeout after which the dispatcher failes the execution
+     * Timeout after which the dispatcher fails the execution
      *
      * @param int $timeout
      *
@@ -33,7 +33,7 @@ public function setBinary(string $binary): CommandDispatcherInterface;
      * Dispatch given commands against implementers logic and creating a new command
      * to read results
      *
-     * @param array $commands
+     * @param array<int, string> $commands
      *
      * @return CommandInterface
      * @throws CommandFailedException

src/Command/CommandInterface.php

@@ -1,13 +1,13 @@
 <?php
 
-namespace SystemCtl\Command;
+namespace icanhazstring\SystemCtl\Command;
 
-use SystemCtl\Exception\CommandFailedException;
+use icanhazstring\SystemCtl\Exception\CommandFailedException;
 
 /**
  * Interface CommandInterface
  *
- * @package SystemCtl\Command
+ * @package icanhazstring\SystemCtl\Command
  * @author icanhazstring <[email protected]>
  */
 interface CommandInterface

src/Command/SymfonyCommand.php

@@ -1,21 +1,24 @@
 <?php
 
-namespace SystemCtl\Command;
+namespace icanhazstring\SystemCtl\Command;
 
 use Symfony\Component\Process\Process;
-use SystemCtl\Exception\CommandFailedException;
+use icanhazstring\SystemCtl\Exception\CommandFailedException;
 
 /**
  * Class SymfonyCommand
  *
- * @package SystemCtl\Command
+ * @package icanhazstring\SystemCtl\Command
  * @author icanhazstring <[email protected]>
  */
 class SymfonyCommand implements CommandInterface
 {
-    /** @var Process */
+    /** @var Process<mixed> */
     private $process;
 
+    /**
+     * @param Process<mixed> $process
+     */
     public function __construct(Process $process)
     {
         $this->process = $process;

src/Command/SymfonyCommandDispatcher.php

@@ -1,19 +1,22 @@
 <?php
 
-namespace SystemCtl\Command;
+namespace icanhazstring\SystemCtl\Command;
 
+use Symfony\Component\Process\Process;
 use Symfony\Component\Process\ProcessBuilder;
 
 /**
  * Class SymfonyCommandDispatcher
  *
- * @package SystemCtl\Command
+ * @package icanhazstring\SystemCtl\Command
  * @author  icanhazstring <[email protected]>
  */
 class SymfonyCommandDispatcher implements CommandDispatcherInterface
 {
+    /** @var string */
     private $binary;
-    private $timetout;
+    /** @var int */
+    private $timeout;
 
     /**
      * @inheritdoc
@@ -30,7 +33,7 @@ public function setBinary(string $binary): CommandDispatcherInterface
      */
     public function setTimeout(int $timeout): CommandDispatcherInterface
     {
-        $this->timetout = $timeout;
+        $this->timeout = $timeout;
 
         return $this;
     }
@@ -40,12 +43,10 @@ public function setTimeout(int $timeout): CommandDispatcherInterface
      */
     public function dispatch(...$commands): CommandInterface
     {
-        $processBuilder = new ProcessBuilder();
-        $processBuilder->setPrefix($this->binary);
-        $processBuilder->setTimeout($this->timetout);
-        $processBuilder->setArguments($commands);
+        $process = new Process(array_merge([$this->binary], $commands));
+        $process->setTimeout($this->timeout);
 
-        $process = new SymfonyCommand($processBuilder->getProcess());
+        $process = new SymfonyCommand($process);
 
         return $process->run();
     }

src/Exception/CommandFailedException.php

@@ -1,11 +1,11 @@
 <?php
 
-namespace SystemCtl\Exception;
+namespace icanhazstring\SystemCtl\Exception;
 
 /**
  * Class CommandFailedException
  *
- * @package SystemCtl\Exception
+ * @package icanhazstring\SystemCtl\Exception
  */
 class CommandFailedException extends \Exception
 {

src/Exception/ExceptionInterface.php

@@ -1,13 +1,13 @@
 <?php
 
-namespace SystemCtl\Exception;
+namespace icanhazstring\SystemCtl\Exception;
 
 use Throwable;
 
 /**
  * Interface ExceptionInterface
  *
- * @package SystemCtl\Exception
+ * @package icanhazstring\SystemCtl\Exception
  */
 interface ExceptionInterface extends Throwable
 {