Append resource links to staging PRs

KSP-CKAN · Sep 26, 2021 · 4a2076b · 4a2076b
1 parent 61514f1
commit 4a2076b
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 0 deletions.
diff --git a/Netkan/CKAN-netkan.csproj b/Netkan/CKAN-netkan.csproj
@@ -121,6 +121,7 @@
     <Compile Include="Transformers\PropertySortTransformer.cs" />
     <Compile Include="Transformers\SpacedockTransformer.cs" />
     <Compile Include="Transformers\StagingTransformer.cs" />
+    <Compile Include="Transformers\StagingLinksTransformer.cs" />
     <Compile Include="Transformers\StripNetkanMetadataTransformer.cs" />
     <Compile Include="Transformers\VersionEditTransformer.cs" />
     <Compile Include="Transformers\VersionedOverrideTransformer.cs" />

diff --git a/Netkan/Transformers/NetkanTransformer.cs b/Netkan/Transformers/NetkanTransformer.cs
@@ -43,6 +43,7 @@ IValidator validator
                 new AvcKrefTransformer(http, ghApi),
                 new InternalCkanTransformer(http, moduleService),
                 new AvcTransformer(http, moduleService, ghApi),
+                new StagingLinksTransformer(),
                 new LocalizationsTransformer(http, moduleService),
                 new VersionEditTransformer(),
                 new ForcedVTransformer(),

diff --git a/Netkan/Transformers/StagingLinksTransformer.cs b/Netkan/Transformers/StagingLinksTransformer.cs
@@ -0,0 +1,54 @@
+using System.Collections.Generic;
+using System.Text;
+using System.Linq;
+using log4net;
+using Newtonsoft.Json.Linq;
+
+using CKAN.NetKAN.Model;
+
+namespace CKAN.NetKAN.Transformers
+{
+    internal sealed class StagingLinksTransformer : ITransformer
+    {
+        public string Name { get { return "staging_links"; } }
+
+        public IEnumerable<Metadata> Transform(Metadata metadata, TransformOptions opts)
+        {
+            if (opts.Staged && !string.IsNullOrEmpty(opts.StagingReason))
+            {
+                var table = LinkTable(metadata);
+                if (!string.IsNullOrEmpty(table))
+                {
+                    log.DebugFormat("Adding links to staging reason: {0}",
+                        table);
+                    opts.StagingReason += table;
+                }
+            }
+            // This transformer never changes the metadata
+            yield return metadata;
+        }
+
+        private string LinkTable(Metadata metadata)
+        {
+            var resourcesJson = (JObject)metadata?.Json()?["resources"];
+            if (resourcesJson == null)
+            {
+                // No resources, no links to append
+                return "";
+            }
+            StringBuilder table = new StringBuilder();
+            // Blank lines to separate the table from the description
+            table.AppendLine("");
+            table.AppendLine("");
+            table.AppendLine("Resource | URL");
+            table.AppendLine(":-- | :--");
+            foreach (var prop in resourcesJson.Properties().OrderBy(prop => prop.Name))
+            {
+                table.AppendLine($"{prop.Name} | <{prop.Value}>");
+            }
+            return table.ToString();
+        }
+
+        private static readonly ILog log = LogManager.GetLogger(typeof(StagingLinksTransformer));
+    }
+}