Merge remote-tracking branch 'origin/master' into fix/#237

Author: jaredcnance

.travis.yml

@@ -6,7 +6,7 @@ services:
 before_script:
   - psql -c 'create database JsonApiDotNetCoreExample;' -U postgres
 mono: none
-dotnet: 2.0.3 # https://www.microsoft.com/net/download/linux
+dotnet: 2.1.105 # https://www.microsoft.com/net/download/linux
 branches:
   only:
     - master

CONTRIBUTING.MD

@@ -2,10 +2,14 @@
 
 ## Workflow
 
-1. Search through the issues to see if your particular issue has already been discovered and possibly addressed
-2. Open an issue if you can't find anything helpful
-3. Open a PR for proposed changes
+1.  Search through the issues to see if your particular issue has already been discovered and possibly addressed
+2.  Open an issue if you can't find anything helpful
+3.  Open a PR for proposed changes
 
 ## Commit Guidelines
 
 I have chosen to loosely follow the [Angular Commit Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit)
+
+# Documentation
+
+If you'd like to help us improve our documentation, please checkout our [GitHub pages repository](https://github.com/json-api-dotnet/json-api-dotnet.github.io) where we host our documentation.

README.md

@@ -12,13 +12,23 @@
 
 A framework for building [json:api](http://jsonapi.org/) compliant web APIs. The ultimate goal of this library is to eliminate as much boilerplate as possible by offering out-of-the-box features such as sorting, filtering and pagination. You just need to focus on defining the resources and implementing your custom business logic. This library has been designed around dependency injection making extensibility incredibly easy.
 
+## Getting Started
+
+These are some steps you can take to help you understand what this project is and how you can use it:
+
+- [What is json:api and why should I use it?](https://nordicapis.com/the-benefits-of-using-json-api/)
+- [The json:api specification](http://jsonapi.org/format/)
+- [Demo [Video]](https://youtu.be/KAMuo6K7VcE)
+- [Our documentation](https://json-api-dotnet.github.io)
+- Check out the examples in the next section
+
 ## Examples
 
 See the [examples](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/src/Examples) directory for up-to-date sample applications. There is also a [Todo List App](https://github.com/json-api-dotnet/TodoListExample) that includes a JADNC API and an EmberJs client.
 
 ## Installation And Usage
 
-See [the documentation](https://json-api-dotnet.github.io/JsonApiDotNetCore/) for detailed usage. 
+See [the documentation](https://json-api-dotnet.github.io/#/) for detailed usage. 
 
 ### Models
 

benchmarks/BenchmarkDotNet.Artifacts/results/Benchmarks.JsonApiContext.PathIsRelationship_Benchmarks-report-github.md

@@ -0,0 +1,12 @@
+```ini
+BenchmarkDotNet=v0.10.10, OS=Mac OS X 10.12
+Processor=Intel Core i5-5257U CPU 2.70GHz (Broadwell), ProcessorCount=4
+.NET Core SDK=2.1.4
+  [Host]     : .NET Core 2.0.5 (Framework 4.6.0.0), 64bit RyuJIT
+  DefaultJob : .NET Core 2.0.5 (Framework 4.6.0.0), 64bit RyuJIT
+```
+
+| Method     |      Mean |      Error |     StdDev |  Gen 0 | Allocated |
+| ---------- | --------: | ---------: | ---------: | -----: | --------: |
+| UsingSplit | 421.08 ns | 19.3905 ns | 54.0529 ns | 0.4725 |     744 B |
+| Current    |  52.23 ns |  0.8052 ns |  0.7532 ns |      - |       0 B |

benchmarks/BenchmarkDotNet.Artifacts/results/Benchmarks.LinkBuilder.LinkBuilder_GetNamespaceFromPath_Benchmarks-report-github.md

@@ -0,0 +1,16 @@
+``` ini
+
+BenchmarkDotNet=v0.10.10, OS=Mac OS X 10.12
+Processor=Intel Core i5-5257U CPU 2.70GHz (Broadwell), ProcessorCount=4
+.NET Core SDK=2.1.4
+  [Host]     : .NET Core 2.0.5 (Framework 4.6.0.0), 64bit RyuJIT
+  Job-XFMVNE : .NET Core 2.0.5 (Framework 4.6.0.0), 64bit RyuJIT
+
+LaunchCount=3  TargetCount=20  WarmupCount=10  
+
+```
+|                     Method |       Mean |     Error |    StdDev |  Gen 0 | Allocated |
+|--------------------------- |-----------:|----------:|----------:|-------:|----------:|
+|                 UsingSplit | 1,197.6 ns | 11.929 ns | 25.933 ns | 0.9251 |    1456 B |
+| UsingSpanWithStringBuilder | 1,542.0 ns | 15.249 ns | 33.792 ns | 0.9460 |    1488 B |
+|       UsingSpanWithNoAlloc |   272.6 ns |  2.265 ns |  5.018 ns | 0.0863 |     136 B |

benchmarks/BenchmarkDotNet.Artifacts/results/Benchmarks.RequestMiddleware.ContainsMediaTypeParameters_Benchmarks-report-github.md

@@ -0,0 +1,14 @@
+``` ini
+
+BenchmarkDotNet=v0.10.10, OS=Mac OS X 10.12
+Processor=Intel Core i5-5257U CPU 2.70GHz (Broadwell), ProcessorCount=4
+.NET Core SDK=2.1.4
+  [Host]     : .NET Core 2.0.5 (Framework 4.6.0.0), 64bit RyuJIT
+  DefaultJob : .NET Core 2.0.5 (Framework 4.6.0.0), 64bit RyuJIT
+
+
+```
+|     Method |      Mean |     Error |    StdDev |  Gen 0 | Allocated |
+|----------- |----------:|----------:|----------:|-------:|----------:|
+| UsingSplit | 157.28 ns | 2.9689 ns | 5.8602 ns | 0.2134 |     336 B |
+|    Current |  39.96 ns | 0.6489 ns | 0.6070 ns |      - |       0 B |

benchmarks/JsonApiContext/PathIsRelationship_Benchmarks.cs

@@ -0,0 +1,24 @@
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Attributes.Exporters;
+
+namespace Benchmarks.JsonApiContext
+{
+    [MarkdownExporter, MemoryDiagnoser]
+    public class PathIsRelationship_Benchmarks
+    {
+        private const string PATH = "https://example.com/api/v1/namespace/articles/relationships/author/";
+
+        [Benchmark]
+        public void Current() 
+            => JsonApiDotNetCore.Services.JsonApiContext.PathIsRelationship(PATH);
+
+        [Benchmark]
+        public void UsingSplit() => UsingSplitImpl(PATH);
+
+        private bool UsingSplitImpl(string path)
+        {
+            var split = path.Split('/');
+            return split[split.Length - 2] == "relationships";
+        }
+    }
+}

benchmarks/LinkBuilder/LinkBuilder_ GetNamespaceFromPath_Benchmarks.cs

@@ -0,0 +1,38 @@
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Attributes.Exporters;
+using BenchmarkDotNet.Attributes.Jobs;
+
+namespace Benchmarks.LinkBuilder
+{
+    [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";
+        private const string ENTITY_NAME = "articles";
+
+        [Benchmark]
+        public void UsingSplit() => GetNamespaceFromPath_BySplitting(PATH, ENTITY_NAME);
+
+        [Benchmark]
+        public void Current() => GetNameSpaceFromPath_Current(PATH, ENTITY_NAME);
+
+        public static string GetNamespaceFromPath_BySplitting(string path, string entityName)
+        {
+            var nSpace = string.Empty;
+            var segments = path.Split('/');
+
+            for (var i = 1; i < segments.Length; i++)
+            {
+                if (segments[i].ToLower() == entityName)
+                    break;
+
+                nSpace += $"/{segments[i]}";
+            }
+
+            return nSpace;
+        }
+
+        public static string GetNameSpaceFromPath_Current(string path, string entityName)
+            => JsonApiDotNetCore.Builders.LinkBuilder.GetNamespaceFromPath(path, entityName);
+    }
+}

benchmarks/Program.cs

@@ -1,5 +1,8 @@
 using BenchmarkDotNet.Running;
+using Benchmarks.JsonApiContext;
+using Benchmarks.LinkBuilder;
 using Benchmarks.Query;
+using Benchmarks.RequestMiddleware;
 using Benchmarks.Serialization;
 
 namespace Benchmarks {
@@ -8,7 +11,10 @@ static void Main(string[] args) {
             var switcher = new BenchmarkSwitcher(new[] {
                 typeof(JsonApiDeserializer_Benchmarks),
                 typeof(JsonApiSerializer_Benchmarks),
-                typeof(QueryParser_Benchmarks)
+                typeof(QueryParser_Benchmarks),
+                typeof(LinkBuilder_GetNamespaceFromPath_Benchmarks),
+                typeof(ContainsMediaTypeParameters_Benchmarks),
+                typeof(PathIsRelationship_Benchmarks)
             });
             switcher.Run(args);
         }

benchmarks/RequestMiddleware/ContainsMediaTypeParameters_Benchmarks.cs

@@ -0,0 +1,25 @@
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Attributes.Exporters;
+using JsonApiDotNetCore.Internal;
+
+namespace Benchmarks.RequestMiddleware
+{
+    [MarkdownExporter, MemoryDiagnoser]
+    public class ContainsMediaTypeParameters_Benchmarks
+    {
+        private const string MEDIA_TYPE = "application/vnd.api+json; version=1";
+
+        [Benchmark]
+        public void UsingSplit() => UsingSplitImpl(MEDIA_TYPE);
+
+        [Benchmark]
+        public void Current() 
+            => JsonApiDotNetCore.Middleware.RequestMiddleware.ContainsMediaTypeParameters(MEDIA_TYPE);
+
+        private bool UsingSplitImpl(string mediaType)
+        {
+            var mediaTypeArr = mediaType.Split(';');
+            return (mediaTypeArr[0] ==  Constants.ContentType && mediaTypeArr.Length == 2);	
+        }
+    }
+}