Merge pull request #1 from abachmann/master

Make directory and decision record template configurable via yaml config file

Author: globtec

README.md

@@ -32,30 +32,30 @@ After of install this project you may execute the binary `phpadr` in your termin
 
 If to execute the command above, it will be showd a list of all avaliable tool commands.
 
-By default the records will be stored in `docs/arch`, to change this workspace use the option `--directory` with the path of the new workspace.
+By default the records will be stored in `docs/arch`, to change this workspace use the option `--config` with the path of the config file.
 
 ### Create a new ADR
 
 You may use the `make:decision` command:
 
 ```
-./vendor/bin/phpadr make:decision <title> [<status="Accepted">] [--directory="docs/arch"]
+./vendor/bin/phpadr make:decision <title> [<status="Accepted">] [--config="adr.yml"]
 ```
 
 ### Count the ADRs
 
 You may use the `workspace:count` command:
 
 ```
-./vendor/bin/phpadr workspace:count [--directory="docs/arch"]
+./vendor/bin/phpadr workspace:count [--config="adr.yml"]
 ```
 
 ### List the ADRs
 
 You may use the `workspace:list` command:
 
 ```
-./vendor/bin/phpadr workspace:list [--directory="docs/arch"]
+./vendor/bin/phpadr workspace:list [--config="adr.yml"]
 ```
 
 ### Help

adr.yml

@@ -0,0 +1,3 @@
+directory: docs/arch
+template:
+  decision-record: template/skeleton.md

composer.json

@@ -19,7 +19,8 @@
     "require": {
         "php": "^7.1.3",
         "ext-mbstring": "*",
-        "symfony/console": "^4.0"
+        "symfony/console": "^4.0",
+        "symfony/yaml": "^4.2@dev"
     },
     "require-dev": {
         "phpunit/phpunit": "^7.0.1",

composer.lock

@@ -16,6 +16,6 @@ It will be used the [PHPUnit](https://phpunit.de/) as testing framework.
 
 ## Consequences
 
-Use unit testing for ensure that the code is working as expected and that changes don't break existing funcionality.
+Use unit testing for ensure that the code is working as expected and that changes don't break existing functionality.
 
 Allow to use Test-Driven Development (TDD) that is an evolutionary approach to development which combines test-first development.

docs/arch/0005-phpunit-as-testing-framework.md

@@ -0,0 +1,21 @@
+# 6. YAML as configuration file
+
+Date: 2018-06-30
+
+## Status
+
+Accepted
+
+## Context
+
+In order to use a custom ADR template, it must be possible to configure the path to it. The same template must be used so that all ADR`s are structured in the same way.
+
+## Decision
+
+The template path can be defined via a [YAML](http://yaml.org/) configuration file.
+
+## Consequences
+
+We need to add [symfony/yaml](https://github.com/symfony/yaml) as a dependency to the project.
+
+To have a single place of truth the "directory" option must be removed from all console commands, because the directory can be defined in the configuration file.

docs/arch/0006-yaml-as-configuration-file.md

@@ -2,15 +2,16 @@
 
 namespace ADR\Command;
 
+use ADR\Domain\DecisionContent;
+use ADR\Domain\DecisionRecord;
+use ADR\Domain\Sequence;
+use ADR\Filesystem\Config;
+use ADR\Filesystem\Workspace;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Input\InputOption;
-use ADR\Filesystem\Workspace;
-use ADR\Domain\Sequence;
-use ADR\Domain\DecisionRecord;
-use ADR\Domain\DecisionContent;
+use Symfony\Component\Console\Output\OutputInterface;
 
 /**
  * Command to make ADRs
@@ -44,17 +45,17 @@ protected function configure()
                 'status',
                 InputArgument::OPTIONAL,
                 sprintf(
-                   'The status of the ADR, avaliable options: [%s]',
+                   'The status of the ADR, available options: [%s]',
                    implode(', ', $options)
                 ),
                 DecisionContent::STATUS_ACCEPTED
             )
             ->addOption(
-                'directory',
+                'config',
                 null,
                 InputOption::VALUE_REQUIRED,
-                'Workspace that store the ADRs',
-                'docs/arch'
+                'Config file',
+                'adr.yml'
             );
     }
 
@@ -66,10 +67,11 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $workspace = new Workspace($input->getOption('directory'));
+        $config = new Config($input->getOption('config'));
+        $workspace = new Workspace($config->directory());
         $sequence = new Sequence($workspace);
         $content = new DecisionContent($sequence->next(), $input->getArgument('title'), $input->getArgument('status'));
-        $record = new DecisionRecord($content);
+        $record = new DecisionRecord($content, $config);
 
         $workspace->add($record);