add PluginGraphAttributesBuilder.WithTitle() to be able to overwrite graph_title

Author: smdn

src/Smdn.Net.MuninNode/Smdn.Net.MuninPlugin/PluginGraphAttributesBuilder.cs

@@ -2,6 +2,9 @@
 // SPDX-License-Identifier: MIT
 using System;
 using System.Collections.Generic;
+#if SYSTEM_DIAGNOSTICS_CODEANALYSIS_MEMBERNOTNULLATTRIBUTE
+using System.Diagnostics.CodeAnalysis;
+#endif
 using System.Text.RegularExpressions;
 
 namespace Smdn.Net.MuninPlugin;
@@ -42,8 +45,7 @@ private static void ThrowIfNotMatch(Regex regex, string input, string paramName,
     }
   }
 
-  private readonly string title;
-
+  private string title;
   private bool? showGraph;
   private string? category;
   private int? height;
@@ -106,14 +108,14 @@ public PluginGraphAttributesBuilder(string title, PluginGraphAttributesBuilder b
   /// <paramref name="title"/> contains invalid characters.
   /// </exception>
   /// <seealso href="https://guide.munin-monitoring.org/en/latest/reference/plugin.html#graph-title">Plugin reference - Global attributes - graph_title</seealso>
+#if !SYSTEM_DIAGNOSTICS_CODEANALYSIS_MEMBERNOTNULLATTRIBUTE
+#pragma warning disable CS8618
+#endif
   public PluginGraphAttributesBuilder(string title)
   {
-    ArgumentExceptionShim.ThrowIfNullOrWhiteSpace(title, nameof(title));
-
-    ThrowIfNotMatch(RegexTitle, title, nameof(title), "graph_title");
-
-    this.title = title;
+    WithTitle(title);
   }
+#pragma warning restore CS8618
 
   /// <summary>Sets a value for the <c>graph</c> to <c>yes</c>.</summary>
   /// <seealso href="https://guide.munin-monitoring.org/en/latest/reference/plugin.html#graph">Plugin reference - Global attributes - graph</seealso>
@@ -231,6 +233,27 @@ public PluginGraphAttributesBuilder DisableUnitScaling()
     return this;
   }
 
+  /// <summary>Overwrites a value for the <c>graph_title</c>.</summary>
+  /// <seealso href="https://guide.munin-monitoring.org/en/latest/reference/plugin.html#graph-title">Plugin reference - Global attributes - graph_title</seealso>
+  /// <exception cref="ArgumentNullException"><paramref name="title"/> is <see langword="null"/>.</exception>
+  /// <exception cref="ArgumentException">
+  /// <paramref name="title"/> is empty, or
+  /// <paramref name="title"/> contains invalid characters.
+  /// </exception>
+#if SYSTEM_DIAGNOSTICS_CODEANALYSIS_MEMBERNOTNULLATTRIBUTE
+  [MemberNotNull(nameof(title))]
+#endif
+  public PluginGraphAttributesBuilder WithTitle(string title)
+  {
+    ArgumentExceptionShim.ThrowIfNullOrWhiteSpace(title, nameof(title));
+
+    ThrowIfNotMatch(RegexTitle, title, nameof(title), "graph_title");
+
+    this.title = title;
+
+    return this;
+  }
+
   /// <summary>Sets a value for the <c>graph_total</c>.</summary>
   /// <seealso href="https://guide.munin-monitoring.org/en/latest/reference/plugin.html#graph-total">Plugin reference - Global attributes - graph_total</seealso>
   /// <exception cref="ArgumentNullException"><paramref name="labelForTotal"/> is <see langword="null"/>.</exception>

tests/Smdn.Net.MuninNode/Smdn.Net.MuninPlugin/PluginGraphAttributesBuilder.cs

@@ -10,18 +10,41 @@ namespace Smdn.Net.MuninPlugin;
 
 [TestFixture]
 public partial class PluginGraphAttributesBuilderTests {
-  [TestCase(null, typeof(ArgumentNullException))]
-  [TestCase("", typeof(ArgumentException))]
-  [TestCase(" ", typeof(ArgumentException))]
-  [TestCase("\0", typeof(ArgumentException))]
-  [TestCase("\0title", typeof(ArgumentException))]
-  [TestCase("\ntitle", typeof(ArgumentException))]
-  [TestCase("\rtitle", typeof(ArgumentException))]
-  [TestCase("\ttitle", typeof(ArgumentException))]
-  [TestCase("title\0", typeof(ArgumentException))]
-  [TestCase("title\n", typeof(ArgumentException))]
-  [TestCase("title\r", typeof(ArgumentException))]
-  [TestCase("title\t", typeof(ArgumentException))]
+  private static System.Collections.IEnumerable YieldTestCases_WithTitle_ArgumentException()
+  {
+    yield return new object?[] { null, typeof(ArgumentNullException) };
+    yield return new object?[] { "", typeof(ArgumentException) };
+    yield return new object?[] { " ", typeof(ArgumentException) };
+    yield return new object?[] { "\0", typeof(ArgumentException) };
+    yield return new object?[] { "\0title", typeof(ArgumentException) };
+    yield return new object?[] { "\ntitle", typeof(ArgumentException) };
+    yield return new object?[] { "\rtitle", typeof(ArgumentException) };
+    yield return new object?[] { "\ttitle", typeof(ArgumentException) };
+    yield return new object?[] { "title\0", typeof(ArgumentException) };
+    yield return new object?[] { "title\n", typeof(ArgumentException) };
+    yield return new object?[] { "title\r", typeof(ArgumentException) };
+    yield return new object?[] { "title\t", typeof(ArgumentException) };
+  }
+
+  private static System.Collections.IEnumerable YieldTestCases_WithTitle()
+  {
+    yield return new object[] { "t" };
+    yield return new object[] { "title" };
+    yield return new object[] { "Title" };
+    yield return new object[] { "TITLE" };
+    yield return new object[] { "title0" };
+    yield return new object[] { "title9" };
+    yield return new object[] { "0title" };
+    yield return new object[] { "9title" };
+    yield return new object[] { "title-x" };
+    yield return new object[] { ".title." };
+    yield return new object[] { "'title'" };
+    yield return new object[] { "title - title" };
+    yield return new object[] { "<title>" };
+    yield return new object[] { "タイトル" };
+  }
+
+  [TestCaseSource(nameof(YieldTestCases_WithTitle_ArgumentException))]
   public void Ctor_ArgumentException(string? title, Type expectedTypeOfException)
     => Assert.That(
       () => new PluginGraphAttributesBuilder(
@@ -43,20 +66,7 @@ IEnumerable<string> expectedAttributeList
       Is.EquivalentTo(expectedAttributeList).Using((IEqualityComparer<string>)StringComparer.Ordinal)
     );
 
-  [TestCase("t")]
-  [TestCase("title")]
-  [TestCase("Title")]
-  [TestCase("TITLE")]
-  [TestCase("title0")]
-  [TestCase("title9")]
-  [TestCase("0title")]
-  [TestCase("9title")]
-  [TestCase("title-x")]
-  [TestCase(".title.")]
-  [TestCase("'title'")]
-  [TestCase("title - title")]
-  [TestCase("<title>")]
-  [TestCase("タイトル")]
+  [TestCaseSource(nameof(YieldTestCases_WithTitle))]
   public void Ctor(string title)
     => AssertBuiltGraphAttributes(
       new PluginGraphAttributesBuilder(title),
@@ -281,6 +291,25 @@ public void DisableUnitScaling()
       ["graph_title title", "graph_scale no"]
     );
 
+  [TestCaseSource(nameof(YieldTestCases_WithTitle_ArgumentException))]
+  public void WithTitle_ArgumentException(string? title, Type expectedTypeOfException)
+    => Assert.That(
+      () => new PluginGraphAttributesBuilder("title")
+        .WithTitle(title: title!),
+      Throws
+        .TypeOf(expectedTypeOfException)
+        .With
+        .Property(nameof(ArgumentException.ParamName))
+        .EqualTo("title")
+    );
+
+  [TestCaseSource(nameof(YieldTestCases_WithTitle))]
+  public void WithTitle(string title)
+    => AssertBuiltGraphAttributes(
+      new PluginGraphAttributesBuilder("title").WithTitle(title),
+      [$"graph_title {title}"]
+    );
+
   [TestCase(null, typeof(ArgumentNullException))]
   [TestCase("", typeof(ArgumentException))]
   [TestCase(" ", typeof(ArgumentException))]