feat: Add the option to set the graph's background color

Closes #25
This commit is contained in:
jubianchi 2018-01-20 09:32:34 +01:00
parent 29e2e60ef8
commit 2a744599c0
No known key found for this signature in database
GPG key ID: 5D9C896D2AA9E390
3 changed files with 16 additions and 11 deletions

View file

@ -1,5 +1,6 @@
# `1.2.0` (unreleased) # `1.2.0` (unreleased)
* Add the `--background` option to set the graph's background color
* Versions correctly merged and checked * Versions correctly merged and checked
# `1.1.0` # `1.1.0`

View file

@ -4,12 +4,6 @@ namespace PMSIpilot\DockerComposeViz;
use Graphp\GraphViz\GraphViz; use Graphp\GraphViz\GraphViz;
use Symfony\Component\Console; use Symfony\Component\Console;
use function PMSIpilot\DockerComposeViz\applyGraphvizStyle;
use function PMSIpilot\DockerComposeViz\createGraph;
use function PMSIpilot\DockerComposeViz\fetchNetworks;
use function PMSIpilot\DockerComposeViz\fetchServices;
use function PMSIpilot\DockerComposeViz\fetchVolumes;
use function PMSIpilot\DockerComposeViz\readConfiguration;
$application = new Console\Application(); $application = new Console\Application();
@ -25,8 +19,15 @@ $application->register('render')
->addOption('no-volumes', null, Console\Input\InputOption::VALUE_NONE, 'Do not display volumes') ->addOption('no-volumes', null, Console\Input\InputOption::VALUE_NONE, 'Do not display volumes')
->addOption('horizontal', 'r', Console\Input\InputOption::VALUE_NONE, 'Display a horizontal graph') ->addOption('horizontal', 'r', Console\Input\InputOption::VALUE_NONE, 'Display a horizontal graph')
->addOption('ignore-override', null, Console\Input\InputOption::VALUE_NONE, 'Ignore override file') ->addOption('ignore-override', null, Console\Input\InputOption::VALUE_NONE, 'Ignore override file')
->addOption('background', null, Console\Input\InputOption::VALUE_REQUIRED, 'Set the graph background color', '#ffffff')
->setCode(function (Console\Input\InputInterface $input, Console\Output\OutputInterface $output) { ->setCode(function (Console\Input\InputInterface $input, Console\Output\OutputInterface $output) {
$backgroundColor = $input->getOption('background');
if (preg_match('/^#[a-fA-F0-9]{6}|transparent$/', $backgroundColor) === 0) {
throw new Console\Exception\InvalidArgumentException(sprintf('Invalid background color "%s". It must be a valid hex color or "transparent".', $backgroundColor));
}
$inputFile = $input->getArgument('input-file'); $inputFile = $input->getArgument('input-file');
$inputFileExtension = pathinfo($inputFile, PATHINFO_EXTENSION); $inputFileExtension = pathinfo($inputFile, PATHINFO_EXTENSION);
$overrideFile = dirname($inputFile).DIRECTORY_SEPARATOR.basename($inputFile, '.'.$inputFileExtension).'.'.$input->getOption('override').'.'.$inputFileExtension; $overrideFile = dirname($inputFile).DIRECTORY_SEPARATOR.basename($inputFile, '.'.$inputFileExtension).'.'.$input->getOption('override').'.'.$inputFileExtension;
@ -57,7 +58,7 @@ $application->register('render')
$overrideVersion = (string) ($override['version'] ?? 1); $overrideVersion = (string) ($override['version'] ?? 1);
if ($configurationVersion !== $overrideVersion) { if ($configurationVersion !== $overrideVersion) {
throw new Console\Exception\LogicException('Version mismatch: file ' . $inputFile . ' specifies version ' . $configurationVersion . ' but file ' . $overrideFile . ' uses version ' . $overrideVersion); throw new Console\Exception\LogicException(sprintf('Version mismatch: file "%s" specifies version "%s" but file "%s" uses version "%s"', $inputFile, $configurationVersion, $overrideFile, $overrideVersion));
} }
$configuration = array_merge_recursive($configuration, $override); $configuration = array_merge_recursive($configuration, $override);
@ -86,7 +87,8 @@ $application->register('render')
$graph = applyGraphvizStyle( $graph = applyGraphvizStyle(
createGraph($services, $volumes, $networks, $input->getOption('no-volumes') === false, $inputFile), createGraph($services, $volumes, $networks, $input->getOption('no-volumes') === false, $inputFile),
$input->getOption('horizontal') $input->getOption('horizontal'),
$input->getOption('background')
); );
switch ($outputFormat) { switch ($outputFormat) {

View file

@ -95,14 +95,16 @@ function createGraph(array $services, array $volumes, array $networks, bool $wit
/** /**
* @public * @public
* *
* @param Graph $graph Input graph * @param Graph $graph Input graph
* @param bool $horizontal Display a horizontal graph * @param bool $horizontal Display a horizontal graph
* @param string $horizontal Background color (any hex color or 'transparent')
* *
* @return Graph A copy of the input graph with style attributes * @return Graph A copy of the input graph with style attributes
*/ */
function applyGraphvizStyle(Graph $graph, bool $horizontal) : Graph function applyGraphvizStyle(Graph $graph, bool $horizontal, string $background) : Graph
{ {
$graph = $graph->createGraphClone(); $graph = $graph->createGraphClone();
$graph->setAttribute('graphviz.graph.bgcolor', $background);
$graph->setAttribute('graphviz.graph.pad', '0.5'); $graph->setAttribute('graphviz.graph.pad', '0.5');
$graph->setAttribute('graphviz.graph.ratio', 'fill'); $graph->setAttribute('graphviz.graph.ratio', 'fill');