Updated parsers

Author: Mpdreamz

src/Elastic.Markdown/Helpers/SemVersion.cs

@@ -11,7 +11,7 @@ namespace Elastic.Markdown.Helpers;
 /// <summary>
 /// A semver2 compatible version.
 /// </summary>
-public sealed class SemVersion :
+public class SemVersion :
 	IEquatable<SemVersion>,
 	IComparable<SemVersion>,
 	IComparable

src/Elastic.Markdown/Myst/FrontMatterParser.cs

@@ -27,11 +27,11 @@ public class YamlFrontMatter
 
 
 	[YamlMember(Alias = "applies")]
-	public DeploymentType? AppliesTo { get; set; }
+	public Deployment? AppliesTo { get; set; }
 }
 
 [YamlSerializable]
-public class DeploymentType
+public class Deployment
 {
 	[YamlMember(Alias = "self")]
 	public SelfManagedDeployment? SelfManaged { get; set; }
@@ -40,6 +40,11 @@ public class DeploymentType
 	public CloudManagedDeployment? Cloud { get; set; }
 }
 
+public class AllVersions() : SemVersion(9999, 9999, 9999)
+{
+	public static AllVersions Instance { get; } = new ();
+}
+
 [YamlSerializable]
 public class SelfManagedDeployment
 {
@@ -51,6 +56,13 @@ public class SelfManagedDeployment
 
 	[YamlMember(Alias = "eck")]
 	public SemVersion? Eck { get; set; }
+
+	public static SelfManagedDeployment All { get; } = new()
+	{
+		Stack = AllVersions.Instance,
+		Ece = AllVersions.Instance,
+		Eck = AllVersions.Instance
+	};
 }
 
 [YamlSerializable]
@@ -61,6 +73,13 @@ public class CloudManagedDeployment
 
 	[YamlMember(Alias = "serverless")]
 	public SemVersion? Serverless { get; set; }
+
+	public static CloudManagedDeployment All { get; } = new()
+	{
+		Ess = AllVersions.Instance,
+		Serverless = AllVersions.Instance
+	};
+
 }
 
 public static class FrontMatterParser
@@ -72,6 +91,8 @@ public static YamlFrontMatter Deserialize(string yaml)
 		var deserializer = new StaticDeserializerBuilder(new YamlFrontMatterStaticContext())
 			.IgnoreUnmatchedProperties()
 			.WithTypeConverter(new SemVersionConverter())
+			.WithTypeConverter(new CloudManagedSerializer())
+			.WithTypeConverter(new SelfManagedSerializer())
 			.Build();
 
 		var frontMatter = deserializer.Deserialize<YamlFrontMatter>(input);
@@ -87,6 +108,10 @@ public class SemVersionConverter : IYamlTypeConverter
 	public object? ReadYaml(IParser parser, Type type, ObjectDeserializer rootDeserializer)
 	{
 		var value = parser.Consume<Scalar>();
+		if (string.IsNullOrWhiteSpace(value.Value))
+			return AllVersions.Instance;
+		if (string.Equals(value.Value, "all", StringComparison.InvariantCultureIgnoreCase))
+			return AllVersions.Instance;
 		return (SemVersion)value.Value;
 	}
 
@@ -97,3 +122,65 @@ public void WriteYaml(IEmitter emitter, object? value, Type type, ObjectSerializ
 		emitter.Emit(new Scalar(value.ToString()!));
 	}
 }
+
+public class CloudManagedSerializer : IYamlTypeConverter
+{
+	public bool Accepts(Type type) => type == typeof(CloudManagedDeployment);
+
+	public object? ReadYaml(IParser parser, Type type, ObjectDeserializer rootDeserializer)
+	{
+		if (parser.TryConsume<Scalar>(out var value))
+		{
+			if (string.IsNullOrWhiteSpace(value.Value))
+				return CloudManagedDeployment.All;
+			if (string.Equals(value.Value, "all", StringComparison.InvariantCultureIgnoreCase))
+				return CloudManagedDeployment.All;
+		}
+		var x = rootDeserializer.Invoke(typeof(Dictionary<string, string>));
+		if (x is not Dictionary<string, string> { Count: > 0 } dictionary)
+			return null;
+
+		var cloudManaged = new CloudManagedDeployment();
+		if (dictionary.TryGetValue("ess", out var v))
+			cloudManaged.Ess = (SemVersion)v;
+		if (dictionary.TryGetValue("serverless", out v))
+			cloudManaged.Serverless = (SemVersion)v;
+		return cloudManaged;
+
+	}
+
+	public void WriteYaml(IEmitter emitter, object? value, Type type, ObjectSerializer serializer) =>
+		serializer.Invoke(value, type);
+}
+
+public class SelfManagedSerializer : IYamlTypeConverter
+{
+	public bool Accepts(Type type) => type == typeof(SelfManagedDeployment);
+
+	public object? ReadYaml(IParser parser, Type type, ObjectDeserializer rootDeserializer)
+	{
+		if (parser.TryConsume<Scalar>(out var value))
+		{
+			if (string.IsNullOrWhiteSpace(value.Value))
+				return SelfManagedDeployment.All;
+			if (string.Equals(value.Value, "all", StringComparison.InvariantCultureIgnoreCase))
+				return SelfManagedDeployment.All;
+		}
+		var x = rootDeserializer.Invoke(typeof(Dictionary<string, string>));
+		if (x is not Dictionary<string, string> { Count: > 0 } dictionary)
+			return null;
+
+		var deployment = new SelfManagedDeployment();
+		if (dictionary.TryGetValue("stack", out var v))
+			deployment.Stack = (SemVersion)v;
+		if (dictionary.TryGetValue("ece", out v))
+			deployment.Ece = (SemVersion)v;
+		if (dictionary.TryGetValue("eck", out v))
+			deployment.Eck = (SemVersion)v;
+		return deployment;
+
+	}
+
+	public void WriteYaml(IEmitter emitter, object? value, Type type, ObjectSerializer serializer) =>
+		serializer.Invoke(value, type);
+}

tests/Elastic.Markdown.Tests/FrontMatter/ProductConstraintTests.cs

@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information
 
 using Elastic.Markdown.Helpers;
+using Elastic.Markdown.Myst;
 using Elastic.Markdown.Tests.Directives;
 using FluentAssertions;
 using Xunit.Abstractions;
@@ -41,3 +42,52 @@ public void ReadsSubstitutions()
 	}
 }
 
+public class CanSpecifyAllForProductVersions(ITestOutputHelper output) : DirectiveTest(output,
+"""
+---
+title: Elastic Docs v3
+navigation_title: "Documentation Guide"
+applies:
+  self:
+    stack: all
+---
+"""
+)
+{
+	[Fact]
+	public void Assert() =>
+		File.YamlFrontMatter!.AppliesTo!.SelfManaged!.Stack.Should().BeEquivalentTo(AllVersions.Instance);
+}
+
+public class EmptyProductVersionMeansAll(ITestOutputHelper output) : DirectiveTest(output,
+"""
+---
+title: Elastic Docs v3
+navigation_title: "Documentation Guide"
+applies:
+  self:
+    stack:
+---
+"""
+)
+{
+	[Fact]
+	public void Assert() =>
+		File.YamlFrontMatter!.AppliesTo!.SelfManaged!.Stack.Should().BeEquivalentTo(AllVersions.Instance);
+}
+
+public class EmptyCloudSetsAllProductsToAll(ITestOutputHelper output) : DirectiveTest(output,
+"""
+---
+title: Elastic Docs v3
+navigation_title: "Documentation Guide"
+applies:
+  cloud:
+---
+"""
+)
+{
+	[Fact]
+	public void Assert() =>
+		File.YamlFrontMatter!.AppliesTo!.Cloud!.Ess.Should().BeEquivalentTo(AllVersions.Instance);
+}