Add the missing documentation

Author: pBouillon

src/AdventOfCode.Commons/Input/IPuzzleInput.cs

@@ -0,0 +1,20 @@
+namespace AdventOfCode.Commons.PuzzleInputReaderStrategy;
+
+/// <summary>
+/// Defines the strategy to be used to read the puzzle input
+/// </summary>
+public interface IPuzzleInputReaderStrategy
+{
+    /// <summary>
+    /// Read the lines composing puzzle input
+    /// </summary>
+    ///
+    /// <returns>
+    /// The puzzle input as an enumeration of its lines
+    /// </returns>
+    ///
+    /// <remarks>
+    /// The trailing blank line is omitted
+    /// </remarks>
+    IEnumerable<string> ReadInput();
+}

src/AdventOfCode.Commons/Input/LocalPuzzleInputReaderStrategy.cs

@@ -0,0 +1,16 @@
+namespace AdventOfCode.Commons.PuzzleInputReaderStrategy;
+
+/// <summary>
+/// Strategy to retrieve the input from a local file at a given path
+/// </summary>
+public class LocalPuzzleInputReaderStrategy : IPuzzleInputReaderStrategy
+{
+    /// <summary>
+    /// The path where the puzzle input is located
+    /// </summary>
+    public required string InputPath { get; init; }
+
+    /// <inheritdoc />
+    public IEnumerable<string> ReadInput()
+        => File.ReadAllLines(InputPath);
+}

src/AdventOfCode.Commons/PuzzleInputReaderStrategy/IPuzzleInput.cs

@@ -1,28 +1,53 @@
 using System.Net;
 
-namespace AdventOfCode.Commons.Input;
+namespace AdventOfCode.Commons.PuzzleInputReaderStrategy;
 
+/// <summary>
+/// Strategy to retrieve the input from the advent of code server
+/// </summary>
 public class RemotePuzzleInputReaderStrategy : IPuzzleInputReaderStrategy
 {
     private const string AdventOfCodeBaseUrl = "https://adventofcode.com";
-    
-    public const string Cookie = "53616c7465645f5f24418ae85f2ee16ffe226239823eded5e30b5f5dee7817447b92dd8ac6207ed1838b8ef68429c61bac187a1e2b7e7cd1e747ea82fe417a96";
 
+    /// <summary>
+    /// The year targeted by this reader
+    /// </summary>
     public required int Year { get; init; }
-    
+
+    /// <summary>
+    /// The day of the puzzle whose entry we want to retrieve
+    /// </summary>
     public required int Day { get; init; }
 
+    /// <summary>
+    /// The inner HTTP client handler, preconfigured to use cookies and provide the value set in
+    /// <see cref="Configuration.CookieValue"/>
+    /// </summary>
     private static HttpClientHandler Handler => new()
     {
         CookieContainer = GetCookieContainer(),
         UseCookies = true,
     };
 
+    /// <summary>
+    /// The inner HTTP client, preconfigured to make requests to the advent of code URI
+    /// </summary>
     private static HttpClient Client => new(Handler)
     {
         BaseAddress = new Uri(AdventOfCodeBaseUrl),
     };
 
+    /// <summary>
+    /// Create a new cookie container with the one set in <see cref="Configuration.CookieValue"/>
+    /// </summary>
+    /// 
+    /// <returns>
+    /// The cookie container for the <see cref="HttpClientHandler"/> to use
+    /// </returns>
+    /// 
+    /// <exception cref="Exception">
+    /// Thrown if it is called but <see cref="Configuration.CookieValue"/> is not set
+    /// </exception>
     private static CookieContainer GetCookieContainer()
     {
         var container = new CookieContainer();
@@ -31,14 +56,15 @@ private static CookieContainer GetCookieContainer()
         {
             Name = "session",
             Domain = ".adventofcode.com",
-            Value = string.IsNullOrEmpty(Cookie)
+            Value = string.IsNullOrEmpty(Configuration.CookieValue)
                 ? throw new Exception("You need to specify your cookie in order to get your input puzzle")
-                : Cookie,
+                : Configuration.CookieValue,
         });
 
         return container;
     }
 
+    /// <inheritdoc />
     public IEnumerable<string> ReadInput()
     {
         var task = Task.Run(async () =>

src/AdventOfCode.Commons/PuzzleInputReaderStrategy/LocalPuzzleInputReaderStrategy.cs

@@ -1,4 +1,4 @@
-using AdventOfCode.Commons.Input;
+using AdventOfCode.Commons.PuzzleInputReaderStrategy;
 
 namespace AdventOfCode.Commons;
 
@@ -15,20 +15,33 @@ namespace AdventOfCode.Commons;
 /// </typeparam>
 public abstract class Solver<TInput, TResult>
 {
-    public readonly Lazy<TInput> Input;
+    /// <summary>
+    /// The puzzle input
+    /// </summary>
+    public readonly TInput PuzzleInput;
 
+    /// <summary>
+    /// Create a new solver and initialize its puzzle input based on the provided <see cref="IPuzzleInputReaderStrategy"/>
+    /// </summary>
+    /// <param name="puzzleInputReader">The strategy to use to retriever the puzzle input</param>
     private Solver(IPuzzleInputReaderStrategy puzzleInputReader)
     {
-        Input = new Lazy<TInput>(() =>
-        {
-            var content = puzzleInputReader.ReadInput();
-            return ParseInput(content);
-        });
+        var content = puzzleInputReader.ReadInput();
+        PuzzleInput = ParseInput(content);
     }
 
+    /// <summary>
+    /// Create a new solver with a puzzle input located in a local file
+    /// </summary>
+    /// <param name="inputPath">The path to the file containing the input</param>
     protected Solver(string inputPath)
         : this(new LocalPuzzleInputReaderStrategy { InputPath = inputPath }) { }
 
+    /// <summary>
+    /// Create a new solver that will retrieve the puzzle input from the server
+    /// </summary>
+    /// <param name="year">The year of the current challenge</param>
+    /// <param name="day">The day for which the puzzle input is needed</param>
     protected Solver(int year, int day)
         : this(new RemotePuzzleInputReaderStrategy { Year = year, Day = day }) { }
 

…Input/RemotePuzzleInputReaderStrategy.cs …ategy/RemotePuzzleInputReaderStrategy.cssrc/AdventOfCode.Commons/Input/RemotePuzzleInputReaderStrategy.cs renamed to src/AdventOfCode.Commons/PuzzleInputReaderStrategy/RemotePuzzleInputReaderStrategy.cs src/AdventOfCode.Commons/Input/RemotePuzzleInputReaderStrategy.cs renamed to src/AdventOfCode.Commons/PuzzleInputReaderStrategy/RemotePuzzleInputReaderStrategy.cs

@@ -32,7 +32,7 @@ public record Example
     {
         /// <summary>
         /// The data of the input mentionned in the example, in the same form as the
-        /// <see cref="Solver{TInput, TResult}.Input"/>
+        /// <see cref="Solver{TInput, TResult}.PuzzleInput"/>
         /// </summary>
         public TInput Input { get; init; } = default!;
 
@@ -71,8 +71,7 @@ public record Puzzle
     /// </summary>
     private readonly TSolver _solver;
 
-    protected TestEngine()
-        => _solver = new TSolver();
+    protected TestEngine() => _solver = new TSolver();
 
     #region Part #1
 
@@ -99,10 +98,10 @@ public void PartOneSolutionTest()
         Skip.If(PartOne.ShouldSkipTests, "Puzzle.ShouldSkipTests has been set to true, test skipped");
 
         // Arrange
-        var input = _solver.Input;
+        var input = _solver.PuzzleInput;
 
         // Act
-        var result = _solver.PartOne(input.Value);
+        var result = _solver.PartOne(input);
 
         // Assert
         result.Should().Be(PartOne.Solution);
@@ -135,10 +134,10 @@ public void PartTwoSolutionTest()
         Skip.If(PartTwo.ShouldSkipTests, "Puzzle.ShouldSkipTests has been set to true, test skipped");
 
         // Arrange
-        var input = _solver.Input;
+        var input = _solver.PuzzleInput;
 
         // Act
-        var result = _solver.PartTwo(input.Value);
+        var result = _solver.PartTwo(input);
 
         // Assert
         result.Should().Be(PartTwo.Solution);