Table layout

Source/SeaInk.Application/Exceptions/CrossedFrameException.cs

@@ -0,0 +1,18 @@
+using System;
+using System.Runtime.Serialization;
+using SeaInk.Application.TableLayout.Indices;
+using SeaInk.Application.TableLayout.Models;
+using SeaInk.Core.Exceptions;
+
+namespace SeaInk.Application.Exceptions
+{
+    [Serializable]
+    public class CrossedFrameException : SeaInkException
+    {
+        public CrossedFrameException(ITableIndex begin, ITableIndex current, Frame frame)
+            : base($"Index {current} should be in frame {frame} starting at {begin}") { }
+
+        protected CrossedFrameException(SerializationInfo info, StreamingContext context)
+            : base(info, context) { }
+    }
+}

Source/SeaInk.Application/Exceptions/InvalidScaleComponentException.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Runtime.Serialization;
+using SeaInk.Core.Exceptions;
+
+namespace SeaInk.Application.Exceptions
+{
+    [Serializable]
+    public class InvalidScaleComponentException : SeaInkException
+    {
+        public InvalidScaleComponentException(string argName, int value)
+            : base($"{argName} must be positive. Value {value}") { }
+
+        protected InvalidScaleComponentException(SerializationInfo info, StreamingContext context)
+            : base(info, context) { }
+    }
+}

Source/SeaInk.Application/Exceptions/MissingAssignmentComponentException.cs

@@ -0,0 +1,17 @@
+using System;
+using System.Runtime.Serialization;
+using SeaInk.Application.TableLayout.Models;
+using SeaInk.Core.Exceptions;
+
+namespace SeaInk.Application.Exceptions
+{
+    [Serializable]
+    public class MissingAssignmentComponentException : SeaInkException
+    {
+        public MissingAssignmentComponentException(AssignmentModel model)
+            : base($"There is no component in the table that represents an assignment {model}") { }
+
+        protected MissingAssignmentComponentException(SerializationInfo info, StreamingContext context)
+            : base(info, context) { }
+    }
+}

Source/SeaInk.Application/Exceptions/MissingStudentComponentException.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Runtime.Serialization;
+using SeaInk.Core.Exceptions;
+
+namespace SeaInk.Application.Exceptions
+{
+    [Serializable]
+    public class MissingStudentComponentException : SeaInkException
+    {
+        public MissingStudentComponentException()
+            : base("Table does not contain a component that represents student") { }
+
+        protected MissingStudentComponentException(SerializationInfo info, StreamingContext context)
+            : base(info, context) { }
+    }
+}

Source/SeaInk.Application/SeaInk.Application.csproj

@@ -2,10 +2,29 @@
 
     <PropertyGroup>
         <TargetFramework>net5.0</TargetFramework>
-        <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
+        <WarningLevel>5</WarningLevel>
+        <TreatWarningsAsErrors>True</TreatWarningsAsErrors>
     </PropertyGroup>
 
+    <ItemGroup>
+        <EditorConfigFiles Remove="..\.editorconfig" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <PackageReference Include="FluentResults" Version="3.1.0" />
+        <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.354">
+            <PrivateAssets>all</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+        </PackageReference>
+    </ItemGroup>
+
+    <ItemGroup>
+        <Content Include="..\..\.editorconfig">
+            <Link>.editorconfig</Link>
+        </Content>
+    </ItemGroup>
+
     <ItemGroup>
       <ProjectReference Include="..\SeaInk.Core\SeaInk.Core.csproj" />
       <ProjectReference Include="..\SeaInk.Utility\SeaInk.Utility.csproj" />

Source/SeaInk.Application/TableLayout/CommandInterfaces/IDrawableLayoutComponent.cs

@@ -0,0 +1,9 @@
+using SeaInk.Application.TableLayout.Indices;
+
+namespace SeaInk.Application.TableLayout.CommandInterfaces
+{
+    public interface IDrawableLayoutComponent
+    {
+        void Draw(ITableIndex begin, ITableEditor editor);
+    }
+}

Source/SeaInk.Application/TableLayout/CommandInterfaces/IExpandableLayoutComponent.cs

@@ -0,0 +1,12 @@
+using FluentResults;
+using SeaInk.Application.TableLayout.ComponentsBase;
+using SeaInk.Application.TableLayout.Indices;
+
+namespace SeaInk.Application.TableLayout.CommandInterfaces
+{
+    public interface IExpandableLayoutComponent<in TComponent>
+        where TComponent : LayoutComponent
+    {
+        Result AddComponent(TComponent component, IScaledTableIndex begin, ITableEditor editor);
+    }
+}

Source/SeaInk.Application/TableLayout/CommandInterfaces/IReducibleLayoutComponent.cs

@@ -0,0 +1,12 @@
+using FluentResults;
+using SeaInk.Application.TableLayout.ComponentsBase;
+using SeaInk.Application.TableLayout.Indices;
+
+namespace SeaInk.Application.TableLayout.CommandInterfaces
+{
+    public interface IReducibleLayoutComponent<in TComponent>
+        where TComponent : LayoutComponent
+    {
+        Result RemoveComponent(TComponent component, IScaledTableIndex begin, ITableEditor editor);
+    }
+}

Source/SeaInk.Application/TableLayout/CommandInterfaces/IRemovableComponent.cs

@@ -0,0 +1,9 @@
+using SeaInk.Application.TableLayout.Indices;
+
+namespace SeaInk.Application.TableLayout.CommandInterfaces
+{
+    public interface IRemovableComponent
+    {
+        void Remove(ITableIndex begin, ITableEditor editor);
+    }
+}

Source/SeaInk.Application/TableLayout/CommandInterfaces/IValueGettingLayoutComponent.cs

@@ -0,0 +1,9 @@
+using SeaInk.Application.TableLayout.Indices;
+
+namespace SeaInk.Application.TableLayout.CommandInterfaces
+{
+    public interface IValueGettingLayoutComponent<T>
+    {
+        T GetValue(ITableIndex begin, ITableDataProvider provider);
+    }
+}

Source/SeaInk.Application/TableLayout/CommandInterfaces/IValueRepresentingLayoutComponent.cs

@@ -0,0 +1,7 @@
+namespace SeaInk.Application.TableLayout.CommandInterfaces
+{
+    public interface IValueRepresentingLayoutComponent<T>
+    {
+        T Value { get; }
+    }
+}

Source/SeaInk.Application/TableLayout/CommandInterfaces/IValueSettingLayoutComponent.cs

@@ -0,0 +1,9 @@
+using SeaInk.Application.TableLayout.Indices;
+
+namespace SeaInk.Application.TableLayout.CommandInterfaces
+{
+    public interface IValueSettingLayoutComponent<T>
+    {
+        void SetValue(T value, ITableIndex begin, ITableEditor editor);
+    }
+}

Source/SeaInk.Application/TableLayout/Commands/AggregateValuesCommand.cs

@@ -0,0 +1,42 @@
+using System.Collections.Generic;
+using System.Linq;
+using FluentResults;
+using SeaInk.Application.TableLayout.CommandsBase;
+using SeaInk.Application.TableLayout.ComponentsBase;
+using SeaInk.Application.TableLayout.Indices;
+using SeaInk.Application.TableLayout.Successes;
+using SeaInk.Utility.Extensions;
+
+namespace SeaInk.Application.TableLayout.Commands
+{
+    public class AggregateValuesCommand<T> : ILayoutCommand
+    {
+        private readonly List<T> _values = new List<T>();
+        private readonly ITableDataProvider _provider;
+        private readonly List<LayoutComponent> _visitedComponents = new List<LayoutComponent>();
+
+        public AggregateValuesCommand(ITableDataProvider provider)
+        {
+            _provider = provider;
+        }
+
+        public IReadOnlyCollection<T> Values => _values.AsReadOnly();
+
+        public Result Execute(LayoutComponent target, ITableIndex begin, ITableEditor? editor)
+        {
+            var command = new GetValueCommand<T>(_provider);
+            Result result = target.ExecuteCommand(new ComponentIgnoringCommand(command, _visitedComponents), begin, editor);
+
+            while (result.IsSuccess)
+            {
+                _values.Add(command.Value.ThrowIfNull(nameof(command.Value)));
+                var success = (SuccessComponent)result.Successes.Single();
+                _visitedComponents.Add(success.Component);
+
+                result = target.ExecuteCommand(new ComponentIgnoringCommand(command, _visitedComponents), begin, editor);
+            }
+
+            return Result.Ok();
+        }
+    }
+}

Source/SeaInk.Application/TableLayout/Commands/ComponentIgnoringCommand.cs

@@ -0,0 +1,33 @@
+using System.Collections.Generic;
+using System.Linq;
+using FluentResults;
+using SeaInk.Application.TableLayout.CommandsBase;
+using SeaInk.Application.TableLayout.ComponentsBase;
+using SeaInk.Application.TableLayout.Errors;
+using SeaInk.Application.TableLayout.Indices;
+using SeaInk.Application.TableLayout.Successes;
+
+namespace SeaInk.Application.TableLayout.Commands
+{
+    public class ComponentIgnoringCommand : ILayoutCommand
+    {
+        private readonly ILayoutCommand _command;
+        private readonly IReadOnlyCollection<LayoutComponent> _ignored;
+
+        public ComponentIgnoringCommand(ILayoutCommand command, IReadOnlyCollection<LayoutComponent> ignored)
+        {
+            _command = command;
+            _ignored = ignored.ToList();
+        }
+
+        public Result Execute(LayoutComponent target, ITableIndex begin, ITableEditor? editor)
+        {
+            if (_ignored.Contains(target))
+                return Result.Fail(new ComponentShouldBeIgnoredError(target));
+
+            Result result = target.ExecuteCommand(_command, begin, editor);
+
+            return result.IsSuccess ? result.WithSuccess(new SuccessComponent(target)) : result;
+        }
+    }
+}

Source/SeaInk.Application/TableLayout/Commands/ComponentRemoveCommand.cs

@@ -0,0 +1,28 @@
+using FluentResults;
+using SeaInk.Application.TableLayout.CommandInterfaces;
+using SeaInk.Application.TableLayout.CommandsBase;
+using SeaInk.Application.TableLayout.Errors;
+using SeaInk.Application.TableLayout.Indices;
+using SeaInk.Utility.Extensions;
+
+namespace SeaInk.Application.TableLayout.Commands
+{
+    public class ComponentRemoveCommand : GenericLayoutCommand<IRemovableComponent>
+    {
+        private readonly IRemovableComponent _component;
+
+        public ComponentRemoveCommand(IRemovableComponent component)
+        {
+            _component = component.ThrowIfNull(nameof(component));
+        }
+
+        protected override Result Execute(IRemovableComponent target, ITableIndex begin, ITableEditor? editor)
+        {
+            if (!target.Equals(_component))
+                return Result.Fail(new InvalidComponentError<IRemovableComponent>(_component, target));
+
+            target.Remove(begin, editor.ThrowIfNull(nameof(editor)));
+            return Result.Ok();
+        }
+    }
+}

Source/SeaInk.Application/TableLayout/Commands/DrawAllCommand.cs

@@ -0,0 +1,30 @@
+using System.Collections.Generic;
+using System.Linq;
+using FluentResults;
+using SeaInk.Application.TableLayout.CommandsBase;
+using SeaInk.Application.TableLayout.ComponentsBase;
+using SeaInk.Application.TableLayout.Indices;
+using SeaInk.Application.TableLayout.Successes;
+
+namespace SeaInk.Application.TableLayout.Commands
+{
+    public class DrawAllCommand : ILayoutCommand
+    {
+        private readonly List<LayoutComponent> _visitedComponents = new List<LayoutComponent>();
+
+        public Result Execute(LayoutComponent target, ITableIndex begin, ITableEditor? editor)
+        {
+            var command = new DrawComponentCommand();
+            Result result = target.ExecuteCommand(new ComponentIgnoringCommand(command, _visitedComponents), begin, editor);
+
+            while (result.IsSuccess)
+            {
+                var success = (SuccessComponent)result.Successes.Single();
+                _visitedComponents.Add(success.Component);
+                result = target.ExecuteCommand(new ComponentIgnoringCommand(command, _visitedComponents), begin, editor);
+            }
+
+            return Result.Ok();
+        }
+    }
+}

Source/SeaInk.Application/TableLayout/Commands/DrawComponentCommand.cs

@@ -0,0 +1,18 @@
+using FluentResults;
+using SeaInk.Application.TableLayout.CommandInterfaces;
+using SeaInk.Application.TableLayout.CommandsBase;
+using SeaInk.Application.TableLayout.Indices;
+using SeaInk.Utility.Extensions;
+
+namespace SeaInk.Application.TableLayout.Commands
+{
+    public class DrawComponentCommand : GenericLayoutCommand<IDrawableLayoutComponent>
+    {
+        protected override Result Execute(IDrawableLayoutComponent target, ITableIndex begin, ITableEditor? editor)
+        {
+            var index = new MergeScanningIndex(begin.Copy(), editor.ThrowIfNull(nameof(editor)));
+            target.Draw(index, editor!);
+            return Result.Ok();
+        }
+    }
+}