move generic parameter to interface for IPayloadMaterializer

Chris Santero · Chris Santero · commit 00dee312d946 · 2015-06-28T20:10:58.000-04:00
diff --git a/JSONAPI.EntityFramework.Tests.TestWebApp/Controllers/CommentsController.cs b/JSONAPI.EntityFramework.Tests.TestWebApp/Controllers/CommentsController.cs
@@ -5,7 +5,7 @@ namespace JSONAPI.EntityFramework.Tests.TestWebApp.Controllers
 {
     public class CommentsController : JsonApiController<Comment>
     {
-        public CommentsController(IPayloadMaterializer payloadMaterializer) : base(payloadMaterializer)
+        public CommentsController(IPayloadMaterializer<Comment> payloadMaterializer) : base(payloadMaterializer)
         {
         }
     }
diff --git a/JSONAPI.EntityFramework.Tests.TestWebApp/Controllers/PostsController.cs b/JSONAPI.EntityFramework.Tests.TestWebApp/Controllers/PostsController.cs
@@ -5,7 +5,7 @@ namespace JSONAPI.EntityFramework.Tests.TestWebApp.Controllers
 {
     public class PostsController : JsonApiController<Post>
     {
-        public PostsController(IPayloadMaterializer payloadMaterializer) : base(payloadMaterializer)
+        public PostsController(IPayloadMaterializer<Post> payloadMaterializer) : base(payloadMaterializer)
         {
         }
     }
diff --git a/JSONAPI.EntityFramework.Tests.TestWebApp/Controllers/TagsController.cs b/JSONAPI.EntityFramework.Tests.TestWebApp/Controllers/TagsController.cs
@@ -5,7 +5,7 @@ namespace JSONAPI.EntityFramework.Tests.TestWebApp.Controllers
 {
     public class TagsController : JsonApiController<Tag>
     {
-        public TagsController(IPayloadMaterializer payloadMaterializer) : base(payloadMaterializer)
+        public TagsController(IPayloadMaterializer<Tag> payloadMaterializer) : base(payloadMaterializer)
         {
         }
     }
diff --git a/JSONAPI.EntityFramework.Tests.TestWebApp/Controllers/UserGroupsController.cs b/JSONAPI.EntityFramework.Tests.TestWebApp/Controllers/UserGroupsController.cs
@@ -5,7 +5,7 @@ namespace JSONAPI.EntityFramework.Tests.TestWebApp.Controllers
 {
     public class UserGroupsController : JsonApiController<UserGroup>
     {
-        public UserGroupsController(IPayloadMaterializer payloadMaterializer) : base(payloadMaterializer)
+        public UserGroupsController(IPayloadMaterializer<UserGroup> payloadMaterializer) : base(payloadMaterializer)
         {
         }
     }
diff --git a/JSONAPI.EntityFramework.Tests.TestWebApp/Controllers/UsersController.cs b/JSONAPI.EntityFramework.Tests.TestWebApp/Controllers/UsersController.cs
@@ -5,7 +5,7 @@ namespace JSONAPI.EntityFramework.Tests.TestWebApp.Controllers
 {
     public class UsersController : JsonApiController<User>
     {
-        public UsersController(IPayloadMaterializer payloadMaterializer) : base(payloadMaterializer)
+        public UsersController(IPayloadMaterializer<User> payloadMaterializer) : base(payloadMaterializer)
         {
         }
     }
diff --git a/JSONAPI.EntityFramework.Tests.TestWebApp/Startup.cs b/JSONAPI.EntityFramework.Tests.TestWebApp/Startup.cs
@@ -61,9 +61,9 @@ public void Configuration(IAppBuilder app)
 
             var containerBuilder = new ContainerBuilder();
             containerBuilder.RegisterModule(module);
-            containerBuilder.RegisterType<EntityFrameworkPayloadMaterializer>()
+            containerBuilder.RegisterGeneric(typeof (EntityFrameworkPayloadMaterializer<>))
                 .WithParameter("apiBaseUrl", "https://www.example.com")
-                .As<IPayloadMaterializer>();
+                .AsImplementedInterfaces();
             containerBuilder.Register(c => HttpContext.Current.GetOwinContext()).As<IOwinContext>();
             containerBuilder.Register(c => c.Resolve<IOwinContext>().Get<TestDbContext>(DbContextKey)).AsSelf().As<DbContext>();
             containerBuilder.RegisterApiControllers(Assembly.GetExecutingAssembly());
diff --git a/JSONAPI.EntityFramework/Http/EntityFrameworkPayloadMaterializer.cs b/JSONAPI.EntityFramework/Http/EntityFrameworkPayloadMaterializer.cs
@@ -11,9 +11,9 @@
 namespace JSONAPI.EntityFramework.Http
 {
     /// <summary>
-    /// Implementation of <see cref="IPayloadMaterializer"/> for use with Entity Framework.
+    /// Implementation of IPayloadMaterializer for use with Entity Framework.
     /// </summary>
-    public class EntityFrameworkPayloadMaterializer : IPayloadMaterializer
+    public class EntityFrameworkPayloadMaterializer<T> : IPayloadMaterializer<T> where T : class
     {
         private readonly string _apiBaseUrl;
         private readonly DbContext _dbContext;
@@ -43,19 +43,20 @@ public EntityFrameworkPayloadMaterializer(
             _singleResourcePayloadBuilder = singleResourcePayloadBuilder;
         }
 
-        public Task<IResourceCollectionPayload> GetRecords<T>(HttpRequestMessage request, CancellationToken cancellationToken) where T : class
+        public Task<IResourceCollectionPayload> GetRecords(HttpRequestMessage request, CancellationToken cancellationToken)
         {
             var query = _dbContext.Set<T>().AsQueryable();
             return _queryableResourceCollectionPayloadBuilder.BuildPayload(query, request, cancellationToken);
         }
 
-        public async Task<ISingleResourcePayload> GetRecordById<T>(string id, HttpRequestMessage request, CancellationToken cancellationToken) where T : class
+        public async Task<ISingleResourcePayload> GetRecordById(string id, HttpRequestMessage request, CancellationToken cancellationToken)
         {
             var singleResource = await _dbContext.Set<T>().FindAsync(cancellationToken, id);
             return _singleResourcePayloadBuilder.BuildPayload(singleResource, _apiBaseUrl, null);
         }
 
-        public async Task<ISingleResourcePayload> CreateRecord<T>(ISingleResourcePayload requestPayload, HttpRequestMessage request, CancellationToken cancellationToken) where T : class
+        public async Task<ISingleResourcePayload> CreateRecord(ISingleResourcePayload requestPayload,
+            HttpRequestMessage request, CancellationToken cancellationToken)
         {
             var newRecord = await MaterializeAsync(requestPayload.PrimaryData, cancellationToken);
             var returnPayload = _singleResourcePayloadBuilder.BuildPayload(newRecord, _apiBaseUrl, null);
@@ -64,7 +65,8 @@ public async Task<ISingleResourcePayload> CreateRecord<T>(ISingleResourcePayload
             return returnPayload;
         }
 
-        public async Task<ISingleResourcePayload> UpdateRecord<T>(string id, ISingleResourcePayload requestPayload, HttpRequestMessage request, CancellationToken cancellationToken) where T : class
+        public async Task<ISingleResourcePayload> UpdateRecord(string id, ISingleResourcePayload requestPayload,
+            HttpRequestMessage request, CancellationToken cancellationToken)
         {
             var newRecord = await MaterializeAsync(requestPayload.PrimaryData, cancellationToken);
             var returnPayload = _singleResourcePayloadBuilder.BuildPayload(newRecord, _apiBaseUrl, null);
@@ -73,7 +75,7 @@ public async Task<ISingleResourcePayload> UpdateRecord<T>(string id, ISingleReso
             return returnPayload;
         }
 
-        public async Task<IJsonApiPayload> DeleteRecord<T>(string id, CancellationToken cancellationToken) where T : class
+        public async Task<IJsonApiPayload> DeleteRecord(string id, CancellationToken cancellationToken)
         {
             var singleResource = await _dbContext.Set<T>().FindAsync(cancellationToken, id);
             _dbContext.Set<T>().Remove(singleResource);
diff --git a/JSONAPI.TodoMVC.API/Controllers/TodosController.cs b/JSONAPI.TodoMVC.API/Controllers/TodosController.cs
@@ -5,7 +5,7 @@ namespace JSONAPI.TodoMVC.API.Controllers
 {
     public class TodosController : JsonApiController<Todo>
     {
-        public TodosController(IPayloadMaterializer payloadMaterializer) : base(payloadMaterializer)
+        public TodosController(IPayloadMaterializer<Todo> payloadMaterializer) : base(payloadMaterializer)
         {
         }
     }
diff --git a/JSONAPI.TodoMVC.API/Startup.cs b/JSONAPI.TodoMVC.API/Startup.cs
@@ -1,10 +1,8 @@
 &#65279;using System.Web.Http;
 using Autofac;
-using Autofac.Integration.WebApi;
 using JSONAPI.Autofac;
 using JSONAPI.Core;
 using JSONAPI.EntityFramework.Http;
-using JSONAPI.Http;
 using JSONAPI.TodoMVC.API.Models;
 using Owin;
 
@@ -32,9 +30,9 @@ private static HttpConfiguration GetWebApiConfiguration()
 
             var containerBuilder = new ContainerBuilder();
             containerBuilder.RegisterModule(module);
-            containerBuilder.RegisterType<EntityFrameworkPayloadMaterializer>()
+            containerBuilder.RegisterGeneric(typeof(EntityFrameworkPayloadMaterializer<>))
                 .WithParameter("apiBaseUrl", "https://www.example.com")
-                .As<IPayloadMaterializer>();
+                .AsImplementedInterfaces();
             var container = containerBuilder.Build();
             httpConfig.UseJsonApiWithAutofac(container);
 
diff --git a/JSONAPI/Http/IPayloadMaterializer.cs b/JSONAPI/Http/IPayloadMaterializer.cs
@@ -8,43 +8,42 @@ namespace JSONAPI.Http
     /// <summary>
     /// This service provides the glue between JSONAPI.NET and your persistence layer.
     /// </summary>
-    public interface IPayloadMaterializer
+    public interface IPayloadMaterializer<T> where T : class
     {
         /// <summary>
         /// Returns a payload containing records that are filtered, sorted,
         /// and paginated according to query parameters present in the provided request.
         /// </summary>
         /// <returns></returns>
-        Task<IResourceCollectionPayload> GetRecords<T>(HttpRequestMessage request, CancellationToken cancellationToken)
-            where T : class;
+        Task<IResourceCollectionPayload> GetRecords(HttpRequestMessage request, CancellationToken cancellationToken);
 
         /// <summary>
         /// Returns a payload with the resource identified by the given ID.
         /// </summary>
         /// <returns></returns>
-        Task<ISingleResourcePayload> GetRecordById<T>(string id, HttpRequestMessage request,
-            CancellationToken cancellationToken) where T : class;
+        Task<ISingleResourcePayload> GetRecordById(string id, HttpRequestMessage request,
+            CancellationToken cancellationToken);
 
         /// <summary>
         /// Creates a record corresponding to the data in the request payload, and returns a payload
         /// corresponding to the created record.
         /// </summary>
         /// <returns></returns>
-        Task<ISingleResourcePayload> CreateRecord<T>(ISingleResourcePayload requestPayload, HttpRequestMessage request,
-            CancellationToken cancellationToken) where T : class;
+        Task<ISingleResourcePayload> CreateRecord(ISingleResourcePayload requestPayload, HttpRequestMessage request,
+            CancellationToken cancellationToken);
 
         /// <summary>
         /// Updates the record corresponding to the data in the request payload, and returns a payload
         /// corresponding to the updated record.
         /// </summary>
         /// <returns></returns>
-        Task<ISingleResourcePayload> UpdateRecord<T>(string id, ISingleResourcePayload requestPayload,
-            HttpRequestMessage request, CancellationToken cancellationToken) where T : class;
+        Task<ISingleResourcePayload> UpdateRecord(string id, ISingleResourcePayload requestPayload,
+            HttpRequestMessage request, CancellationToken cancellationToken);
 
         /// <summary>
         /// Deletes the record corresponding to the given id.
         /// </summary>
         /// <returns></returns>
-        Task<IJsonApiPayload> DeleteRecord<T>(string id, CancellationToken cancellationToken) where T : class;
+        Task<IJsonApiPayload> DeleteRecord(string id, CancellationToken cancellationToken);
     }
 }
diff --git a/JSONAPI/Http/JsonApiController.cs b/JSONAPI/Http/JsonApiController.cs
@@ -11,13 +11,13 @@ namespace JSONAPI.Http
     /// </summary>
     public class JsonApiController<T> : ApiController where T : class
     {
-        private readonly IPayloadMaterializer _payloadMaterializer;
+        private readonly IPayloadMaterializer<T> _payloadMaterializer;
 
         /// <summary>
         /// Creates a new ApiController
         /// </summary>
         /// <param name="payloadMaterializer"></param>
-        public JsonApiController(IPayloadMaterializer payloadMaterializer)
+        public JsonApiController(IPayloadMaterializer<T> payloadMaterializer)
         {
             _payloadMaterializer = payloadMaterializer;
         }
@@ -28,7 +28,7 @@ public JsonApiController(IPayloadMaterializer payloadMaterializer)
         /// <returns></returns>
         public virtual async Task<IHttpActionResult> Get(CancellationToken cancellationToken)
         {
-            var payload = await _payloadMaterializer.GetRecords<T>(Request, cancellationToken);
+            var payload = await _payloadMaterializer.GetRecords(Request, cancellationToken);
             return Ok(payload);
         }
 
@@ -40,7 +40,7 @@ public virtual async Task<IHttpActionResult> Get(CancellationToken cancellationT
         /// <returns></returns>
         public virtual async Task<IHttpActionResult> Get(string id, CancellationToken cancellationToken)
         {
-            var payload = await _payloadMaterializer.GetRecordById<T>(id, Request, cancellationToken);
+            var payload = await _payloadMaterializer.GetRecordById(id, Request, cancellationToken);
             return Ok(payload);
         }
 
@@ -52,7 +52,7 @@ public virtual async Task<IHttpActionResult> Get(string id, CancellationToken ca
         /// <returns></returns>
         public virtual async Task<IHttpActionResult> Post([FromBody]ISingleResourcePayload requestPayload, CancellationToken cancellationToken)
         {
-            var payload = await _payloadMaterializer.CreateRecord<T>(requestPayload, Request, cancellationToken);
+            var payload = await _payloadMaterializer.CreateRecord(requestPayload, Request, cancellationToken);
             return Ok(payload);
         }
 
@@ -65,7 +65,7 @@ public virtual async Task<IHttpActionResult> Post([FromBody]ISingleResourcePaylo
         /// <returns></returns>
         public virtual async Task<IHttpActionResult> Patch(string id, [FromBody]ISingleResourcePayload requestPayload, CancellationToken cancellationToken)
         {
-            var payload = await _payloadMaterializer.UpdateRecord<T>(id, requestPayload, Request, cancellationToken);
+            var payload = await _payloadMaterializer.UpdateRecord(id, requestPayload, Request, cancellationToken);
             return Ok(payload);
         }
 
@@ -76,7 +76,7 @@ public virtual async Task<IHttpActionResult> Patch(string id, [FromBody]ISingleR
         /// <param name="cancellationToken"></param>
         public virtual async Task<IHttpActionResult> Delete(string id, CancellationToken cancellationToken)
         {
-            var payload = await _payloadMaterializer.DeleteRecord<T>(id, cancellationToken);
+            var payload = await _payloadMaterializer.DeleteRecord(id, cancellationToken);
             return Ok(payload);
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ namespace JSONAPI.EntityFramework.Tests.TestWebApp.Controllers`
`5`	`5`	`{`
`6`	`6`	`public class CommentsController : JsonApiController<Comment>`
`7`	`7`	`{`
`8`		`- public CommentsController(IPayloadMaterializer payloadMaterializer) : base(payloadMaterializer)`
	`8`	`+ public CommentsController(IPayloadMaterializer<Comment> payloadMaterializer) : base(payloadMaterializer)`
`9`	`9`	`{`
`10`	`10`	`}`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ namespace JSONAPI.EntityFramework.Tests.TestWebApp.Controllers`
`5`	`5`	`{`
`6`	`6`	`public class PostsController : JsonApiController<Post>`
`7`	`7`	`{`
`8`		`- public PostsController(IPayloadMaterializer payloadMaterializer) : base(payloadMaterializer)`
	`8`	`+ public PostsController(IPayloadMaterializer<Post> payloadMaterializer) : base(payloadMaterializer)`
`9`	`9`	`{`
`10`	`10`	`}`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ namespace JSONAPI.EntityFramework.Tests.TestWebApp.Controllers`
`5`	`5`	`{`
`6`	`6`	`public class TagsController : JsonApiController<Tag>`
`7`	`7`	`{`
`8`		`- public TagsController(IPayloadMaterializer payloadMaterializer) : base(payloadMaterializer)`
	`8`	`+ public TagsController(IPayloadMaterializer<Tag> payloadMaterializer) : base(payloadMaterializer)`
`9`	`9`	`{`
`10`	`10`	`}`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ namespace JSONAPI.EntityFramework.Tests.TestWebApp.Controllers`
`5`	`5`	`{`
`6`	`6`	`public class UserGroupsController : JsonApiController<UserGroup>`
`7`	`7`	`{`
`8`		`- public UserGroupsController(IPayloadMaterializer payloadMaterializer) : base(payloadMaterializer)`
	`8`	`+ public UserGroupsController(IPayloadMaterializer<UserGroup> payloadMaterializer) : base(payloadMaterializer)`
`9`	`9`	`{`
`10`	`10`	`}`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ namespace JSONAPI.EntityFramework.Tests.TestWebApp.Controllers`
`5`	`5`	`{`
`6`	`6`	`public class UsersController : JsonApiController<User>`
`7`	`7`	`{`
`8`		`- public UsersController(IPayloadMaterializer payloadMaterializer) : base(payloadMaterializer)`
	`8`	`+ public UsersController(IPayloadMaterializer<User> payloadMaterializer) : base(payloadMaterializer)`
`9`	`9`	`{`
`10`	`10`	`}`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,9 +11,9 @@`
`11`	`11`	`namespace JSONAPI.EntityFramework.Http`
`12`	`12`	`{`
`13`	`13`	`/// <summary>`
`14`		`- /// Implementation of <see cref="IPayloadMaterializer"/> for use with Entity Framework.`
	`14`	`+ /// Implementation of IPayloadMaterializer for use with Entity Framework.`
`15`	`15`	`/// </summary>`
`16`		`- public class EntityFrameworkPayloadMaterializer : IPayloadMaterializer`
	`16`	`+ public class EntityFrameworkPayloadMaterializer<T> : IPayloadMaterializer<T> where T : class`
`17`	`17`	`{`
`18`	`18`	`private readonly string _apiBaseUrl;`
`19`	`19`	`private readonly DbContext _dbContext;`
`@@ -43,19 +43,20 @@ public EntityFrameworkPayloadMaterializer(`
`43`	`43`	`_singleResourcePayloadBuilder = singleResourcePayloadBuilder;`
`44`	`44`	`}`
`45`	`45`
`46`		`- public Task<IResourceCollectionPayload> GetRecords<T>(HttpRequestMessage request, CancellationToken cancellationToken) where T : class`
	`46`	`+ public Task<IResourceCollectionPayload> GetRecords(HttpRequestMessage request, CancellationToken cancellationToken)`
`47`	`47`	`{`
`48`	`48`	`var query = _dbContext.Set<T>().AsQueryable();`
`49`	`49`	`return _queryableResourceCollectionPayloadBuilder.BuildPayload(query, request, cancellationToken);`
`50`	`50`	`}`
`51`	`51`
`52`		`- public async Task<ISingleResourcePayload> GetRecordById<T>(string id, HttpRequestMessage request, CancellationToken cancellationToken) where T : class`
	`52`	`+ public async Task<ISingleResourcePayload> GetRecordById(string id, HttpRequestMessage request, CancellationToken cancellationToken)`
`53`	`53`	`{`
`54`	`54`	`var singleResource = await _dbContext.Set<T>().FindAsync(cancellationToken, id);`
`55`	`55`	`return _singleResourcePayloadBuilder.BuildPayload(singleResource, _apiBaseUrl, null);`
`56`	`56`	`}`
`57`	`57`
`58`		`- public async Task<ISingleResourcePayload> CreateRecord<T>(ISingleResourcePayload requestPayload, HttpRequestMessage request, CancellationToken cancellationToken) where T : class`
	`58`	`+ public async Task<ISingleResourcePayload> CreateRecord(ISingleResourcePayload requestPayload,`
	`59`	`+ HttpRequestMessage request, CancellationToken cancellationToken)`
`59`	`60`	`{`
`60`	`61`	`var newRecord = await MaterializeAsync(requestPayload.PrimaryData, cancellationToken);`
`61`	`62`	`var returnPayload = _singleResourcePayloadBuilder.BuildPayload(newRecord, _apiBaseUrl, null);`
`@@ -64,7 +65,8 @@ public async Task<ISingleResourcePayload> CreateRecord<T>(ISingleResourcePayload`
`64`	`65`	`return returnPayload;`
`65`	`66`	`}`
`66`	`67`
`67`		`- public async Task<ISingleResourcePayload> UpdateRecord<T>(string id, ISingleResourcePayload requestPayload, HttpRequestMessage request, CancellationToken cancellationToken) where T : class`
	`68`	`+ public async Task<ISingleResourcePayload> UpdateRecord(string id, ISingleResourcePayload requestPayload,`
	`69`	`+ HttpRequestMessage request, CancellationToken cancellationToken)`
`68`	`70`	`{`
`69`	`71`	`var newRecord = await MaterializeAsync(requestPayload.PrimaryData, cancellationToken);`
`70`	`72`	`var returnPayload = _singleResourcePayloadBuilder.BuildPayload(newRecord, _apiBaseUrl, null);`
`@@ -73,7 +75,7 @@ public async Task<ISingleResourcePayload> UpdateRecord<T>(string id, ISingleReso`
`73`	`75`	`return returnPayload;`
`74`	`76`	`}`
`75`	`77`
`76`		`- public async Task<IJsonApiPayload> DeleteRecord<T>(string id, CancellationToken cancellationToken) where T : class`
	`78`	`+ public async Task<IJsonApiPayload> DeleteRecord(string id, CancellationToken cancellationToken)`
`77`	`79`	`{`
`78`	`80`	`var singleResource = await _dbContext.Set<T>().FindAsync(cancellationToken, id);`
`79`	`81`	`_dbContext.Set<T>().Remove(singleResource);`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ namespace JSONAPI.TodoMVC.API.Controllers`
`5`	`5`	`{`
`6`	`6`	`public class TodosController : JsonApiController<Todo>`
`7`	`7`	`{`
`8`		`- public TodosController(IPayloadMaterializer payloadMaterializer) : base(payloadMaterializer)`
	`8`	`+ public TodosController(IPayloadMaterializer<Todo> payloadMaterializer) : base(payloadMaterializer)`
`9`	`9`	`{`
`10`	`10`	`}`
`11`	`11`	`}`