Annotated example projects

Bart Koelman · Bart Koelman · commit 2640675abd18 · 2021-10-16T01:23:31.000+02:00
diff --git a/src/Examples/GettingStarted/Controllers/BooksController.cs b/src/Examples/GettingStarted/Controllers/BooksController.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using GettingStarted.Models;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
diff --git a/src/Examples/GettingStarted/Controllers/PeopleController.cs b/src/Examples/GettingStarted/Controllers/PeopleController.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using GettingStarted.Models;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
diff --git a/src/Examples/GettingStarted/Data/SampleDbContext.cs b/src/Examples/GettingStarted/Data/SampleDbContext.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using GettingStarted.Models;
 using JetBrains.Annotations;
 using Microsoft.EntityFrameworkCore;
@@ -9,16 +7,11 @@ namespace GettingStarted.Data
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
     public class SampleDbContext : DbContext
     {
-        public DbSet<Book> Books { get; set; }
+        public DbSet<Book> Books => Set<Book>();
 
         public SampleDbContext(DbContextOptions<SampleDbContext> options)
             : base(options)
         {
         }
-
-        protected override void OnModelCreating(ModelBuilder builder)
-        {
-            builder.Entity<Person>();
-        }
     }
 }
diff --git a/src/Examples/GettingStarted/Models/Book.cs b/src/Examples/GettingStarted/Models/Book.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
@@ -10,12 +8,12 @@ namespace GettingStarted.Models
     public sealed class Book : Identifiable<int>
     {
         [Attr]
-        public string Title { get; set; }
+        public string Title { get; set; } = null!;
 
         [Attr]
         public int PublishYear { get; set; }
 
         [HasOne]
-        public Person Author { get; set; }
+        public Person Author { get; set; } = null!;
     }
 }
diff --git a/src/Examples/GettingStarted/Models/Person.cs b/src/Examples/GettingStarted/Models/Person.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using System.Collections.Generic;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
@@ -11,9 +9,9 @@ namespace GettingStarted.Models
     public sealed class Person : Identifiable<int>
     {
         [Attr]
-        public string Name { get; set; }
+        public string Name { get; set; } = null!;
 
         [HasMany]
-        public ICollection<Book> Books { get; set; }
+        public ICollection<Book> Books { get; set; } = new List<Book>();
     }
 }
diff --git a/src/Examples/GettingStarted/Program.cs b/src/Examples/GettingStarted/Program.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Hosting;
 
diff --git a/src/Examples/GettingStarted/Startup.cs b/src/Examples/GettingStarted/Startup.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using GettingStarted.Data;
 using GettingStarted.Models;
 using JetBrains.Annotations;
diff --git a/src/Examples/JsonApiDotNetCoreExample/Controllers/NonJsonApiController.cs b/src/Examples/JsonApiDotNetCoreExample/Controllers/NonJsonApiController.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using System.IO;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Mvc;
diff --git a/src/Examples/JsonApiDotNetCoreExample/Controllers/OperationsController.cs b/src/Examples/JsonApiDotNetCoreExample/Controllers/OperationsController.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JsonApiDotNetCore.AtomicOperations;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
diff --git a/src/Examples/JsonApiDotNetCoreExample/Controllers/PeopleController.cs b/src/Examples/JsonApiDotNetCoreExample/Controllers/PeopleController.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
diff --git a/src/Examples/JsonApiDotNetCoreExample/Controllers/TagsController.cs b/src/Examples/JsonApiDotNetCoreExample/Controllers/TagsController.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
diff --git a/src/Examples/JsonApiDotNetCoreExample/Controllers/TodoItemsController.cs b/src/Examples/JsonApiDotNetCoreExample/Controllers/TodoItemsController.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
diff --git a/src/Examples/JsonApiDotNetCoreExample/Data/AppDbContext.cs b/src/Examples/JsonApiDotNetCoreExample/Data/AppDbContext.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JetBrains.Annotations;
 using JsonApiDotNetCoreExample.Models;
 using Microsoft.EntityFrameworkCore;
@@ -11,7 +9,7 @@ namespace JsonApiDotNetCoreExample.Data
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
     public sealed class AppDbContext : DbContext
     {
-        public DbSet<TodoItem> TodoItems { get; set; }
+        public DbSet<TodoItem> TodoItems => Set<TodoItem>();
 
         public AppDbContext(DbContextOptions<AppDbContext> options)
             : base(options)
@@ -23,7 +21,7 @@ protected override void OnModelCreating(ModelBuilder builder)
             // When deleting a person, un-assign him/her from existing todo items.
             builder.Entity<Person>()
                 .HasMany(person => person.AssignedTodoItems)
-                .WithOne(todoItem => todoItem.Assignee)
+                .WithOne(todoItem => todoItem.Assignee!)
                 .IsRequired(false)
                 .OnDelete(DeleteBehavior.SetNull);
 
diff --git a/src/Examples/JsonApiDotNetCoreExample/Definitions/TodoItemDefinition.cs b/src/Examples/JsonApiDotNetCoreExample/Definitions/TodoItemDefinition.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using System.ComponentModel;
 using System.Threading;
 using System.Threading.Tasks;
@@ -24,7 +22,7 @@ public TodoItemDefinition(IResourceGraph resourceGraph, ISystemClock systemClock
             _systemClock = systemClock;
         }
 
-        public override SortExpression OnApplySort(SortExpression existingSort)
+        public override SortExpression OnApplySort(SortExpression? existingSort)
         {
             return existingSort ?? GetDefaultSortOrder();
         }
diff --git a/src/Examples/JsonApiDotNetCoreExample/Models/Person.cs b/src/Examples/JsonApiDotNetCoreExample/Models/Person.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using System.Collections.Generic;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
@@ -11,12 +9,12 @@ namespace JsonApiDotNetCoreExample.Models
     public sealed class Person : Identifiable<int>
     {
         [Attr]
-        public string FirstName { get; set; }
+        public string? FirstName { get; set; }
 
         [Attr]
-        public string LastName { get; set; }
+        public string LastName { get; set; } = null!;
 
         [HasMany]
-        public ISet<TodoItem> AssignedTodoItems { get; set; }
+        public ISet<TodoItem> AssignedTodoItems { get; set; } = new HashSet<TodoItem>();
     }
 }
diff --git a/src/Examples/JsonApiDotNetCoreExample/Models/Tag.cs b/src/Examples/JsonApiDotNetCoreExample/Models/Tag.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using System.Collections.Generic;
 using System.ComponentModel.DataAnnotations;
 using JetBrains.Annotations;
@@ -11,12 +9,11 @@ namespace JsonApiDotNetCoreExample.Models
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
     public sealed class Tag : Identifiable<int>
     {
-        [Required]
         [MinLength(1)]
         [Attr]
-        public string Name { get; set; }
+        public string Name { get; set; } = null!;
 
         [HasMany]
-        public ISet<TodoItem> TodoItems { get; set; }
+        public ISet<TodoItem> TodoItems { get; set; } = new HashSet<TodoItem>();
     }
 }
diff --git a/src/Examples/JsonApiDotNetCoreExample/Models/TodoItem.cs b/src/Examples/JsonApiDotNetCoreExample/Models/TodoItem.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using System;
 using System.Collections.Generic;
 using JetBrains.Annotations;
@@ -12,7 +10,7 @@ namespace JsonApiDotNetCoreExample.Models
     public sealed class TodoItem : Identifiable<int>
     {
         [Attr]
-        public string Description { get; set; }
+        public string Description { get; set; } = null!;
 
         [Attr]
         public TodoItemPriority Priority { get; set; }
@@ -24,12 +22,12 @@ public sealed class TodoItem : Identifiable<int>
         public DateTimeOffset? LastModifiedAt { get; set; }
 
         [HasOne]
-        public Person Owner { get; set; }
+        public Person Owner { get; set; } = null!;
 
         [HasOne]
-        public Person Assignee { get; set; }
+        public Person? Assignee { get; set; }
 
         [HasMany]
-        public ISet<Tag> Tags { get; set; }
+        public ISet<Tag> Tags { get; set; } = new HashSet<Tag>();
     }
 }
diff --git a/src/Examples/JsonApiDotNetCoreExample/Models/TodoItemPriority.cs b/src/Examples/JsonApiDotNetCoreExample/Models/TodoItemPriority.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JetBrains.Annotations;
 
 namespace JsonApiDotNetCoreExample.Models
diff --git a/src/Examples/JsonApiDotNetCoreExample/Program.cs b/src/Examples/JsonApiDotNetCoreExample/Program.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Hosting;
 
diff --git a/src/Examples/JsonApiDotNetCoreExample/Startup.cs b/src/Examples/JsonApiDotNetCoreExample/Startup.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using System;
 using System.Text.Json.Serialization;
 using JsonApiDotNetCore.Configuration;
diff --git a/src/Examples/MultiDbContextExample/Controllers/ResourceAsController.cs b/src/Examples/MultiDbContextExample/Controllers/ResourceAsController.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
diff --git a/src/Examples/MultiDbContextExample/Controllers/ResourceBsController.cs b/src/Examples/MultiDbContextExample/Controllers/ResourceBsController.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
diff --git a/src/Examples/MultiDbContextExample/Data/DbContextA.cs b/src/Examples/MultiDbContextExample/Data/DbContextA.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JetBrains.Annotations;
 using Microsoft.EntityFrameworkCore;
 using MultiDbContextExample.Models;
@@ -9,7 +7,7 @@ namespace MultiDbContextExample.Data
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
     public sealed class DbContextA : DbContext
     {
-        public DbSet<ResourceA> ResourceAs { get; set; }
+        public DbSet<ResourceA> ResourceAs => Set<ResourceA>();
 
         public DbContextA(DbContextOptions<DbContextA> options)
             : base(options)
diff --git a/src/Examples/MultiDbContextExample/Data/DbContextB.cs b/src/Examples/MultiDbContextExample/Data/DbContextB.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JetBrains.Annotations;
 using Microsoft.EntityFrameworkCore;
 using MultiDbContextExample.Models;
@@ -9,7 +7,7 @@ namespace MultiDbContextExample.Data
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
     public sealed class DbContextB : DbContext
     {
-        public DbSet<ResourceB> ResourceBs { get; set; }
+        public DbSet<ResourceB> ResourceBs => Set<ResourceB>();
 
         public DbContextB(DbContextOptions<DbContextB> options)
             : base(options)
diff --git a/src/Examples/MultiDbContextExample/Models/ResourceA.cs b/src/Examples/MultiDbContextExample/Models/ResourceA.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
@@ -10,6 +8,6 @@ namespace MultiDbContextExample.Models
     public sealed class ResourceA : Identifiable<int>
     {
         [Attr]
-        public string NameA { get; set; }
+        public string? NameA { get; set; }
     }
 }
diff --git a/src/Examples/MultiDbContextExample/Models/ResourceB.cs b/src/Examples/MultiDbContextExample/Models/ResourceB.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
@@ -10,6 +8,6 @@ namespace MultiDbContextExample.Models
     public sealed class ResourceB : Identifiable<int>
     {
         [Attr]
-        public string NameB { get; set; }
+        public string? NameB { get; set; }
     }
 }
diff --git a/src/Examples/MultiDbContextExample/Program.cs b/src/Examples/MultiDbContextExample/Program.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Hosting;
 
diff --git a/src/Examples/MultiDbContextExample/Properties/launchSettings.json b/src/Examples/MultiDbContextExample/Properties/launchSettings.json
@@ -1,4 +1,4 @@
-﻿{
+{
   "$schema": "http://json.schemastore.org/launchsettings.json",
   "iisSettings": {
     "windowsAuthentication": false,
@@ -12,15 +12,15 @@
     "IIS Express": {
       "commandName": "IISExpress",
       "launchBrowser": false,
-      "launchUrl": "/resourceBs",
+      "launchUrl": "resourceBs",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
       }
     },
     "Kestrel": {
       "commandName": "Project",
       "launchBrowser": false,
-      "launchUrl": "/resourceBs",
+      "launchUrl": "resourceBs",
       "applicationUrl": "https://localhost:44350;http://localhost:14150",
       "environmentVariables": {
         "ASPNETCORE_ENVIRONMENT": "Development"
diff --git a/src/Examples/MultiDbContextExample/Repositories/DbContextARepository.cs b/src/Examples/MultiDbContextExample/Repositories/DbContextARepository.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using System.Collections.Generic;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
diff --git a/src/Examples/MultiDbContextExample/Repositories/DbContextBRepository.cs b/src/Examples/MultiDbContextExample/Repositories/DbContextBRepository.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using System.Collections.Generic;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
diff --git a/src/Examples/MultiDbContextExample/Startup.cs b/src/Examples/MultiDbContextExample/Startup.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
 using Microsoft.AspNetCore.Builder;
diff --git a/src/Examples/NoEntityFrameworkExample/Controllers/WorkItemsController.cs b/src/Examples/NoEntityFrameworkExample/Controllers/WorkItemsController.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
diff --git a/src/Examples/NoEntityFrameworkExample/Data/AppDbContext.cs b/src/Examples/NoEntityFrameworkExample/Data/AppDbContext.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using JetBrains.Annotations;
 using Microsoft.EntityFrameworkCore;
 using NoEntityFrameworkExample.Models;
@@ -9,7 +7,7 @@ namespace NoEntityFrameworkExample.Data
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
     public sealed class AppDbContext : DbContext
     {
-        public DbSet<WorkItem> WorkItems { get; set; }
+        public DbSet<WorkItem> WorkItems => Set<WorkItem>();
 
         public AppDbContext(DbContextOptions<AppDbContext> options)
             : base(options)
diff --git a/src/Examples/NoEntityFrameworkExample/Models/WorkItem.cs b/src/Examples/NoEntityFrameworkExample/Models/WorkItem.cs
diff --git a/src/Examples/NoEntityFrameworkExample/Program.cs b/src/Examples/NoEntityFrameworkExample/Program.cs
diff --git a/src/Examples/NoEntityFrameworkExample/Properties/launchSettings.json b/src/Examples/NoEntityFrameworkExample/Properties/launchSettings.json
diff --git a/src/Examples/NoEntityFrameworkExample/Services/WorkItemService.cs b/src/Examples/NoEntityFrameworkExample/Services/WorkItemService.cs
diff --git a/src/Examples/NoEntityFrameworkExample/Startup.cs b/src/Examples/NoEntityFrameworkExample/Startup.cs
diff --git a/src/Examples/ReportsExample/Controllers/ReportsController.cs b/src/Examples/ReportsExample/Controllers/ReportsController.cs
diff --git a/src/Examples/ReportsExample/Models/Report.cs b/src/Examples/ReportsExample/Models/Report.cs
diff --git a/src/Examples/ReportsExample/Models/ReportStatistics.cs b/src/Examples/ReportsExample/Models/ReportStatistics.cs
diff --git a/src/Examples/ReportsExample/Program.cs b/src/Examples/ReportsExample/Program.cs
diff --git a/src/Examples/ReportsExample/Properties/launchSettings.json b/src/Examples/ReportsExample/Properties/launchSettings.json
diff --git a/src/Examples/ReportsExample/Services/ReportService.cs b/src/Examples/ReportsExample/Services/ReportService.cs
diff --git a/src/Examples/ReportsExample/Startup.cs b/src/Examples/ReportsExample/Startup.cs
diff --git a/test/NoEntityFrameworkTests/WorkItemTests.cs b/test/NoEntityFrameworkTests/WorkItemTests.cs

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-#nullable disable`
`2`		`-`
`3`	`1`	`using GettingStarted.Models;`
`4`	`2`	`using JsonApiDotNetCore.Configuration;`
`5`	`3`	`using JsonApiDotNetCore.Controllers;`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-#nullable disable`
`2`		`-`
`3`	`1`	`using JetBrains.Annotations;`
`4`	`2`	`using JsonApiDotNetCore.Resources;`
`5`	`3`	`using JsonApiDotNetCore.Resources.Annotations;`
`@@ -10,12 +8,12 @@ namespace GettingStarted.Models`
`10`	`8`	`public sealed class Book : Identifiable<int>`
`11`	`9`	`{`
`12`	`10`	`[Attr]`
`13`		`- public string Title { get; set; }`
	`11`	`+ public string Title { get; set; } = null!;`
`14`	`12`
`15`	`13`	`[Attr]`
`16`	`14`	`public int PublishYear { get; set; }`
`17`	`15`
`18`	`16`	`[HasOne]`
`19`		`- public Person Author { get; set; }`
	`17`	`+ public Person Author { get; set; } = null!;`
`20`	`18`	`}`
`21`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-#nullable disable`
`2`		`-`
`3`	`1`	`using System.Collections.Generic;`
`4`	`2`	`using JetBrains.Annotations;`
`5`	`3`	`using JsonApiDotNetCore.Resources;`
`@@ -11,9 +9,9 @@ namespace GettingStarted.Models`
`11`	`9`	`public sealed class Person : Identifiable<int>`
`12`	`10`	`{`
`13`	`11`	`[Attr]`
`14`		`- public string Name { get; set; }`
	`12`	`+ public string Name { get; set; } = null!;`
`15`	`13`
`16`	`14`	`[HasMany]`
`17`		`- public ICollection<Book> Books { get; set; }`
	`15`	`+ public ICollection<Book> Books { get; set; } = new List<Book>();`
`18`	`16`	`}`
`19`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-#nullable disable`
`2`		`-`
`3`	`1`	`using Microsoft.AspNetCore.Hosting;`
`4`	`2`	`using Microsoft.Extensions.Hosting;`
`5`	`3`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-#nullable disable`
`2`		`-`
`3`	`1`	`using GettingStarted.Data;`
`4`	`2`	`using GettingStarted.Models;`
`5`	`3`	`using JetBrains.Annotations;`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-#nullable disable`
`2`		`-`
`3`	`1`	`using System.IO;`
`4`	`2`	`using System.Threading.Tasks;`
`5`	`3`	`using Microsoft.AspNetCore.Mvc;`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-#nullable disable`
`2`		`-`
`3`	`1`	`using JsonApiDotNetCore.AtomicOperations;`
`4`	`2`	`using JsonApiDotNetCore.Configuration;`
`5`	`3`	`using JsonApiDotNetCore.Controllers;`