Feat/BookApplication

COMET.Web.Common.Tests/Components/BookEditor/InputEditorTestFixture.cs

@@ -0,0 +1,122 @@
+// --------------------------------------------------------------------------------------------------------------------
+//  <copyright file="InputEditorTestFixture.cs" company="RHEA System S.A.">
+//     Copyright (c) 2023 RHEA System S.A.
+// 
+//     Authors: Sam Gerené, Alex Vorobiev, Alexander van Delft, Jaime Bernar, Théate Antoine, Nabil Abbar
+// 
+//     This file is part of COMET WEB Community Edition
+//     The COMET WEB Community Edition is the RHEA Web Application implementation of ECSS-E-TM-10-25 Annex A and Annex C.
+// 
+//     The 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 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.BookEditor
+{
+    using Bunit;
+
+    using CDP4Common.ReportingData;
+    using CDP4Common.SiteDirectoryData;
+
+    using COMET.Web.Common.Components.BookEditor;
+    using COMET.Web.Common.Test.Helpers;
+    using COMET.Web.Common.ViewModels.Components.BookEditor;
+
+    using DevExpress.Blazor;
+
+    using DynamicData;
+
+    using Microsoft.AspNetCore.Components;
+
+    using Moq;
+
+    using NUnit.Framework;
+
+    using TestContext = Bunit.TestContext;
+
+    [TestFixture]
+    public class InputEditorTestFixture
+    {
+        private TestContext context;
+        private IRenderedComponent<InputEditor<Book>> component;
+        private Book book;
+        private List<DomainOfExpertise> activeDomains;
+        private List<Category> availableCategories;
+
+        [SetUp]
+        public void Setup()
+        {
+            this.context = new TestContext();
+            this.context.ConfigureDevExpressBlazor();
+
+            this.activeDomains = new List<DomainOfExpertise>
+            {
+                new() { Name = "Sys" }
+            };
+
+            this.availableCategories = new List<Category>
+            {
+                new() { Name = "Category" }
+            };
+
+            this.book = new Book()
+            {
+                Name = "Book Example",
+                ShortName = "bookExample",
+                Owner = this.activeDomains.First(),
+                Category = this.availableCategories
+            };
+
+            this.component = this.context.RenderComponent<InputEditor<Book>>(parameters =>
+            {
+                parameters.Add(p => p.Item, this.book);
+                parameters.Add(p => p.ActiveDomains, this.activeDomains);
+                parameters.Add(p => p.AvailableCategories, this.availableCategories);
+            });
+        }
+
+        [Test]
+        public void VerifyComponent()
+        {
+            var dxtabs = this.component.FindComponent<DxTabs>();
+
+            dxtabs.Instance.ActiveTabIndex = 0;
+
+            var textboxes = this.component.FindComponents<DxTextBox>();
+            var combobox = this.component.FindComponent<DxComboBox<DomainOfExpertise, DomainOfExpertise>>();
+
+            var nameTextbox = textboxes[0];
+            var shortNameTextbox = textboxes[1];
+
+            Assert.Multiple(() =>
+            {
+                Assert.That(nameTextbox.Instance.Text, Is.EqualTo("Book Example"));
+                Assert.That(shortNameTextbox.Instance.Text, Is.EqualTo("bookExample"));
+                Assert.That(combobox.Instance.Value, Is.EqualTo(this.activeDomains.First()));
+            });
+
+            dxtabs.Instance.ActiveTabIndex = 1;
+            this.component.Render();
+
+            var listbox = this.component.FindComponent<DxListBox<Category, Category>>();
+
+            Assert.Multiple(() =>
+            {
+                Assert.That(listbox.Instance.Data, Is.EquivalentTo(this.availableCategories));
+                Assert.That(listbox.Instance.Values, Is.EquivalentTo(this.availableCategories));
+            });
+        }
+    }
+}
+

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

@@ -43,6 +43,9 @@
     <InternalsVisibleTo Include="DynamicProxyGenAssembly2" />
   </ItemGroup>
   <ItemGroup>
+    <Content Update="Components\BookEditor\InputEditor.razor">
+      <ExcludeFromSingleFile>true</ExcludeFromSingleFile>
+    </Content>
     <Content Update="wwwroot\DefaultTextConfiguration.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </Content>

COMET.Web.Common/Components/BookEditor/EditorPopup.razor

@@ -0,0 +1,41 @@
+<!------------------------------------------------------------------------------
+// Copyright (c) 2023 RHEA System S.A.
+//
+//   Authors: Sam Gerené, Alex Vorobiev, Alexander van Delft, Jaime Bernar, Théate Antoine, Nabil Abbar
+//
+//   This file is part of COMET WEB Community Edition
+//   The COMET WEB Community Edition is the RHEA Web Application implementation of ECSS-E-TM-10-25
+//   Annex A and Annex C.
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+------------------------------------------------------------------------------->
+@namespace COMET.Web.Common.Components.BookEditor
+@inherits DisposableComponent
+
+<DxPopup @bind-Visible="@this.ViewModel.IsVisible" CloseOnOutsideClick="false" ShowCloseButton="true" ShowFooter="true" HeaderText="@this.ViewModel.HeaderText" Closed="@(()=> this.ViewModel.OnCancelClick.InvokeAsync())">
+    <Content>
+        <InputEditor Item="@this.ViewModel.Item" ActiveDomains="@this.ViewModel.ActiveDomains" AvailableCategories="@this.ViewModel.AvailableCategories" />
+        <div style="display:flex; flex-direction:column">
+            @foreach (var validationError in this.ViewModel.ValidationErrors.Items)
+            {
+                <ValidationMessageComponent ValidationMessage="@validationError"/>
+            }
+        </div>
+    </Content>
+    <FooterTemplate>
+        <div class="modal-footer">
+            <DxButton Text="OK" RenderStyle="ButtonRenderStyle.Primary" Click="@(async () => await this.OnConfirmClick())" />
+            <DxButton Text="Cancel" RenderStyle="ButtonRenderStyle.Danger" Click="@(async () => await this.ViewModel.OnCancelClick.InvokeAsync())" />
+        </div>
+    </FooterTemplate>
+</DxPopup>

COMET.Web.Common/Components/BookEditor/EditorPopup.razor.cs

@@ -0,0 +1,123 @@
+// --------------------------------------------------------------------------------------------------------------------
+//  <copyright file="InputEditor.razor.cs" company="RHEA System S.A.">
+//    Copyright (c) 2023 RHEA System S.A.
+// 
+//    Authors: Sam Gerené, Alex Vorobiev, Alexander van Delft, Jaime Bernar, Théate Antoine, Nabil Abbar
+// 
+//    This file is part of COMET WEB Community Edition
+//    The COMET WEB Community Edition is the RHEA Web Application implementation of ECSS-E-TM-10-25
+//    Annex A and Annex C.
+// 
+//    Licensed under the Apache License, Version 2.0 (the "License");
+//    you may not use this file except in compliance with the License.
+//    You may obtain a copy of the License at
+// 
+//        http://www.apache.org/licenses/LICENSE-2.0
+// 
+//    Unless required by applicable law or agreed to in writing, software
+//    distributed under the License is distributed on an "AS IS" BASIS,
+//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//    See the License for the specific language governing permissions and
+//    limitations under the License.
+// 
+//  </copyright>
+//  --------------------------------------------------------------------------------------------------------------------
+
+namespace COMET.Web.Common.Components.BookEditor
+{
+    using CDP4Common.ReportingData;
+
+    using COMET.Web.Common.Services;
+    using COMET.Web.Common.ViewModels.Components.BookEditor;
+
+    using Microsoft.AspNetCore.Components;
+
+    using INamedThing = CDP4Common.CommonData.INamedThing;
+    using IOwnedThing = CDP4Common.EngineeringModelData.IOwnedThing;
+    using IShortNamedThing = CDP4Common.CommonData.IShortNamedThing;
+
+    /// <summary>
+    /// Support class for the BookEditorPopup component
+    /// </summary>
+    public partial class EditorPopup
+    {
+        /// <summary>
+        /// Gets or sets the <see cref="IEditorPopupViewModel"/>
+        /// </summary>
+        [Parameter]
+        public IEditorPopupViewModel ViewModel { get; set; }
+
+        /// <summary>
+        /// Method invoked when the component is ready to start, having received its
+        /// initial parameters from its parent in the render tree.
+        ///
+        /// Override this method if you will perform an asynchronous operation and
+        /// want the component to refresh when that operation is completed.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing any asynchronous operation.</returns>
+        protected override async Task OnInitializedAsync()
+        {
+            await base.OnInitializedAsync();
+            this.Disposables.Add(this.ViewModel.ValidationErrors.Connect().Subscribe(_ => this.InvokeAsync(this.StateHasChanged)));
+        }
+
+        /// <summary>
+        /// Handler for when the confirm button has been clicked
+        /// </summary>
+        private async Task OnConfirmClick()
+        {
+            var validationErrors = new List<string>();
+
+            if (this.ViewModel.Item is INamedThing namedThing)
+            {
+                var error = ValidationService.ValidateProperty(nameof(namedThing.Name), namedThing.Name);
+
+                if (!string.IsNullOrEmpty(error))
+                {
+                    validationErrors.Add(error);
+                }
+            }
+
+            if (this.ViewModel.Item is IShortNamedThing shortNamedThing)
+            {
+                var error = ValidationService.ValidateProperty(nameof(shortNamedThing.ShortName), shortNamedThing.ShortName);
+
+                if (!string.IsNullOrEmpty(error))
+                {
+                    validationErrors.Add(error);
+                }
+            }
+
+            if (this.ViewModel.Item is IOwnedThing ownedThing)
+            {
+                var error = ownedThing.Owner == null ? "The thing must be owned by a DoE" : string.Empty;
+
+                if (!string.IsNullOrEmpty(error))
+                {
+                    validationErrors.Add(error);
+                }
+            }
+
+            if (this.ViewModel.Item is TextualNote textualNote)
+            {
+                var error = string.IsNullOrEmpty(textualNote.Content)? "The textual note must contain a content" : string.Empty;
+
+                if (!string.IsNullOrEmpty(error))
+                {
+                    validationErrors.Add(error);
+                }
+            }
+
+            this.ViewModel.ValidationErrors.Edit(inner =>
+            {
+                inner.Clear();
+                inner.AddRange(validationErrors);
+            });
+
+            if (!this.ViewModel.ValidationErrors.Items.Any())
+            {
+                await this.ViewModel.OnConfirmClick.InvokeAsync();
+            }
+        }
+    }
+}

COMET.Web.Common/Components/BookEditor/InputEditor.razor

@@ -0,0 +1,93 @@
+<!------------------------------------------------------------------------------
+// Copyright (c) 2023 RHEA System S.A.
+//
+//   Authors: Sam Gerené, Alex Vorobiev, Alexander van Delft, Jaime Bernar, Théate Antoine, Nabil Abbar
+//
+//   This file is part of COMET WEB Community Edition
+//   The COMET WEB Community Edition is the RHEA Web Application implementation of ECSS-E-TM-10-25
+//   Annex A and Annex C.
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+------------------------------------------------------------------------------->
+@namespace COMET.Web.Common.Components.BookEditor
+@inherits DisposableComponent
+@using CDP4Common.SiteDirectoryData
+@using CDP4Common.CommonData
+@using CDP4Common.EngineeringModelData
+@using CDP4Common.ReportingData
+@typeparam TItem
+
+<div>
+    <DxTabs>
+        <DxTabPage Text="Basic">
+            <div class="tab-content">
+                @if (this.Item is INamedThing namedThing)
+                {
+                    <div class="w-100 editor-row">
+                        <p>Name:</p>
+                        <DxTextBox CssClass="w-100" @bind-Text="@namedThing.Name" />
+                    </div>
+                }
+
+                @if (this.Item is IShortNamedThing shortNamedThing)
+                {
+                    <div class="w-100 editor-row">
+                        <p>ShortName:</p>
+                        <DxTextBox CssClass="w-100" @bind-Text="@shortNamedThing.ShortName" />
+                    </div>
+                }
+
+                @if (this.Item is IOwnedThing ownedThing)
+                {
+                    <div class="w-100 editor-row">
+                        <p>Owner:</p>
+                        <DxComboBox @bind-Value="@ownedThing.Owner"
+                                    Data="@this.ActiveDomains"
+                                    TData="DomainOfExpertise"
+                                    TValue="DomainOfExpertise"
+                                    TextFieldName="@nameof(DomainOfExpertise.Name)"
+                                    CssClass="w-100" />
+                    </div>
+                }
+
+                @if (this.Item is TextualNote textualNote)
+                {
+                    <div class="w-100 editor-row">
+                        <p>Content:</p>
+                        <DxMemo @bind-Text="textualNote.Content"
+                                CssClass="w-100"
+                                Rows="4" />
+                    </div>
+                }
+            </div>
+        </DxTabPage>
+        <DxTabPage Text="Category">
+            <div class="tab-content">
+                @if (this.Item is ICategorizableThing categorizableThing)
+                {
+                    <DxListBox Values="@categorizableThing.Category"
+                               Data="@this.AvailableCategories"
+                               TData="Category"
+                               TValue="Category"
+                               ValuesChanged="@this.OnCategoryChange"
+                               TextFieldName="@nameof(Category.Name)"
+                               SelectionMode="ListBoxSelectionMode.Multiple"
+                               ShowCheckboxes="true"
+                               CssClass="w-auto mt-1 me-1 flex-grow-1 chi-220"
+                               style="flex-basis: 240px">
+                    </DxListBox>
+                }
+            </div>
+        </DxTabPage>
+    </DxTabs>
+</div>