AdventOfCodeSupport 2.0.0-beta.2

This is a prerelease version of AdventOfCodeSupport.
There is a newer version of this package available.
See the version list below for details.
The owner has unlisted this package. This could mean that the package is deprecated, has security vulnerabilities or shouldn't be used anymore.
dotnet add package AdventOfCodeSupport --version 2.0.0-beta.2
NuGet\Install-Package AdventOfCodeSupport -Version 2.0.0-beta.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="AdventOfCodeSupport" Version="2.0.0-beta.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AdventOfCodeSupport --version 2.0.0-beta.2
#r "nuget: AdventOfCodeSupport, 2.0.0-beta.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install AdventOfCodeSupport as a Cake Addin
#addin nuget:?package=AdventOfCodeSupport&version=2.0.0-beta.2&prerelease

// Install AdventOfCodeSupport as a Cake Tool
#tool nuget:?package=AdventOfCodeSupport&version=2.0.0-beta.2&prerelease

AdventOfCodeSupport

This package provides support to simplify the process of storing each day's puzzle within a single solution. Each day is automatically registered to a central location, with built-in support for BenchmarkDotNet, downloading input files, and submitting answers.

Getting Started

  • Begin by adding this NuGet package to your project AdventOfCodeSupport.
  • Add a folder to your project for the current year i.e. 2022.
  • Add a subfolder to the year called Inputs.
  • Place each day's input into that folder named by day with 2 digits 01.txt.
  • Create a class in the 2022 folder called Day01.cs
Project/
├── Program.cs
└── 2022/
    ├── Day01.cs
    ├── Day02.cs
    └── Inputs/
        ├── 01.txt
        └── 02.txt
using AdventOfCodeSupport;

namespace Foo._2022;

public class Day01 : AdventBase
{
    protected override void InternalOnLoad()
    {
        // Optional override, runs before Part1/2.
        // Benchmarked separately.
    }
    
    protected override object InternalPart1()
    {
        // Part 1 solution here.
        Console.WriteLine($"Characters: {Input.Text.Length}");
        Console.WriteLine($"Lines: {Input.Lines.Length}");
        Console.WriteLine($"Blocks: {Input.Blocks.Length}");
        var partOneAnswer = 42;
        return partOneAnswer;
    }

    protected override object InternalPart2()
    {
        // Part 2 solution here.
        Bag["Foo"] = "Bar"; // Pass information to unit tests.
        var partTwoAnswer = "ArDKz";
        return partTwoAnswer;
    }
}
  • The property Input loads the day's input file automatically, containing Text for the raw text, Lines split on new lines removing leading and trailing empty new lines, and Blocks which are split on double new lines.
  • Returned answers can be used by SubmitPart1/2Async() *see below.
  • Create a new AdventSolutions() at your entry point.
  • Select your day from the AdventSolutions, for example:
using AdventOfCodeSupport;

var solutions = new AdventSolutions();
var today = solutions.GetMostRecentDay();
// var day3 = solutions.GetDay(2022, 3);
// var day4 = solutions.First(x => x.Year == 2022 && x.Day == 4);
today.Part1().Part2();
// today.Benchmark();
  • Run your solution parts with today.Part1().Part2().
  • Or benchmark them with today.Benchmark(), benchmarking requires running in Release.

Benchmarking

There's 2 different ways you can benchmark your solutions with this package, namely, on the derived AdventBase day object itself with .Benchmark(); or, on the entire collection of days under AdventSolutions with .BenchmarkAll(). Both options accept IConfig for BenchmarkDotNet configuration, refer to their documentation for more information. BenchmarkAll() also optionally accepts a year parameter to limit the run to a specific year.

Download Input Files

To begin you'll need to login to www.adventofcode.com, open the browser dev tools, then head to Application Tab → Storage → Cookies, click the cookie for the site, then copy the value (long chain of numbers and letters) of the session cookie.

  • Open the folder containing your .csproj file in terminal.
  • Run the command dotnet user-secrets init
  • Then dotnet user-secrets set "session" "cookie" but replace the word cookie with the actual cookie copied from the site.
  • After pulling your day from AdventSolutions call .DownloadInputAsync()
var solutions = new AdventSolutions();
var day = solutions.GetMostRecentDay();
await day.DownloadInputAsync();

This only downloads input files that aren't on disk, so if you need to replace one for whatever reason, you'll need to delete the old file first.

Submit Answers

If you'd like to submit your answers from code, follow the steps for the user-secrets in the Download Input Files section above.

Calling the submit methods first checks if a correct answer has already been submitted, if yes, then returns null, if no, runs part code if it hasn't already ran, then asks the user if they'd like to submit their answer. True/false will be returned accordingly, as well as print the feedback to console from the attempted submission.

var solutions = new AdventSolutions();
var day = solutions.GetMostRecentDay();
await day.SubmitPart1Async();
await day.SubmitPart2Async();

Check Answers

If you'd like to check your answers from code, follow the steps for the user-secrets in the Download Input Files section above.

These methods can be useful if you've already submitted a correct answer in the past, but would like to rework your solution to the day's puzzle. It will run the part if not already ran, and then compare your new answer to the correct answer you've previously submitted.

var solutions = new AdventSolutions();
var day = solutions.GetMostRecentDay();
await day.CheckPart1Async();
await day.CheckPart2Async();

Unit Testing

Some extension methods such as SetTestInput which means InputText and InputLines will use that test input instead of the actual input file, along with GetBag() can help assist you with creating unit tests.

protected override void InternalPart1()
{
    // Do some work then...
    Bag["Test"] = InputText; // Pass to unit test.
}
using AdventOfCodeSupport;
using AdventOfCodeSupport.Testing;

public class SampleTests
{
    private readonly AdventSolutions _solutions;

    public SampleTests()
    {
        _solutions = new AdventSolutions();
    }
    
    [Fact]
    public void InputTest_CustomInput_TextLoaded()
    {
        var day = _solutions.GetDay(2022, 4);
        day.SetTestInput("123");
        day.Part1();
        Assert.StartsWith("123", day.GetBag()["Test"]);
    }
}
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.4.2 510 12/6/2023
2.4.1 433 12/4/2023
2.3.3 402 12/2/2023
2.3.2 425 12/2/2023
2.0.0 382 11/21/2023
1.4.0 777 12/5/2022
1.3.3 788 12/3/2022
1.3.2 772 12/3/2022
1.3.1 688 12/2/2022
1.2.3 767 12/1/2022
1.1.2 817 12/1/2022
1.1.0 760 11/30/2022
1.0.0 767 11/30/2022

- Submit answers from code.
- Only check already submitted every 15 min.
- Breaking changes:
- `InputLines` -> `Input.Lines`
- `InputTest` -> `Input.Text`
- `InputBlocks` -> `Input.Blocks`
- `override void InternalPart1()` -> `override object InternalPart1()`
- `solutions.DownloadInputsAsync()` -> `day.DownloadInputAsync()`
- added optional override `InternalOnLoad()`, runs prior to `Part1/2()`