optional attribute and relationship names

jaredcnance · jaredcnance · commit 062b208e1852 · 2018-09-22T21:06:55.000-07:00
diff --git a/src/Examples/GettingStarted/Controllers/ArticlesController.cs b/src/Examples/GettingStarted/Controllers/ArticlesController.cs
@@ -1,17 +1,15 @@
 using GettingStarted.Models;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
-using Microsoft.Extensions.Logging;
 
 namespace GettingStarted
 {
     public class ArticlesController : JsonApiController<Article>
     {
         public ArticlesController(
           IJsonApiContext jsonApiContext,
-          IResourceService<Article> resourceService,
-          ILoggerFactory loggerFactory)
-          : base(jsonApiContext, resourceService, loggerFactory)
+          IResourceService<Article> resourceService)
+          : base(jsonApiContext, resourceService)
         { }
     }
 }
diff --git a/src/Examples/GettingStarted/Controllers/PeopleController.cs b/src/Examples/GettingStarted/Controllers/PeopleController.cs
@@ -1,17 +1,15 @@
 using GettingStarted.Models;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
-using Microsoft.Extensions.Logging;
 
 namespace GettingStarted
 {
     public class PeopleController : JsonApiController<Person>
     {
         public PeopleController(
           IJsonApiContext jsonApiContext,
-          IResourceService<Person> resourceService,
-          ILoggerFactory loggerFactory)
-          : base(jsonApiContext, resourceService, loggerFactory)
+          IResourceService<Person> resourceService)
+          : base(jsonApiContext, resourceService)
         { }
     }
 }
diff --git a/src/Examples/GettingStarted/Models/Article.cs b/src/Examples/GettingStarted/Models/Article.cs
@@ -4,10 +4,10 @@ namespace GettingStarted.Models
 {
     public class Article : Identifiable
     {
-        [Attr("title")]
+        [Attr]
         public string Title { get; set; }
         
-        [HasOne("author")]
+        [HasOne]
         public Person Author { get; set; }
         public int AuthorId { get; set; }
     }
diff --git a/src/Examples/GettingStarted/Models/Person.cs b/src/Examples/GettingStarted/Models/Person.cs
@@ -5,10 +5,10 @@ namespace GettingStarted.Models
 {
     public class Person : Identifiable
     {
-        [Attr("name")]
+        [Attr] 
         public string Name { get; set; }
 
-        [HasMany("articles")]
+        [HasMany] 
         public List<Article> Articles { get; set; }
     }
 }
diff --git a/src/JsonApiDotNetCore/Builders/ContextGraphBuilder.cs b/src/JsonApiDotNetCore/Builders/ContextGraphBuilder.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
+using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Extensions;
 using JsonApiDotNetCore.Graph;
 using JsonApiDotNetCore.Internal;
@@ -64,9 +65,8 @@ public class ContextGraphBuilder : IContextGraphBuilder
     {
         private List<ContextEntity> _entities = new List<ContextEntity>();
         private List<ValidationResult> _validationResults = new List<ValidationResult>();
-
         private bool _usesDbContext;
-        private IResourceNameFormatter _resourceNameFormatter = new DefaultResourceNameFormatter();
+        private IResourceNameFormatter _resourceNameFormatter = JsonApiOptions.ResourceNameFormatter;
 
         public Link DocumentLinks { get; set; } = Link.All;
 
@@ -128,6 +128,7 @@ protected virtual List<AttrAttribute> GetAttributes(Type entityType)
                 if (attribute == null)
                     continue;
 
+                attribute.PublicAttributeName = attribute.PublicAttributeName ?? JsonApiOptions.ResourceNameFormatter.FormatPropertyName(prop);
                 attribute.InternalAttributeName = prop.Name;
                 attribute.PropertyInfo = prop;
 
@@ -146,6 +147,8 @@ protected virtual List<RelationshipAttribute> GetRelationships(Type entityType)
             {
                 var attribute = (RelationshipAttribute)prop.GetCustomAttribute(typeof(RelationshipAttribute));
                 if (attribute == null) continue;
+
+                attribute.PublicRelationshipName = attribute.PublicRelationshipName ?? JsonApiOptions.ResourceNameFormatter.FormatPropertyName(prop);
                 attribute.InternalRelationshipName = prop.Name;
                 attribute.Type = GetRelationshipType(attribute, prop);
                 attributes.Add(attribute);
diff --git a/src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs b/src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using JsonApiDotNetCore.Builders;
+using JsonApiDotNetCore.Graph;
 using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Models;
 using JsonApiDotNetCore.Serialization;
@@ -16,6 +17,11 @@ namespace JsonApiDotNetCore.Configuration
     /// </summary>
     public class JsonApiOptions
     {
+        /// <summary>
+        /// Provides an interface for formatting resource names by convention
+        /// </summary>
+        public static IResourceNameFormatter ResourceNameFormatter { get; set; } = new DefaultResourceNameFormatter();
+
         /// <summary>
         /// Whether or not stack traces should be serialized in Error objects
         /// </summary>
diff --git a/src/JsonApiDotNetCore/Graph/IResourceNameFormatter.cs b/src/JsonApiDotNetCore/Graph/IResourceNameFormatter.cs
@@ -17,6 +17,11 @@ public interface IResourceNameFormatter
         /// Get the publicly visible resource name from the internal type name
         /// </summary>
         string FormatResourceName(Type resourceType);
+
+        /// <summary>
+        /// Get the publicly visible name for the given property
+        /// </summary>
+        string FormatPropertyName(PropertyInfo property);
     }
 
     public class DefaultResourceNameFormatter : IResourceNameFormatter
@@ -47,5 +52,22 @@ public string FormatResourceName(Type type)
                 throw new InvalidOperationException($"Cannot define multiple {nameof(ResourceAttribute)}s on type '{type}'.", e);
             }
         }
+
+        /// <summary>
+        /// Uses the internal PropertyInfo to determine the external resource name.
+        /// By default the name will be formatted to kebab-case.
+        /// </summary>
+        /// <example>
+        /// Given the following property:
+        /// <code>
+        /// public string CompoundProperty { get; set; }
+        /// </code>
+        /// The public attribute will be formatted like so:
+        /// <code>
+        /// _default.FormatPropertyName(compoundProperty).Dump(); 
+        /// // > "compound-property"
+        /// </code>
+        /// </example>
+        public string FormatPropertyName(PropertyInfo property) => str.Dasherize(property.Name);
     }
 }
diff --git a/src/JsonApiDotNetCore/Graph/ServiceDiscoveryFacade.cs b/src/JsonApiDotNetCore/Graph/ServiceDiscoveryFacade.cs
@@ -1,4 +1,5 @@
 using JsonApiDotNetCore.Builders;
+using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Data;
 using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Models;
@@ -55,23 +56,20 @@ public ServiceDiscoveryFacade(
         /// <summary>
         /// Add resources, services and repository implementations to the container.
         /// </summary>
-        /// <param name="resourceNameFormatter">The type name formatter used to get the string representation of resource names.</param>
-        public ServiceDiscoveryFacade AddCurrentAssembly(IResourceNameFormatter resourceNameFormatter = null)
-            => AddAssembly(Assembly.GetCallingAssembly(), resourceNameFormatter);
+        public ServiceDiscoveryFacade AddCurrentAssembly() => AddAssembly(Assembly.GetCallingAssembly());
 
         /// <summary>
         /// Add resources, services and repository implementations to the container.
         /// </summary>
         /// <param name="assembly">The assembly to search for resources in.</param>
-        /// <param name="resourceNameFormatter">The type name formatter used to get the string representation of resource names.</param>
-        public ServiceDiscoveryFacade AddAssembly(Assembly assembly, IResourceNameFormatter resourceNameFormatter = null)
+        public ServiceDiscoveryFacade AddAssembly(Assembly assembly)
         {
             AddDbContextResolvers(assembly);
 
             var resourceDescriptors = TypeLocator.GetIdentifableTypes(assembly);
             foreach (var resourceDescriptor in resourceDescriptors)
             {
-                AddResource(assembly, resourceDescriptor, resourceNameFormatter);
+                AddResource(assembly, resourceDescriptor);
                 AddServices(assembly, resourceDescriptor);
                 AddRepositories(assembly, resourceDescriptor);
             }
@@ -93,20 +91,19 @@ private void AddDbContextResolvers(Assembly assembly)
         /// Adds resources to the graph and registers <see cref="ResourceDefinition{T}"/> types on the container.
         /// </summary>
         /// <param name="assembly">The assembly to search for resources in.</param>
-        /// <param name="resourceNameFormatter">The type name formatter used to get the string representation of resource names.</param>
-        public ServiceDiscoveryFacade AddResources(Assembly assembly, IResourceNameFormatter resourceNameFormatter = null)
+        public ServiceDiscoveryFacade AddResources(Assembly assembly)
         {
             var identifiables = TypeLocator.GetIdentifableTypes(assembly);
             foreach (var identifiable in identifiables)
-                AddResource(assembly, identifiable, resourceNameFormatter);
+                AddResource(assembly, identifiable);
 
             return this;
         }
 
-        private void AddResource(Assembly assembly, ResourceDescriptor resourceDescriptor, IResourceNameFormatter resourceNameFormatter = null)
+        private void AddResource(Assembly assembly, ResourceDescriptor resourceDescriptor)
         {
             RegisterResourceDefinition(assembly, resourceDescriptor);
-            AddResourceToGraph(resourceDescriptor, resourceNameFormatter);
+            AddResourceToGraph(resourceDescriptor);
         }
 
         private void RegisterResourceDefinition(Assembly assembly, ResourceDescriptor identifiable)
@@ -125,17 +122,14 @@ private void RegisterResourceDefinition(Assembly assembly, ResourceDescriptor id
             }            
         }
 
-        private void AddResourceToGraph(ResourceDescriptor identifiable, IResourceNameFormatter resourceNameFormatter = null)
+        private void AddResourceToGraph(ResourceDescriptor identifiable)
         {
-            var resourceName = FormatResourceName(identifiable.ResourceType, resourceNameFormatter);
+            var resourceName = FormatResourceName(identifiable.ResourceType);
             _graphBuilder.AddResource(identifiable.ResourceType, identifiable.IdType, resourceName);
         }
 
-        private string FormatResourceName(Type resourceType, IResourceNameFormatter resourceNameFormatter)
-        {
-            resourceNameFormatter = resourceNameFormatter ?? new DefaultResourceNameFormatter();
-            return resourceNameFormatter.FormatResourceName(resourceType);
-        }
+        private string FormatResourceName(Type resourceType) 
+            => JsonApiOptions.ResourceNameFormatter.FormatResourceName(resourceType);
 
         /// <summary>
         /// Add <see cref="IResourceService{T, TId}"/> implementations to container.
diff --git a/src/JsonApiDotNetCore/Models/AttrAttribute.cs b/src/JsonApiDotNetCore/Models/AttrAttribute.cs
@@ -26,15 +26,15 @@ public class AttrAttribute : Attribute
         /// </code>
         /// 
         /// </example>
-        public AttrAttribute(string publicName, bool isImmutable = false, bool isFilterable = true, bool isSortable = true)
+        public AttrAttribute(string publicName = null, bool isImmutable = false, bool isFilterable = true, bool isSortable = true)
         {
             PublicAttributeName = publicName;
             IsImmutable = isImmutable;
             IsFilterable = isFilterable;
             IsSortable = isSortable;
         }
 
-        public AttrAttribute(string publicName, string internalName, bool isImmutable = false)
+        internal AttrAttribute(string publicName, string internalName, bool isImmutable = false)
         {
             PublicAttributeName = publicName;
             InternalAttributeName = internalName;
@@ -44,7 +44,7 @@ public AttrAttribute(string publicName, string internalName, bool isImmutable =
         /// <summary>
         /// How this attribute is exposed through the API
         /// </summary>
-        public string PublicAttributeName { get; }
+        public string PublicAttributeName { get; internal set;}
 
         /// <summary>
         /// The internal property name this attribute belongs to.
diff --git a/src/JsonApiDotNetCore/Models/HasManyAttribute.cs b/src/JsonApiDotNetCore/Models/HasManyAttribute.cs
@@ -23,7 +23,7 @@ public class HasManyAttribute : RelationshipAttribute
         /// </code>
         /// 
         /// </example>
-        public HasManyAttribute(string publicName, Link documentLinks = Link.All, bool canInclude = true)
+        public HasManyAttribute(string publicName = null, Link documentLinks = Link.All, bool canInclude = true)
         : base(publicName, documentLinks, canInclude)
         { }
 
diff --git a/src/JsonApiDotNetCore/Models/HasOneAttribute.cs b/src/JsonApiDotNetCore/Models/HasOneAttribute.cs
@@ -26,7 +26,7 @@ public class HasOneAttribute : RelationshipAttribute
         /// </code>
         /// 
         /// </example>
-        public HasOneAttribute(string publicName, Link documentLinks = Link.All, bool canInclude = true, string withForeignKey = null)
+        public HasOneAttribute(string publicName = null, Link documentLinks = Link.All, bool canInclude = true, string withForeignKey = null)
         : base(publicName, documentLinks, canInclude)
         {
             _explicitIdentifiablePropertyName = withForeignKey;
diff --git a/src/JsonApiDotNetCore/Models/RelationshipAttribute.cs b/src/JsonApiDotNetCore/Models/RelationshipAttribute.cs
@@ -11,7 +11,7 @@ protected RelationshipAttribute(string publicName, Link documentLinks, bool canI
             CanInclude = canInclude;
         }
 
-        public string PublicRelationshipName { get; }
+        public string PublicRelationshipName { get; internal set; }
         public string InternalRelationshipName { get; internal set; }
         
         /// <summary>

Original file line number	Diff line number	Diff line change
`@@ -1,17 +1,15 @@`
`1`	`1`	`using GettingStarted.Models;`
`2`	`2`	`using JsonApiDotNetCore.Controllers;`
`3`	`3`	`using JsonApiDotNetCore.Services;`
`4`		`-using Microsoft.Extensions.Logging;`
`5`	`4`
`6`	`5`	`namespace GettingStarted`
`7`	`6`	`{`
`8`	`7`	`public class ArticlesController : JsonApiController<Article>`
`9`	`8`	`{`
`10`	`9`	`public ArticlesController(`
`11`	`10`	`IJsonApiContext jsonApiContext,`
`12`		`- IResourceService<Article> resourceService,`
`13`		`- ILoggerFactory loggerFactory)`
`14`		`- : base(jsonApiContext, resourceService, loggerFactory)`
	`11`	`+ IResourceService<Article> resourceService)`
	`12`	`+ : base(jsonApiContext, resourceService)`
`15`	`13`	`{ }`
`16`	`14`	`}`
`17`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,10 +4,10 @@ namespace GettingStarted.Models`
`4`	`4`	`{`
`5`	`5`	`public class Article : Identifiable`
`6`	`6`	`{`
`7`		`- [Attr("title")]`
	`7`	`+ [Attr]`
`8`	`8`	`public string Title { get; set; }`
`9`	`9`
`10`		`- [HasOne("author")]`
	`10`	`+ [HasOne]`
`11`	`11`	`public Person Author { get; set; }`
`12`	`12`	`public int AuthorId { get; set; }`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,10 +5,10 @@ namespace GettingStarted.Models`
`5`	`5`	`{`
`6`	`6`	`public class Person : Identifiable`
`7`	`7`	`{`
`8`		`- [Attr("name")]`
	`8`	`+ [Attr]`
`9`	`9`	`public string Name { get; set; }`
`10`	`10`
`11`		`- [HasMany("articles")]`
	`11`	`+ [HasMany]`
`12`	`12`	`public List<Article> Articles { get; set; }`
`13`	`13`	`}`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public class HasOneAttribute : RelationshipAttribute`
`26`	`26`	`/// </code>`
`27`	`27`	`///`
`28`	`28`	`/// </example>`
`29`		`- public HasOneAttribute(string publicName, Link documentLinks = Link.All, bool canInclude = true, string withForeignKey = null)`
	`29`	`+ public HasOneAttribute(string publicName = null, Link documentLinks = Link.All, bool canInclude = true, string withForeignKey = null)`
`30`	`30`	`: base(publicName, documentLinks, canInclude)`
`31`	`31`	`{`
`32`	`32`	`_explicitIdentifiablePropertyName = withForeignKey;`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ protected RelationshipAttribute(string publicName, Link documentLinks, bool canI`
`11`	`11`	`CanInclude = canInclude;`
`12`	`12`	`}`
`13`	`13`
`14`		`- public string PublicRelationshipName { get; }`
	`14`	`+ public string PublicRelationshipName { get; internal set; }`
`15`	`15`	`public string InternalRelationshipName { get; internal set; }`
`16`	`16`
`17`	`17`	`/// <summary>`