Merge pull request #2 from pBouillon/handle-for-remote-input

Handle the remote input

Author: pBouillon

src/AdventOfCode.Commons/AdventOfCode.Commons.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>net7.0</TargetFramework>
@@ -8,11 +8,11 @@
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
     <LangVersion>preview</LangVersion>
   </PropertyGroup>
 
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
     <LangVersion>preview</LangVersion>
   </PropertyGroup>
 

src/AdventOfCode.Commons/Configuration.cs

@@ -0,0 +1,17 @@
+namespace AdventOfCode.Commons;
+
+/// <summary>
+/// Configure the constants and values required for the application to run
+/// </summary>
+public static class Configuration
+{
+    /// <summary>
+    /// Your session cookie, if you want to retrieve your input from the internet
+    /// </summary>
+    ///
+    /// <remarks>
+    /// To get your cookie, head to https://adventofcode.com/, then look into the cookies
+    /// the website has set and paste its value here, it be something like <c>session:"[value]"</c>
+    /// </remarks>
+    public readonly static string? CookieValue = Environment.GetEnvironmentVariable("AOC_COOKIE");
+}

src/AdventOfCode.Commons/PuzzleInputReaderStrategy/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/PuzzleInputReaderStrategy/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/RemotePuzzleInputReaderStrategy.cs

@@ -0,0 +1,84 @@
+using System.Net;
+
+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";
+
+    /// <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();
+
+        container.Add(new Cookie
+        {
+            Name = "session",
+            Domain = ".adventofcode.com",
+            Value = string.IsNullOrEmpty(Configuration.CookieValue)
+                ? throw new Exception("You need to specify your cookie in order to get your input puzzle")
+                : Configuration.CookieValue,
+        });
+
+        return container;
+    }
+
+    /// <inheritdoc />
+    public IEnumerable<string> ReadInput()
+    {
+        var task = Task.Run(async () =>
+        {
+            var response = await Client.GetAsync($"/{Year}/day/{Day}/input");
+
+            return await response.EnsureSuccessStatusCode()
+                .Content
+                .ReadAsStringAsync();
+        });
+
+        task.Wait();
+
+        var content = task.Result;
+        return content.Split("\n")[..^1];
+    }
+}

src/AdventOfCode.Commons/Solver.cs

@@ -1,4 +1,6 @@
-namespace AdventOfCode.Commons;
+using AdventOfCode.Commons.PuzzleInputReaderStrategy;
+
+namespace AdventOfCode.Commons;
 
 /// <summary>
 /// Represent the solver used for a given day
@@ -14,30 +16,56 @@
 public abstract class Solver<TInput, TResult>
 {
     /// <summary>
-    /// The path to the input file (ex: <c>"day1/input.txt"</c>)
+    /// The puzzle input
     /// </summary>
-    protected abstract string InputPath { get; }
+    public readonly Lazy<TInput> PuzzleInput;
 
-    public readonly TInput Input;
+    /// <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)
+    {
+        PuzzleInput = new Lazy<TInput>(() =>
+        {
+            var content = puzzleInputReader.ReadInput();
+            return ParseInput(content);
+        });
+    }
 
-    protected Solver()
-        => Input = ReadInput(InputPath);
+    /// <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>
-    /// Logic for the solution of the first part of the puzzle
+    /// 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 }) { }
+
+
+    /// <summary>
+    /// Parse the input file and convert it to <typeparamref name="TInput"/>
+    /// for it to be used as the input of the <see cref="PartOne(TInput)"/>
+    /// and <see cref="PartTwo(TInput)"/>
     /// </summary>
     /// 
-    /// <param name="input">
-    /// The digested puzzle input
+    /// <param name="inputPath">
+    /// The path of your puzzle input
     /// </param>
     /// 
     /// <returns>
-    /// The puzzle's solution
+    /// The digested input
     /// </returns>
-    public abstract TResult PartOne(TInput input);
+    public abstract TInput ParseInput(IEnumerable<string> input);
 
     /// <summary>
-    /// Logic for the solution of the second part of the puzzle
+    /// Logic for the solution of the first part of the puzzle
     /// </summary>
     /// 
     /// <param name="input">
@@ -47,20 +75,18 @@ protected Solver()
     /// <returns>
     /// The puzzle's solution
     /// </returns>
-    public abstract TResult PartTwo(TInput input);
+    public abstract TResult PartOne(TInput input);
 
     /// <summary>
-    /// Parse the input file and convert it to <typeparamref name="TInput"/>
-    /// for it to be used as the input of the <see cref="PartOne(TInput)"/>
-    /// and <see cref="PartTwo(TInput)"/>
+    /// Logic for the solution of the second part of the puzzle
     /// </summary>
     /// 
-    /// <param name="inputPath">
-    /// The path of your puzzle input
+    /// <param name="input">
+    /// The digested puzzle input
     /// </param>
     /// 
     /// <returns>
-    /// The digested input
+    /// The puzzle's solution
     /// </returns>
-    public abstract TInput ReadInput(string inputPath);
+    public abstract TResult PartTwo(TInput input);
 }

src/AdventOfCode.Commons/TestEngine.cs

@@ -7,15 +7,15 @@ namespace AdventOfCode.Commons;
 /// <summary>
 /// Test engine for the implemented <typeparamref name="TSolver"/>
 /// </summary>
-/// 
+///
 /// <typeparam name="TSolver">
 /// The <see cref="Solver{TInput, TResult}"/> to use
 /// </typeparam>
-/// 
+///
 /// <typeparam name="TInput">
 /// The type of the data used to solve the puzzle
 /// </typeparam>
-/// 
+///
 /// <typeparam name="TResult">
 /// The type of the result of the puzzle
 /// </typeparam>
@@ -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
 
@@ -82,7 +81,7 @@ protected TestEngine()
     public void PartOneExampleTest()
     {
         Skip.If(PartOne.ShouldSkipTests, "Puzzle.ShouldSkipTests has been set to true, test skipped");
-        
+
         // Arrange
         var input = PartOne.Example.Input;
 
@@ -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);
+        var result = _solver.PartOne(input.Value);
 
         // 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);
+        var result = _solver.PartTwo(input.Value);
 
         // Assert
         result.Should().Be(PartTwo.Solution);

src/AdventOfCode.Usage/AdventOfCode.Usage.csproj

@@ -26,7 +26,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <None Update="input.txt">
+    <None Update="WithLocalInput\input.txt">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
   </ItemGroup>

src/AdventOfCode.Usage/Solver.cs renamed to src/AdventOfCode.Usage/WithLocalInput/Solver.cs

@@ -1,6 +1,6 @@
 using AdventOfCode.Commons;
 
-namespace AdventOfCode.Usage;
+namespace AdventOfCode.Usage.WithLocalInput;
 
 /// <summary>
 /// Example of how to use the <see cref="Solver{TInput, TResult}"/> for a simple puzzle
@@ -13,17 +13,14 @@ namespace AdventOfCode.Usage;
 /// </summary>
 public class Solver : Solver<int[], int>
 {
-    protected override string InputPath => "input.txt";
+    public Solver() : base(inputPath: "WithLocalInput/input.txt") { }
 
     public override int PartOne(int[] input)
         => input.Max();
 
     public override int PartTwo(int[] input)
         => input.Sum();
 
-    public override int[] ReadInput(string inputPath)
-        => File
-            .ReadAllLines(inputPath)
-            .Select(int.Parse)
-            .ToArray();
+    public override int[] ParseInput(IEnumerable<string> input)
+        => input.Select(int.Parse).ToArray();
 }

src/AdventOfCode.Usage/SolverTest.cs renamed to src/AdventOfCode.Usage/WithLocalInput/SolverTest.cs

@@ -1,6 +1,6 @@
 using AdventOfCode.Commons;
 
-namespace AdventOfCode.Usage;
+namespace AdventOfCode.Usage.WithLocalInput;
 
 /// <summary>
 /// Example of how to test the <see cref="Solver{TInput, TResult}"/>