AdventOfCode

Advent of Code puzzle solutions in Elixir. It's work in progress and starting year 2015 to 2022, random days are attempted.

Code Organization

All solution modules reside in lib/<year>/day_<day>.ex and associated tests have the same structure in test/ folder. Input files are in lib/data/inputs/<year>_<day>.txt.

Stubs

To make the experience boilerplate-free and give all solutions uniform (more or less) structure, type mix gen --year <year> --day <day> or mix gen <year> <day> to have the structure and stub generated. Optionally, if you have COOKIE environment variable storing your cookie then it will download the input file and add the title on the moduledocs for you. Type mix help gen for more.

To solve the problem for a particular year/day, type in mix solve --year <year> --day <day> or mix solve <year> <day> and you will see the result of the mentioned year/day if it is valid and has been solved. Type mix help solve for more.

Introducing a new year

During December 1 of a new year (if Advent of Code is happening that year), the following steps should be taken (this should be more streamlined in future):

Create a new folder XXXX (in year format) under /lib or /test
Update the @latest_year attribute on advent_of_code.ex
Double check your session cookie (in case you're using it)

All commands should work from then on.

Testing

run mix test to ensure all solutions are working okay. To run test for a particular year and day, type mix test --only y<last-two-digits-of-year><zero-padded-day>. For example: mix test --only y1501 tests for 2015 as year and 1 as day.

Updating README and Stats

If you want to update the README.md (i.e. this file) please do not update README.me directly, instead update the static content (not stats related) on priv/partials/readme_content.md and then run mix readme to regenerate this file.

The stats, both in <year>/README.md and the bottom part of README.md are autogenerated by pulling from the live code state. To keep the stats updated, run mix update_stats command. This does the following two things:

Runs mix gen_stats to update the relevant README.md so that the latest stats are always displayed.
Runs mix gen_readme to update the main README.md to reflect all the stars.
Runs mix gen_tags to update tags.md with latest tag summary
Runs mix gen_difficulties to update difficulties.md with latest difficulty summary

Note that you can call those commands independently and also set up pre-commit hooks to run it for you.

🏆 291/450

Day	2015	2016	2017	2018	2019	2020	2021	2022	2023
🌟	48	22	34	15	15	44	24	45	44
1	🥇	🥇	🥇	🥇	🥇	🥇	🥇	🥇	🥇
2	🥇	🥇	🥇	🥇	🥇	🥇	🥇	🥇	🥇
3	🥇	🥇	🥇	🥇	🥇	🥇	🥇	🥇	🥇
4	🥇	🥇	🥇	🥇	🥇	🥇	🥇	🥇	🥇
5	🥇	🥇	🥇	🥇	🥈	🥇	🥇	🥇	🥇
6	🥇	🥇	🥇	🥇	🥇	🥇	🥇	🥇	🥇
7	🥇	🥇	🥈			🥇	🥇	🥇	🥇
8	🥇	🥇	🥇	🥈	🥇	🥇		🥇	🥇
9	🥇	🥇	🥇	🥇		🥇	🥇	🥇	🥇
10	🥇	🥇	🥇		🥇	🥇		🥇	🥇
11	🥇		🥇			🥇		🥇	🥇
12	🥇	🥇	🥇			🥇		🥇	🥇
13	🥇		🥇			🥇		🥇	🥇
14	🥇		🥈			🥇		🥇	🥇
15	🥇		🥇			🥇	🥇	🥇	🥇
16	🥇		🥇			🥈	🥇		🥇
17	🥇		🥇
18	🥇		🥈			🥇		🥇	🥇
19	🥇					🥇		🥇	🥇
20	🥇					🥈		🥇
21	🥇					🥇	🥇	🥇
22						🥇		🥈	🥇
23	🥇		🥈			🥈		🥇	🥇
24	🥇					🥈		🥇	🥇
25	🥇					🥇	🥇	🥇	🥇

Remove macro and use Transformer functions.

Oh this is going to be a big one. When I first started this challenge, I was fairly new to Elixir and the file structure for inputs was different. So to save myself some time figuring out the relativity of locations (maybe) I decided to use Macro and include it everywhere.

I recently restructured the input file locations (by moving them to /priv/input_files) and this makes it easier to just use functions. There are 97 modules that use the macro and the task is to replace them with function calls.

As an example:

If we previously had:

use AdventOfCode.Helpers.InputReader, year: 2015, day: 1

def run_1, do: input!() |> floor(0)
def run_2, do: input!() |> to_basement(0, 0)

They will now become:

  alias AdventOfCode.Helpers.InputReader

  def input(), do: InputReader.read_from_file(2015, 1)

  def run(input \\ input()) do
    input = parse(input)
    {run_1(input), run_2(input)}
  end

  def run_1(input), do: ...
  def run_2(input), do: ...
  def parse(input), do: ...

And then on tests, remove individual tests for run_1 and run_2 and make them a single run test. As an example -

THIS

defmodule AdventOfCode.Y2020.Day01Test do
  ...
  test "Year 2020, Day 1, Part 1" do
    assert Solution.run_1() == 1_014_624
  end

  test "Year 2020, Day 1, Part 2" do
    assert Solution.run_2() == 80_072_256
  end
end

SHOULD BECOME THIS

defmodule AdventOfCode.Y2020.Day01Test do
  ...
  test "Year 2020, Day 1" do
    assert Solution.run_1() == {1_014_624, 80_072_256}
  end

Basically, use turns into alias and we add a new @input that is read_from_input(year, day) (which is in the use macro now).

After the change is done, we should ensure it didn't break anything by running mix test --only y151 (15 = 20(15) and 01 = day 01 -- days < 10 are 0 padded ). Thankfully, I had them test cases covered 🤓

In addition, we moved some common functionalities into Transformers module. Like String.split(&1, "\n") became Transformers.lines(). If while changing this, we encounter some of those, then we can change those as well.

I will be opening up PRs that solve fraction of these and add a checkbox in here.

Will add tool to visualize/find them here soon.

code-shoily / advent_of_code Goto Github PK

advent_of_code's Introduction

AdventOfCode

Code Organization

Stubs

Introducing a new year

Testing

Updating README and Stats

Pages

🏆 291/450

advent_of_code's People

Contributors

Stargazers

Watchers

Forkers

advent_of_code's Issues

Remove macro and use Transformer functions.

Pad 0 for single digit day problems

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent