Initial commit

Author: hmazter

.gitignore

@@ -0,0 +1,5 @@
+# IDE
+.idea
+
+# PHP
+vendor

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Kristoffer Högberg
+
+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.

README.md

@@ -0,0 +1,33 @@
+Console Skeleton
+================
+
+Skeleton for a console application, including:
+* DI-Container
+* Services and commands [autowired in yaml-config](config/services.yaml)
+* [Example Command](src/Command/ExampleCommand.php)
+* [Example test](tests/Command/ExampleCommandTest.php)
+
+## Getting started
+
+This will create a new project with the skeleton for a console application:
+
+```bash
+composer create-project hmazter/console-skeleton the-new-app-name
+cd the-new-app-name
+```
+
+The skeleton can then be executed with:
+```bash
+./app
+```
+
+Tests can be run with:
+```bash
+composer test
+```
+
+Go ahead and:
+* Edit/replace command in src/Commad/ExampleCommand
+* Add more commands in src/Command
+* Add additional classed that you need in src/
+* Edit/replace the test in tests/Command/ExampleCommandTest

app

@@ -0,0 +1,28 @@
+#!/usr/bin/env php
+<?php
+
+require __DIR__ . '/vendor/autoload.php';
+
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\Console\Application;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
+
+// Load services and commands from services.yaml
+$container = new ContainerBuilder();
+$loader = new YamlFileLoader($container, new FileLocator(__DIR__ . '/config'));
+$loader->load('services.yaml');
+
+// compile the DI container
+$container->compile();
+
+// create new console application
+$application = new Application();
+
+// add all services from the container that are tagged "console.command" as commands in the app
+$consoleCommands = $container->findTaggedServiceIds('console.command');
+foreach ($consoleCommands as $consoleCommand => $tags) {
+    $application->add($container->get($consoleCommand));
+}
+
+$application->run();

composer.json

@@ -0,0 +1,37 @@
+{
+  "name": "hmazter/console-skeleton",
+  "description": "Skeleton for a console application with DI-container and yaml-config",
+  "type": "project",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Kristoffer Högberg",
+      "email": "[email protected]",
+      "homepage": "https://hmazter.com"
+    }
+  ],
+  "require": {
+    "php": "^7.2",
+    "symfony/console": "^4.0",
+    "symfony/dependency-injection": "^4.0",
+    "symfony/config": "^4.0",
+    "symfony/yaml": "^4.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^7.0",
+    "symfony/var-dumper": "^4.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "App\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Tests\\": "tests/"
+    }
+  },
+  "scripts": {
+    "test": "./vendor/bin/phpunit"
+  }
+}

config/services.yaml

@@ -0,0 +1,16 @@
+#parameters:
+
+services:
+  # Autowire all services in the app except Commands
+  App\:
+      resource: '../src/*'
+      exclude: '../src/Command'
+      autowire: true
+      public: false
+
+  # Autowire all Commands in the app, and make them public to allow for registering in the application
+  App\Command\:
+      resource: '../src/Command'
+      autowire: true
+      public: true
+      tags: [console.command]

phpunit.xml

@@ -0,0 +1,7 @@
+<phpunit bootstrap="vendor/autoload.php">
+    <testsuites>
+        <testsuite name="application">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

src/Command/ExampleCommand.php

@@ -0,0 +1,29 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ExampleCommand extends Command
+{
+    public function __construct()
+    {
+        parent::__construct();
+
+        // TODO: inject and initialize any services needed for the command here
+    }
+
+    protected function configure()
+    {
+        $this->setName('example')
+            ->setDescription('Example command');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $output->writeln('This is an example, replace or edit me');
+    }
+}

tests/Command/ExampleCommandTest.php

@@ -0,0 +1,29 @@
+<?php
+declare(strict_types=1);
+
+namespace Tests\Command;
+
+use App\Command\ExampleCommand;
+use App\Pwned\PwnedPasswords;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Tester\CommandTester;
+
+class ExampleCommandTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function command_outputs_info()
+    {
+        $application = new Application();
+        $application->add(new ExampleCommand());
+
+        $command = $application->find('example');
+        $commandTester = new CommandTester($command);
+        $commandTester->execute(['command' => $command->getName()]);
+
+        $output = $commandTester->getDisplay();
+        $this->assertContains('This is an example', $output);
+    }
+}