Resolves issue #13

Author: peter279k

.gitignore

@@ -5,6 +5,7 @@ composer.lock
 
 # PHPUnit
 build/
+.phpunit.result.cache
 
 # Vagrant
 .vagrant

src/SystemCtl.php

@@ -9,6 +9,7 @@
 use icanhazstring\SystemCtl\Unit\Service;
 use icanhazstring\SystemCtl\Unit\Timer;
 use icanhazstring\SystemCtl\Unit\Socket;
+use icanhazstring\SystemCtl\Unit\Scope;
 use icanhazstring\SystemCtl\Unit\UnitInterface;
 
 /**
@@ -229,6 +230,38 @@ public function getSockets(?string $unitPrefix = null): array
         }, $units);
     }
 
+    /**
+     * @param string $name
+     *
+     * @return Scope
+     */
+    public function getScope(string $name): Scope
+    {
+        $units = $this->listUnits($name, [Scope::UNIT]);
+
+        $unitName = $this->searchForUnitInUnits($name, $units);
+
+        if (is_null($unitName)) {
+            throw UnitNotFoundException::create(Scope::UNIT, $name);
+        }
+
+        return new Scope($unitName, $this->getCommandDispatcher());
+    }
+
+    /**
+     * @param null|string $unitPrefix
+     *
+     * @return Scope[]
+     */
+    public function getScopes(?string $unitPrefix = null): array
+    {
+        $units = $this->listUnits($unitPrefix, [Scope::UNIT]);
+
+        return array_map(function ($unitName) {
+            return new Scope($unitName, $this->getCommandDispatcher());
+        }, $units);
+    }
+
     /**
      * Restart the daemon to reload specs and new units
      *

src/Unit/Scope.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace icanhazstring\SystemCtl\Unit;
+
+/**
+ * Class Scope
+ *
+ * @package icanhazstring\SystemCtl\Unit
+ */
+class Scope extends AbstractUnit
+{
+    /**
+     * @var string
+     */
+    public const UNIT = 'scope';
+
+    /**
+     * @inheritdoc
+     */
+    protected function getUnitSuffix(): string
+    {
+        return static::UNIT;
+    }
+}

test/Integration/Unit/UnitTest.php

@@ -11,6 +11,7 @@
 use icanhazstring\SystemCtl\Unit\Service;
 use icanhazstring\SystemCtl\Unit\Timer;
 use icanhazstring\SystemCtl\Unit\Socket;
+use icanhazstring\SystemCtl\Unit\Scope;
 
 /**
  * Class UnitTest
@@ -114,4 +115,33 @@ public function testSocketCommandsIfProcessIsUnsuccessFulShouldRaiseException():
         $this->expectException(CommandFailedException::class);
         $socket->start();
     }
+
+    public function testScopeCommandsIfProcessIsSuccessfulShouldReturnTrue(): void
+    {
+        $command = $this->prophesize(CommandInterface::class);
+        $command->isSuccessful()->willReturn(true);
+
+        $commandDispatcher = $this->createCommandDispatcherStub();
+        $commandDispatcher->dispatch(Argument::cetera())->willReturn($command);
+
+        $scope = new Scope('AwesomeScope', $commandDispatcher->reveal());
+
+        $this->assertTrue($scope->start());
+        $this->assertTrue($scope->stop());
+        $this->assertTrue($scope->enable());
+        $this->assertTrue($scope->disable());
+        $this->assertTrue($scope->reload());
+        $this->assertTrue($scope->restart());
+    }
+
+    public function testScopeCommandsIfProcessIsUnsuccessFulShouldRaiseException(): void
+    {
+        $commandDispatcher = $this->createCommandDispatcherStub();
+        $commandDispatcher->dispatch(Argument::cetera())->willThrow(CommandFailedException::class);
+
+        $scope = new Scope('AwesomeScope', $commandDispatcher->reveal());
+
+        $this->expectException(CommandFailedException::class);
+        $scope->start();
+    }
 }

test/Unit/SystemCtlTest.php

@@ -12,6 +12,7 @@
 use icanhazstring\SystemCtl\Unit\Service;
 use icanhazstring\SystemCtl\Unit\Timer;
 use icanhazstring\SystemCtl\Unit\Socket;
+use icanhazstring\SystemCtl\Unit\Scope;
 
 /**
  * Class SystemCtlTest
@@ -155,6 +156,25 @@ public function itShouldCallCommandDispatcherWithListUnitsAndUnitPrefixOnSocketG
         $this->assertEquals($unitName, $socket->getName());
     }
 
+    /**
+     * @test
+     */
+    public function itShouldCallCommandDispatcherWithListUnitsAndUnitPrefixOnScopeGetting(): void
+    {
+        $unitName = 'testScope';
+        $output = ' testScope.scope     Active running';
+        $commandDispatcherStub = $this->buildCommandDispatcherStub();
+        $commandDispatcherStub
+            ->dispatch(...['list-units', $unitName . '*'])
+            ->willReturn($this->buildCommandStub($output));
+
+        $systemctl = (new SystemCtl())->setCommandDispatcher($commandDispatcherStub->reveal());
+
+        $scope = $systemctl->getScope($unitName);
+        $this->assertInstanceOf(Scope::class, $scope);
+        $this->assertEquals($unitName, $scope->getName());
+    }
+
     /**
      * @test
      */
@@ -189,6 +209,23 @@ public function itShouldThrowAnExceptionIfNoSocketCouldBeFound(): void
         $systemctl->getSocket($unitName);
     }
 
+    /**
+     * @test
+     */
+    public function itShouldThrowAnExceptionIfNoScopeCouldBeFound(): void
+    {
+        $unitName = 'testScope';
+        $commandDispatcherStub = $this->buildCommandDispatcherStub();
+        $commandDispatcherStub
+            ->dispatch(...['list-units', $unitName . '*'])
+            ->willReturn($this->buildCommandStub(''));
+
+        $systemctl = (new SystemCtl())->setCommandDispatcher($commandDispatcherStub->reveal());
+
+        $this->expectException(UnitNotFoundException::class);
+        $systemctl->getScope($unitName);
+    }
+
     /**
      * @test
      */

test/Unit/Unit/AbstractUnitTest.php

@@ -52,6 +52,9 @@ public function itShouldReturnCorrectNameDataProvider(): array
             [
                 'name' => 'test1.socket',
             ],
+            [
+                'name' => 'test1.scope',
+            ],
             [
                 'name' => 'test1.mount',
             ],
@@ -110,6 +113,10 @@ public function itDetectsMultiInstanceUnitsCorrectlyDataProvider(): array
                 'name' => 'test1.socket',
                 'isMultiInstance' => false,
             ],
+            [
+                'name' => 'test1.scope',
+                'isMultiInstance' => false,
+            ],
         ];
     }
 
@@ -162,6 +169,10 @@ public function itDetectsMultiInstanceInstanceNamesCorrectlyDataProvider(): arra
                 'name' => 'test1.socket',
                 'instanceName' => null,
             ],
+            [
+                'name' => 'test1.scope',
+                'instanceName' => null,
+            ],
         ];
     }
 

test/Unit/Utils/OutputFetcherTest.php

@@ -39,10 +39,12 @@ public function itDeterminesTheCorrectAmountOfUnitsDataProvider(): array
   awesomeservice.service       active running
   nonservice.timer             active running
   nonservice.socket            active running
+  nonservice.scope             active running
   superservice.mount           active running
   awesomeservice.mount         active running
   nonservice.timer             active running
   nonservice.socket            active running
+  nonservice.scope             active running
   superservice.service         active running
   awesomeservice.service       active running
 ● [email protected]   loaded failed failed
@@ -64,6 +66,11 @@ public function itDeterminesTheCorrectAmountOfUnitsDataProvider(): array
                 'suffix' => 'socket',
                 'amount' => 2,
             ],
+            [
+                'output' => $output,
+                'suffix' => 'scope',
+                'amount' => 2,
+            ],
             [
                 'output' => $output,
                 'suffix' => 'mount',
@@ -101,10 +108,12 @@ public function itOnlyExtractsTheUnitNamesDataProvider(): array
   foo-bar.service    Active running
   a-timer.timer          Active running
   a-socket.socket          Active running
+  a-scope.scope          Active running
   super.mount        Active running
   awesome.mount      Active running
   nonservice.timer          Active running
   nonservice.socket          Active running
+  nonservice.scope          Active running
   [email protected]      Active running
   [email protected]    Active running
 ● [email protected] loaded failed failed
@@ -138,6 +147,14 @@ public function itOnlyExtractsTheUnitNamesDataProvider(): array
                     'nonservice',
                 ],
             ],
+            [
+                'output' => $output,
+                'suffix' => 'scope',
+                'units'  => [
+                    'a-scope',
+                    'nonservice',
+                ],
+            ],
             [
                 'output' => $output,
                 'suffix' => 'mount',