Merge pull request #324 from json-api-dotnet/feat/#297

feat(DocumentBuilder): allow for output attribute filtering

Author: jaredcnance

src/Examples/JsonApiDotNetCoreExample/Controllers/UsersController.cs

@@ -0,0 +1,17 @@
+using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.Services;
+using JsonApiDotNetCoreExample.Models;
+using Microsoft.Extensions.Logging;
+
+namespace JsonApiDotNetCoreExample.Controllers
+{
+    public class UsersController : JsonApiController<User>
+    {
+        public UsersController(
+            IJsonApiContext jsonApiContext,
+            IResourceService<User> resourceService,
+            ILoggerFactory loggerFactory) 
+            : base(jsonApiContext, resourceService, loggerFactory)
+        { }
+    }
+}

src/Examples/JsonApiDotNetCoreExample/Data/AppDbContext.cs

@@ -37,7 +37,7 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
 
         public DbSet<Article> Articles { get; set; }
         public DbSet<Author> Authors { get; set; }
-
         public DbSet<NonJsonApiResource> NonJsonApiResources { get; set; }
+        public DbSet<User> Users { get; set; }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Migrations/20180327120810_initial.cs

@@ -1,7 +1,5 @@
-using Microsoft.EntityFrameworkCore.Metadata;
 using Microsoft.EntityFrameworkCore.Migrations;
 using System;
-using System.Collections.Generic;
 using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata;
 
 namespace JsonApiDotNetCoreExample.Migrations

src/Examples/JsonApiDotNetCoreExample/Models/User.cs

@@ -0,0 +1,10 @@
+using JsonApiDotNetCore.Models;
+
+namespace JsonApiDotNetCoreExample.Models
+{
+    public class User : Identifiable
+    {
+        [Attr("username")] public string Username { get; set; }
+        [Attr("password")] public string Password { get; set; }
+    }
+}

src/Examples/JsonApiDotNetCoreExample/Resources/UserResource.cs

@@ -0,0 +1,12 @@
+using System.Collections.Generic;
+using JsonApiDotNetCore.Models;
+using JsonApiDotNetCoreExample.Models;
+
+namespace JsonApiDotNetCoreExample.Resources
+{
+    public class UserResource : ResourceDefinition<User>
+    {
+        protected override List<AttrAttribute> OutputAttrs()
+            => Remove(user => user.Password);
+    }
+}

src/Examples/JsonApiDotNetCoreExample/Startup.cs

@@ -7,6 +7,9 @@
 using Microsoft.EntityFrameworkCore;
 using JsonApiDotNetCore.Extensions;
 using System;
+using JsonApiDotNetCore.Models;
+using JsonApiDotNetCoreExample.Resources;
+using JsonApiDotNetCoreExample.Models;
 
 namespace JsonApiDotNetCoreExample
 {
@@ -38,7 +41,9 @@ public virtual IServiceProvider ConfigureServices(IServiceCollection services)
                     options.Namespace = "api/v1";
                     options.DefaultPageSize = 5;
                     options.IncludeTotalRecordCount = true;
-                });
+                })
+                // TODO: this should be handled via auto-discovery
+                .AddScoped<ResourceDefinition<User>, UserResource>();
 
             var provider = services.BuildServiceProvider();
             var appContext = provider.GetRequiredService<AppDbContext>();

src/Examples/ReportsExample/Controllers/ReportsController.cs

@@ -1,7 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Threading.Tasks;
+using System.Threading.Tasks;
 using Microsoft.AspNetCore.Mvc;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;

src/Examples/ReportsExample/Services/ReportService.cs

@@ -1,4 +1,3 @@
-using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
 using JsonApiDotNetCore.Services;

src/JsonApiDotNetCore/Builders/ContextGraphBuilder.cs

@@ -59,7 +59,6 @@ public IContextGraph Build()
             _entities.ForEach(e => e.Links = GetLinkFlags(e.EntityType));
 
             var graph = new ContextGraph(_entities, _usesDbContext, _validationResults);
-
             return graph;
         }
 
@@ -83,7 +82,8 @@ public IContextGraphBuilder AddResource<TResource, TId>(string pluralizedTypeNam
             EntityType = entityType,
             IdentityType = idType,
             Attributes = GetAttributes(entityType),
-            Relationships = GetRelationships(entityType)
+            Relationships = GetRelationships(entityType),
+            ResourceType = GetResourceDefinitionType(entityType)
         };
 
         private Link GetLinkFlags(Type entityType)
@@ -104,8 +104,12 @@ protected virtual List<AttrAttribute> GetAttributes(Type entityType)
             foreach (var prop in properties)
             {
                 var attribute = (AttrAttribute)prop.GetCustomAttribute(typeof(AttrAttribute));
-                if (attribute == null) continue;
+                if (attribute == null)
+                    continue;
+
                 attribute.InternalAttributeName = prop.Name;
+                attribute.PropertyInfo = prop;
+
                 attributes.Add(attribute);
             }
             return attributes;
@@ -136,6 +140,8 @@ protected virtual Type GetRelationshipType(RelationshipAttribute relation, Prope
                 return prop.PropertyType;
         }
 
+        private Type GetResourceDefinitionType(Type entityType) => typeof(ResourceDefinition<>).MakeGenericType(entityType);
+
         public IContextGraphBuilder AddDbContext<T>() where T : DbContext
         {
             _usesDbContext = true;

src/JsonApiDotNetCore/Builders/DocumentBuilder.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
@@ -14,22 +15,29 @@ public class DocumentBuilder : IDocumentBuilder
         private readonly IContextGraph _contextGraph;
         private readonly IRequestMeta _requestMeta;
         private readonly DocumentBuilderOptions _documentBuilderOptions;
+        private readonly IScopedServiceProvider _scopedServiceProvider;
 
-        public DocumentBuilder(IJsonApiContext jsonApiContext, IRequestMeta requestMeta = null, IDocumentBuilderOptionsProvider documentBuilderOptionsProvider = null)
+        public DocumentBuilder(
+            IJsonApiContext jsonApiContext, 
+            IRequestMeta requestMeta = null, 
+            IDocumentBuilderOptionsProvider documentBuilderOptionsProvider = null,
+            IScopedServiceProvider scopedServiceProvider = null)
         {
             _jsonApiContext = jsonApiContext;
             _contextGraph = jsonApiContext.ContextGraph;
             _requestMeta = requestMeta;
-            _documentBuilderOptions = documentBuilderOptionsProvider?.GetDocumentBuilderOptions() ?? new DocumentBuilderOptions(); ;
+            _documentBuilderOptions = documentBuilderOptionsProvider?.GetDocumentBuilderOptions() ?? new DocumentBuilderOptions();
+            _scopedServiceProvider = scopedServiceProvider;
         }
 
         public Document Build(IIdentifiable entity)
         {
             var contextEntity = _contextGraph.GetContextEntity(entity.GetType());
 
+            var resourceDefinition = _scopedServiceProvider?.GetService(contextEntity.ResourceType) as IResourceDefinition;
             var document = new Document
             {
-                Data = GetData(contextEntity, entity),
+                Data = GetData(contextEntity, entity, resourceDefinition),
                 Meta = GetMeta(entity)
             };
 
@@ -44,8 +52,8 @@ public Document Build(IIdentifiable entity)
         public Documents Build(IEnumerable<IIdentifiable> entities)
         {
             var entityType = entities.GetElementType();
-
             var contextEntity = _contextGraph.GetContextEntity(entityType);
+            var resourceDefinition = _scopedServiceProvider?.GetService(contextEntity.ResourceType) as IResourceDefinition;
 
             var enumeratedEntities = entities as IList<IIdentifiable> ?? entities.ToList();
             var documents = new Documents
@@ -59,7 +67,7 @@ public Documents Build(IEnumerable<IIdentifiable> entities)
 
             foreach (var entity in enumeratedEntities)
             {
-                documents.Data.Add(GetData(contextEntity, entity));
+                documents.Data.Add(GetData(contextEntity, entity, resourceDefinition));
                 documents.Included = AppendIncludedObject(documents.Included, contextEntity, entity);
             }
 
@@ -98,7 +106,11 @@ private List<DocumentData> AppendIncludedObject(List<DocumentData> includedObjec
             return includedObject;
         }
 
+        [Obsolete("You should specify an IResourceDefinition implementation using the GetData/3 overload.")]
         public DocumentData GetData(ContextEntity contextEntity, IIdentifiable entity)
+            => GetData(contextEntity, entity, resourceDefinition: null);
+
+        public DocumentData GetData(ContextEntity contextEntity, IIdentifiable entity, IResourceDefinition resourceDefinition = null)
         {
             var data = new DocumentData
             {
@@ -111,7 +123,8 @@ public DocumentData GetData(ContextEntity contextEntity, IIdentifiable entity)
 
             data.Attributes = new Dictionary<string, object>();
 
-            contextEntity.Attributes.ForEach(attr =>
+            var resourceAttributes = resourceDefinition?.GetOutputAttrs(entity) ?? contextEntity.Attributes;
+            resourceAttributes.ForEach(attr =>
             {
                 var attributeValue = attr.GetValue(entity);
                 if (ShouldIncludeAttribute(attr, attributeValue))
@@ -219,8 +232,9 @@ private DocumentData GetIncludedEntity(IIdentifiable entity)
             if (entity == null) return null;
 
             var contextEntity = _jsonApiContext.ContextGraph.GetContextEntity(entity.GetType());
+            var resourceDefinition = _scopedServiceProvider.GetService(contextEntity.ResourceType) as IResourceDefinition;
 
-            var data = GetData(contextEntity, entity);
+            var data = GetData(contextEntity, entity, resourceDefinition);
 
             data.Attributes = new Dictionary<string, object>();