master → develop

.github/CONTRIBUTING.MD

@@ -0,0 +1,41 @@
+# Contributing
+
+## 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
+
+## 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.
+
+# Backporting Features To Prior Releases
+
+To backport a feature that has been approved and merged into `master`:
+
+## Requester
+
+Open an issue requesting the feature you would like backported. The change will be reviewed based on: 
+
+- compatibility
+- difficulty in porting the change 
+- the added value the feature provides for users on the older versions
+- how difficult it is for users to migrate from the older version to the newer version
+
+## Maintainer
+
+- Checkout the version you want to apply the feature on top of and create a new branch to release the new version:
+  ```
+  git checkout tags/v2.5.1 -b release/2.5.2
+  ```
+- Cherrypick the merge commit: `git cherry-pick {git commit SHA}`
+- Bump the package version in the csproj
+- Make any other compatibility, documentation or tooling related changes
+- Push the branch to origin and verify the build
+- Once the build is verified, create a GitHub release, tagging the release branch
+- Open a PR back to master with any other additions

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,8 @@
+## Description
+
+...
+
+## Environment
+
+- JsonApiDotNetCore Version: 
+- Other Relevant Package Versions:

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+
+
+Closes #{ISSUE_NUMBER}
+
+#### BUG FIX
+- [ ] reproduce issue in tests
+- [ ] fix issue
+- [ ] bump package version
+
+#### FEATURE
+- [ ] write tests that address the requirements outlined in the issue
+- [ ] fulfill the feature requirements
+- [ ] bump package version
+
+#### RELATED REPOSITORY UPDATES
+- does this feature require documentation? if so, open an issue in the [docs repo](https://github.com/json-api-dotnet/json-api-dotnet.github.io/issues/new)
+- does this feature break an API that is implemented in the templates repository? if so, [open an issue](https://github.com/json-api-dotnet/Templates/issues/new)

Build.ps1

@@ -23,6 +23,9 @@ $revision = "{0:D4}" -f [convert]::ToInt32($revision, 10)
 
 dotnet restore
 
+dotnet build ./src/Examples/GettingStarted/GettingStarted.csproj
+CheckLastExitCode
+
 dotnet test ./test/UnitTests/UnitTests.csproj
 CheckLastExitCode
 
@@ -35,7 +38,13 @@ CheckLastExitCode
 dotnet test ./test/OperationsExampleTests/OperationsExampleTests.csproj
 CheckLastExitCode
 
-dotnet build .\src\JsonApiDotNetCore -c Release
+dotnet test ./test/ResourceEntitySeparationExampleTests/ResourceEntitySeparationExampleTests.csproj
+CheckLastExitCode
+
+dotnet test ./test/DiscoveryTests/DiscoveryTests.csproj
+CheckLastExitCode
+
+dotnet build ./src/JsonApiDotNetCore/JsonApiDotNetCore.csproj -c Release
 CheckLastExitCode
 
 Write-Output "APPVEYOR_REPO_TAG: $env:APPVEYOR_REPO_TAG"

JsonApiDotnetCore.sln

@@ -1,4 +1,4 @@
-Microsoft Visual Studio Solution File, Format Version 12.00
+Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 15
 VisualStudioVersion = 15.0.27130.2010
 MinimumVisualStudioVersion = 10.0.40219.1
@@ -45,6 +45,10 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ResourceEntitySeparationExa
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ResourceEntitySeparationExampleTests", "test\ResourceEntitySeparationExampleTests\ResourceEntitySeparationExampleTests.csproj", "{6DFA30D7-1679-4333-9779-6FB678E48EF5}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GettingStarted", "src\Examples\GettingStarted\GettingStarted.csproj", "{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DiscoveryTests", "test\DiscoveryTests\DiscoveryTests.csproj", "{09C0C8D8-B721-4955-8889-55CB149C3B5C}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -187,6 +191,30 @@ Global
 		{6DFA30D7-1679-4333-9779-6FB678E48EF5}.Release|x64.Build.0 = Release|Any CPU
 		{6DFA30D7-1679-4333-9779-6FB678E48EF5}.Release|x86.ActiveCfg = Release|Any CPU
 		{6DFA30D7-1679-4333-9779-6FB678E48EF5}.Release|x86.Build.0 = Release|Any CPU
+		{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Debug|x64.Build.0 = Debug|Any CPU
+		{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Debug|x86.Build.0 = Debug|Any CPU
+		{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Release|Any CPU.Build.0 = Release|Any CPU
+		{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Release|x64.ActiveCfg = Release|Any CPU
+		{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Release|x64.Build.0 = Release|Any CPU
+		{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Release|x86.ActiveCfg = Release|Any CPU
+		{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Release|x86.Build.0 = Release|Any CPU
+		{09C0C8D8-B721-4955-8889-55CB149C3B5C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{09C0C8D8-B721-4955-8889-55CB149C3B5C}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{09C0C8D8-B721-4955-8889-55CB149C3B5C}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{09C0C8D8-B721-4955-8889-55CB149C3B5C}.Debug|x64.Build.0 = Debug|Any CPU
+		{09C0C8D8-B721-4955-8889-55CB149C3B5C}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{09C0C8D8-B721-4955-8889-55CB149C3B5C}.Debug|x86.Build.0 = Debug|Any CPU
+		{09C0C8D8-B721-4955-8889-55CB149C3B5C}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{09C0C8D8-B721-4955-8889-55CB149C3B5C}.Release|Any CPU.Build.0 = Release|Any CPU
+		{09C0C8D8-B721-4955-8889-55CB149C3B5C}.Release|x64.ActiveCfg = Release|Any CPU
+		{09C0C8D8-B721-4955-8889-55CB149C3B5C}.Release|x64.Build.0 = Release|Any CPU
+		{09C0C8D8-B721-4955-8889-55CB149C3B5C}.Release|x86.ActiveCfg = Release|Any CPU
+		{09C0C8D8-B721-4955-8889-55CB149C3B5C}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -205,6 +233,8 @@ Global
 		{9CD2C116-D133-4FE4-97DA-A9FEAFF045F1} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
 		{F4097194-9415-418A-AB4E-315C5D5466AF} = {026FBC6C-AF76-4568-9B87-EC73457899FD}
 		{6DFA30D7-1679-4333-9779-6FB678E48EF5} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
+		{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71} = {026FBC6C-AF76-4568-9B87-EC73457899FD}
+		{09C0C8D8-B721-4955-8889-55CB149C3B5C} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {A2421882-8F0A-4905-928F-B550B192F9A4}

README.md

@@ -75,3 +75,39 @@ public class Startup
     }
 }
 ```
+
+### Development
+
+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: 
+
+```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
+```
+
+And then to run the tests:
+
+```bash
+dotnet test
+```
+
+#### Cleaning
+
+Sometimes the compiled files can be dirty / corrupt from other branches / failed builds.
+
+```bash
+dotnet clean
+```

appveyor.yml

@@ -18,6 +18,7 @@ branches:
   - master
   - develop
   - unstable
+  - /release\/.+/
 
 nuget:
   disable_publish_on_pr: true
@@ -38,6 +39,7 @@ test: off
 artifacts:
 - path: .\**\artifacts\**\*.nupkg
   name: NuGet
+
 deploy:
 - provider: NuGet
   server: https://www.myget.org/F/research-institute/api/v2/package
@@ -47,17 +49,28 @@ deploy:
   symbol_server: https://www.myget.org/F/research-institute/symbols/api/v2/package
   on:
     branch: develop
+
 - provider: NuGet
   server: https://www.myget.org/F/jadnc/api/v2/package
   api_key:
     secure: 6CeYcZ4Ze+57gxfeuHzqP6ldbUkPtF6pfpVM1Gw/K2jExFrAz763gNAQ++tiacq3
   skip_symbols: false
   on:
     branch: unstable
+
 - provider: NuGet
   name: production
+  skip_symbols: false
   api_key:
     secure: /fsEOgG4EdtNd6DPmko9h3NxQwx1IGDcFreGTKd2KA56U2KEkpX/L/pCGpCIEf2s
   on:
     branch: master
     appveyor_repo_tag: true
+
+- provider: NuGet
+  skip_symbols: false
+  api_key:
+    secure: /fsEOgG4EdtNd6DPmko9h3NxQwx1IGDcFreGTKd2KA56U2KEkpX/L/pCGpCIEf2s
+  on:
+    branch: /release\/.+/
+    appveyor_repo_tag: true

benchmarks/Serialization/JsonApiDeserializer_Benchmarks.cs

@@ -17,7 +17,7 @@ namespace Benchmarks.Serialization {
     public class JsonApiDeserializer_Benchmarks {
         private const string TYPE_NAME = "simple-types";
         private static readonly string Content = JsonConvert.SerializeObject(new Document {
-            Data = new DocumentData {
+            Data = new ResourceObject {
                 Type = TYPE_NAME,
                     Id = "1",
                     Attributes = new Dictionary<string, object> {

build.sh

@@ -9,3 +9,4 @@ dotnet test ./test/UnitTests/UnitTests.csproj
 dotnet test ./test/JsonApiDotNetCoreExampleTests/JsonApiDotNetCoreExampleTests.csproj
 dotnet test ./test/NoEntityFrameworkTests/NoEntityFrameworkTests.csproj
 dotnet test ./test/OperationsExampleTests/OperationsExampleTests.csproj
+dotnet test ./test/ResourceEntitySeparationExampleTests/ResourceEntitySeparationExampleTests.csproj

src/Examples/GettingStarted/.gitignore

@@ -0,0 +1 @@
+*.db

src/Examples/GettingStarted/Controllers/ArticlesController.cs

@@ -0,0 +1,15 @@
+using GettingStarted.Models;
+using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.Services;
+
+namespace GettingStarted
+{
+    public class ArticlesController : JsonApiController<Article>
+    {
+        public ArticlesController(
+          IJsonApiContext jsonApiContext,
+          IResourceService<Article> resourceService)
+          : base(jsonApiContext, resourceService)
+        { }
+    }
+}

src/Examples/GettingStarted/Controllers/PeopleController.cs

@@ -0,0 +1,15 @@
+using GettingStarted.Models;
+using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.Services;
+
+namespace GettingStarted
+{
+    public class PeopleController : JsonApiController<Person>
+    {
+        public PeopleController(
+          IJsonApiContext jsonApiContext,
+          IResourceService<Person> resourceService)
+          : base(jsonApiContext, resourceService)
+        { }
+    }
+}

src/Examples/GettingStarted/Data/SampleDbContext.cs

@@ -0,0 +1,17 @@
+using GettingStarted.Models;
+using GettingStarted.ResourceDefinitionExample;
+using Microsoft.EntityFrameworkCore;
+
+namespace GettingStarted
+{
+    public class SampleDbContext : DbContext
+    {
+        public SampleDbContext(DbContextOptions<SampleDbContext> options)
+        : base(options)
+        { }
+
+        public DbSet<Article> Articles { get; set; }
+        public DbSet<Person> People { get; set; }
+        public DbSet<Model> Models { get; set; }
+    }
+}

src/Examples/GettingStarted/GettingStarted.csproj

@@ -0,0 +1,21 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp2.0</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Folder Include="wwwroot\" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="../../JsonApiDotNetCore/JsonApiDotNetCore.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore" Version="2.1.0" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore" Version="2.1.0" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="2.1.0" />
+  </ItemGroup>
+
+</Project>

src/Examples/GettingStarted/Models/Article.cs

@@ -0,0 +1,14 @@
+using JsonApiDotNetCore.Models;
+
+namespace GettingStarted.Models
+{
+    public class Article : Identifiable
+    {
+        [Attr]
+        public string Title { get; set; }
+
+        [HasOne]
+        public Person Author { get; set; }
+        public int AuthorId { get; set; }
+    }
+}

src/Examples/GettingStarted/Models/Person.cs

@@ -0,0 +1,14 @@
+using System.Collections.Generic;
+using JsonApiDotNetCore.Models;
+
+namespace GettingStarted.Models
+{
+    public class Person : Identifiable
+    {
+        [Attr] 
+        public string Name { get; set; }
+
+        [HasMany] 
+        public List<Article> Articles { get; set; }
+    }
+}