Skip to content

Simplify the PlantUML import patterns #521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
alexanderlinne wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Simplify the PlantUML import patterns #521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e055e0
test: cover the PlantUML import with tests
alexanderlinne Oct 23, 2026
edf1e95
refactor: simplify PlantUML import patterns
alexanderlinne Oct 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 28 additions & 48 deletions ArchUnitNET/Domain/PlantUml/Import/PlantUmlParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,57 +7,42 @@
using System.Text;
using System.Text.RegularExpressions;
using ArchUnitNET.Domain.PlantUml.Exceptions;
using static ArchUnitNET.Domain.PlantUml.Import.PlantUmlPatterns;

namespace ArchUnitNET.Domain.PlantUml.Import
{
internal class PlantUmlParser
{
private PlantUmlPatterns _plantUmlPatterns = new PlantUmlPatterns();

public PlantUmlParsedDiagram Parse(string filename)
{
if (filename is null)
{
throw new ArgumentNullException(nameof(filename));
}
return CreateDiagram(ReadLines(filename));
return CreateDiagram(
ReadLines(() => new StreamReader(filename, Encoding.UTF8), filename)
);
}

public PlantUmlParsedDiagram Parse(Stream stream)
{
if (stream is null)
{
throw new ArgumentNullException("stream");
}
return CreateDiagram(ReadLines(stream));
}

private IEnumerable<string> ReadLines(string filename)
{
try
{
return File.ReadAllLines(filename, Encoding.UTF8);
}
catch (Exception ex)
when (ex is IOException
|| ex is UnauthorizedAccessException
|| ex is SecurityException
)
{
throw new PlantUmlParseException("Could not parse diagram from " + filename, ex);
throw new ArgumentNullException(nameof(stream));
}
return CreateDiagram(
ReadLines(() => new StreamReader(stream, Encoding.UTF8), "stream")
);
}

private IEnumerable<string> ReadLines(Stream stream)
private static IEnumerable<string> ReadLines(Func<TextReader> open, string source)
{
try
{
var lines = new List<string>();
using (StreamReader sr = new StreamReader(stream, Encoding.UTF8))
using (TextReader reader = open())
{
string line;
while ((line = sr.ReadLine()) != null)
while ((line = reader.ReadLine()) != null)
{
lines.Add(line);
}
Expand All @@ -70,7 +55,7 @@ private IEnumerable<string> ReadLines(Stream stream)
|| ex is SecurityException
)
{
throw new PlantUmlParseException("Could not parse diagram from stream", ex);
throw new PlantUmlParseException("Could not parse diagram from " + source, ex);
}
}

Expand Down Expand Up @@ -98,18 +83,18 @@ IEnumerable<string> plantUmlDiagramLines
{
var result = new List<ParsedDependency>();
foreach (
PlantUmlDependencyMatcher matcher in _plantUmlPatterns.MatchDependencies(
plantUmlDiagramLines
PlantUmlDependencyMatcher matcher in plantUmlDiagramLines.SelectMany(
PlantUmlDependencyMatcher.TryParse
)
)
{
PlantUmlComponent origin = FindComponentMatching(
plantUmlComponents,
matcher.MatchOrigin
matcher.Origin
);
PlantUmlComponent target = FindComponentMatching(
plantUmlComponents,
matcher.MatchTarget
matcher.Target
);
result.Add(new ParsedDependency(origin.Identifier, target.Identifier));
}
Expand All @@ -130,27 +115,24 @@ string originOrTargetString
private ISet<PlantUmlComponent> ParseComponents(IEnumerable<string> plantUmlDiagramLines)
{
return new HashSet<PlantUmlComponent>(
_plantUmlPatterns
.FilterComponents(plantUmlDiagramLines)
.Select(p => CreateNewComponent(p))
.Distinct()
plantUmlDiagramLines
.Select(PlantUmlComponentMatcher.TryParse)
.Where(matcher => matcher != null)
.Select(CreateNewComponent)
);
}

private PlantUmlComponent CreateNewComponent(string input)
private PlantUmlComponent CreateNewComponent(PlantUmlComponentMatcher matcher)
{
PlantUmlComponentMatcher matcher = _plantUmlPatterns.MatchComponent(input);

var componentName = new ComponentName(matcher.MatchComponentName());
var componentName = new ComponentName(matcher.Name);
ImmutableHashSet<Stereotype> immutableStereotypes = IdentifyStereotypes(
matcher,
componentName
);
string alias = matcher.MatchAlias();
return new PlantUmlComponent(
componentName,
immutableStereotypes,
alias != null ? new Alias(alias) : null
matcher.Alias != null ? new Alias(matcher.Alias) : null
);
}

Expand All @@ -159,13 +141,9 @@ private ImmutableHashSet<Stereotype> IdentifyStereotypes(
ComponentName componentName
)
{
var stereotypes = ImmutableHashSet.CreateBuilder<Stereotype>();
foreach (string stereotype in matcher.MatchStereoTypes())
{
stereotypes.Add(new Stereotype(stereotype));
}

ImmutableHashSet<Stereotype> result = stereotypes.ToImmutable();
ImmutableHashSet<Stereotype> result = matcher
.Stereotypes.Select(stereotype => new Stereotype(stereotype))
.ToImmutableHashSet();
if (result.IsEmpty)
{
throw new IllegalDiagramException(
Expand All @@ -181,7 +159,9 @@ ComponentName componentName

private IEnumerable<string> FilterOutComments(IEnumerable<string> lines)
{
return lines.Where(l => !Regex.IsMatch(l, "^\\s*'")).ToList();
return lines
.Where(l => !l.TrimStart().StartsWith("'", StringComparison.Ordinal))
.ToList();
}
}
}
Loading
Loading