Skip to content

Commit 759d613

Browse files
smegheadsmeghead
authored
Merge pull request #93 from smeghead/feat/highlight-target-classes-rel-target
feat: Highlight the target class when output with rel-target
2 parents 2d6a775 + 5946d0c commit 759d613

File tree

6 files changed

+217
-61
lines changed

6 files changed

+217
-61
lines changed

‎src/Config/Options.php‎

Lines changed: 18 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -168,42 +168,36 @@ public function hidePrivateMethods(): bool
168168
}
169169

170170
/**
171-
* @return array<string>
171+
* @return list<string>
172172
*/
173-
public function fromClass(): array
173+
public function relTargetsFrom(): array
174174
{
175-
if (!isset($this->opt['rel-target-from'])) {
176-
return [];
175+
$targets = [];
176+
if (isset($this->opt['rel-target-from'])) {
177+
$targets = [...$targets, ...explode(',', $this->opt['rel-target-from'])];
177178
}
178-
179-
return explode(',', $this->opt['rel-target-from']);
180-
}
181-
182-
/**
183-
* @return array<string>
184-
*/
185-
public function toClass(): array
186-
{
187-
if (!isset($this->opt['rel-target-to'])) {
188-
return [];
179+
if (isset($this->opt['rel-target'])) {
180+
$targets = [...$targets, ...explode(',', $this->opt['rel-target'])];
189181
}
190-
191-
return explode(',', $this->opt['rel-target-to']);
182+
return array_values($targets);
192183
}
193184

194185
/**
195-
* @return array<string>
186+
* @return list<string>
196187
*/
197-
public function targetClass(): array
188+
public function relTargetsTo(): array
198189
{
199-
if (!isset($this->opt['rel-target'])) {
200-
return [];
190+
$targets = [];
191+
if (isset($this->opt['rel-target-to'])) {
192+
$targets = [...$targets, ...explode(',', $this->opt['rel-target-to'])];
201193
}
202-
203-
return explode(',', $this->opt['rel-target']);
194+
if (isset($this->opt['rel-target'])) {
195+
$targets = [...$targets, ...explode(',', $this->opt['rel-target'])];
196+
}
197+
return array_values($targets);
204198
}
205199

206-
public function depth(): int
200+
public function relTargetsDepth(): int
207201
{
208202
return (int) ($this->opt['rel-target-depth'] ?? PHP_INT_MAX);
209203
}

‎src/DiagramElement/ClassIdentifier.php‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Smeghead\PhpClassDiagram\DiagramElement;
6+
7+
use Smeghead\PhpClassDiagram\Config\Options;
8+
9+
final class ClassIdentifier {
10+
public function __construct(private Options $options, private string $directory, private Entry $entry)
11+
{
12+
}
13+
14+
public function getIdentifier(): string
15+
{
16+
$meta = $this->entry->getClass()->getClassType()->getMetaName();
17+
$classSummary = ($this->options->classNameSummary()
18+
? $this->entry->getClass()->getDescription()
19+
: '');
20+
return sprintf(
21+
'%s "%s" as %s%s%s',
22+
$meta,
23+
$this->entry->getClass()->getClassType()->getName() . (empty($classSummary) ? '' : sprintf("\\n<b>%s</b>", $classSummary)),
24+
$this->entry->getClass()->getClassNameAlias(),
25+
$this->getLinkExpression($meta),
26+
$this->getRelTargetStyle()
27+
);
28+
}
29+
30+
private function getLinkExpression(string $meta): string
31+
{
32+
if (empty($this->options->svgTopurl())) {
33+
return '';
34+
}
35+
$path = sprintf(
36+
'/%s%s.php',
37+
empty($this->directory) ? '' : sprintf('%s/', $this->directory),
38+
$this->entry->getClass()->getClassType()->getName());
39+
return sprintf(
40+
' [[%s %s %s]]',
41+
$path,
42+
$this->entry->getClass()->getClassType()->getName(),
43+
ucfirst($meta)
44+
);
45+
}
46+
47+
private function getRelTargetStyle(): string
48+
{
49+
$targets = [
50+
...$this->options->relTargetsFrom(),
51+
...$this->options->relTargetsTo(),
52+
];
53+
return array_search($this->entry->getClass()->getClassType()->getName(), $targets) !== false
54+
? ' #FFF0F5;line:740125;text:740125' : '';
55+
}
56+
}

‎src/DiagramElement/Entry.php‎

Lines changed: 3 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,9 @@ public function dump(int $level = 0): array
4848
{
4949
$indent = str_repeat(' ', $level);
5050
$lines = [];
51-
$meta = $this->class->getClassType()->getMetaName();
52-
$classSummary = ($this->options->classNameSummary()
53-
? $this->class->getDescription()
54-
: '');
55-
$classIdentifier = sprintf(
56-
'%s "%s" as %s%s',
57-
$meta,
58-
$this->class->getClassType()->getName() . (empty($classSummary) ? '' : sprintf("\\n<b>%s</b>", $classSummary)),
59-
$this->class->getClassNameAlias(),
60-
$this->getLinkExpression($meta)
61-
);
51+
$identifier = new ClassIdentifier($this->options, $this->directory, $this);
52+
$classIdentifier = $identifier->getIdentifier();
53+
6254
if ($this->options->classProperties() || $this->options->classMethods()) {
6355
$lines[] = sprintf('%s%s {', $indent, $classIdentifier);
6456
if ($this->options->classProperties()) {
@@ -192,21 +184,4 @@ public function getUsingArrows(): array
192184
}
193185
return $arrows;
194186
}
195-
196-
private function getLinkExpression(string $meta): string
197-
{
198-
if (empty($this->options->svgTopurl())) {
199-
return '';
200-
}
201-
$path = sprintf(
202-
'/%s%s.php',
203-
empty($this->directory) ? '' : sprintf('%s/', $this->directory),
204-
$this->class->getClassType()->getName());
205-
return sprintf(
206-
' [[%s %s %s]]',
207-
$path,
208-
$this->class->getClassType()->getName(),
209-
ucfirst($meta)
210-
);
211-
}
212187
}

‎src/DiagramElement/RelationsFilter.php‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
use InvalidArgumentException;
66
use Smeghead\PhpClassDiagram\Config\Options;
7-
use Smeghead\PhpClassDiagram\Enums\DependenciesDirection;
87
use function preg_match;
98

109
class RelationsFilter {
@@ -27,15 +26,10 @@ public function __construct(private Options $options)
2726
public function filterRelations(array $relation_expressions): array
2827
{
2928
$output = [];
30-
$fromClasses = $this->options->fromClass();
31-
$toClasses = $this->options->toClass();
29+
$fromClasses = $this->options->relTargetsFrom();
30+
$toClasses = $this->options->relTargetsTo();
3231

33-
if ([] !== $this->options->targetClass()) {
34-
$fromClasses = $this->options->targetClass();
35-
$toClasses = $this->options->targetClass();
36-
}
37-
38-
$this->maxDepth = $this->options->depth() - 1;
32+
$this->maxDepth = $this->options->relTargetsDepth() - 1;
3933
$this->relationExpressions = $relation_expressions;
4034

4135
if ([] === $fromClasses && [] === $toClasses) {

‎test/DiagramElement/ClassIdentifierTest.php‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use PHPUnit\Framework\TestCase;
6+
use Smeghead\PhpClassDiagram\Config\Options;
7+
use Smeghead\PhpClassDiagram\DiagramElement\ClassIdentifier;
8+
use Smeghead\PhpClassDiagram\DiagramElement\Entry;
9+
use Smeghead\PhpClassDiagram\Php\PhpReader;
10+
11+
final class ClassIdentifierTest extends TestCase
12+
{
13+
private string $fixtureDir;
14+
15+
public function setUp(): void
16+
{
17+
$this->fixtureDir = realpath(sprintf('%s/../fixtures', __DIR__));
18+
}
19+
20+
public function testClass(): void
21+
{
22+
$directory = sprintf('%s/namespace', $this->fixtureDir);
23+
24+
$options = new Options([]);
25+
$entry = $this->getTargetEntry('product/Product.php', $directory, $options);
26+
27+
$sut = new ClassIdentifier($options, 'product', $entry);
28+
29+
$this->assertSame('class "Product" as product_Product', $sut->getIdentifier());
30+
}
31+
32+
public function testInterface(): void
33+
{
34+
$directory = sprintf('%s/interface', $this->fixtureDir);
35+
36+
$options = new Options([]);
37+
$entry = $this->getTargetEntry('product/Interface_.php', $directory, $options);
38+
39+
$sut = new ClassIdentifier($options, 'product', $entry);
40+
41+
$this->assertSame('interface "Interface_" as product_Interface_', $sut->getIdentifier());
42+
}
43+
44+
public function testEnum(): void
45+
{
46+
$directory = sprintf('%s/enum', $this->fixtureDir);
47+
48+
$options = new Options([]);
49+
$entry = $this->getTargetEntry('TestEnum.php', $directory, $options);
50+
51+
$sut = new ClassIdentifier($options, '', $entry);
52+
53+
$this->assertSame('enum "Suit\n<b>スート</b>" as Suit', $sut->getIdentifier());
54+
}
55+
56+
public function testClassRelTarget(): void
57+
{
58+
$directory = sprintf('%s/namespace', $this->fixtureDir);
59+
60+
$options = new Options(['rel-target' => 'Product,Name']);
61+
$entry = $this->getTargetEntry('product/Product.php', $directory, $options);
62+
63+
$sut = new ClassIdentifier($options, 'product', $entry);
64+
65+
$this->assertSame('class "Product" as product_Product #FFF0F5;line:740125;text:740125', $sut->getIdentifier());
66+
}
67+
68+
public function testClassRelTargetNotMatch(): void
69+
{
70+
$directory = sprintf('%s/namespace', $this->fixtureDir);
71+
72+
$options = new Options(['rel-target' => 'ProductXX,Name']);
73+
$entry = $this->getTargetEntry('product/Product.php', $directory, $options);
74+
75+
$sut = new ClassIdentifier($options, 'product', $entry);
76+
77+
$this->assertSame('class "Product" as product_Product', $sut->getIdentifier());
78+
}
79+
80+
private function getTargetEntry(string $path, string $directory, Options $options): Entry
81+
{
82+
$filename = sprintf('%s/%s', $directory, $path);
83+
$classes = PhpReader::parseFile($directory, $filename, $options);
84+
if (count($classes) === 0) {
85+
throw new \Exception('class not found.');
86+
}
87+
return new Entry(dirname($path), $classes[0]->getInfo(), $options);
88+
}
89+
90+
}

‎test/OptionsTest.php‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -292,4 +292,51 @@ public function testHidePrivateMethodsTrue(): void
292292
$this->assertFalse($options->hidePrivateProperties(), 'hide-private-property is false.');
293293
$this->assertTrue($options->hidePrivateMethods(), 'hide-private-methods is true.');
294294
}
295+
296+
public function testRelTarget(): void
297+
{
298+
$opt = [
299+
'rel-target' => 'Product,Name',
300+
];
301+
302+
$options = new Options($opt);
303+
304+
$this->assertSame(['Product', 'Name'], $options->relTargetsFrom());
305+
$this->assertSame(['Product', 'Name'], $options->relTargetsTo());
306+
}
307+
308+
public function testRelTargetFrom(): void
309+
{
310+
$opt = [
311+
'rel-target-from' => 'Product,Name',
312+
];
313+
314+
$options = new Options($opt);
315+
316+
$this->assertSame(['Product', 'Name'], $options->relTargetsFrom());
317+
$this->assertSame([], $options->relTargetsTo());
318+
}
319+
320+
public function testRelTargetTo(): void
321+
{
322+
$opt = [
323+
'rel-target-to' => 'Product,Name',
324+
];
325+
326+
$options = new Options($opt);
327+
328+
$this->assertSame([], $options->relTargetsFrom());
329+
$this->assertSame(['Product', 'Name'], $options->relTargetsTo());
330+
}
331+
332+
public function testRelTargetDepth(): void
333+
{
334+
$opt = [
335+
'rel-target-depth' => '1',
336+
];
337+
338+
$options = new Options($opt);
339+
340+
$this->assertSame(1, $options->relTargetsDepth());
341+
}
295342
}

0 commit comments

Comments
 (0)