[WIP] CardView Component;fixes #725

COMET.Web.Common.Tests/Components/CardView/CardViewTestFixture.cs

@@ -0,0 +1,303 @@
+// --------------------------------------------------------------------------------------------------------------------
+//  <copyright file="CardViewTestFixture.cs" company="Starion Group S.A.">
+//     Copyright (c) 2023-2024 Starion Group S.A.
+// 
+//     Authors: Sam Gerené, Alex Vorobiev, Alexander van Delft, Jaime Bernar, Théate Antoine, Nabil Abbar
+// 
+//     This file is part of CDP4-COMET WEB Community Edition
+//     The CDP4-COMET WEB Community Edition is the Starion Web Application implementation of ECSS-E-TM-10-25 Annex A and Annex C.
+// 
+//     The CDP4-COMET WEB Community Edition is free software; you can redistribute it and/or
+//     modify it under the terms of the GNU Affero General Public
+//     License as published by the Free Software Foundation; either
+//     version 3 of the License, or (at your option) any later version.
+// 
+//     The CDP4-COMET WEB Community Edition is distributed in the hope that it will be useful,
+//     but WITHOUT ANY WARRANTY; without even the implied warranty of
+//     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+//    Affero General Public License for more details.
+// 
+//    You should have received a copy of the GNU Affero General Public License
+//    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//  </copyright>
+//  --------------------------------------------------------------------------------------------------------------------
+
+namespace COMET.Web.Common.Tests.Components.CardView
+{
+    using Bunit;
+
+    using COMET.Web.Common.Components.CardView;
+
+    using DevExpress.Blazor.Internal;
+
+    using Microsoft.AspNetCore.Components;
+    using Microsoft.Extensions.DependencyInjection;
+
+    using NUnit.Framework;
+
+    using TestContext = Bunit.TestContext;
+
+    public class CardViewTestFixture
+    {
+        private TestContext context;
+        private TestClass testClass1 = new ();
+        private TestClass testClass2 = new ();
+        private TestClass testClass3 = new ();
+        private TestClass[] testClasses;
+
+        private static RenderFragment<TestClass> NormalTemplate()
+        {
+            RenderFragment Template(TestClass child) =>
+                builder =>
+                {
+                    builder.OpenComponent<CardField<TestClass>>(0);
+                    builder.AddAttribute(1, "Context", child);
+                    builder.AddAttribute(2, "FieldName", "Id");
+                    builder.CloseComponent();
+                    builder.OpenComponent<CardField<TestClass>>(3);
+                    builder.AddAttribute(4, "Context", child);
+                    builder.AddAttribute(5, "FieldName", "Name");
+                    builder.CloseComponent();
+                };
+
+            return Template;
+        }
+
+        private static RenderFragment<TestClass> NoSearchAndSortTemplate()
+        {
+            RenderFragment Template(TestClass child) =>
+                builder =>
+                {
+                    builder.OpenComponent<CardField<TestClass>>(0);
+                    builder.AddAttribute(1, "Context", child);
+                    builder.AddAttribute(2, "FieldName", "Id");
+                    builder.AddAttribute(3, "AllowSearch", false);
+                    builder.AddAttribute(4, "AllowSort", false);
+                    builder.CloseComponent();
+                    builder.OpenComponent<CardField<TestClass>>(5);
+                    builder.AddAttribute(6, "Context", child);
+                    builder.AddAttribute(7, "FieldName", "Name");
+                    builder.AddAttribute(8, "AllowSearch", false);
+                    builder.AddAttribute(9, "AllowSort", false);
+                    builder.CloseComponent();
+                };
+
+            return Template;
+        }
+
+        [SetUp]
+        public void Setup()
+        {
+            this.context = new TestContext();
+            this.testClasses = [this.testClass1, this.testClass2, this.testClass3];
+
+            this.context.Services.AddDevExpressBlazor(_ => ConfigureJsInterop(this.context.JSInterop));
+
+            this.context.JSInterop.SetupVoid("DxBlazor.AdaptiveDropDown.init");
+            this.context.JSInterop.SetupVoid("DxBlazor.DropDown.getReference");
+            this.context.JSInterop.SetupVoid("DxBlazor.ComboBox.loadModule");
+            this.context.JSInterop.SetupVoid("DxBlazor.Input.loadModule");
+        }
+
+        [Test]
+        public void VerifyComponent()
+        {
+            var component = this.context.RenderComponent<CardView<TestClass>>(parameters =>
+            {
+                parameters
+                    .Add(p => p.Items, this.testClasses)
+                    .Add(p => p.ItemSize, 150)
+                    .Add(p => p.ItemTemplate, NormalTemplate());
+            });
+
+            var cardView = component;
+
+            Assert.Multiple(() =>
+                {
+                    Assert.That(cardView.Instance.AllowSort, Is.True);
+                    Assert.That(cardView.Instance.AllowSearch, Is.True);
+                    Assert.That(cardView.Instance.ItemSize, Is.EqualTo(150));
+                    Assert.That(cardView.Instance.SearchFields, Is.EquivalentTo(new [] {"Id", "Name"}));
+                    Assert.That(cardView.Instance.SortFields, Is.EquivalentTo(new[] { string.Empty, "Id", "Name" }));
+                });
+
+            var textBoxParentComponent = component.Find("#search-textbox");
+
+            Assert.Multiple(() =>
+            {
+                Assert.That(textBoxParentComponent, Is.Not.Null);
+                Assert.That(textBoxParentComponent.Attributes.Single(x => x.Name == "style").Value.Contains("visibility:block"), Is.True);
+            });
+
+            var comboBoxParentComponent = component.Find("#sort-dropdown");
+
+            Assert.Multiple(() =>
+            {
+                Assert.That(comboBoxParentComponent, Is.Not.Null);
+                Assert.That(comboBoxParentComponent.Attributes.Single(x => x.Name == "style").Value.Contains("visibility:block"), Is.True);
+            });
+
+            var cardFields = component.FindComponents<CardField<TestClass>>();
+
+            Assert.Multiple(() =>
+            {
+                Assert.That(cardFields.Count, Is.EqualTo(6));
+
+                foreach (var cardField in cardFields)
+                {
+                    Assert.That(cardField.Instance.AllowSearch, Is.True);
+                    Assert.That(cardField.Instance.AllowSort, Is.True);
+                }
+
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass1.Name)).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass2.Name)).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass3.Name)).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass1.Id.ToString())).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass2.Id.ToString())).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass3.Id.ToString())).Count, Is.EqualTo(1));
+            });
+        }
+
+        [Test]
+        public void VerifyComponentWithoutSortAndSearch()
+        {
+            var component = this.context.RenderComponent<CardView<TestClass>>(parameters =>
+            {
+                parameters
+                    .Add(p => p.Items, this.testClasses)
+                    .Add(p => p.ItemSize, 150)
+                    .Add(p => p.ItemTemplate, NoSearchAndSortTemplate());
+            });
+
+            var cardView = component;
+
+            Assert.Multiple(() =>
+            {
+                Assert.That(cardView.Instance.AllowSort, Is.False);
+                Assert.That(cardView.Instance.AllowSearch, Is.False);
+                Assert.That(cardView.Instance.ItemSize, Is.EqualTo(150));
+                Assert.That(cardView.Instance.SearchFields.Count, Is.EqualTo(0));
+                Assert.That(cardView.Instance.SortFields.Count, Is.EqualTo(1));
+            });
+
+            var textBoxParentComponent = component.Find("#search-textbox");
+
+            Assert.Multiple(() =>
+            {
+                Assert.That(textBoxParentComponent, Is.Not.Null);
+                Assert.That(textBoxParentComponent.Attributes.Single(x => x.Name == "style").Value.Contains("visibility:hidden"), Is.True);
+            });
+
+            var comboBoxParentComponent = component.Find("#sort-dropdown");
+
+            Assert.Multiple(() =>
+            {
+                Assert.That(comboBoxParentComponent, Is.Not.Null);
+                Assert.That(comboBoxParentComponent.Attributes.Single(x => x.Name == "style").Value.Contains("visibility:hidden"), Is.True);
+            });
+
+            var cardFields = component.FindComponents<CardField<TestClass>>();
+
+            Assert.Multiple(() =>
+            {
+                Assert.That(cardFields.Count, Is.EqualTo(6));
+
+                foreach (var cardField in cardFields)
+                {
+                    Assert.That(cardField.Instance.AllowSearch, Is.False);
+                    Assert.That(cardField.Instance.AllowSort, Is.False);
+                }
+
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass1.Name)).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass2.Name)).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass3.Name)).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass1.Id.ToString())).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass2.Id.ToString())).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass3.Id.ToString())).Count, Is.EqualTo(1));
+            });
+        }
+
+        [Test]
+        public void VerifyComponentRerenders()
+        {
+            var component = this.context.RenderComponent<CardView<TestClass>>(parameters =>
+            {
+                parameters
+                    .Add(p => p.Items, this.testClasses)
+                    .Add(p => p.ItemSize, 150)
+                    .Add(p => p.ItemTemplate, NoSearchAndSortTemplate());
+            });
+
+            var cardFields = component.FindComponents<CardField<TestClass>>();
+
+            Assert.Multiple(() =>
+            {
+                Assert.That(cardFields.Count, Is.EqualTo(6));
+
+                foreach (var cardField in cardFields)
+                {
+                    Assert.That(cardField.Instance.AllowSearch, Is.False);
+                    Assert.That(cardField.Instance.AllowSort, Is.False);
+                }
+
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass1.Name)).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass2.Name)).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass3.Name)).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass1.Id.ToString())).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass2.Id.ToString())).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass3.Id.ToString())).Count, Is.EqualTo(1));
+            });
+
+            // create new collection of items
+            this.testClass1 = new TestClass();
+            this.testClass2 = new TestClass();
+            this.testClass3 = new TestClass();
+            this.testClasses = [this.testClass1, this.testClass2, this.testClass3];
+
+            component.SetParametersAndRender(parameters => parameters
+                .Add(p => p.Items, this.testClasses));
+
+            cardFields = component.FindComponents<CardField<TestClass>>();
+
+            Assert.Multiple(() =>
+            {
+                Assert.That(cardFields.Count, Is.EqualTo(6));
+
+                foreach (var cardField in cardFields)
+                {
+                    Assert.That(cardField.Instance.AllowSearch, Is.False);
+                    Assert.That(cardField.Instance.AllowSort, Is.False);
+                }
+
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass1.Name)).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass2.Name)).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass3.Name)).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass1.Id.ToString())).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass2.Id.ToString())).ToList().Count, Is.EqualTo(1));
+                Assert.That(cardFields.Where(x => x.Markup.Contains(this.testClass3.Id.ToString())).Count, Is.EqualTo(1));
+            });
+        }
+
+        /// <summary>
+        /// Configure the <see cref="BunitJSInterop" /> for DevExpress
+        /// </summary>
+        /// <param name="interop">The <see cref="BunitJSInterop" /> to configure</param>
+        private static void ConfigureJsInterop(BunitJSInterop interop)
+        {
+            interop.Mode = JSRuntimeMode.Loose;
+
+            var rootModule = interop.SetupModule("./_content/DevExpress.Blazor/dx-blazor.js");
+            rootModule.Mode = JSRuntimeMode.Strict;
+
+            rootModule.Setup<DeviceInfo>("getDeviceInfo", _ => true)
+                .SetResult(new DeviceInfo(false));
+        }
+    }
+
+    public class TestClass
+    {
+        public Guid Id { get; } = Guid.NewGuid();
+
+        public string Name { get; } = $"Name-{DateTime.Now.Ticks}";
+    }
+}

COMET.Web.Common/COMET.Web.Common.csproj

@@ -36,13 +36,15 @@
         <PackageReference Include="CDP4ServicesDal-CE" Version="27.4.1" />
         <PackageReference Include="CDP4Web-CE" Version="27.4.1" />
         <PackageReference Include="DevExpress.Blazor" Version="23.2.9" />
+        <PackageReference Include="FastMember" Version="1.5.0" />
         <PackageReference Include="FluentResults" Version="3.16.0" />
         <PackageReference Include="Microsoft.AspNetCore.Components.Authorization" Version="8.0.10" />
         <PackageReference Include="Microsoft.AspNetCore.WebUtilities" Version="8.0.10" />
         <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="8.0.0" />
         <PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="8.0.2" />
         <PackageReference Include="ReactiveUI" Version="20.1.63" />
         <PackageReference Include="System.Drawing.Common" Version="8.0.10" />
+        <PackageReference Include="System.Linq.Dynamic.Core" Version="1.5.0" />
         <PackageReference Include="System.Text.RegularExpressions" Version="4.3.1" />
     </ItemGroup>