style: rename Entity to Resource

Author: maurei

src/JsonApiDotNetCore/Builders/ResourceGraphBuilder.cs

@@ -38,7 +38,7 @@ public IResourceGraph Build()
 
         private void SetResourceLinksOptions(ResourceContext resourceContext)
         {
-            var attribute = (LinksAttribute)resourceContext.EntityType.GetCustomAttribute(typeof(LinksAttribute));
+            var attribute = (LinksAttribute)resourceContext.ResourceType.GetCustomAttribute(typeof(LinksAttribute));
             if (attribute != null)
             {
                 resourceContext.RelationshipLinks = attribute.RelationshipLinks;
@@ -69,12 +69,12 @@ public IResourceGraphBuilder AddResource(Type entityType, Type idType, string pl
 
         private ResourceContext GetEntity(string pluralizedTypeName, Type entityType, Type idType) => new ResourceContext
         {
-            EntityName = pluralizedTypeName,
-            EntityType = entityType,
+            ResourceName = pluralizedTypeName,
+            ResourceType = entityType,
             IdentityType = idType,
             Attributes = GetAttributes(entityType),
             Relationships = GetRelationships(entityType),
-            ResourceType = GetResourceDefinitionType(entityType)
+            ResourceDefinitionType = GetResourceDefinitionType(entityType)
         };
 
 
@@ -234,7 +234,7 @@ private string GetResourceNameFromDbSetProperty(PropertyInfo property, Type reso
 
         private void AssertEntityIsNotAlreadyDefined(Type entityType)
         {
-            if (_entities.Any(e => e.EntityType == entityType))
+            if (_entities.Any(e => e.ResourceType == entityType))
                 throw new InvalidOperationException($"Cannot add entity type {entityType} to context resourceGraph, there is already an entity of that type configured.");
         }
     }

src/JsonApiDotNetCore/Hooks/Execution/HookExecutorHelper.cs

@@ -97,23 +97,14 @@ public HashSet<TEntity> LoadDbValues<TEntity>(IEnumerable<TEntity> entities, Res
             return new HashSet<TEntity>(dbValues);
         }
 
-
         public bool ShouldLoadDbValues(Type entityType, ResourceHook hook)
         {
             var discovery = GetHookDiscovery(entityType);
-
             if (discovery.DatabaseValuesDisabledHooks.Contains(hook))
-            {
                 return false;
-            }
             if (discovery.DatabaseValuesEnabledHooks.Contains(hook))
-            {
                 return true;
-            }
-            else
-            {
-                return _options.LoaDatabaseValues;
-            }
+            return _options.LoaDatabaseValues;
         }
 
         bool ShouldExecuteHook(DependentType entityType, ResourceHook hook)

src/JsonApiDotNetCore/Internal/Contracts/IContextEntityProvider.cs renamed to src/JsonApiDotNetCore/Internal/Contracts/IResourceContextProvider.cs

@@ -1,7 +1,4 @@
 using System;
-using System.Collections.Generic;
-using System.Linq.Expressions;
-using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Models;
 
 namespace JsonApiDotNetCore.Internal.Contracts
@@ -14,7 +11,7 @@ public interface IResourceContextProvider
         /// <summary>
         /// Gets all registered context entities
         /// </summary>
-        ResourceContext[] GetContextEntities();
+        ResourceContext[] GetResourceContexts();
 
         /// <summary>
         /// Get the resource metadata by the DbSet property name

src/JsonApiDotNetCore/Internal/InverseRelationships.cs

@@ -45,9 +45,9 @@ public void Resolve()
             {
                 DbContext context = _resolver.GetContext();
 
-                foreach (ResourceContext ce in _provider.GetContextEntities())
+                foreach (ResourceContext ce in _provider.GetResourceContexts())
                 {
-                    IEntityType meta = context.Model.FindEntityType(ce.EntityType);
+                    IEntityType meta = context.Model.FindEntityType(ce.ResourceType);
                     if (meta == null) continue;
                     foreach (var attr in ce.Relationships)
                     {

src/JsonApiDotNetCore/Internal/ContextEntity.cs renamed to src/JsonApiDotNetCore/Internal/ResourceContext.cs

@@ -11,12 +11,12 @@ public class ResourceContext
         /// <summary>
         /// The exposed resource name
         /// </summary>
-        public string EntityName { get; set; }
+        public string ResourceName { get; set; }
 
         /// <summary>
         /// The data model type
         /// </summary>
-        public Type EntityType { get; set; }
+        public Type ResourceType { get; set; }
 
         /// <summary>
         /// The identity member type
@@ -27,7 +27,7 @@ public class ResourceContext
         /// The concrete <see cref="ResourceDefinition{T}"/> type.
         /// We store this so that we don't need to re-compute the generic type.
         /// </summary>
-        public Type ResourceType { get; set; }
+        public Type ResourceDefinitionType { get; set; }
 
         /// <summary>
         /// Exposed resource attributes.

src/JsonApiDotNetCore/Internal/ResourceGraph.cs

@@ -13,28 +13,25 @@ namespace JsonApiDotNetCore.Internal
     public class ResourceGraph : IResourceGraph
     {
         internal List<ValidationResult> ValidationResults { get; }
-        private List<ResourceContext> _entities { get; }
+        private List<ResourceContext> _resources { get; }
 
         public ResourceGraph(List<ResourceContext> entities, List<ValidationResult> validationResults = null)
         {
-            _entities = entities;
+            _resources = entities;
             ValidationResults = validationResults;
         }
 
         /// <inheritdoc />
-        public ResourceContext[] GetContextEntities() => _entities.ToArray();
-
+        public ResourceContext[] GetResourceContexts() => _resources.ToArray();
         /// <inheritdoc />
         public ResourceContext GetResourceContext(string entityName)
-            => _entities.SingleOrDefault(e => string.Equals(e.EntityName, entityName, StringComparison.OrdinalIgnoreCase));
-
+            => _resources.SingleOrDefault(e => string.Equals(e.ResourceName, entityName, StringComparison.OrdinalIgnoreCase));
         /// <inheritdoc />
         public ResourceContext GetResourceContext(Type entityType)
-            => _entities.SingleOrDefault(e => e.EntityType == entityType);
+            => _resources.SingleOrDefault(e => e.ResourceType == entityType);
         /// <inheritdoc />
         public ResourceContext GetResourceContext<TResource>() where TResource : class, IIdentifiable
             => GetResourceContext(typeof(TResource));
-
         /// <inheritdoc/>
         public List<IResourceField> GetFields<T>(Expression<Func<T, dynamic>> selector = null) where T : IIdentifiable
         {
@@ -65,7 +62,6 @@ public List<RelationshipAttribute> GetRelationships(Type type)
         {
             return GetResourceContext(type).Relationships.ToList();
         }
-
         /// <inheritdoc />
         public RelationshipAttribute GetInverse(RelationshipAttribute relationship)
         {
@@ -144,7 +140,5 @@ private enum FieldFilterType
             Attribute,
             Relationship
         }
-
-
     }
 }

src/JsonApiDotNetCore/Middleware/DefaultTypeMatchFilter.cs

@@ -33,7 +33,7 @@ public void OnActionExecuting(ActionExecutingContext context)
 
                     throw new JsonApiException(409,
                         $"Cannot '{context.HttpContext.Request.Method}' type '{deserializedType.Name}' "
-                        + $"to '{expectedJsonApiResource?.EntityName}' endpoint.",
+                        + $"to '{expectedJsonApiResource?.ResourceName}' endpoint.",
                         detail: "Check that the request payload type matches the type expected by this endpoint.");
                 }
             }

src/JsonApiDotNetCore/Middleware/RequestMiddleware.cs

@@ -46,7 +46,7 @@ public async Task Invoke(HttpContext httpContext,
             {
                 _currentRequest.SetRequestResource(GetCurrentEntity());
                 _currentRequest.IsRelationshipPath = PathIsRelationship();
-                _currentRequest.BasePath = GetBasePath(_currentRequest.GetRequestResource().EntityName);
+                _currentRequest.BasePath = GetBasePath(_currentRequest.GetRequestResource().ResourceName);
             }
 
             if (IsValid())

src/JsonApiDotNetCore/QueryParameterServices/Common/QueryParameterService.cs

@@ -66,7 +66,7 @@ protected RelationshipAttribute GetRelationship(string propertyName)
             if (propertyName == null) return null;
             var relationship = _requestResource.Relationships.FirstOrDefault(r => r.Is(propertyName));
             if (relationship == null)
-                throw new JsonApiException(400, $"{propertyName} is not a valid relationship on {_requestResource.EntityName}.");
+                throw new JsonApiException(400, $"{propertyName} is not a valid relationship on {_requestResource.ResourceName}.");
 
             return relationship;
         }

src/JsonApiDotNetCore/QueryParameterServices/FilterService.cs

@@ -18,7 +18,7 @@ public class FilterService : QueryParameterService, IFilterService
 
         public FilterService(IResourceDefinitionProvider resourceDefinitionProvider, IResourceGraph resourceGraph, ICurrentRequest currentRequest) : base(resourceGraph, currentRequest)
         {
-            _requestResourceDefinition = resourceDefinitionProvider.Get(_requestResource.EntityType);
+            _requestResourceDefinition = resourceDefinitionProvider.Get(_requestResource.ResourceType);
             _filters = new List<FilterQueryContext>();
         }
 

src/JsonApiDotNetCore/QueryParameterServices/IncludeService.cs

@@ -59,13 +59,13 @@ private void ParseChain(string chain)
 
         private JsonApiException CannotIncludeError(ResourceContext resourceContext, string requestedRelationship)
         {
-           return new JsonApiException(400, $"Including the relationship {requestedRelationship} on {resourceContext.EntityName} is not allowed");
+           return new JsonApiException(400, $"Including the relationship {requestedRelationship} on {resourceContext.ResourceName} is not allowed");
         }
 
         private JsonApiException InvalidRelationshipError(ResourceContext resourceContext, string requestedRelationship)
         {
-           return new JsonApiException(400, $"Invalid relationship {requestedRelationship} on {resourceContext.EntityName}",
-                $"{resourceContext.EntityName} does not have a relationship named {requestedRelationship}");
+           return new JsonApiException(400, $"Invalid relationship {requestedRelationship} on {resourceContext.ResourceName}",
+                $"{resourceContext.ResourceName} does not have a relationship named {requestedRelationship}");
         }
     }
 }

src/JsonApiDotNetCore/QueryParameterServices/SortService.cs

@@ -39,7 +39,7 @@ public List<SortQueryContext> Get()
         {
             if (_queries == null)
             {
-                var requestResourceDefinition = _resourceDefinitionProvider.Get(_requestResource.EntityType);
+                var requestResourceDefinition = _resourceDefinitionProvider.Get(_requestResource.ResourceType);
                 if (requestResourceDefinition != null)
                     return requestResourceDefinition.DefaultSort()?.Select(d => BuildQueryContext(new SortQuery(d.Item1.PublicAttributeName, d.Item2))).ToList();
             }

src/JsonApiDotNetCore/QueryParameterServices/SparseFieldsService.cs

@@ -61,7 +61,7 @@ public virtual void Parse(KeyValuePair<string, StringValues> queryParameter)
                 // it is possible that the request resource has a relationship
                 // that is equal to the resource name, like with self-referering data types (eg directory structures)
                 // if not, no longer support this type of sparse field selection.
-                if (navigation == _requestResource.EntityName && !_requestResource.Relationships.Any(a => a.Is(navigation)))
+                if (navigation == _requestResource.ResourceName && !_requestResource.Relationships.Any(a => a.Is(navigation)))
                     throw new JsonApiException(400, $"Use \"?fields=...\" instead of \"fields[{navigation}]\":" +
                         $" the square bracket navigations is now reserved " +
                         $"for relationships only. See https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/555#issuecomment-543100865");
@@ -71,7 +71,7 @@ public virtual void Parse(KeyValuePair<string, StringValues> queryParameter)
 
                 var relationship = _requestResource.Relationships.SingleOrDefault(a => a.Is(navigation));
                 if (relationship == null)
-                    throw new JsonApiException(400, $"\"{navigation}\" in \"fields[{navigation}]\" is not a valid relationship of {_requestResource.EntityName}");
+                    throw new JsonApiException(400, $"\"{navigation}\" in \"fields[{navigation}]\" is not a valid relationship of {_requestResource.ResourceName}");
 
                 foreach (var field in fields)
                     RegisterRelatedResourceField(field, relationship);
@@ -100,7 +100,7 @@ private void RegisterRequestResourceField(string field)
         {
             var attr = _requestResource.Attributes.SingleOrDefault(a => a.Is(field));
             if (attr == null)
-                throw new JsonApiException(400, $"'{_requestResource.EntityName}' does not contain '{field}'.");
+                throw new JsonApiException(400, $"'{_requestResource.ResourceName}' does not contain '{field}'.");
 
             (_selectedFields = _selectedFields ?? new List<AttrAttribute>()).Add(attr);
         }

src/JsonApiDotNetCore/Serialization/Common/BaseDocumentParser.cs

@@ -138,7 +138,7 @@ private IIdentifiable ParseResourceObject(ResourceObject data)
                              + "If you have manually registered the resource, check that the call to AddResource correctly sets the public name.");
             }
 
-            var entity = (IIdentifiable)Activator.CreateInstance(contextEntity.EntityType);
+            var entity = (IIdentifiable)Activator.CreateInstance(contextEntity.ResourceType);
 
             entity = SetAttributes(entity, data.Attributes, contextEntity.Attributes);
             entity = SetRelationships(entity, data.Relationships, contextEntity.Relationships);

src/JsonApiDotNetCore/Serialization/Common/ResourceObjectBuilder.cs

@@ -28,7 +28,7 @@ public ResourceObject Build(IIdentifiable entity, IEnumerable<AttrAttribute> att
             var resourceContext = _provider.GetResourceContext(entity.GetType());
 
             // populating the top-level "type" and "id" members.
-            var ro = new ResourceObject { Type = resourceContext.EntityName, Id = entity.StringId.NullIfEmpty() };
+            var ro = new ResourceObject { Type = resourceContext.ResourceName, Id = entity.StringId.NullIfEmpty() };
 
             // populating the top-level "attribute" member of a resource object. never include "id" as an attribute
             if (attributes != null && (attributes = attributes.Where(attr => attr.InternalAttributeName != _identifiablePropertyName)).Any())
@@ -98,7 +98,7 @@ private List<ResourceIdentifierObject> GetRelatedResourceLinkage(HasManyAttribut
         /// </summary>
         private ResourceIdentifierObject GetResourceIdentifier(IIdentifiable entity)
         {
-            var resourceName = _provider.GetResourceContext(entity.GetType()).EntityName;
+            var resourceName = _provider.GetResourceContext(entity.GetType()).ResourceName;
             return new ResourceIdentifierObject
             {
                 Type = resourceName,

src/JsonApiDotNetCore/Serialization/Server/Builders/IncludedResourceObjectBuilder.cs

@@ -121,7 +121,7 @@ protected override RelationshipEntry GetRelationshipData(RelationshipAttribute r
         private ResourceObject GetOrBuildResourceObject(IIdentifiable parent, RelationshipAttribute relationship)
         {
             var type = parent.GetType();
-            var resourceName = _provider.GetResourceContext(type).EntityName;
+            var resourceName = _provider.GetResourceContext(type).ResourceName;
             var entry = _included.SingleOrDefault(ro => ro.Type == resourceName && ro.Id == parent.StringId);
             if (entry == null)
             {

src/JsonApiDotNetCore/Serialization/Server/Builders/LinkBuilder.cs

@@ -31,7 +31,7 @@ public TopLevelLinks GetTopLevelLinks(ResourceContext primaryResource)
         {
             TopLevelLinks topLevelLinks = null;
             if (ShouldAddTopLevelLink(primaryResource, Link.Self))
-                topLevelLinks = new TopLevelLinks { Self = GetSelfTopLevelLink(primaryResource.EntityName) };
+                topLevelLinks = new TopLevelLinks { Self = GetSelfTopLevelLink(primaryResource.ResourceName) };
 
             if (ShouldAddTopLevelLink(primaryResource, Link.Paging))
                 SetPageLinks(primaryResource, ref topLevelLinks);
@@ -80,7 +80,7 @@ private string GetSelfTopLevelLink(string resourceName)
 
         private string GetPageLink(ResourceContext primaryResource, int pageOffset, int pageSize)
         {
-            return $"{GetBasePath()}/{primaryResource.EntityName}?page[size]={pageSize}&page[number]={pageOffset}";
+            return $"{GetBasePath()}/{primaryResource.ResourceName}?page[size]={pageSize}&page[number]={pageOffset}";
         }
 
 
@@ -101,12 +101,12 @@ public RelationshipLinks GetRelationshipLinks(RelationshipAttribute relationship
             var childNavigation = relationship.PublicRelationshipName;
             RelationshipLinks links = null;
             if (ShouldAddRelationshipLink(parentResourceContext, relationship, Link.Related))
-                links = new RelationshipLinks { Related = GetRelatedRelationshipLink(parentResourceContext.EntityName, parent.StringId, childNavigation) };
+                links = new RelationshipLinks { Related = GetRelatedRelationshipLink(parentResourceContext.ResourceName, parent.StringId, childNavigation) };
 
             if (ShouldAddRelationshipLink(parentResourceContext, relationship, Link.Self))
             {
                 links = links ?? new RelationshipLinks();
-                links.Self = GetSelfRelationshipLink(parentResourceContext.EntityName, parent.StringId, childNavigation);
+                links.Self = GetSelfRelationshipLink(parentResourceContext.ResourceName, parent.StringId, childNavigation);
             }
 
             return links;

src/JsonApiDotNetCore/Serialization/Server/ResponseSerializerFactory.cs

@@ -46,7 +46,7 @@ private Type GetDocumentPrimaryType()
             if (_currentRequest.RequestRelationship != null && !_currentRequest.IsRelationshipPath)
                 return _currentRequest.RequestRelationship.DependentType;
 
-            return _currentRequest.GetRequestResource()?.EntityType;
+            return _currentRequest.GetRequestResource()?.ResourceType;
         }
     }
 }

src/JsonApiDotNetCore/Services/ResourceDefinitionProvider.cs

@@ -20,7 +20,7 @@ public ResourceDefinitionProvider(IResourceGraph resourceContextProvider, IScope
         /// <inheritdoc/>
         public IResourceDefinition Get(Type resourceType)
         {
-            return (IResourceDefinition)_serviceProvider.GetService(_resourceContextProvider.GetResourceContext(resourceType).ResourceType);
+            return (IResourceDefinition)_serviceProvider.GetService(_resourceContextProvider.GetResourceContext(resourceType).ResourceDefinitionType);
         }
     }
 }

test/UnitTests/Builders/ContextGraphBuilder_Tests.cs

@@ -37,9 +37,9 @@ public void Can_Build_ResourceGraph_Using_Builder()
             var resourceGraph = container.GetRequiredService<IResourceGraph>();
             var dbResource = resourceGraph.GetResourceContext("db-resources");
             var nonDbResource = resourceGraph.GetResourceContext("non-db-resources");
-            Assert.Equal(typeof(DbResource), dbResource.EntityType);
-            Assert.Equal(typeof(NonDbResource), nonDbResource.EntityType);
-            Assert.Equal(typeof(ResourceDefinition<NonDbResource>), nonDbResource.ResourceType);
+            Assert.Equal(typeof(DbResource), dbResource.ResourceType);
+            Assert.Equal(typeof(NonDbResource), nonDbResource.ResourceType);
+            Assert.Equal(typeof(ResourceDefinition<NonDbResource>), nonDbResource.ResourceDefinitionType);
         }
 
         [Fact]
@@ -54,7 +54,7 @@ public void Resources_Without_Names_Specified_Will_Use_Default_Formatter()
 
             // assert
             var resource = resourceGraph.GetResourceContext(typeof(TestResource));
-            Assert.Equal("test-resources", resource.EntityName);
+            Assert.Equal("test-resources", resource.ResourceName);
         }
 
         [Fact]
@@ -69,7 +69,7 @@ public void Resources_Without_Names_Specified_Will_Use_Configured_Formatter()
 
             // assert
             var resource = resourceGraph.GetResourceContext(typeof(TestResource));
-            Assert.Equal("testResources", resource.EntityName);
+            Assert.Equal("testResources", resource.ResourceName);
         }
 
         [Fact]

test/UnitTests/Builders/LinkBuilderTests.cs

@@ -211,7 +211,7 @@ private ResourceContext GetResourceContext<TResource>(Link resourceLinks = Link.
                 ResourceLinks = resourceLinks,
                 TopLevelLinks = topLevelLinks,
                 RelationshipLinks = relationshipLinks,
-                EntityName = typeof(TResource).Name.Dasherize() + "s"
+                ResourceName = typeof(TResource).Name.Dasherize() + "s"
             };
         }
     }