Merge branch 'release/5.2.0' into master

OnTopic Editor 5.2.0 is a very minor update, which doesn't introduce any new public-facing features, but does make a number of performance improvements, such as reducing the amount of mapping that needs to be performed for each topic by relying on the new lightweight `PermittedContentType` view model (#50) and supporting the new `AttributeDictionary` constructor for view models (#49). In addition, it also includes a number of internal code improvements, such as adoption of new C# 10 capabilities (#52), including global using directives (#53). See Pull Request #57 for details.
OnTopicCMS · Jun 26, 2022 · ef23c1f · ef23c1f
2 parents 3b468d3 + 12ea593
commit ef23c1f
Show file tree

Hide file tree

Showing 113 changed files with 9,207 additions and 7,602 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,19 +1,20 @@
 <Project>
 
   <PropertyGroup>
-    <LangVersion>9.0</LangVersion>
+    <LangVersion>10.0</LangVersion>
     <AddRazorSupportForMvc>true</AddRazorSupportForMvc>
     <Nullable>enable</Nullable>
     <AnalysisLevel>latest</AnalysisLevel>
     <AnalysisMode>AllEnabledByDefault</AnalysisMode>
+    <ImplicitUsings>enable</ImplicitUsings>
     <NoWarn>NU5118</NoWarn>
   </PropertyGroup>
 
   <PropertyGroup>
     <Product>OnTopic</Product>
     <Authors>Ignia</Authors>
     <Company>Ignia</Company>
-    <Copyright>©2021 Ignia, LLC</Copyright>
+    <Copyright>©2022 Ignia, LLC</Copyright>
     <PackageProjectUrl>https://github.com/Ignia/Topic-Editor-MVC/</PackageProjectUrl>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <UseFullSemVerForNuGet>true</UseFullSemVerForNuGet>

diff --git a/OnTopic.Editor.AspNetCore.All/Properties/AssemblyInfo.cs b/OnTopic.Editor.AspNetCore.All/Properties/AssemblyInfo.cs
@@ -3,7 +3,6 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using System;
 using System.Runtime.InteropServices;
 
 /*==============================================================================================================================

diff --git a/OnTopic.Editor.AspNetCore.Attributes/BooleanAttribute/BooleanAttributeBindingModel.cs b/OnTopic.Editor.AspNetCore.Attributes/BooleanAttribute/BooleanAttributeBindingModel.cs
@@ -3,7 +3,6 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using OnTopic.Editor.AspNetCore.Models;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.BooleanAttribute {
 

diff --git a/OnTopic.Editor.AspNetCore.Attributes/BooleanAttribute/BooleanAttributeDescriptor.cs b/OnTopic.Editor.AspNetCore.Attributes/BooleanAttribute/BooleanAttributeDescriptor.cs
@@ -3,7 +3,6 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using OnTopic.Metadata;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.BooleanAttribute {
 

diff --git a/OnTopic.Editor.AspNetCore.Attributes/BooleanAttribute/BooleanAttributeDescriptorViewModel.cs b/OnTopic.Editor.AspNetCore.Attributes/BooleanAttribute/BooleanAttributeDescriptorViewModel.cs
@@ -3,7 +3,6 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using OnTopic.Editor.AspNetCore.Models.Metadata;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.BooleanAttribute {
 
@@ -15,6 +14,19 @@ namespace OnTopic.Editor.AspNetCore.Attributes.BooleanAttribute {
   /// </summary>
   public record BooleanAttributeDescriptorViewModel: AttributeDescriptorViewModel {
 
+    /*==========================================================================================================================
+    | CONSTRUCTOR
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Initializes a new <see cref="BooleanAttributeDescriptorViewModel"/> with an <paramref name="attributes"/> dictionary.
+    /// </summary>
+    /// <param name="attributes">An <see cref="AttributeDictionary"/> of attribute values.</param>
+    public BooleanAttributeDescriptorViewModel(AttributeDictionary attributes): base(attributes) { }
+
+    /// <summary>
+    ///   Initializes a new instance of the <see cref="BooleanAttributeDescriptorViewModel"/> class.
+    /// </summary>
+    public BooleanAttributeDescriptorViewModel(): base() {}
 
   } //Class
 } //Namespace
diff --git a/OnTopic.Editor.AspNetCore.Attributes/BooleanAttribute/BooleanAttributeViewModel.cs b/OnTopic.Editor.AspNetCore.Attributes/BooleanAttribute/BooleanAttributeViewModel.cs
@@ -3,10 +3,7 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using System;
 using System.Diagnostics.CodeAnalysis;
-using OnTopic.Editor.AspNetCore.Models;
-using OnTopic.Editor.AspNetCore.Models.Metadata;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.BooleanAttribute {
 

diff --git a/OnTopic.Editor.AspNetCore.Attributes/BooleanAttribute/BooleanViewComponent.cs b/OnTopic.Editor.AspNetCore.Attributes/BooleanAttribute/BooleanViewComponent.cs
@@ -3,9 +3,7 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using Microsoft.AspNetCore.Mvc;
 using OnTopic.AspNetCore.Mvc.Components;
-using OnTopic.Editor.AspNetCore.Models;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.BooleanAttribute {
 

diff --git a/OnTopic.Editor.AspNetCore.Attributes/DateTimeAttribute/DateTimeAttributeDescriptor.cs b/OnTopic.Editor.AspNetCore.Attributes/DateTimeAttribute/DateTimeAttributeDescriptor.cs
@@ -3,7 +3,6 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using OnTopic.Metadata;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.DateTimeAttribute {
 

diff --git a/...ic.Editor.AspNetCore.Attributes/DateTimeAttribute/DateTimeAttributeDescriptorViewModel.cs b/...ic.Editor.AspNetCore.Attributes/DateTimeAttribute/DateTimeAttributeDescriptorViewModel.cs
@@ -3,7 +3,6 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using OnTopic.Editor.AspNetCore.Models.Metadata;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.DateTimeAttribute {
 
@@ -15,6 +14,27 @@ namespace OnTopic.Editor.AspNetCore.Attributes.DateTimeAttribute {
   /// </summary>
   public record DateTimeAttributeDescriptorViewModel: AttributeDescriptorViewModel {
 
+    /*==========================================================================================================================
+    | CONSTRUCTOR
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Initializes a new <see cref="DateTimeAttributeDescriptorViewModel"/> with an <paramref name="attributes"/> dictionary.
+    /// </summary>
+    /// <param name="attributes">An <see cref="AttributeDictionary"/> of attribute values.</param>
+    public DateTimeAttributeDescriptorViewModel(AttributeDictionary attributes): base(attributes) {
+      Contract.Requires(attributes, nameof(attributes));
+      IncludeDatePicker         = attributes.GetBoolean(nameof(IncludeDatePicker));
+      IncludeTimePicker         = attributes.GetBoolean(nameof(IncludeTimePicker));
+      DateTimeOffset            = attributes.GetInteger(nameof(DateTimeOffset));
+      DateTimeOffsetUnits       = attributes.GetValue(nameof(DateTimeOffsetUnits))?? DateTimeOffsetUnits;
+
+    }
+
+    /// <summary>
+    ///   Initializes a new instance of the <see cref="DateTimeAttributeDescriptorViewModel"/> class.
+    /// </summary>
+    public DateTimeAttributeDescriptorViewModel() : base() { }
+
     /*==========================================================================================================================
     | INCLUDE DATE PICKER?
     \-------------------------------------------------------------------------------------------------------------------------*/

diff --git a/OnTopic.Editor.AspNetCore.Attributes/DateTimeAttribute/DateTimeAttributeViewModel.cs b/OnTopic.Editor.AspNetCore.Attributes/DateTimeAttribute/DateTimeAttributeViewModel.cs
@@ -3,10 +3,7 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using System;
 using System.Globalization;
-using OnTopic.Editor.AspNetCore.Models;
-using OnTopic.Editor.AspNetCore.Models.Metadata;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.DateTimeAttribute {
 

diff --git a/OnTopic.Editor.AspNetCore.Attributes/DateTimeAttribute/DateTimeViewComponent.cs b/OnTopic.Editor.AspNetCore.Attributes/DateTimeAttribute/DateTimeViewComponent.cs
@@ -3,10 +3,7 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using Microsoft.AspNetCore.Mvc;
 using OnTopic.AspNetCore.Mvc.Components;
-using OnTopic.Editor.AspNetCore.Models;
-using OnTopic.Internal.Diagnostics;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.DateTimeAttribute {
 

diff --git a/OnTopic.Editor.AspNetCore.Attributes/FileListAttribute/FileListAttributeDescriptor.cs b/OnTopic.Editor.AspNetCore.Attributes/FileListAttribute/FileListAttributeDescriptor.cs
@@ -3,7 +3,6 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using OnTopic.Metadata;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.FileListAttribute {
 

diff --git a/...ic.Editor.AspNetCore.Attributes/FileListAttribute/FileListAttributeDescriptorViewModel.cs b/...ic.Editor.AspNetCore.Attributes/FileListAttribute/FileListAttributeDescriptorViewModel.cs
@@ -3,7 +3,6 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using OnTopic.Editor.AspNetCore.Models.Metadata;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.FileListAttribute {
 
@@ -15,6 +14,26 @@ namespace OnTopic.Editor.AspNetCore.Attributes.FileListAttribute {
   /// </summary>
   public record FileListAttributeDescriptorViewModel: AttributeDescriptorViewModel {
 
+    /*==========================================================================================================================
+    | CONSTRUCTOR
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Initializes a new <see cref="FileListAttributeDescriptorViewModel"/> with an <paramref name="attributes"/> dictionary.
+    /// </summary>
+    /// <param name="attributes">An <see cref="AttributeDictionary"/> of attribute values.</param>
+    public FileListAttributeDescriptorViewModel(AttributeDictionary attributes): base(attributes) {
+      Contract.Requires(attributes, nameof(attributes));
+      Path                      = attributes.GetValue(nameof(Path));
+      Extension                 = attributes.GetValue(nameof(Extension));
+      Filter                    = attributes.GetValue(nameof(Filter));
+      IncludeSubdirectories     = attributes.GetBoolean(nameof(IncludeSubdirectories))?? false;
+    }
+
+    /// <summary>
+    ///   Initializes a new instance of the <see cref="FileListAttributeDescriptorViewModel"/> class.
+    /// </summary>
+    public FileListAttributeDescriptorViewModel() : base() { }
+
     /*==========================================================================================================================
     | PROPERTY: PATH
     \-------------------------------------------------------------------------------------------------------------------------*/

diff --git a/OnTopic.Editor.AspNetCore.Attributes/FileListAttribute/FileListAttributeViewModel.cs b/OnTopic.Editor.AspNetCore.Attributes/FileListAttribute/FileListAttributeViewModel.cs
@@ -3,11 +3,8 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using System.Collections.ObjectModel;
 using System.ComponentModel.DataAnnotations;
 using Microsoft.AspNetCore.Mvc.Rendering;
-using OnTopic.Editor.AspNetCore.Models;
-using OnTopic.Editor.AspNetCore.Models.Metadata;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.FileListAttribute {
 

diff --git a/OnTopic.Editor.AspNetCore.Attributes/FileListAttribute/FileListViewComponent.cs b/OnTopic.Editor.AspNetCore.Attributes/FileListAttribute/FileListViewComponent.cs
@@ -3,14 +3,8 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using System;
-using System.Collections.ObjectModel;
-using System.IO;
 using Microsoft.AspNetCore.Hosting;
-using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Rendering;
-using OnTopic.Editor.AspNetCore.Models;
-using OnTopic.Internal.Diagnostics;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.FileListAttribute {
 

diff --git a/OnTopic.Editor.AspNetCore.Attributes/FilePathAttribute/FilePathAttributeDescriptor.cs b/OnTopic.Editor.AspNetCore.Attributes/FilePathAttribute/FilePathAttributeDescriptor.cs
@@ -3,7 +3,6 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using OnTopic.Metadata;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.FilePathAttribute {
 

diff --git a/...ic.Editor.AspNetCore.Attributes/FilePathAttribute/FilePathAttributeDescriptorViewModel.cs b/...ic.Editor.AspNetCore.Attributes/FilePathAttribute/FilePathAttributeDescriptorViewModel.cs
@@ -3,8 +3,6 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using OnTopic.Editor.AspNetCore.Models;
-using OnTopic.Editor.AspNetCore.Models.Metadata;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.FilePathAttribute {
 
@@ -16,6 +14,26 @@ namespace OnTopic.Editor.AspNetCore.Attributes.FilePathAttribute {
   /// </summary>
   public record FilePathAttributeDescriptorViewModel: AttributeDescriptorViewModel {
 
+    /*==========================================================================================================================
+    | CONSTRUCTOR
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Initializes a new <see cref="FilePathAttributeDescriptorViewModel"/> with an <paramref name="attributes"/> dictionary.
+    /// </summary>
+    /// <param name="attributes">An <see cref="AttributeDictionary"/> of attribute values.</param>
+    public FilePathAttributeDescriptorViewModel(AttributeDictionary attributes): base(attributes) {
+      Contract.Requires(attributes, nameof(attributes));
+      InheritValue              = attributes.GetBoolean(nameof(InheritValue))?? InheritValue;
+      RelativeToTopicPath       = attributes.GetBoolean(nameof(RelativeToTopicPath))?? RelativeToTopicPath;
+      BaseTopicPath             = attributes.GetValue(nameof(BaseTopicPath))?? BaseTopicPath;
+      IncludeCurrentTopic       = attributes.GetBoolean(nameof(IncludeCurrentTopic))?? IncludeCurrentTopic;
+    }
+
+    /// <summary>
+    ///   Initializes a new instance of the <see cref="FilePathAttributeDescriptorViewModel"/> class.
+    /// </summary>
+    public FilePathAttributeDescriptorViewModel() : base() { }
+
     /*==========================================================================================================================
     | PROPERTY: INHERIT VALUE
     \-------------------------------------------------------------------------------------------------------------------------*/

diff --git a/OnTopic.Editor.AspNetCore.Attributes/FilePathAttribute/FilePathAttributeViewModel.cs b/OnTopic.Editor.AspNetCore.Attributes/FilePathAttribute/FilePathAttributeViewModel.cs
@@ -4,8 +4,6 @@
 | Project       Topics Library
 \=============================================================================================================================*/
 using System.ComponentModel.DataAnnotations;
-using OnTopic.Editor.AspNetCore.Models;
-using OnTopic.Editor.AspNetCore.Models.Metadata;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.FilePathAttribute {
 

diff --git a/OnTopic.Editor.AspNetCore.Attributes/FilePathAttribute/FilePathViewComponent.cs b/OnTopic.Editor.AspNetCore.Attributes/FilePathAttribute/FilePathViewComponent.cs
@@ -3,12 +3,7 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using System;
-using System.Linq;
-using Microsoft.AspNetCore.Mvc;
 using OnTopic.AspNetCore.Mvc;
-using OnTopic.Editor.AspNetCore.Models;
-using OnTopic.Internal.Diagnostics;
 using OnTopic.Repositories;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.FilePathAttribute {
@@ -203,7 +198,7 @@ public string GetPath(string attributeKey, FilePathAttributeDescriptorViewModel
         foreach (var truncationTopic in truncatePathAtTopic) {
           var truncateTopicLocation = relativePath?.IndexOf(truncationTopic, StringComparison.OrdinalIgnoreCase);
           if (truncateTopicLocation >= 0) {
-            relativePath        = relativePath?.Substring(0, truncateTopicLocation.Value + truncationTopic.Length + 1);
+            relativePath        = relativePath?[..(truncateTopicLocation.Value + truncationTopic.Length + 1)];
           }
         }
       }
@@ -216,7 +211,7 @@ public string GetPath(string attributeKey, FilePathAttributeDescriptorViewModel
       /*------------------------------------------------------------------------------------------------------------------------
       | Replace path slashes with backslashes if the resulting file path value uses a UNC or basic file path format
       \-----------------------------------------------------------------------------------------------------------------------*/
-      if (filePath.Contains("\\", StringComparison.Ordinal)) {
+      if (filePath.Contains('\\', StringComparison.Ordinal)) {
         filePath                = filePath.Replace("/", "\\", StringComparison.Ordinal);
       }
 

diff --git a/OnTopic.Editor.AspNetCore.Attributes/HtmlAttribute/HtmlAttributeDescriptor.cs b/OnTopic.Editor.AspNetCore.Attributes/HtmlAttribute/HtmlAttributeDescriptor.cs
@@ -3,7 +3,6 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using OnTopic.Metadata;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.HtmlAttribute {
 

diff --git a/OnTopic.Editor.AspNetCore.Attributes/HtmlAttribute/HtmlAttributeDescriptorViewModel.cs b/OnTopic.Editor.AspNetCore.Attributes/HtmlAttribute/HtmlAttributeDescriptorViewModel.cs
@@ -18,12 +18,34 @@ public record HtmlAttributeDescriptorViewModel: TextAreaAttributeDescriptorViewM
     /*==========================================================================================================================
     | CONSTRUCTOR
     \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Initializes a new <see cref="HtmlAttributeDescriptorViewModel"/> with an <paramref name="attributes"/> dictionary.
+    /// </summary>
+    /// <param name="attributes">An <see cref="AttributeDictionary"/> of attribute values.</param>
+    public HtmlAttributeDescriptorViewModel(AttributeDictionary attributes): base(attributes) {
+      Contract.Requires(attributes, nameof(attributes));
+      Height                    = attributes.GetInteger(nameof(Height));
+      Rows                      = 20;
+      RegisterResources();
+    }
+
     /// <summary>
     ///   Initializes a new instance of a <see cref="HtmlAttributeDescriptorViewModel"/>
     /// </summary>
     public HtmlAttributeDescriptorViewModel() {
-      Scripts.Register(new("https://cdn.ckeditor.com/4.14.0/standard/ckeditor.js"), true, false);
       Rows = 20;
+      RegisterResources();
+    }
+
+    /*==========================================================================================================================
+    | REGISTER RESOURCES
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Derived classes may optionally override this method in order to register resources, as an alternative to setting these
+    ///   in the constructor.
+    /// </summary>
+    protected void RegisterResources() {
+      Scripts.Register(new("https://cdn.ckeditor.com/4.14.0/standard/ckeditor.js"), true, false);
     }
 
     /*==========================================================================================================================

diff --git a/OnTopic.Editor.AspNetCore.Attributes/HtmlAttribute/HtmlViewComponent.cs b/OnTopic.Editor.AspNetCore.Attributes/HtmlAttribute/HtmlViewComponent.cs
@@ -3,9 +3,6 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using Microsoft.AspNetCore.Mvc;
-using OnTopic.Editor.AspNetCore.Models;
-using OnTopic.Internal.Diagnostics;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.HtmlAttribute {
 

diff --git a/...tCore.Attributes/IncomingRelationshipAttribute/IncomingRelationshipAttributeDescriptor.cs b/...tCore.Attributes/IncomingRelationshipAttribute/IncomingRelationshipAttributeDescriptor.cs
@@ -3,7 +3,6 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
-using OnTopic.Metadata;
 
 namespace OnTopic.Editor.AspNetCore.Attributes.IncomingRelationshipAttribute {