make directory and decision record template configurable via yaml config file

Author: abachmann

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

@@ -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,6 +2,7 @@
 
 namespace ADR\Command;
 
+use ADR\Filesystem\Config;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -50,11 +51,11 @@ protected function configure()
                 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);
 

src/Command/MakeDecisionCommand.php

@@ -2,6 +2,7 @@
 
 namespace ADR\Command;
 
+use ADR\Filesystem\Config;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputInterface;
@@ -26,11 +27,11 @@ protected function configure()
             ->setDescription('Count the ADRs')
             ->setHelp('This command allows you count the ADRs')
             ->addOption(
-                'directory',
+                'config',
                 null,
                 InputOption::VALUE_REQUIRED,
-                'Workspace that store the ADRs',
-                'docs/arch'
+                'Config file',
+                'adr.yml'
             );
     }
 
@@ -42,8 +43,9 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
+        $config = new Config($input->getOption('config'));
         $style = new SymfonyStyle($input, $output);
-        $workspace = new Workspace($input->getOption('directory'));
+        $workspace = new Workspace($config->directory());
 
         $style->table(['Count'], [[$workspace->count()]]);
     }

src/Command/WorkspaceCountCommand.php

@@ -2,6 +2,7 @@
 
 namespace ADR\Command;
 
+use ADR\Filesystem\Config;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputInterface;
@@ -26,11 +27,11 @@ protected function configure()
             ->setDescription('List the ADRs')
             ->setHelp('This command allows you list the ADRs')
             ->addOption(
-                'directory',
+                'config',
                 null,
                 InputOption::VALUE_REQUIRED,
-                'Workspace that store the ADRs',
-                'docs/arch'
+                'Config file',
+                'adr.yml'
             );
     }
 
@@ -42,7 +43,8 @@ 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());
 
         $records = $workspace->records();