Added JsonResult and controller base extensions for IActionResult objects

Author: jamesmcroft

src/MADE.Web.Mvc/Extensions/ControllerBaseExtensions.cs

@@ -0,0 +1,79 @@
+namespace MADE.Web.Mvc.Extensions
+{
+    using System;
+    using System.Net;
+    using MADE.Web.Mvc.Responses;
+    using Microsoft.AspNetCore.Http;
+    using Microsoft.AspNetCore.Mvc;
+    using Microsoft.AspNetCore.Mvc.ModelBinding;
+    using Newtonsoft.Json;
+    using JsonResult = MADE.Web.Mvc.Responses.JsonResult;
+
+    /// <summary>
+    /// Defines a collection of extensions for MVC <see cref="ControllerBase"/> instances.
+    /// </summary>
+    public static class ControllerBaseExtensions
+    {
+        /// <summary>
+        /// Creates a <see cref="JsonResult"/> object from the specified value for a controller response.
+        /// </summary>
+        /// <param name="controller">The controller that is performing the response.</param>
+        /// <param name="value">The value object to serialize.</param>
+        /// <param name="statusCode">The expected result HTTP status code.</param>
+        /// <param name="serializerSettings">The Json.NET serializer settings for serializing the result.</param>
+        /// <returns>The created <see cref="JsonResult"/> for the response.</returns>
+        /// <exception cref="ArgumentNullException">Thrown if the <paramref name="controller"/> is <see langword="null"/>.</exception>
+        public static IActionResult Json(
+            this ControllerBase controller,
+            object value,
+            HttpStatusCode statusCode = HttpStatusCode.OK,
+            JsonSerializerSettings serializerSettings = null)
+        {
+            if (controller == null)
+            {
+                throw new ArgumentNullException(nameof(controller));
+            }
+
+            return new JsonResult(value, statusCode, serializerSettings);
+        }
+
+        /// <summary>
+        /// Creates an <see cref="InternalServerErrorObjectResult"/> that produces a <see cref="StatusCodes.Status500InternalServerError"/> response.
+        /// </summary>
+        /// <param name="controller">The controller that is performing the response.</param>
+        /// <param name="responseContent">An error object to be returned to the client.</param>
+        /// <returns>The created <see cref="BadRequestObjectResult"/> for the response.</returns>
+        /// <exception cref="ArgumentNullException">Thrown if the <paramref name="controller"/> is <see langword="null"/>.</exception>
+        public static IActionResult InternalServerError(this ControllerBase controller, object responseContent)
+        {
+            if (controller == null)
+            {
+                throw new ArgumentNullException(nameof(controller));
+            }
+
+            return new InternalServerErrorObjectResult(responseContent);
+        }
+
+        /// <summary>
+        /// Creates an <see cref="InternalServerErrorObjectResult"/> that produces a <see cref="StatusCodes.Status500InternalServerError"/> response.
+        /// </summary>
+        /// <param name="controller">The controller that is performing the response.</param>
+        /// <param name="modelState">The <see cref="ModelStateDictionary" /> containing errors to be returned to the client.</param>
+        /// <returns>The created <see cref="BadRequestObjectResult"/> for the response.</returns>
+        /// <exception cref="ArgumentNullException">Thrown if the <paramref name="controller"/> or <paramref name="modelState"/> is <see langword="null"/>.</exception>
+        public static IActionResult InternalServerError(this ControllerBase controller, ModelStateDictionary modelState)
+        {
+            if (controller == null)
+            {
+                throw new ArgumentNullException(nameof(controller));
+            }
+
+            if (modelState == null)
+            {
+                throw new ArgumentNullException(nameof(modelState));
+            }
+
+            return new InternalServerErrorObjectResult(modelState);
+        }
+    }
+}

src/MADE.Web.Mvc/MADE.Web.Mvc.csproj

@@ -16,4 +16,12 @@
     <FrameworkReference Include="Microsoft.AspNetCore.App" />
   </ItemGroup>
 
+  <ItemGroup>
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\MADE.Web\MADE.Web.csproj" />
+  </ItemGroup>
+
 </Project>

src/MADE.Web.Mvc/Responses/JsonResult.cs

@@ -0,0 +1,82 @@
+namespace MADE.Web.Mvc.Responses
+{
+    using System;
+    using System.Net;
+    using System.Runtime.ExceptionServices;
+    using System.Threading.Tasks;
+    using MADE.Web.Extensions;
+    using Microsoft.AspNetCore.Http;
+    using Microsoft.AspNetCore.Mvc;
+    using Microsoft.AspNetCore.Mvc.Infrastructure;
+    using Newtonsoft.Json;
+
+    /// <summary>
+    /// Defines a model for a result of a request that is serialized as JSON using Json.NET.
+    /// </summary>
+    public class JsonResult : ActionResult, IStatusCodeActionResult
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="JsonResult"/> class with the object to serialize.
+        /// </summary>
+        /// <param name="value">The value object to serialize.</param>
+        /// <param name="statusCode">The expected result HTTP status code.</param>
+        /// <param name="serializerSettings">The Json.Net serializer settings for serializing the result.</param>
+        public JsonResult(
+            object value,
+            HttpStatusCode statusCode = HttpStatusCode.OK,
+            JsonSerializerSettings serializerSettings = default)
+        {
+            this.Value = value;
+            this.StatusCode = (int)statusCode;
+            this.SerializerSettings = serializerSettings;
+        }
+
+        /// <summary>
+        /// Gets the value object to serialize.
+        /// </summary>
+        public object Value { get; }
+
+        /// <summary>
+        /// Gets the expected result HTTP status code.
+        /// </summary>
+        public int? StatusCode { get; }
+
+        /// <summary>
+        /// Gets the Json.Net serializer settings for serializing the result.
+        /// </summary>
+        public JsonSerializerSettings SerializerSettings { get; }
+
+        /// <summary>
+        /// Executes the result operation of the action method asynchronously writing the <see cref="Value"/> to the response.
+        /// </summary>
+        /// <param name="context">The context in which the result is executed.</param>
+        /// <returns>An asynchronous operation.</returns>
+        /// <exception cref="ArgumentNullException">Thrown if <paramref name="context"/> is <see langword="null"/>.</exception>
+        public override async Task ExecuteResultAsync(ActionContext context)
+        {
+            if (context == null)
+            {
+                throw new ArgumentNullException(nameof(context));
+            }
+
+            HttpResponse response = context.HttpContext.Response;
+
+            ExceptionDispatchInfo exceptionDispatchInfo = null;
+            try
+            {
+                await response.WriteJsonAsync(
+                    this.StatusCode.GetValueOrDefault((int)HttpStatusCode.OK),
+                    this.Value,
+                    this.SerializerSettings);
+            }
+            catch (Exception ex)
+            {
+                exceptionDispatchInfo = ExceptionDispatchInfo.Capture(ex);
+            }
+            finally
+            {
+                exceptionDispatchInfo?.Throw();
+            }
+        }
+    }
+}