Merge branch 'improvement/model-interfaces' into develop

JeremyCaney · JeremyCaney · commit 2f98c39856c4 · 2021-03-01T13:21:38.000-08:00
Reevaluated the view model interfaces. - Introduced new `ICoreTopicViewModel` interface with `Key` and `ContentType` (565273f, 527dee4, eef391c) - Introduced new `INavigableTopicViewModel` interface with `Title`, `ShorTitle`, and `WebPath` (adf7ff8) - Cross-applied interfaces that satisfied subsets of other interfaces; this includes applying: - `ICoreTopicViewModel` to `ITopicBindingModel` (3b5dda8) - `IAssociatedTopicBindingModel` to `ITopicViewModel` (8ad42b9) - `ITopicBindingModel` to `ITopicViewModel` (ffe775e) - `INavigableTopicViewModel` to `INavigationTopicViewModel<T>` (adf7ff8) - `INaviableTopicViewModel` to `IPageTopicViewModel` (c41d989) - Removed `IsHidden` from `ITopicViewModel`, `TopicViewModel`; hidden models are excluded by the `TopicMappingService`, so this doesn't provide value (68a4e83). - Marked the `IPageTopicViewModel` as obsolete; narrow applications are expected to use the `InavigableTopicViewModel` instead (745e562). - Marked core properties (e.g., `Key`, `ContentType`, &c.) as non-nullable and required to reflect the fact that these should always be present (1bf25be, bfa64f1). - Updated `TopicViewModelCollection` to use the much narrower (new) `ICoreTopicViewModel`, thus reducing the interface requirements of its `TItem` (eef391c).
diff --git a/OnTopic.AspNetCore.Mvc.Host/Views/Shared/_TopicAttributes.cshtml b/OnTopic.AspNetCore.Mvc.Host/Views/Shared/_TopicAttributes.cshtml
@@ -7,7 +7,6 @@
   <li>ContentType: @Model.ContentType</li>
   <li>UniqueKey: @Model.UniqueKey</li>
   <li>WebPath: @Model.WebPath</li>
-  <li>IsHidden? @Model.IsHidden</li>
   <li>LastModified: @Model.LastModified</li>
   <li>View: @Model.View</li>
 </ul>
diff --git a/OnTopic.Tests/BindingModels/BasicTopicBindingModel.cs b/OnTopic.Tests/BindingModels/BasicTopicBindingModel.cs
@@ -4,6 +4,7 @@
 | Project       Topics Library
 \=============================================================================================================================*/
 using System.ComponentModel.DataAnnotations;
+using System.Diagnostics.CodeAnalysis;
 using OnTopic.Models;
 
 namespace OnTopic.Tests.BindingModels {
@@ -21,14 +22,15 @@ public class BasicTopicBindingModel : ITopicBindingModel {
 
     public BasicTopicBindingModel() { }
 
-    public BasicTopicBindingModel(string? key, string? contentType) {
+    public BasicTopicBindingModel(string key, string contentType) {
       Key = key;
       ContentType = contentType;
     }
 
+    [Required, NotNull, DisallowNull]
     public string? Key { get; init; }
 
-    [Required]
+    [Required, NotNull, DisallowNull]
     public string? ContentType { get; init; }
 
   } //Class
diff --git a/OnTopic.Tests/BindingModels/InvalidReferenceTypeTopicBindingModel.cs b/OnTopic.Tests/BindingModels/InvalidReferenceTypeTopicBindingModel.cs
@@ -4,9 +4,8 @@
 | Project       Topics Library
 \=============================================================================================================================*/
 using System;
-using OnTopic.Mapping.Annotations;
 using OnTopic.Models;
-using OnTopic.ViewModels;
+using OnTopic.Tests.ViewModels;
 
 namespace OnTopic.Tests.BindingModels {
 
@@ -24,7 +23,7 @@ public class InvalidReferenceTypeTopicBindingModel : BasicTopicBindingModel {
 
     public InvalidReferenceTypeTopicBindingModel(string? key = null) : base(key, "Page") { }
 
-    public TopicViewModel BaseTopic { get; } = new();
+    public EmptyViewModel BaseTopic { get; } = new();
 
   } //Class
 } //Namespace
diff --git a/OnTopic.Tests/BindingModels/InvalidRelationshipBaseTypeTopicBindingModel.cs b/OnTopic.Tests/BindingModels/InvalidRelationshipBaseTypeTopicBindingModel.cs
@@ -6,7 +6,7 @@
 using System;
 using System.Collections.ObjectModel;
 using OnTopic.Models;
-using OnTopic.ViewModels;
+using OnTopic.Tests.ViewModels;
 
 namespace OnTopic.Tests.BindingModels {
 
@@ -24,7 +24,7 @@ public class InvalidRelationshipBaseTypeTopicBindingModel : BasicTopicBindingMod
 
     public InvalidRelationshipBaseTypeTopicBindingModel(string? key = null) : base(key, "ContentTypeDescriptor") { }
 
-    public Collection<TopicViewModel> ContentTypes { get; } = new();
+    public Collection<EmptyViewModel> ContentTypes { get; } = new();
 
   } //Class
 } //Namespace
diff --git a/OnTopic.Tests/BindingModels/RecordTopicBindingModel.cs b/OnTopic.Tests/BindingModels/RecordTopicBindingModel.cs
@@ -4,6 +4,7 @@
 | Project       Topics Library
 \=============================================================================================================================*/
 using System.ComponentModel.DataAnnotations;
+using System.Diagnostics.CodeAnalysis;
 using OnTopic.Models;
 
 namespace OnTopic.Tests.BindingModels {
@@ -22,9 +23,10 @@ public class RecordTopicBindingModel : ITopicBindingModel {
 
     public RecordTopicBindingModel() { }
 
+    [Required, NotNull, DisallowNull]
     public string? Key { get; init; }
 
-    [Required]
+    [Required, NotNull, DisallowNull]
     public string? ContentType { get; init; }
 
   } //Class
diff --git a/OnTopic.Tests/TopicMappingServiceTest.cs b/OnTopic.Tests/TopicMappingServiceTest.cs
@@ -85,13 +85,11 @@ public async Task Map_Generic_ReturnsNewModel() {
 
       topic.Attributes.SetValue("MetaTitle", "ValueA");
       topic.Attributes.SetValue("Title", "Value1");
-      topic.Attributes.SetValue("IsHidden", "1");
 
       var target                = await _mappingService.MapAsync<PageTopicViewModel>(topic).ConfigureAwait(false);
 
       Assert.AreEqual<string>("ValueA", target.MetaTitle);
       Assert.AreEqual<string>("Value1", target.Title);
-      Assert.AreEqual<bool>(true, target.IsHidden);
 
     }
 
@@ -127,13 +125,11 @@ public async Task Map_Dynamic_ReturnsNewModel() {
 
       topic.Attributes.SetValue("MetaTitle", "ValueA");
       topic.Attributes.SetValue("Title", "Value1");
-      topic.Attributes.SetValue("IsHidden", "1");
 
       var target                = (PageTopicViewModel?)await _mappingService.MapAsync(topic).ConfigureAwait(false);
 
       Assert.AreEqual<string>("ValueA", target.MetaTitle);
       Assert.AreEqual<string>("Value1", target.Title);
-      Assert.AreEqual<bool>(true, target.IsHidden);
 
     }
 
diff --git a/OnTopic.Tests/ViewModels/EmptyViewModel.cs b/OnTopic.Tests/ViewModels/EmptyViewModel.cs
@@ -0,0 +1,23 @@
+﻿/*==============================================================================================================================
+| Author        Ignia, LLC
+| Client        Ignia, LLC
+| Project       Topics Library
+\=============================================================================================================================*/
+using OnTopic.Models;
+
+namespace OnTopic.Tests.ViewModels {
+
+  /*============================================================================================================================
+  | VIEW MODEL: EMPTY
+  \---------------------------------------------------------------------------------------------------------------------------*/
+  /// <summary>
+  ///   A view model that does not implement any properties or interfaces. This will be invalid for mapping models that expect
+  ///   e.g. <see cref="IAssociatedTopicBindingModel"/> or <see cref="ITopicBindingModel"/>.
+  /// </summary>
+  /// <remarks>
+  ///   This is a sample class intended for test purposes only; it is not designed for use in a production environment.
+  /// </remarks>
+  public class EmptyViewModel {
+
+  }
+}
diff --git a/OnTopic.ViewModels/BindingModels/AssociatedTopicBindingModel.cs b/OnTopic.ViewModels/BindingModels/AssociatedTopicBindingModel.cs
@@ -4,6 +4,7 @@
 | Project       Topics Library
 \=============================================================================================================================*/
 using System.ComponentModel.DataAnnotations;
+using System.Diagnostics.CodeAnalysis;
 using OnTopic.Mapping.Reverse;
 using OnTopic.Models;
 
@@ -32,7 +33,7 @@ public record AssociatedTopicBindingModel : IAssociatedTopicBindingModel {
     /// <requires description="The value from the getter must not be null." exception="T:System.ArgumentNullException">
     ///   value is not null
     /// </requires>
-    [Required]
+    [Required, NotNull, DisallowNull]
     public string? UniqueKey { get; init; }
 
   } //Class
diff --git a/OnTopic.ViewModels/NavigationTopicViewModel.cs b/OnTopic.ViewModels/NavigationTopicViewModel.cs
@@ -5,6 +5,8 @@
 \=============================================================================================================================*/
 using System;
 using System.Collections.ObjectModel;
+using System.ComponentModel.DataAnnotations;
+using System.Diagnostics.CodeAnalysis;
 using OnTopic.Models;
 
 namespace OnTopic.ViewModels {
@@ -34,6 +36,7 @@ public sealed record NavigationTopicViewModel : INavigationTopicViewModel<Naviga
     | TITLE
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <inheritdoc cref="TopicViewModel"/>
+    [Required, NotNull, DisallowNull]
     public string? Title { get; init; }
 
     /*==========================================================================================================================
@@ -48,6 +51,7 @@ public sealed record NavigationTopicViewModel : INavigationTopicViewModel<Naviga
     | WEB PATH
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <inheritdoc cref="WebPath"/>
+    [Required, NotNull, DisallowNull]
     public string? WebPath { get; init; }
 
     /*==========================================================================================================================
diff --git a/OnTopic.ViewModels/TopicViewModel.cs b/OnTopic.ViewModels/TopicViewModel.cs
@@ -4,6 +4,8 @@
 | Project       Topics Library
 \=============================================================================================================================*/
 using System;
+using System.ComponentModel.DataAnnotations;
+using System.Diagnostics.CodeAnalysis;
 using OnTopic.Mapping.Annotations;
 using OnTopic.Models;
 
@@ -20,7 +22,7 @@ namespace OnTopic.ViewModels {
   ///   default implementations that can be used directly, used as base classes, or overwritten at the presentation level. They
   ///   are supplied for convenience to model factory default settings for out-of-the-box content types.
   /// </remarks>
-  public record TopicViewModel: ITopicViewModel {
+  public record TopicViewModel: ITopicViewModel, ICoreTopicViewModel, IAssociatedTopicBindingModel, ITopicBindingModel {
 
     /*==========================================================================================================================
     | ID
@@ -32,24 +34,28 @@ public record TopicViewModel: ITopicViewModel {
     | KEY
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <inheritdoc />
+    [Required, NotNull, DisallowNull]
     public string? Key { get; init; }
 
     /*==========================================================================================================================
     | CONTENT TYPE
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <inheritdoc />
+    [Required, NotNull, DisallowNull]
     public string? ContentType { get; init; }
 
     /*==========================================================================================================================
     | UNIQUE KEY
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <inheritdoc />
+    [Required, NotNull, DisallowNull]
     public string? UniqueKey { get; init; }
 
     /*==========================================================================================================================
     | WEB PATH
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <inheritdoc />
+    [Required, NotNull, DisallowNull]
     public string? WebPath { get; init; }
 
     /*==========================================================================================================================
@@ -62,12 +68,15 @@ public record TopicViewModel: ITopicViewModel {
     | TITLE
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <inheritdoc />
+    [Required, NotNull, DisallowNull]
     public string? Title { get; init; }
 
     /*==========================================================================================================================
     | IS HIDDEN?
     \-------------------------------------------------------------------------------------------------------------------------*/
-    /// <inheritdoc />
+    /// <inheritdoc/>
+    [Obsolete("The IsHidden property is no longer supported by TopicViewModel.", true)]
+    [DisableMapping]
     public bool IsHidden { get; init; }
 
     /*==========================================================================================================================
diff --git a/OnTopic.ViewModels/_collections/TopicViewModelCollection.cs b/OnTopic.ViewModels/_collections/TopicViewModelCollection.cs
@@ -16,15 +16,15 @@ namespace OnTopic.ViewModels {
   | VIEW MODEL: TOPIC COLLECTION
   \---------------------------------------------------------------------------------------------------------------------------*/
   /// <summary>
-  ///   Provides a basic collection interface for use with models implementing <see cref="ITopicViewModel"/>, including <see
+  ///   Provides a basic collection interface for use with models implementing <see cref="ICoreTopicViewModel"/>, including <see
   ///   cref="TopicViewModel"/> and derivatives.
   /// </summary>
   /// <remarks>
   ///   Typically, view models should be created as part of the presentation layer. The <see cref="Models"/> namespace contains
   ///   default implementations that can be used directly, used as base classes, or overwritten at the presentation level. They
   ///   are supplied for convenience to model factory default settings for out-of-the-box content types.
   /// </remarks>
-  public class TopicViewModelCollection<TItem>: KeyedCollection<string, TItem> where TItem: ITopicViewModel {
+  public class TopicViewModelCollection<TItem>: KeyedCollection<string, TItem> where TItem: ICoreTopicViewModel {
 
     /*==========================================================================================================================
     | CONSTRUCTOR
diff --git a/OnTopic.ViewModels/_contentTypes/PageTopicViewModel.cs b/OnTopic.ViewModels/_contentTypes/PageTopicViewModel.cs
@@ -18,7 +18,15 @@ namespace OnTopic.ViewModels {
   ///   default implementations that can be used directly, used as base classes, or overwritten at the presentation level. They
   ///   are supplied for convenience to model factory default settings for out-of-the-box content types.
   /// </remarks>
-  public record PageTopicViewModel: TopicViewModel, IPageTopicViewModel {
+  public record PageTopicViewModel: TopicViewModel, INavigableTopicViewModel {
+
+    /*==========================================================================================================================
+    | SHORT TITLE
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Provides a short title to be used in the navigation, for cases where the normal title is too long.
+    /// </summary>
+    public string? ShortTitle { get; init; }
 
     /*==========================================================================================================================
     | SUBTITLE
@@ -56,14 +64,6 @@ public record PageTopicViewModel: TopicViewModel, IPageTopicViewModel {
     /// </summary>
     public bool? NoIndex { get; init; }
 
-    /*==========================================================================================================================
-    | SHORT TITLE
-    \-------------------------------------------------------------------------------------------------------------------------*/
-    /// <summary>
-    ///   Provides a short title to be used in the navigation, for cases where the normal title is too long.
-    /// </summary>
-    public string? ShortTitle { get; init; }
-
     /*==========================================================================================================================
     | BODY
     \-------------------------------------------------------------------------------------------------------------------------*/
diff --git a/OnTopic.ViewModels/_contentTypes/VideoTopicViewModel.cs b/OnTopic.ViewModels/_contentTypes/VideoTopicViewModel.cs
@@ -4,6 +4,8 @@
 | Project       Topics Library
 \=============================================================================================================================*/
 using System;
+using System.ComponentModel.DataAnnotations;
+using System.Diagnostics.CodeAnalysis;
 
 namespace OnTopic.ViewModels {
 
@@ -26,6 +28,7 @@ public record VideoTopicViewModel: PageTopicViewModel {
     /// <summary>
     ///   Provides a URL reference to a video to display on the page.
     /// </summary>
+    [Required, NotNull, DisallowNull]
     public Uri? VideoUrl { get; init; }
 
     /*==========================================================================================================================
diff --git a/OnTopic/Models/IAssociatedTopicBindingModel.cs b/OnTopic/Models/IAssociatedTopicBindingModel.cs
@@ -4,6 +4,7 @@
 | Project       Topics Library
 \=============================================================================================================================*/
 using System.ComponentModel.DataAnnotations;
+using System.Diagnostics.CodeAnalysis;
 using OnTopic.Mapping.Reverse;
 
 namespace OnTopic.Models {
@@ -30,7 +31,7 @@ public interface IAssociatedTopicBindingModel {
     /// <requires description="The value from the getter must not be null." exception="T:System.ArgumentNullException">
     ///   value is not null
     /// </requires>
-    [Required]
+    [Required, NotNull, DisallowNull]
     string? UniqueKey { get; init; }
 
   } //Class
diff --git a/OnTopic/Models/ICoreTopicViewModel.cs b/OnTopic/Models/ICoreTopicViewModel.cs
@@ -0,0 +1,60 @@
+﻿/*==============================================================================================================================
+| Author        Ignia, LLC
+| Client        Ignia, LLC
+| Project       Topics Library
+\=============================================================================================================================*/
+using System.Collections.ObjectModel;
+using System.ComponentModel.DataAnnotations;
+using System.Diagnostics.CodeAnalysis;
+using OnTopic.Mapping;
+using OnTopic.Metadata;
+
+namespace OnTopic.Models {
+
+  /*============================================================================================================================
+  | INTERFACE: CORE TOPIC VIEW MODEL
+  \---------------------------------------------------------------------------------------------------------------------------*/
+  /// <summary>
+  ///   Ensures that a model maintains, at minimum, a <see cref="Key"/> and <see cref="ContentType"/> property, which are
+  ///   expected of all <see cref="Topic"/>s.
+  /// </summary>
+  /// <remarks>
+  ///   <para>
+  ///     This is necessary to support e.g. a <see cref="KeyedCollection{TKey, TValue}"/>, while also allowing it to filter by
+  ///     <see cref="ContentType"/>—a common requirement for topic (view model) collections.
+  ///   </para>
+  ///   <para>
+  ///     It is not required that topic view models implement the <see cref="ICoreTopicViewModel"/> interface for the <see cref=
+  ///     "TopicMappingService"/> to correctly identify and map <see cref="Topic"/>s to topic view models. That said, the
+  ///     interface does ensure that those view models can be keyed, which is useful for, especially, child collections.
+  ///   </para>
+  /// </remarks>
+  public interface ICoreTopicViewModel {
+
+    /*==========================================================================================================================
+    | PROPERTY: KEY
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Gets the topic's <see cref="Key"/> attribute, the primary text identifier for the <see cref="Topic"/>.
+    /// </summary>
+    /// <requires description="The value from the getter must not be null." exception="T:System.ArgumentNullException">
+    ///   value is not null
+    /// </requires>
+    [Required, NotNull, DisallowNull]
+    string? Key { get; init; }
+
+    /*==========================================================================================================================
+    | PROPERTY: CONTENT TYPE
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Gets the key name of the content type that the current topic represents.
+    /// </summary>
+    /// <remarks>
+    ///   Each topic is associated with a content type. The content type determines which attributes are displayed in the Topics
+    ///   Editor (via the <see cref="ContentTypeDescriptor.AttributeDescriptors"/> property).
+    /// </remarks>
+    [Required, NotNull, DisallowNull]
+    string? ContentType { get; init; }
+
+  } //Class
+} //Namespace
diff --git a/OnTopic/Models/INavigableTopicViewModel.cs b/OnTopic/Models/INavigableTopicViewModel.cs
diff --git a/OnTopic/Models/INavigationTopicViewModel{T}.cs b/OnTopic/Models/INavigationTopicViewModel{T}.cs
diff --git a/OnTopic/Models/IPageTopicViewModel.cs b/OnTopic/Models/IPageTopicViewModel.cs
diff --git a/OnTopic/Models/ITopicBindingModel.cs b/OnTopic/Models/ITopicBindingModel.cs
diff --git a/OnTopic/Models/ITopicViewModel.cs b/OnTopic/Models/ITopicViewModel.cs
