Clean up some files and add some type hints

Author: mattstauffer

.gitattributes

@@ -1,7 +1,4 @@
 * text=auto
 /.github export-ignore
-.styleci.yml export-ignore
-.scrutinizer.yml export-ignore
-BACKERS.md export-ignore
-CONTRIBUTING.md export-ignore
-CHANGELOG.md export-ignore
+.editorconfig export-ignore
+takeout-banner.png export-ignore

app/InitializesCommands.php

@@ -7,7 +7,7 @@
 
 trait InitializesCommands
 {
-    public function initializeCommand()
+    public function initializeCommand(): void
     {
         app()->bind('console', function () {
             return $this;

app/Services/BaseService.php

@@ -35,6 +35,7 @@ abstract class BaseService
     protected $shell;
     protected $environment;
     protected $docker;
+    protected $dockerTags;
 
     public function __construct(Shell $shell, Environment $environment, Docker $docker, DockerTags $dockerTags)
     {
@@ -56,7 +57,7 @@ public function __construct(Shell $shell, Environment $environment, Docker $dock
         ];
     }
 
-    public function install()
+    public function install(): void
     {
         $this->prompts();
         $this->ensureImageIsDownloaded();
@@ -71,7 +72,7 @@ public function install()
 
             $this->info("\nInstallation complete!");
         } catch (Throwable $e) {
-            return $this->error("\nInstallation failed!");
+            $this->error("\nInstallation failed!");
         }
     }
 
@@ -90,7 +91,12 @@ public function shortName(): string
         return strtolower(class_basename(static::class));
     }
 
-    protected function ensureImageIsDownloaded()
+    public function defaultPort(): int
+    {
+        return $this->defaultPort;
+    }
+
+    protected function ensureImageIsDownloaded(): void
     {
         if ($this->docker->imageIsDownloaded($this->organization, $this->imageName, $this->tag)) {
             return;
@@ -100,7 +106,7 @@ protected function ensureImageIsDownloaded()
         $this->docker->downloadImage($this->organization, $this->imageName, $this->tag);
     }
 
-    protected function prompts()
+    protected function prompts(): void
     {
         foreach ($this->defaultPrompts as $prompt) {
             $this->askQuestion($prompt);
@@ -118,7 +124,7 @@ protected function prompts()
         $this->tag = $this->resolveTag($this->promptResponses['tag']);
     }
 
-    protected function askQuestion($prompt): void
+    protected function askQuestion(array $prompt): void
     {
         $this->promptResponses[$prompt['shortname']] = app('console')->ask($prompt['prompt'], $prompt['default'] ?? null);
     }
@@ -132,11 +138,12 @@ protected function resolveTag($responseTag)
         return $responseTag;
     }
 
-    protected function buildParameters()
+    protected function buildParameters(): array
     {
         $parameters = $this->promptResponses;
         $parameters['container_name'] = $this->containerName();
         $parameters['tag'] = $this->tag; // Overwrite "latest" with actual latest tag
+
         return $parameters;
     }
 

app/Shell/Docker.php

@@ -34,7 +34,7 @@ public function stopContainer(string $containerId)
         }
     }
 
-    public function isInstalled(): Bool
+    public function isInstalled(): bool
     {
         $process = $this->shell->execQuietly('docker --version 2>&1');
 
@@ -54,7 +54,7 @@ public function containers(): array
         }, explode("\n", $output)));
     }
 
-    public function imageIsDownloaded($organization, $imageName, $tag): Bool
+    public function imageIsDownloaded(string $organization, string $imageName, ?string $tag): bool
     {
         $process = $this->shell->execQuietly(sprintf(
             'docker image inspect %s/%s:%s',
@@ -66,7 +66,7 @@ public function imageIsDownloaded($organization, $imageName, $tag): Bool
         return $process->isSuccessful();
     }
 
-    public function downloadImage($organization, $imageName, $tag)
+    public function downloadImage(string $organization, string $imageName, ?string $tag): void
     {
         $this->shell->exec(sprintf(
             'docker pull %s/%s:%s',

app/Shell/DockerTags.php

@@ -4,6 +4,7 @@
 
 use GuzzleHttp\Client;
 use GuzzleHttp\Psr7\Stream;
+use Psr\Http\Message\StreamInterface;
 
 class DockerTags
 {
@@ -14,14 +15,14 @@ public function __construct(Client $guzzle)
         $this->guzzle = $guzzle;
     }
 
-    public function getLatestTag($organization, $imageName): string
+    public function getLatestTag(string $organization, string $imageName): string
     {
         return collect($this->getTags($organization, $imageName))->first(function ($tag) {
             return $tag !== 'latest';
         });
     }
 
-    public function getTags($organization, $imageName): array
+    public function getTags(string $organization, string $imageName): array
     {
         return $this->filterResponseForTags(
             $this->getTagsResponse($organization, $imageName)
@@ -37,7 +38,7 @@ protected function filterResponseForTags(Stream $stream): array
             ->toArray();
     }
 
-    protected function getTagsResponse($organization, $imageName): Stream
+    protected function getTagsResponse($organization, $imageName): StreamInterface
     {
         return $this->guzzle
             ->get($this->buildTagsUrl($organization, $imageName))

app/Shell/Environment.php

@@ -11,7 +11,7 @@ public function __construct(Shell $shell)
         $this->shell = $shell;
     }
 
-    public function portIsAvailable($port)
+    public function portIsAvailable($port): bool
     {
         // Check to see if the system is running a service with the desired port
         $process = $this->shell->execQuietly("netstat -vanp tcp | grep {$port}");

app/Shell/Shell.php

@@ -14,7 +14,7 @@ public function __construct(ConsoleOutput $output)
         $this->output = $output;
     }
 
-    public function exec($command, $parameters = [], $quiet = false): Process
+    public function exec(string $command, array $parameters = [], bool $quiet = false): Process
     {
         $process = $this->buildProcess($command);
         $process->run(function ($type, $buffer) use ($quiet) {
@@ -32,27 +32,27 @@ public function exec($command, $parameters = [], $quiet = false): Process
         return $process;
     }
 
-    public function execQuietly($command, $parameters = []): Process
+    public function execQuietly(string $command, array $parameters = []): Process
     {
         return $this->exec($command, $parameters, $quiet = true);
     }
 
-    public function formatStartMessage(string $buffer)
+    public function formatStartMessage(string $buffer): string
     {
         return rtrim(sprintf('<bg=blue;fg=white> RUN </> <fg=blue>%s</>', $buffer));
     }
 
-    public function formatErrorMessage(string $buffer)
+    public function formatErrorMessage(string $buffer): string
     {
         return rtrim(sprintf('<bg=red;fg=white> ERR </> %s', $buffer));
     }
 
-    public function formatMessage(string $buffer)
+    public function formatMessage(string $buffer): string
     {
         return rtrim(sprintf('<bg=green;fg=white> OUT </> %s', $buffer));
     }
 
-    public function buildProcess($command): Process
+    public function buildProcess(string $command): Process
     {
         $process = Process::fromShellCommandline($command);
         $process->setTimeout(null);

app/WritesToConsole.php

@@ -4,27 +4,27 @@
 
 trait WritesToConsole
 {
-    public function alert(string $message)
+    public function alert(string $message): void
     {
         app('console')->alert($message);
     }
 
-    public function warn(string $message)
+    public function warn(string $message): void
     {
         app('console')->warn($message);
     }
 
-    public function error(string $message)
+    public function error(string $message): void
     {
         app('console')->error($message);
     }
 
-    public function line(string $message)
+    public function line(string $message): void
     {
         app('console')->line($message);
     }
 
-    public function info(string $message)
+    public function info(string $message): void
     {
         app('console')->info($message);
     }

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "tightenco/takeout",
-    "description": "Takeout, by Tighten -- Simple one-off Docker containers.",
+    "description": "Manage your dev dependencies with simple one-off Docker containers.",
     "keywords": ["cli", "console", "docker", "containers", "dependency management"],
     "homepage": "https://takeout.tighten.co/",
     "type": "project",
@@ -19,7 +19,8 @@
         "php": "^7.2.5",
         "guzzlehttp/guzzle": "^6.5",
         "laravel-zero/framework": "^7.0",
-        "nunomaduro/laravel-console-menu": "^3.0"
+        "nunomaduro/laravel-console-menu": "^3.0",
+        "ext-json": "*"
     },
     "require-dev": {
         "mockery/mockery": "^1.3.1",

tests/Feature/BaseServiceTest.php

@@ -9,6 +9,7 @@
 use Mockery as M;
 use Symfony\Component\Process\Process;
 use Tests\TestCase;
+use function app;
 
 class BaseServiceTest extends TestCase
 {
@@ -23,6 +24,9 @@ function it_generates_shortname()
     function it_installs_services()
     {
         app()->instance('console', M::mock(Command::class, function ($mock) {
+//            $service = new MeiliSearch;
+//            $mock->shouldReceive('ask')->with('Which host port would you like this service to use?', $service->defaultPort())->andReturn(7700);
+//            $mock->shouldReceive('ask')->with('Which tag (version) of this service would you like to use?', 'latest')->andReturn('v1.1.1');
             $mock->shouldIgnoreMissing();
         }));