Initial groundwork for command builders (#19)

Directory.Packages.props

@@ -5,5 +5,6 @@
     <PackageVersion Include="Remora.Results" Version="7.4.1" />
     <PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
     <PackageVersion Include="Remora.Results.Analyzers" Version="1.0.2" />
+    <PackageVersion Include="OneOf" Version="3.0.223" />
   </ItemGroup>
 </Project>

Remora.Commands/Builders/AbstractCommandBuilder.cs

@@ -0,0 +1,175 @@
+//
+//  AbstractCommandBuilder.cs
+//
+//  Author:
+//       Jarl Gullberg <[email protected]>
+//
+//  Copyright (c) Jarl Gullberg
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU Lesser General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program 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 Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using System;
+using System.Collections.Generic;
+using Remora.Commands.Conditions;
+using Remora.Commands.DependencyInjection;
+
+namespace Remora.Commands.Builders;
+
+/// <summary>
+/// An abstract builder class with shared functionality/data between commands and groups.
+/// </summary>
+/// <typeparam name="TSelf">The type of the builder.</typeparam>
+public abstract class AbstractCommandBuilder<TSelf> where TSelf : AbstractCommandBuilder<TSelf>
+{
+    /// <summary>
+    /// Gets or sets the description of the group or command.
+    /// </summary>
+    public string? Description { get; protected set; }
+
+    /// <summary>
+    /// Gets the associated list of aliases.
+    /// </summary>
+    protected List<string> Aliases { get; }
+
+    /// <summary>
+    /// Gets the associated list of attributes.
+    /// </summary>
+    protected List<Attribute> Attributes { get; }
+
+    /// <summary>
+    /// Gets the associated list of conditions.
+    /// </summary>
+    protected List<ConditionAttribute> Conditions { get; }
+
+    /// <summary>
+    /// Gets the associated parent node if any.
+    /// </summary>
+    protected GroupBuilder? Parent { get; }
+
+    /// <summary>
+    /// Gets the associated <see cref="TreeRegistrationBuilder"/> for the command or group.
+    /// </summary>
+    protected TreeRegistrationBuilder? TreeBuilder { get; }
+
+    /// <summary>
+    /// Gets or sets the name of the command or group.
+    /// </summary>
+    protected string Name { get; set; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AbstractCommandBuilder{TSelf}"/> class.
+    /// </summary>
+    /// <param name="treeBuilder">The registration builder.</param>
+    protected AbstractCommandBuilder(TreeRegistrationBuilder treeBuilder)
+        : this()
+    {
+        TreeBuilder = treeBuilder;
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AbstractCommandBuilder{TSelf}"/> class.
+    /// </summary>
+    /// <param name="parent">The parent of the builder.</param>
+    protected AbstractCommandBuilder(GroupBuilder? parent = null)
+    {
+        Name = string.Empty;
+        Aliases = new();
+        Attributes = new();
+        Conditions = new();
+        Parent = parent;
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AbstractCommandBuilder{TSelf}"/> class.
+    /// </summary>
+    private AbstractCommandBuilder()
+    {
+        Aliases = new();
+        Attributes = new();
+        Conditions = new();
+        Name = string.Empty;
+    }
+
+    /// <summary>
+    /// Sets the name of the builder.
+    /// </summary>
+    /// <param name="name">The name of the builder.</param>
+    /// <returns>The current builder to chain calls with.</returns>
+    public TSelf WithName(string name)
+    {
+        Name = name;
+        return (TSelf)this;
+    }
+
+    /// <summary>
+    /// Sets the description of the builder.
+    /// </summary>
+    /// <param name="description">The description of the builder.</param>
+    /// <returns>The current builder to chain calls with.</returns>
+    public TSelf WithDescription(string description)
+    {
+        Description = description;
+        return (TSelf)this;
+    }
+
+    /// <summary>
+    /// Adds an alias to the builder.
+    /// </summary>
+    /// <param name="alias">The alias to add.</param>
+    /// <returns>The current builder to chain calls with.</returns>
+    public TSelf AddAlias(string alias)
+    {
+        Aliases.Add(alias);
+        return (TSelf)this;
+    }
+
+    /// <summary>
+    /// Adds multiple aliases to the builder.
+    /// </summary>
+    /// <param name="aliases">The aliases to add.</param>
+    /// <returns>The current builder to chain calls with.</returns>
+    public TSelf AddAliases(IEnumerable<string> aliases)
+    {
+        Aliases.AddRange(aliases);
+        return (TSelf)this;
+    }
+
+    /// <summary>
+    /// Adds an attribute to the builder. Conditions must be added via <see cref="AddCondition"/>.
+    /// </summary>
+    /// <param name="attribute">The attribute to add.</param>
+    /// <returns>The current builder to chain calls with.</returns>
+    public TSelf AddAttribute(Attribute attribute)
+    {
+        if (attribute is ConditionAttribute)
+        {
+            throw new InvalidOperationException("Conditions must be added via AddCondition.");
+        }
+
+        Attributes.Add(attribute);
+        return (TSelf)this;
+    }
+
+    /// <summary>
+    /// Adds a condition to the builder.
+    /// </summary>
+    /// <param name="condition">The condition to add.</param>
+    /// <returns>The current builder to chain calls with.</returns>
+    public TSelf AddCondition(ConditionAttribute condition)
+    {
+        Conditions.Add(condition);
+        return (TSelf)this;
+    }
+}