Fix/routing convention

.gitignore

@@ -1 +1,3 @@
 \.vs/
+
+*.user

JsonApiDotnetCore.sln

@@ -15,6 +15,7 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{C5B4D998-CECB-454D-9F32-085A897577BE}"
 	ProjectSection(SolutionItems) = preProject
 		.gitignore = .gitignore
+		README.md = README.md
 	EndProjectSection
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NoEntityFrameworkExample", "src\NoEntityFrameworkExample\NoEntityFrameworkExample.csproj", "{570165EC-62B5-4684-A139-8D2A30DD4475}"

README.md

@@ -248,9 +248,10 @@ services.AddJsonApi<AppDbContext>(
 #### Disable Convention
 
 You can disable the dasherized convention and specify your own template
-by using the `DisableRoutingConvention` Attribute:
+by using the `DisableRoutingConvention` Attribute. 
 
 ```csharp
+[Route("[controller]")]
 [DisableRoutingConvention]
 public class CamelCasedModelsController : JsonApiController<CamelCasedModel>
 {
@@ -263,6 +264,22 @@ public class CamelCasedModelsController : JsonApiController<CamelCasedModel>
 }
 ```
 
+It is important to note that your routes *must* still end with the model name in the same format
+as the resource name. This is so that we can build accurrate resource links in the json:api document.
+For example, if you define a resource as `MyModels` the controller route must match:
+
+```csharp
+// resource definition
+builder.AddResource<TodoItem>("myModels");
+
+// controller definition
+[Route("api/myModels")]
+[DisableRoutingConvention]
+public class TodoItemsController : JsonApiController<TodoItem>
+{ //...
+}
+```
+
 ### Defining Custom Data Access Methods
 
 By default, data retrieval is distributed across 3 layers:
@@ -287,7 +304,7 @@ public void ConfigureServices(IServiceCollection services)
     services.AddJsonApi(options => {
         options.Namespace = "api/v1";
         options.BuildContextGraph((builder) => {
-            builder.AddResource<MyModel>("my-models");
+            builder.AddResource<MyModel>("my-models");1
         });
     }, mvcBuilder);
     // ...

src/JsonApiDotNetCore/Builders/ContextGraphBuilder.cs

@@ -10,18 +10,18 @@ namespace JsonApiDotNetCore.Builders
 {
     public class ContextGraphBuilder : IContextGraphBuilder
     {
-        private List<ContextEntity> Entities;
+        private List<ContextEntity> _entities;
         private bool _usesDbContext;
         public ContextGraphBuilder()
         {
-            Entities = new List<ContextEntity>();
+            _entities = new List<ContextEntity>();
         }
 
         public IContextGraph Build()
         {
             var graph = new ContextGraph()
             {
-                Entities = Entities,
+                Entities = _entities,
                 UsesDbContext = _usesDbContext
             };
             return graph;
@@ -30,7 +30,7 @@ public IContextGraph Build()
         public void AddResource<TResource>(string pluralizedTypeName) where TResource : class
         {
             var entityType = typeof(TResource);
-            Entities.Add(new ContextEntity
+            _entities.Add(new ContextEntity
             {
                 EntityName = pluralizedTypeName,
                 EntityType = entityType,
@@ -108,7 +108,7 @@ public void AddDbContext<T>() where T : DbContext
                 }
             }
 
-            Entities = entities;
+            _entities = entities;
         }
 
         private string GetResourceName(PropertyInfo property)

src/JsonApiDotNetCore/Builders/DocumentBuilder.cs

@@ -9,8 +9,8 @@ namespace JsonApiDotNetCore.Builders
 {
     public class DocumentBuilder : IDocumentBuilder
     {
-        private IJsonApiContext _jsonApiContext;
-        private IContextGraph _contextGraph;
+        private readonly IJsonApiContext _jsonApiContext;
+        private readonly IContextGraph _contextGraph;
         private readonly IRequestMeta _requestMeta;
 
         public DocumentBuilder(IJsonApiContext jsonApiContext)
@@ -50,14 +50,15 @@ public Documents Build(IEnumerable<IIdentifiable> entities)
 
             var contextEntity = _contextGraph.GetContextEntity(entityType);
 
+            var enumeratedEntities = entities as IList<IIdentifiable> ?? entities.ToList();
             var documents = new Documents
             {
                 Data = new List<DocumentData>(),
-                Meta = GetMeta(entities.FirstOrDefault()),
+                Meta = GetMeta(enumeratedEntities.FirstOrDefault()),
                 Links = _jsonApiContext.PageManager.GetPageLinks(new LinkBuilder(_jsonApiContext))
             };
 
-            foreach (var entity in entities)
+            foreach (var entity in enumeratedEntities)
             {
                 documents.Data.Add(GetData(contextEntity, entity));
                 documents.Included = AppendIncludedObject(documents.Included, contextEntity, entity);
@@ -155,9 +156,9 @@ private void AddRelationships(DocumentData data, ContextEntity contextEntity, II
                     if(navigationEntity == null)
                         relationshipData.SingleData = null;
                     else if (navigationEntity is IEnumerable)
-                        relationshipData.ManyData = GetRelationships((IEnumerable<object>)navigationEntity, r.InternalRelationshipName);
+                        relationshipData.ManyData = GetRelationships((IEnumerable<object>)navigationEntity);
                     else
-                        relationshipData.SingleData = GetRelationship(navigationEntity, r.InternalRelationshipName);
+                        relationshipData.SingleData = GetRelationship(navigationEntity);
                 }
 
                 data.Relationships.Add(r.PublicRelationshipName, relationshipData);
@@ -174,9 +175,9 @@ private List<DocumentData> GetIncludedEntities(ContextEntity contextEntity, IIde
 
                 var navigationEntity = _jsonApiContext.ContextGraph.GetRelationship(entity, r.InternalRelationshipName);
 
-                if (navigationEntity is IEnumerable)
-                    foreach (var includedEntity in (IEnumerable)navigationEntity)
-                        AddIncludedEntity(included, (IIdentifiable)includedEntity);
+                if (navigationEntity is IEnumerable hasManyNavigationEntity)
+                    foreach (IIdentifiable includedEntity in hasManyNavigationEntity)
+                        AddIncludedEntity(included, includedEntity);
                 else
                     AddIncludedEntity(included, (IIdentifiable)navigationEntity);
             });
@@ -216,7 +217,7 @@ private bool RelationshipIsIncluded(string relationshipName)
                 _jsonApiContext.IncludedRelationships.Contains(relationshipName);
         }
 
-        private List<Dictionary<string, string>> GetRelationships(IEnumerable<object> entities, string relationshipName)
+        private List<Dictionary<string, string>> GetRelationships(IEnumerable<object> entities)
         {
             var objType = entities.GetType().GenericTypeArguments[0];
 
@@ -232,7 +233,7 @@ private List<Dictionary<string, string>> GetRelationships(IEnumerable<object> en
             }
             return relationships;
         }
-        private Dictionary<string, string> GetRelationship(object entity, string relationshipName)
+        private Dictionary<string, string> GetRelationship(object entity)
         {
             var objType = entity.GetType();
 

src/JsonApiDotNetCore/Builders/LinkBuilder.cs

@@ -1,12 +1,11 @@
-using JsonApiDotNetCore.Extensions;
 using JsonApiDotNetCore.Services;
 using Microsoft.AspNetCore.Http;
 
 namespace JsonApiDotNetCore.Builders
 {
     public class LinkBuilder
     {
-        IJsonApiContext _context;
+        private readonly IJsonApiContext _context;
 
         public LinkBuilder(IJsonApiContext context)
         {

src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs

@@ -20,8 +20,7 @@ public void BuildContextGraph<TContext>(Action<IContextGraphBuilder> builder)
 
             contextGraphBuilder.AddDbContext<TContext>();
 
-            if(builder != null)
-                builder(contextGraphBuilder);
+            builder?.Invoke(contextGraphBuilder);
 
             ContextGraph = contextGraphBuilder.Build();
         }

src/JsonApiDotNetCore/Controllers/JsonApiControllerMixin.cs

@@ -4,9 +4,6 @@ namespace JsonApiDotNetCore.Controllers
 {
     public abstract class JsonApiControllerMixin : Controller
     {
-        protected JsonApiControllerMixin()
-        { }
-
         protected IActionResult UnprocessableEntity()
         {
             return new StatusCodeResult(422);

src/JsonApiDotNetCore/Data/DefaultEntityRepository.cs

@@ -3,6 +3,7 @@
 using System.Threading.Tasks;
 using JsonApiDotNetCore.Extensions;
 using JsonApiDotNetCore.Internal;
+using JsonApiDotNetCore.Internal.Generics;
 using JsonApiDotNetCore.Internal.Query;
 using JsonApiDotNetCore.Models;
 using JsonApiDotNetCore.Services;
@@ -58,8 +59,8 @@ public virtual IQueryable<TEntity> Filter(IQueryable<TEntity> entities,  FilterQ
 
             if(filterQuery.IsAttributeOfRelationship)
                 return entities.Filter(new RelatedAttrFilterQuery(_jsonApiContext, filterQuery));
-            else
-                return entities.Filter(new AttrFilterQuery(_jsonApiContext, filterQuery));
+
+            return entities.Filter(new AttrFilterQuery(_jsonApiContext, filterQuery));
         }
 
         public virtual IQueryable<TEntity> Sort(IQueryable<TEntity> entities, List<SortQuery> sortQueries)
@@ -69,9 +70,10 @@ public virtual IQueryable<TEntity> Sort(IQueryable<TEntity> entities, List<SortQ
 
             var orderedEntities = entities.Sort(sortQueries[0]);
 
-            if(sortQueries.Count() > 1)
-                for(var i=1; i < sortQueries.Count(); i++)
-                    orderedEntities = orderedEntities.Sort(sortQueries[i]);
+            if (sortQueries.Count <= 1) return orderedEntities;
+
+            for(var i=1; i < sortQueries.Count; i++)
+                orderedEntities = orderedEntities.Sort(sortQueries[i]);
 
             return orderedEntities;
         }

src/JsonApiDotNetCore/Data/IEntityRepository.cs

@@ -1,7 +1,6 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
-using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Internal.Query;
 using JsonApiDotNetCore.Models;
 

src/JsonApiDotNetCore/Extensions/IApplicationBuilderExtensions.cs

@@ -1,8 +1,9 @@
 using JsonApiDotNetCore.Middleware;
 using Microsoft.AspNetCore.Builder;
 
-namespace JsonApiDotNetCore.Routing
+namespace JsonApiDotNetCore.Extensions
 {
+    // ReSharper disable once InconsistentNaming
     public static class IApplicationBuilderExtensions
     {
         public static IApplicationBuilder UseJsonApi(this IApplicationBuilder app, bool useMvc = true)

src/JsonApiDotNetCore/Extensions/IQueryableExtensions.cs

@@ -8,22 +8,21 @@
 
 namespace JsonApiDotNetCore.Extensions
 {
+    // ReSharper disable once InconsistentNaming
     public static class IQueryableExtensions
     {
         public static IOrderedQueryable<TSource> Sort<TSource>(this IQueryable<TSource> source, SortQuery sortQuery)
         {
-            if (sortQuery.Direction == SortDirection.Descending)
-                return source.OrderByDescending(sortQuery.SortedAttribute.InternalAttributeName);
-
-            return source.OrderBy(sortQuery.SortedAttribute.InternalAttributeName);
+            return sortQuery.Direction == SortDirection.Descending 
+                ? source.OrderByDescending(sortQuery.SortedAttribute.InternalAttributeName) 
+                : source.OrderBy(sortQuery.SortedAttribute.InternalAttributeName);
         }
 
         public static IOrderedQueryable<TSource> Sort<TSource>(this IOrderedQueryable<TSource> source, SortQuery sortQuery)
         {
-            if (sortQuery.Direction == SortDirection.Descending)
-                return source.ThenByDescending(sortQuery.SortedAttribute.InternalAttributeName);
-
-            return source.ThenBy(sortQuery.SortedAttribute.InternalAttributeName);
+            return sortQuery.Direction == SortDirection.Descending 
+                ? source.ThenByDescending(sortQuery.SortedAttribute.InternalAttributeName) 
+                : source.ThenBy(sortQuery.SortedAttribute.InternalAttributeName);
         }
 
         public static IOrderedQueryable<TSource> OrderBy<TSource>(this IQueryable<TSource> source, string propertyName)
@@ -178,10 +177,9 @@ private static Expression GetFilterExpressionLambda(Expression left, Expression
             return body;
         }
 
-
-        public static IQueryable<TSource> Select<TSource>(this IQueryable<TSource> source, IEnumerable<string> columns)
+        public static IQueryable<TSource> Select<TSource>(this IQueryable<TSource> source, List<string> columns)
         {
-            if (columns == null || columns.Count() == 0)
+            if (columns == null || columns.Any() == false)
                 return source;
 
             var sourceType = source.ElementType;
@@ -201,7 +199,7 @@ public static IQueryable<TSource> Select<TSource>(this IQueryable<TSource> sourc
             var selector = Expression.Lambda(body, parameter);
 
             return source.Provider.CreateQuery<TSource>(
-                Expression.Call(typeof(Queryable), "Select", new Type[] { sourceType, resultType },
+                Expression.Call(typeof(Queryable), "Select", new[] { sourceType, resultType },
                 source.Expression, Expression.Quote(selector)));
         }
     }

src/JsonApiDotNetCore/Extensions/IServiceCollectionExtensions.cs

@@ -4,6 +4,8 @@
 using JsonApiDotNetCore.Data;
 using JsonApiDotNetCore.Formatters;
 using JsonApiDotNetCore.Internal;
+using JsonApiDotNetCore.Internal.Generics;
+using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.Serialization;
 using JsonApiDotNetCore.Services;
 using Microsoft.AspNetCore.Http;
@@ -13,6 +15,7 @@
 
 namespace JsonApiDotNetCore.Extensions
 {
+    // ReSharper disable once InconsistentNaming
     public static class IServiceCollectionExtensions
     {
         public static void AddJsonApi<TContext>(this IServiceCollection services)

src/JsonApiDotNetCore/Formatters/JsonApiReader.cs

@@ -4,7 +4,6 @@
 using JsonApiDotNetCore.Serialization;
 using JsonApiDotNetCore.Services;
 using Microsoft.AspNetCore.Mvc.Formatters;
-using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Logging;
 using Newtonsoft.Json;
 

src/JsonApiDotNetCore/Internal/DasherizedRoutingConvention.cs

@@ -3,14 +3,13 @@
 using System.Reflection;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Extensions;
-using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.ApplicationModels;
 
 namespace JsonApiDotNetCore.Internal
 {
     public class DasherizedRoutingConvention : IApplicationModelConvention
     {
-        private string _namespace;
+        private readonly string _namespace;
         public DasherizedRoutingConvention(string nspace)
         {
             _namespace = nspace;
@@ -20,14 +19,11 @@ public void Apply(ApplicationModel application)
         {
             foreach (var controller in application.Controllers)
             {
-                var template = string.Empty;
-
-                if (IsDasherizedJsonApiController(controller))
-                    template = $"{_namespace}/{controller.ControllerName.Dasherize()}";
-                else 
-                    template = GetTemplate(controller);
+                if (IsDasherizedJsonApiController(controller) == false)
+                    continue;
 
-                controller.Selectors[0].AttributeRouteModel = new AttributeRouteModel()
+                var template = $"{_namespace}/{controller.ControllerName.Dasherize()}";
+                controller.Selectors[0].AttributeRouteModel = new AttributeRouteModel
                 {
                     Template = template
                 };
@@ -40,15 +36,5 @@ private bool IsDasherizedJsonApiController(ControllerModel controller)
             var notDisabled = type.GetCustomAttribute<DisableRoutingConventionAttribute>() == null;
             return notDisabled && type.IsSubclassOf(typeof(JsonApiControllerMixin));
         }
-
-        private string GetTemplate(ControllerModel controller)
-        {
-            var type = controller.ControllerType;
-            var routeAttr = type.GetCustomAttribute<RouteAttribute>();
-            if(routeAttr != null)
-                return ((RouteAttribute)routeAttr).Template;
-
-            return controller.ControllerName;
-        }
     }
 }

src/JsonApiDotNetCore/Internal/Error.cs

@@ -30,6 +30,6 @@ public Error(string status, string title, string detail)
         public string Status { get; set; }
 
         [JsonIgnore]
-        public int StatusCode { get { return int.Parse(Status); } }
+        public int StatusCode => int.Parse(Status);
     }
 }