refactor: Provide customization to RelationshipResolver

Rather than raw configuration

src/ConventionalChangelog/Changelog.cs

@@ -11,11 +11,11 @@ public class Changelog
 
     public Changelog(Configuration configuration)
     {
-        IConfigured configured = new Configured(configuration);
-        _relationshipResolver = new RelationshipResolver(configuration);
-        _repositoryReader = new RepositoryReader(configured);
-        _parser = new MessageParser(configured);
-        _logWriter = new LogWriter(configured);
+        ICustomization customization = new Customization(configuration);
+        _repositoryReader = new RepositoryReader(customization);
+        _parser = new MessageParser(customization);
+        _relationshipResolver = new RelationshipResolver(customization);
+        _logWriter = new LogWriter(customization);
     }
 
     public string FromRepository(string path)

src/ConventionalChangelog/Conventional/MessageParser.cs

@@ -5,13 +5,13 @@ namespace ConventionalChangelog.Conventional;
 
 public class MessageParser
 {
-    private readonly IConfigured _configured;
+    private readonly ICustomization _customization;
 
-    public MessageParser(Configuration configuration) : this(new Configured(configuration))
+    public MessageParser(Configuration configuration) : this(new Customization(configuration))
     {
     }
 
-    internal MessageParser(IConfigured configured) => _configured = configured;
+    internal MessageParser(ICustomization customization) => _customization = customization;
 
     public CommitMessage Parse(Commit commit)
     {
@@ -28,22 +28,22 @@ private CommitMessage Read(TextReader lines)
     {
         var (typeIndicator, description) = HeaderFrom(lines.ReadLine());
         var (body, footers) = BodyFrom(lines);
-        typeIndicator = _configured.Sanitize(typeIndicator, footers);
+        typeIndicator = _customization.Sanitize(typeIndicator, footers);
 
         return new CommitMessage(typeIndicator, description, body, footers);
     }
 
 #if NET6_0
     private (string, string) HeaderFrom(string? header)
     {
-        var twoParts = header?.Split(_configured.Separator);
+        var twoParts = header?.Split(_customization.Separator);
         return twoParts?.Length == 2
             ? (twoParts.First(), twoParts.Last().Trim())
             : ("", "");
     }
 #elif NET7_0_OR_GREATER
     private (string, string) HeaderFrom(string? header) =>
-        header?.Split(_configured.Separator) is [var first, var second]
+        header?.Split(_customization.Separator) is [var first, var second]
             ? (first,second.Trim())
             : ("", "");
 #endif
@@ -54,7 +54,7 @@ private CommitMessage Read(TextReader lines)
         var footers = Enumerable.Empty<Footer>();
         while (reader.ReadLine() is { } line)
         {
-            if (_configured.IsFooter(line))
+            if (_customization.IsFooter(line))
             {
                 footers = FootersFrom(LinesFrom(reader).Prepend(line));
                 break;
@@ -76,15 +76,15 @@ private IEnumerable<Footer> FootersFrom(IEnumerable<string> lines)
         Footer? buffer = null;
         foreach (var line in lines)
         {
-            if (buffer is not null && _configured.IsFooter(line))
+            if (buffer is not null && _customization.IsFooter(line))
             {
                 yield return buffer with {Value = buffer.Value.Trim()};
                 buffer = null;
             }
             if (buffer is not null)
                 buffer = buffer with { Value = buffer.Value + Environment.NewLine + line};
             else
-                buffer = _configured.FooterFrom(line);
+                buffer = _customization.FooterFrom(line);
         }
 
         if (buffer is not null)

src/ConventionalChangelog/Configured.cs → src/ConventionalChangelog/Customization.cs

@@ -3,7 +3,7 @@
 
 namespace ConventionalChangelog;
 
-internal class Configured : IConfigured, IComparer<string>
+internal class Customization : ICustomization, IComparer<string>
 {
     private const string ConventionalCommitSeparator = ": "; // see https://www.conventionalcommits.org/en/v1.0.0/#specification
 
@@ -13,16 +13,23 @@ internal class Configured : IConfigured, IComparer<string>
     private readonly string _footerPattern;
     private readonly string _semanticVersionPattern;
 
-    public Configured(Configuration configuration)
+    public Customization(Configuration configuration)
     {
         _commitTypes = configuration.CommitTypes.ToImmutableArray();
         _versionTagPrefix = configuration.VersionTagPrefix;
         _changelogOrder = configuration.ChangelogOrder;
         _footerPattern = configuration.FooterPattern;
         _semanticVersionPattern = configuration.SemanticVersionPattern;
+        Relationships = new Relationship[]
+        {
+            new(configuration.DropSelf, true, false),
+            new(configuration.DropOther, false, true),
+            new(configuration.DropBoth, true, true),
+        };
     }
 
     public string Separator => ConventionalCommitSeparator;
+    public IReadOnlyCollection<Relationship> Relationships { get; }
 
     public string Sanitize(string typeIndicator, IEnumerable<CommitMessage.Footer> footers)
     {

src/ConventionalChangelog/IConfigured.cs → src/ConventionalChangelog/ICustomization.cs

@@ -2,7 +2,7 @@
 
 namespace ConventionalChangelog;
 
-public interface IConfigured
+internal interface ICustomization
 {
     string Sanitize(string typeIndicator, IEnumerable<CommitMessage.Footer> footers);
     ChangelogType TypeFor(string typeIndicator);
@@ -15,4 +15,5 @@ public interface IConfigured
     bool IsVersionTag(string tagName);
 
     string Separator { get; }
+    IReadOnlyCollection<Relationship> Relationships { get; }
 }

src/ConventionalChangelog/LogWriter.cs

@@ -13,19 +13,19 @@ internal class LogWriter
 
     private static readonly string EmptyChangelog = ChangelogTitle + NewLine;
 
-    private readonly IConfigured _configured;
+    private readonly ICustomization _customization;
 
 
-    public LogWriter(IConfigured configured)
+    public LogWriter(ICustomization customization)
     {
-        _configured = configured;
+        _customization = customization;
     }
 
     public string Print(IEnumerable<IPrintable> writable)
     {
         var writtenLog = new WrittenLog(EmptyChangelog);
-        foreach (var printable in _configured.Ordered(writable))
-            writtenLog.Add(printable, _configured.TypeFor(printable.TypeIndicator));
+        foreach (var printable in _customization.Ordered(writable))
+            writtenLog.Add(printable, _customization.TypeFor(printable.TypeIndicator));
         return writtenLog.Print();
     }
 

src/ConventionalChangelog/RelationshipResolver.cs

@@ -2,47 +2,53 @@
 
 namespace ConventionalChangelog;
 
+internal record Relationship(string Token, bool DropSelf, bool DropOther);
+
 internal class RelationshipResolver
 {
-    private readonly record struct Relationship(string Token, bool Add, bool Register, bool Remove);
+    private readonly record struct Rule(string Token, bool Add, bool Register, bool Remove);
 
-    private readonly IEnumerable<Relationship> _relationships;
+    private readonly IEnumerable<Rule> _rules;
 
-    public RelationshipResolver(Configuration configuration)
+    public RelationshipResolver(ICustomization customization)
     {
-        _relationships = new Relationship[] {
-            new(configuration.DropSelf, true, true, true),
-            new(configuration.DropBoth, false, false, true),
-            new(configuration.DropOther, false, true, false),
-        };
+        _rules = customization.Relationships.Select(AsRule);
     }
 
+    private static Rule AsRule(Relationship relationship) => new
+    (
+        relationship.Token,
+        relationship is { DropOther: false },
+        relationship.DropSelf != relationship.DropOther,
+        relationship is { DropSelf: true}
+    );
+
     public IEnumerable<CommitMessage> ResolveRelationshipsBetween(IEnumerable<CommitMessage> messages)
     {
-        return _relationships.Aggregate(messages, Reduce);
+        return _rules.Aggregate(messages, Reduce);
     }
 
-    private static IEnumerable<CommitMessage> Reduce(IEnumerable<CommitMessage> messages, Relationship relationship)
+    private static IEnumerable<CommitMessage> Reduce(IEnumerable<CommitMessage> messages, Rule rule)
     {
-        return messages.Aggregate(new Resolver(relationship), (c, m) => c.Add(m)).Messages;
+        return messages.Aggregate(new Resolver(rule), (c, m) => c.Add(m)).Messages;
     }
 
 
     private class Resolver
     {
-        private readonly Relationship _relationship;
+        private readonly Rule _rule;
         private readonly List<CommitMessage> _messages = new();
         private readonly Dictionary<string, List<CommitMessage>> _references = new();
 
-        public Resolver(Relationship relationship) => _relationship = relationship;
+        public Resolver(Rule rule) => _rule = rule;
 
         public Resolver Add(CommitMessage message)
         {
             var found = _references.TryGetValue(message.Hash, out var referenced);
 
-            if (!found || _relationship.Add) _messages.Add(message);
-            if (!found || _relationship.Register) CacheReferences(message);
-            if (found && _relationship.Remove) _messages.RemoveAll(referenced!.Contains);
+            if (!found || _rule.Add) _messages.Add(message);
+            if (!found || _rule.Register) CacheReferences(message);
+            if (found && _rule.Remove) _messages.RemoveAll(referenced!.Contains);
             return this;
         }
 
@@ -53,7 +59,7 @@ private void CacheReferences(CommitMessage source)
         }
 
         private IEnumerable<string> ReferencesFrom(CommitMessage commitMessage) =>
-            commitMessage.Footers.Where(_relationship.Token.Matches).Select(Target);
+            commitMessage.Footers.Where(_rule.Token.Matches).Select(Target);
 
         private static string Target(CommitMessage.Footer f) => f.Value;
 

src/ConventionalChangelog/RepositoryReader.cs

@@ -4,11 +4,11 @@ namespace ConventionalChangelog;
 
 internal class RepositoryReader
 {
-    private readonly IConfigured _configured;
+    private readonly ICustomization _customization;
 
-    public RepositoryReader(IConfigured configured)
+    public RepositoryReader(ICustomization customization)
     {
-        _configured = configured;
+        _customization = customization;
     }
 
     public IEnumerable<Commit> CommitsFrom(string path)
@@ -25,7 +25,7 @@ public IEnumerable<Commit> CommitsFrom(string path)
     private object? NewestVersionCommitIn(IRepository repository)
     {
         var versionCommits = repository.Tags
-            .Where(tag => _configured.IsVersionTag(tag.FriendlyName))
+            .Where(tag => _customization.IsVersionTag(tag.FriendlyName))
             .Select(x => x.Target)
             .ToHashSet();