Merge branch 'master' into develop

Author: maurei

.editorconfig

@@ -12,3 +12,14 @@ charset = utf-8
 
 [*.{csproj,props}]
 indent_size = 2
+
+[*.{cs,vb}]
+dotnet_naming_rule.private_members_with_underscore.symbols  = private_fields
+dotnet_naming_rule.private_members_with_underscore.style    = prefix_underscore
+dotnet_naming_rule.private_members_with_underscore.severity = suggestion
+
+dotnet_naming_symbols.private_fields.applicable_kinds           = field
+dotnet_naming_symbols.private_fields.applicable_accessibilities = private
+
+dotnet_naming_style.prefix_underscore.capitalization = camel_case
+dotnet_naming_style.prefix_underscore.required_prefix = _

.travis.yml

@@ -1,12 +1,11 @@
 language: csharp
-dist: trusty
 sudo: required
 services:
  - postgresql
 before_script:
   - psql -c 'create database JsonApiDotNetCoreExample;' -U postgres
 mono: none
-dotnet: 2.1.300 # https://www.microsoft.com/net/download/linux
+dotnet: 3.0.100 # https://www.microsoft.com/net/download/linux
 branches:
   only:
     - master

Build.ps1

@@ -35,12 +35,6 @@ CheckLastExitCode
 dotnet test ./test/NoEntityFrameworkTests/NoEntityFrameworkTests.csproj
 CheckLastExitCode
 
-dotnet test ./test/OperationsExampleTests/OperationsExampleTests.csproj
-CheckLastExitCode
-
-dotnet test ./test/ResourceEntitySeparationExampleTests/ResourceEntitySeparationExampleTests.csproj
-CheckLastExitCode
-
 dotnet test ./test/DiscoveryTests/DiscoveryTests.csproj
 CheckLastExitCode
 

Directory.Build.props

@@ -1,30 +1,23 @@
 <Project>
-
   <PropertyGroup>
-    <NetCoreAppVersion>netcoreapp2.0</NetCoreAppVersion>
-    <NetStandardVersion>netstandard2.0</NetStandardVersion>
-
-    <AspNetCoreVersion>2.1.0</AspNetCoreVersion>
-
-    <MicrosoftLoggingVersion>2.1.0</MicrosoftLoggingVersion>
-    <MicrosoftConfigurationVersion>2.1.0</MicrosoftConfigurationVersion>
-    <MicrosoftOptionsVersion>2.1.0</MicrosoftOptionsVersion>
-
-    <EFCoreVersion>2.1.0</EFCoreVersion>
-    <EFCoreToolsVersion>2.1.0</EFCoreToolsVersion>
-
-    <NpgsqlVersion>4.0.0</NpgsqlVersion>
-    <NpgsqlPostgreSQLVersion>2.1.0</NpgsqlPostgreSQLVersion>
-
+    <NetCoreAppVersion>netcoreapp3.0</NetCoreAppVersion>
+    <NetStandardVersion>netstandard2.1</NetStandardVersion>
+    <AspNetCoreVersion>3.*</AspNetCoreVersion>
+    <MicrosoftLoggingVersion>3.*</MicrosoftLoggingVersion>
+    <MicrosoftConfigurationVersion>3.*</MicrosoftConfigurationVersion>
+    <MicrosoftOptionsVersion>3.*</MicrosoftOptionsVersion>
+    <EFCoreVersion>3.*</EFCoreVersion>
+    <EFCoreToolsVersion>3.*</EFCoreToolsVersion>
+    <NpgsqlVersion>4.1.1</NpgsqlVersion>
+    <NpgsqlPostgreSQLVersion>3.0.1</NpgsqlPostgreSQLVersion>
     <TuplesVersion>4.5.0</TuplesVersion>
   </PropertyGroup>
 
   <!-- Test Project Dependencies -->
   <PropertyGroup>
-    <TestSdkVersion>15.7.2</TestSdkVersion>
-    <XUnitVersion>2.3.1</XUnitVersion>
-    <BogusVersion>22.1.2</BogusVersion>
-    <MoqVersion>4.8.3</MoqVersion>
+    <TestSdkVersion>16.3.0</TestSdkVersion>
+    <XUnitVersion>2.4.1</XUnitVersion>
+    <BogusVersion>28.4.1</BogusVersion>
+    <MoqVersion>4.13.1</MoqVersion>
   </PropertyGroup>
-
-</Project>
+</Project>

JsonApiDotnetCore.sln

@@ -42,7 +42,7 @@ See [the documentation](https://json-api-dotnet.github.io/#/) for detailed usage
 
 ```csharp
 public class Article : Identifiable
-{ 
+{
     [Attr("name")]
     public string Name { get; set; }
 }
@@ -53,10 +53,12 @@ public class Article : Identifiable
 ```csharp
 public class ArticlesController : JsonApiController<Article>
 {
-    public ArticlesController(
-        IJsonApiContext jsonApiContext,
-        IResourceService<Article> resourceService) 
-    : base(jsonApiContext, resourceService) { }
+        public ArticlesController(
+            IJsonApiOptions jsonApiOptions,
+            IResourceService<Article> resourceService,
+            ILoggerFactory loggerFactory) 
+            : base(jsonApiOptions, resourceService, loggerFactory)
+        { }
 }
 ```
 
@@ -79,19 +81,18 @@ public class Startup
 
 ### Development
 
-Restore all nuget packages with:
+Restore all NuGet packages with:
 
 ```bash
 dotnet restore
 ```
 
 #### Testing
 
-Running tests locally requires access to a postgresql database.  
-If you have docker installed, this can be propped up via: 
+Running tests locally requires access to a PostgreSQL database.  If you have docker installed, this can be propped up via: 
 
 ```bash
-docker run --rm --name jsonapi-dotnet-core-testing  -e POSTGRES_DB=JsonApiDotNetCoreExample -e POSTGRES_USER=postgres  -e POSTGRES_PASSWORD=postgres   -p 5432:5432   postgres
+docker run --rm --name jsonapi-dotnet-core-testing  -e POSTGRES_DB=JsonApiDotNetCoreExample -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 postgres:12.0
 ```
 
 And then to run the tests:
@@ -107,3 +108,14 @@ Sometimes the compiled files can be dirty / corrupt from other branches / failed
 ```bash
 dotnet clean
 ```
+
+## Compatibility
+
+A lot of changes were introduced in v4.0.0, the following chart should help you with compatibility issues between .NET Core versions
+
+| .NET Core Version | JADNC Version |
+| ----------------- | ------------- |
+| 2.*               | v3.*          |
+| 3.*               | v4.*          |
+
+

README.md

@@ -1,5 +1,5 @@
 version: '{build}'
-os: Visual Studio 2017
+os: Visual Studio 2019
 
 environment:
   POSTGRES_PORT: tcp://localhost:5432

appveyor.yml

@@ -1,10 +1,11 @@
 using BenchmarkDotNet.Attributes;
 using BenchmarkDotNet.Attributes.Exporters;
 using BenchmarkDotNet.Attributes.Jobs;
+using System;
 
 namespace Benchmarks.LinkBuilder
 {
-    [MarkdownExporter, SimpleJob(launchCount : 3, warmupCount : 10, targetCount : 20), MemoryDiagnoser]
+    [MarkdownExporter, SimpleJob(launchCount: 3, warmupCount: 10, targetCount: 20), MemoryDiagnoser]
     public class LinkBuilder_GetNamespaceFromPath_Benchmarks
     {
         private const string PATH = "/api/some-really-long-namespace-path/resources/current/articles";
@@ -14,7 +15,7 @@ public class LinkBuilder_GetNamespaceFromPath_Benchmarks
         public void UsingSplit() => GetNamespaceFromPath_BySplitting(PATH, ENTITY_NAME);
 
         [Benchmark]
-        public void Current() => GetNameSpaceFromPath_Current(PATH, ENTITY_NAME);
+        public void Current() => GetNameSpaceFromPathCurrent(PATH, ENTITY_NAME);
 
         public static string GetNamespaceFromPath_BySplitting(string path, string entityName)
         {
@@ -32,7 +33,38 @@ public static string GetNamespaceFromPath_BySplitting(string path, string entity
             return nSpace;
         }
 
-        public static string GetNameSpaceFromPath_Current(string path, string entityName)
-            => JsonApiDotNetCore.Builders.LinkBuilder.GetNamespaceFromPath(path, entityName);
+        public static string GetNameSpaceFromPathCurrent(string path, string entityName)
+        {
+
+            var entityNameSpan = entityName.AsSpan();
+            var pathSpan = path.AsSpan();
+            const char delimiter = '/';
+            for (var i = 0; i < pathSpan.Length; i++)
+            {
+                if (pathSpan[i].Equals(delimiter))
+                {
+                    var nextPosition = i + 1;
+                    if (pathSpan.Length > i + entityNameSpan.Length)
+                    {
+                        var possiblePathSegment = pathSpan.Slice(nextPosition, entityNameSpan.Length);
+                        if (entityNameSpan.SequenceEqual(possiblePathSegment))
+                        {
+                            // check to see if it's the last position in the string
+                            //   or if the next character is a /
+                            var lastCharacterPosition = nextPosition + entityNameSpan.Length;
+
+                            if (lastCharacterPosition == pathSpan.Length || pathSpan.Length >= lastCharacterPosition + 2 && pathSpan[lastCharacterPosition].Equals(delimiter))
+                            {
+                                return pathSpan.Slice(0, i).ToString();
+                            }
+                        }
+                    }
+                }
+            }
+
+            return string.Empty;
+
+
+        }
     }
 }

benchmarks/LinkBuilder/LinkBuilder_ GetNamespaceFromPath_Benchmarks.cs

@@ -1,4 +1,4 @@
-using BenchmarkDotNet.Running;
+using BenchmarkDotNet.Running;
 using Benchmarks.JsonApiContext;
 using Benchmarks.LinkBuilder;
 using Benchmarks.Query;
@@ -9,8 +9,8 @@ namespace Benchmarks {
     class Program {
         static void Main(string[] args) {
             var switcher = new BenchmarkSwitcher(new[] {
-                typeof(JsonApiDeserializer_Benchmarks),
-                typeof(JsonApiSerializer_Benchmarks),
+                typeof(JsonApideserializer_Benchmarks),
+                //typeof(JsonApiSerializer_Benchmarks),
                 typeof(QueryParser_Benchmarks),
                 typeof(LinkBuilder_GetNamespaceFromPath_Benchmarks),
                 typeof(ContainsMediaTypeParameters_Benchmarks),

benchmarks/Program.cs

@@ -5,6 +5,7 @@
 using BenchmarkDotNet.Attributes.Jobs;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Internal;
+using JsonApiDotNetCore.Managers.Contracts;
 using JsonApiDotNetCore.Models;
 using JsonApiDotNetCore.Services;
 using Microsoft.AspNetCore.Http.Internal;
@@ -21,14 +22,14 @@ public class QueryParser_Benchmarks {
         private const string DESCENDING_SORT = "-" + ATTRIBUTE;
 
         public QueryParser_Benchmarks() {
-            var controllerContextMock = new Mock<IControllerContext>();
-            controllerContextMock.Setup(m => m.RequestEntity).Returns(new ContextEntity {
+            var requestMock = new Mock<IRequestContext>();
+            requestMock.Setup(m => m.GetRequestResource()).Returns(new ResourceContext {
                 Attributes = new List<AttrAttribute> {
                     new AttrAttribute(ATTRIBUTE, ATTRIBUTE)
                 }
             });
             var options = new JsonApiOptions();
-            _queryParser = new BenchmarkFacade(controllerContextMock.Object, options);
+            _queryParser = new BenchmarkFacade(requestMock.Object, options);
         }
 
         [Benchmark]
@@ -56,10 +57,10 @@ private void Run(int iterations, Action action) {
         }
 
         // this facade allows us to expose and micro-benchmark protected methods
-        private class BenchmarkFacade : QueryParser {
+        private class BenchmarkFacade : QueryParameterDiscovery {
             public BenchmarkFacade(
-                IControllerContext controllerContext,
-                JsonApiOptions options) : base(controllerContext, options) { }
+                IRequestContext currentRequest,
+                JsonApiOptions options) : base(currentRequest, options) { }
 
             public void _ParseSortParameters(string value) => base.ParseSortParameters(value);
         }