TD-169 GDSMultiPageFormService solution added.

GDSMultiPageFormService.sln

@@ -0,0 +1,25 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.1.32328.378
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "GDS.MultiPageFormData", "GDSMultiPageFormService\GDS.MultiPageFormData.csproj", "{AF5FEF7C-EA21-4921-9C9B-F2B2FCDA80A7}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{AF5FEF7C-EA21-4921-9C9B-F2B2FCDA80A7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{AF5FEF7C-EA21-4921-9C9B-F2B2FCDA80A7}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{AF5FEF7C-EA21-4921-9C9B-F2B2FCDA80A7}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{AF5FEF7C-EA21-4921-9C9B-F2B2FCDA80A7}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {164138B3-4E9F-4D9B-9E54-8006D0495B41}
+	EndGlobalSection
+EndGlobal

GDSMultiPageFormService/ClockService.cs

@@ -0,0 +1,9 @@
+namespace GDS.MultiPageFormData
+{
+    using System;
+
+    public class ClockService
+    {
+        public static DateTime UtcNow => DateTime.UtcNow;
+    }
+}

GDSMultiPageFormService/Enums/Enumeration.cs

@@ -0,0 +1,131 @@
+namespace GDS.MultiPageFormData.Enums
+{
+    using System;
+    using System.Collections.Generic;
+    using System.ComponentModel;
+    using System.Globalization;
+    using System.Linq;
+    using System.Reflection;
+
+    /// <summary>
+    /// Enumeration base class as recommended at https://ankitvijay.net/2020/05/21/introduction-enumeration-class/
+    /// and https://docs.microsoft.com/en-us/dotnet/architecture/microservices/microservice-ddd-cqrs-patterns/enumeration-classes-over-enum-types
+    /// </summary>
+    public abstract class Enumeration
+    {
+        public string Name { get; private set; }
+
+        public int Id { get; private set; }
+
+        protected Enumeration(int id, string name) => (Id, Name) = (id, name);
+
+        public override string ToString() => Name;
+
+        public static IEnumerable<T> GetAll<T>() where T : Enumeration =>
+            typeof(T).GetFields(
+                    BindingFlags.Public |
+                    BindingFlags.Static |
+                    BindingFlags.DeclaredOnly)
+                .Select(f => f.GetValue(null))
+                .Cast<T>();
+
+        public override bool Equals(object? obj)
+        {
+            if (obj == null)
+            {
+                return false;
+            }
+
+            if (!(obj is Enumeration objAsEnumeration))
+            {
+                return false;
+            }
+
+            var typeMatches = this.GetType() == obj.GetType();
+            var valueMatches = Id.Equals(objAsEnumeration.Id);
+
+            return typeMatches && valueMatches;
+        }
+
+        public static bool TryGetFromIdOrName<T>(
+            string idOrName,
+            out T enumeration,
+            bool ignoreCase = false
+        )
+            where T : Enumeration
+        {
+            var comparison =
+                ignoreCase ? StringComparison.CurrentCultureIgnoreCase : StringComparison.CurrentCulture;
+            return TryParse(item => string.Equals(item.Name, idOrName, comparison), out enumeration) ||
+                   int.TryParse(idOrName, out var id) &&
+                   TryParse(item => item.Id == id, out enumeration);
+        }
+
+        protected static bool TryParse<TEnumeration>(
+            Func<TEnumeration, bool> predicate,
+            out TEnumeration enumeration)
+            where TEnumeration : Enumeration
+        {
+            enumeration = GetAll<TEnumeration>().FirstOrDefault(predicate);
+            return enumeration != null;
+        }
+
+        public static T FromId<T>(int id) where T : Enumeration
+        {
+            var matchingItem = Parse<T, int>(id, "nameOrValue", item => item.Id == id);
+            return matchingItem;
+        }
+
+        public static T FromName<T>(string name) where T : Enumeration
+        {
+            var matchingItem = Parse<T, string>(name, "name", item => item.Name == name);
+            return matchingItem;
+        }
+
+        private static TEnumeration Parse<TEnumeration, TIntOrString>(
+            TIntOrString nameOrValue,
+            string description,
+            Func<TEnumeration, bool> predicate)
+            where TEnumeration : Enumeration
+        {
+            var matchingItem = GetAll<TEnumeration>().FirstOrDefault(predicate);
+
+            if (matchingItem == null)
+            {
+                throw new InvalidOperationException(
+                    $"'{nameOrValue}' is not a valid {description} in {typeof(TEnumeration)}");
+            }
+
+            return matchingItem;
+        }
+
+        public int CompareTo(object other) => Id.CompareTo(((Enumeration)other).Id);
+    }
+
+    internal class EnumerationTypeConverter<T> : TypeConverter where T : Enumeration
+    {
+        public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
+        {
+            return sourceType == typeof(string) || base.CanConvertFrom(context, sourceType);
+        }
+
+        public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
+        {
+            return value is string casted
+                ? Enumeration.FromName<T>(casted)
+                : base.ConvertFrom(context, culture, value);
+        }
+
+        public override object ConvertTo(
+            ITypeDescriptorContext context,
+            CultureInfo culture,
+            object value,
+            Type destinationType
+        )
+        {
+            return destinationType == typeof(string) && value is Enumeration casted
+                ? casted.Name
+                : base.ConvertTo(context, culture, value, destinationType);
+        }
+    }
+}

GDSMultiPageFormService/Enums/MultiPageFormDataFeature.cs

@@ -0,0 +1,120 @@
+using System;
+namespace GDS.MultiPageFormData.Enums
+{
+    public class MultiPageFormDataFeature : Enumeration
+    {
+        public static readonly MultiPageFormDataFeature AddNewCourse = new MultiPageFormDataFeature(
+            0,
+            nameof(AddNewCourse),
+            "AddNewCourseDataGuid"
+        );
+
+        public static readonly MultiPageFormDataFeature AddRegistrationPrompt = new MultiPageFormDataFeature(
+            1,
+            nameof(AddRegistrationPrompt),
+            "AddRegistrationPromptDataGuid"
+        );
+
+        public static readonly MultiPageFormDataFeature EditRegistrationPrompt = new MultiPageFormDataFeature(
+            2,
+            nameof(EditRegistrationPrompt),
+            "EditRegistrationPromptDataGuid"
+        );
+
+        public static readonly MultiPageFormDataFeature AddAdminField = new MultiPageFormDataFeature(
+            3,
+            nameof(AddAdminField),
+            "AddAdminFieldDataGuid"
+        );
+
+        public static readonly MultiPageFormDataFeature EditAdminField = new MultiPageFormDataFeature(
+            4,
+            nameof(EditAdminField),
+            "EditAdminFieldDataGuid"
+        );
+
+        public static readonly MultiPageFormDataFeature AddNewFramework = new MultiPageFormDataFeature(
+            5,
+            nameof(AddNewFramework),
+            "AddNewFrameworkDataGuid"
+        );
+
+        public static readonly MultiPageFormDataFeature EditAssessmentQuestion = new MultiPageFormDataFeature(
+            6,
+            nameof(EditAssessmentQuestion),
+            "EditAssessmentQuestionDataGuid"
+        );
+
+        public static readonly MultiPageFormDataFeature EditSignpostingParameter = new MultiPageFormDataFeature(
+            7,
+            nameof(EditSignpostingParameter),
+            "EditSignpostingParameterDataGuid"
+        );
+
+        public static readonly MultiPageFormDataFeature AddCompetencyLearningResourceSummary = new MultiPageFormDataFeature(
+            8,
+            nameof(AddCompetencyLearningResourceSummary),
+            "AddCompetencyLearningResourceSummaryDataGuid"
+        );
+
+        public static readonly MultiPageFormDataFeature EditCompetencyLearningResources = new MultiPageFormDataFeature(
+            9,
+            nameof(EditCompetencyLearningResources),
+            "EditCompetencyLearningResourcesDataGuid"
+        );
+
+        public static readonly MultiPageFormDataFeature SearchInSelfAssessmentOverviewGroups = new MultiPageFormDataFeature(
+            10,
+            nameof(SearchInSelfAssessmentOverviewGroups),
+            "SearchInSelfAssessmentOverviewGroupsDataGuid"
+        );
+
+        public static readonly MultiPageFormDataFeature AddSelfAssessmentRequestVerification = new MultiPageFormDataFeature(
+            11,
+            nameof(AddSelfAssessmentRequestVerification),
+            "AddSelfAssessmentRequestVerificationDataGuid"
+        );
+
+        public static readonly MultiPageFormDataFeature AddNewSupervisor = new MultiPageFormDataFeature(
+            12,
+            nameof(AddNewSupervisor),
+            "AddNewSupervisorDataGuid"
+        );
+
+        public static readonly MultiPageFormDataFeature EnrolDelegateOnProfileAssessment = new MultiPageFormDataFeature(
+            13,
+            nameof(EnrolDelegateOnProfileAssessment),
+            "EnrolDelegateOnProfileAssessmentDataGuid"
+        );
+
+        public static readonly MultiPageFormDataFeature EnrolDelegateInActivity = new MultiPageFormDataFeature(
+            14,
+            nameof(EnrolDelegateInActivity),
+            "EnrolDelegateInActivity"
+        );
+
+        public readonly string TempDataKey;
+
+        private MultiPageFormDataFeature(int id, string name, string tempDataKey) : base(id, name)
+        {
+            TempDataKey = tempDataKey;
+        }
+
+        public static implicit operator MultiPageFormDataFeature(string value)
+        {
+            try
+            {
+                return FromName<MultiPageFormDataFeature>(value);
+            }
+            catch (InvalidOperationException e)
+            {
+                throw new InvalidCastException(e.Message);
+            }
+        }
+
+        public static implicit operator string?(MultiPageFormDataFeature? applicationType)
+        {
+            return applicationType?.Name;
+        }
+    }
+}

GDSMultiPageFormService/GDS.MultiPageFormData.csproj

@@ -0,0 +1,16 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net6.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <Version>$(VersionPrefix)</Version>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Dapper" Version="2.0.123" />
+    <PackageReference Include="Microsoft.FeatureManagement.AspNetCore" Version="2.5.1" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
+  </ItemGroup>
+
+</Project>

GDSMultiPageFormService/Models/MultipageFormData.cs

@@ -0,0 +1,16 @@
+namespace GDS.MultiPageFormData.Models
+{
+    using System;
+    internal class MultiPageFormData
+    {
+        public int Id { get; set; }
+
+        public Guid TempDataGuid { get; set; }
+
+        public string Json { get; set; }
+
+        public string Feature { get; set; }
+
+        public DateTime CreatedDate { get; set; }
+    }
+}