Merge pull request #640 from nulltoken/ntk/terse

Teach OpenApiJsonWriter to produce a terse output

Author: darrelmiller

src/Microsoft.OpenApi/Writers/OpenApiJsonWriter.cs

@@ -18,6 +18,16 @@ public OpenApiJsonWriter(TextWriter textWriter) : base(textWriter, null)
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OpenApiJsonWriter"/> class.
+        /// </summary>
+        /// <param name="textWriter">The text writer.</param>
+        /// <param name="settings">Settings for controlling how the OpenAPI document will be written out.</param>
+        public OpenApiJsonWriter(TextWriter textWriter, OpenApiJsonWriterSettings settings) : base(textWriter, settings)
+        {
+            _produceTerseOutput = settings.Terse;
+        }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="OpenApiJsonWriter"/> class.
         /// </summary>
@@ -27,6 +37,11 @@ public OpenApiJsonWriter(TextWriter textWriter, OpenApiWriterSettings settings)
         {
         }
 
+        /// <summary>
+        /// Indicates whether or not the produced document will be written in a compact or pretty fashion.
+        /// </summary>
+        private bool _produceTerseOutput = false;
+
         /// <summary>
         /// Base Indentation Level.
         /// This denotes how many indentations are needed for the property in the base object.
@@ -51,7 +66,7 @@ public override void WriteStartObject()
                     Writer.Write(WriterConstants.ArrayElementSeparator);
                 }
 
-                Writer.WriteLine();
+                WriteLine();
                 WriteIndentation();
             }
 
@@ -68,13 +83,16 @@ public override void WriteEndObject()
             var currentScope = EndScope(ScopeType.Object);
             if (currentScope.ObjectCount != 0)
             {
-                Writer.WriteLine();
+                WriteLine();
                 DecreaseIndentation();
                 WriteIndentation();
             }
             else
             {
-                Writer.Write(WriterConstants.WhiteSpaceForEmptyObject);
+                if (!_produceTerseOutput)
+                {
+                    Writer.Write(WriterConstants.WhiteSpaceForEmptyObject);
+                }
                 DecreaseIndentation();
             }
 
@@ -99,7 +117,7 @@ public override void WriteStartArray()
                     Writer.Write(WriterConstants.ArrayElementSeparator);
                 }
 
-                Writer.WriteLine();
+                WriteLine();
                 WriteIndentation();
             }
 
@@ -115,7 +133,7 @@ public override void WriteEndArray()
             var current = EndScope(ScopeType.Array);
             if (current.ObjectCount != 0)
             {
-                Writer.WriteLine();
+                WriteLine();
                 DecreaseIndentation();
                 WriteIndentation();
             }
@@ -143,7 +161,7 @@ public override void WritePropertyName(string name)
                 Writer.Write(WriterConstants.ObjectMemberSeparator);
             }
 
-            Writer.WriteLine();
+            WriteLine();
 
             currentScope.ObjectCount++;
 
@@ -154,6 +172,11 @@ public override void WritePropertyName(string name)
             Writer.Write(name);
 
             Writer.Write(WriterConstants.NameValueSeparator);
+
+            if (!_produceTerseOutput)
+            {
+                Writer.Write(WriterConstants.NameValueSeparatorWhiteSpaceSuffix);
+            }
         }
 
         /// <summary>
@@ -198,7 +221,7 @@ protected override void WriteValueSeparator()
                     Writer.Write(WriterConstants.ArrayElementSeparator);
                 }
 
-                Writer.WriteLine();
+                WriteLine();
                 WriteIndentation();
                 currentScope.ObjectCount++;
             }
@@ -212,5 +235,31 @@ public override void WriteRaw(string value)
             WriteValueSeparator();
             Writer.Write(value);
         }
+
+        /// <summary>
+        /// Write the indentation.
+        /// </summary>
+        public override void WriteIndentation()
+        {
+            if (_produceTerseOutput)
+            {
+                return;
+            }
+
+            base.WriteIndentation();
+        }
+
+        /// <summary>
+        /// Writes a line terminator to the text string or stream.
+        /// </summary>
+        private void WriteLine()
+        {
+            if (_produceTerseOutput)
+            {
+                return;
+            }
+
+            Writer.WriteLine();
+        }
     }
 }

src/Microsoft.OpenApi/Writers/OpenApiJsonWriterSettings.cs

@@ -0,0 +1,19 @@
+namespace Microsoft.OpenApi.Writers
+{
+    /// <summary>
+    /// Configuration settings to control how OpenAPI Json documents are written
+    /// </summary>
+    public class OpenApiJsonWriterSettings : OpenApiWriterSettings
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OpenApiJsonWriterSettings"/> class.
+        /// </summary>
+        public OpenApiJsonWriterSettings()
+        { }
+
+        /// <summary>
+        /// Indicates whether or not the produced document will be written in a compact or pretty fashion.
+        /// </summary>
+        public bool Terse { get; set; } = false;
+    }
+}

src/Microsoft.OpenApi/Writers/WriterConstants.cs

@@ -81,7 +81,13 @@ internal static class WriterConstants
         /// <summary>
         /// The separator between the name and the value.
         /// </summary>
-        internal const string NameValueSeparator = ": ";
+        internal const string NameValueSeparator = ":";
+
+        /// <summary>
+        /// The white space postfixing <see cref="NameValueSeparator"/>
+        /// when producing pretty content.
+        /// </summary>
+        internal const string NameValueSeparatorWhiteSpaceSuffix = " ";
 
         /// <summary>
         /// The white space for empty object

test/.gitignore

@@ -0,0 +1 @@
+*.received.*

test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
-        <TargetFrameworks>net462;net50</TargetFrameworks>
+        <TargetFrameworks>net48;net50</TargetFrameworks>
         <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
         <Authors></Authors>
         <Company>Microsoft</Company>

test/Microsoft.OpenApi.SmokeTests/Microsoft.OpenApi.SmokeTests.csproj

@@ -1,11 +1,11 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net462</TargetFrameworks>
+    <TargetFrameworks>net48</TargetFrameworks>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
-    <DefineConstants>TRACE;DEBUG;net462</DefineConstants>
+    <DefineConstants>TRACE;DEBUG;NET48</DefineConstants>
   </PropertyGroup>
 
   <ItemGroup>

test/Microsoft.OpenApi.Tests/Microsoft.OpenApi.Tests.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>net462;net50</TargetFrameworks>
+    <TargetFrameworks>net48;net50</TargetFrameworks>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
     <Authors></Authors>
     <Company>Microsoft</Company>
@@ -19,6 +19,8 @@
     <PackageReference Include="FluentAssertions" Version="5.10.3" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
     <PackageReference Include="SharpYaml" Version="1.8.0" />
+    <PackageReference Include="Verify" Version="13.3.1" />
+    <PackageReference Include="Verify.Xunit" Version="13.3.1" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
       <PrivateAssets>all</PrivateAssets>

test/Microsoft.OpenApi.Tests/Models/OpenApiCallbackTests.SerializeAdvancedCallbackAsV3JsonWorks_produceTerseOutput=False.verified.txt

@@ -0,0 +1,20 @@
+{
+  "$request.body#/url": {
+    "post": {
+      "requestBody": {
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object"
+            }
+          }
+        }
+      },
+      "responses": {
+        "200": {
+          "description": "Success"
+        }
+      }
+    }
+  }
+}

test/Microsoft.OpenApi.Tests/Models/OpenApiCallbackTests.SerializeAdvancedCallbackAsV3JsonWorks_produceTerseOutput=True.verified.txt

@@ -0,0 +1 @@
+{"$request.body#/url":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success"}}}}}

test/Microsoft.OpenApi.Tests/Models/OpenApiCallbackTests.SerializeReferencedCallbackAsV3JsonWithoutReferenceWorks_produceTerseOutput=False.verified.txt

@@ -0,0 +1,20 @@
+{
+  "$request.body#/url": {
+    "post": {
+      "requestBody": {
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object"
+            }
+          }
+        }
+      },
+      "responses": {
+        "200": {
+          "description": "Success"
+        }
+      }
+    }
+  }
+}