View Source Advent Of Code
This is a small framework to help solving the Advent of Code problems. Focus on the problems and it will take care of the rest.
Configure your cookie
Retrieve your cookie from the AoC website and write the session ID in
$HOME/.adventofcode.session
.
Installation
mix deps.get
mix compile
Use the commands
The following commands use the default year and day based on current date. It is
possible to override the defaults with the mix aoc.set
command.
mix aoc.create
– Create the solution file, the test file and the input file for the current day. The input is downloaded from the AoC website and requires the session cookie. But you can create any of those files manually and the command will not overwrite them.mix aoc.fetch
– Download the input. This will not overwrite an existing file. Inputs are stored in thepriv
directory.mix aoc.open
– Open the problem page on AoC website.mix aoc.test
– Run the tests. This relies on themix test
command and will call it with the default test filename that would be generated bytmix aoc.create
.mix aoc.run
– Run the solution. This command also accepts a--part
option to run only one part of the solution.
Defaults management commands
mix aoc.set --year 2022
– Set the default year to 2022mix aoc.set --day 12
– Set the default daymix aoc.set --year 2022 --day 12
– Set both defaultsmix aoc.set
– Delete the default values
Writing solutions
The mix aoc.create
command will generate modules with the boilerplate code to
be called by mix aoc.run
and the generated tests.
defmodule AoC.Y23.Day1 do
alias AoC.Input, warn: false
def read_file(file, _part) do
# Input.read!(file)
# Input.stream!(file, trim: true)
end
def parse_input(input, _part) do
input
end
def part_one(problem) do
problem
end
def part_two(problem) do
problem
end
end
To call your code manually, you may use the following code:
solution_for_p1 =
"path/to/input/file"
|> AoC.Y23.Day1.read_file(:part_one)
|> AoC.Y23.Day1.parse_input(:part_one)
|> AoC.Y23.Day1.part_one(:part_one)
The generated tests will also call those functions one by one, so you can debug and assert each part separately.
The different callbacks are:
read_file/2
andparse_input/2
– The first one accepts an input file path, or aAoC.Input.FakeFile
struct from the tests. CallInput.read!
orInput.stream!
to return the whole contents or a stream of lines.The return value will be passed to
parse_input/2
. This allows to separate the parsing logic from the raw file manipulation. Most logic is generally contained in one of those two functions, and the other one is a oneliner.Note that the second argument to each callback,
:part_one
or:part_two
can help to apply different logic for each problem part.part_one/1
andpart_two/1
– The first argument is the result ofparse_input/2
. The return should be the solution to the problem that will be printed bymix aoc.run
. But some problems may require to print a drawing to the console for instance, so you can return anything from those callbacks. The return value is also checked in the generated tests.