feat: Add 2024/day01 initial code

Author: obalunenko

Makefile

@@ -8,6 +8,9 @@ SHELL := env APP_NAME=$(APP_NAME) $(SHELL)
 
 SHELL := env GOTOOLS_IMAGE_TAG=$(GOTOOLS_IMAGE_TAG) $(SHELL)
 
+AOC_PUZZLE_URL=
+SHELL := env AOC_PUZZLE_URL=$(AOC_PUZZLE_URL) $(SHELL)
+
 COMPOSE_TOOLS_FILE=deployments/docker-compose/go-tools-docker-compose.yml
 COMPOSE_TOOLS_CMD_BASE=docker compose -f $(COMPOSE_TOOLS_FILE)
 COMPOSE_TOOLS_CMD_UP=$(COMPOSE_TOOLS_CMD_BASE) up --exit-code-from

internal/puzzles/solutions/2024/day01/solution.go

@@ -0,0 +1,30 @@
+// Package day01 contains solution for https://adventofcode.com/2024/day/1 puzzle.
+package day01
+
+import (
+	"io"
+
+	"github.com/obalunenko/advent-of-code/internal/puzzles"
+)
+
+func init() {
+	puzzles.Register(solution{})
+}
+
+type solution struct{}
+
+func (s solution) Year() string {
+	return puzzles.Year2024.String()
+}
+
+func (s solution) Day() string {
+	return puzzles.Day01.String()
+}
+
+func (s solution) Part1(input io.Reader) (string, error) {
+	return "", puzzles.ErrNotImplemented
+}
+
+func (s solution) Part2(input io.Reader) (string, error) {
+	return "", puzzles.ErrNotImplemented
+}

internal/puzzles/solutions/2024/day01/solution_test.go

@@ -0,0 +1,117 @@
+package day01
+
+import (
+	"errors"
+	"io"
+	"path/filepath"
+	"testing"
+	"testing/iotest"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/obalunenko/advent-of-code/internal/puzzles/common/utils"
+)
+
+func Test_solution_Year(t *testing.T) {
+	var s solution
+
+	want := "2024"
+	got := s.Year()
+
+	assert.Equal(t, want, got)
+}
+
+func Test_solution_Day(t *testing.T) {
+	var s solution
+
+	want := "1"
+	got := s.Day()
+
+	assert.Equal(t, want, got)
+}
+
+func Test_solution_Part1(t *testing.T) {
+	var s solution
+
+	type args struct {
+		input io.Reader
+	}
+
+	tests := []struct {
+		name    string
+		args    args
+		want    string
+		wantErr assert.ErrorAssertionFunc
+	}{
+		{
+			name: "test example from description",
+			args: args{
+				input: utils.ReaderFromFile(t, filepath.Join("testdata", "input.txt")),
+			},
+			want:    "11",
+			wantErr: assert.NoError,
+		},
+		{
+			name: "",
+			args: args{
+				input: iotest.ErrReader(errors.New("custom error")),
+			},
+			want:    "",
+			wantErr: assert.Error,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, err := s.Part1(tt.args.input)
+			if !tt.wantErr(t, err) {
+				return
+			}
+
+			assert.Equal(t, tt.want, got)
+		})
+	}
+}
+
+func Test_solution_Part2(t *testing.T) {
+	var s solution
+
+	type args struct {
+		input io.Reader
+	}
+
+	tests := []struct {
+		name    string
+		args    args
+		want    string
+		wantErr assert.ErrorAssertionFunc
+	}{
+		{
+			name: "",
+			args: args{
+				input: utils.ReaderFromFile(t, filepath.Join("testdata", "input.txt")),
+			},
+			want:    "",
+			wantErr: assert.NoError,
+		},
+		{
+			name: "",
+			args: args{
+				input: iotest.ErrReader(errors.New("custom error")),
+			},
+			want:    "",
+			wantErr: assert.Error,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, err := s.Part2(tt.args.input)
+			if !tt.wantErr(t, err) {
+				return
+			}
+
+			assert.Equal(t, tt.want, got)
+		})
+	}
+}

internal/puzzles/solutions/2024/day01/spec.md

@@ -0,0 +1,70 @@
+# Puzzle https://adventofcode.com/2024/day/1
+
+# --- Day 1: Historian Hysteria ---
+
+##  --- Part One  ---
+
+The Chief Historian is always present for the big Christmas sleigh launch, but nobody has seen him in months! 
+Last anyone heard, he was visiting locations that are historically significant to the North Pole; 
+a group of Senior Historians has asked you to accompany them as they check the places they think he was most likely to visit.
+
+As each location is checked, they will mark it on their list with a star. They figure the Chief Historian must be 
+in one of the first fifty places they'll look, so in order to save Christmas, you need to help them get fifty stars on 
+their list before Santa takes off on December 25th.
+
+Collect stars by solving puzzles. Two puzzles will be made available on each day in the Advent calendar; 
+the second puzzle is unlocked when you complete the first. Each puzzle grants one star. Good luck!
+
+You haven't even left yet and the group of Elvish Senior Historians has already hit a problem: their list of locations 
+to check is currently empty. Eventually, someone decides that the best place to check first would be the 
+Chief Historian's office.
+
+Upon pouring into the office, everyone confirms that the Chief Historian is indeed nowhere to be found. 
+Instead, the Elves discover an assortment of notes and lists of historically significant locations! T
+his seems to be the planning the Chief Historian was doing before he left. 
+Perhaps these notes can be used to determine which locations to search?
+
+Throughout the Chief's office, the historically significant locations are listed not by name but by a unique number 
+called the location ID. To make sure they don't miss anything, The Historians split into two groups, 
+each searching the office and trying to create their own complete list of location IDs.
+
+There's just one problem: by holding the two lists up side by side (your puzzle input), it quickly becomes clear that 
+the lists aren't very similar. Maybe you can help The Historians reconcile their lists?
+
+For example:
+
+```text
+3   4
+4   3
+2   5
+1   3
+3   9
+3   3
+```
+
+Maybe the lists are only off by a small amount! To find out, pair up the numbers and measure how far apart they are. 
+Pair up the smallest number in the left list with the smallest number in the right list, then the second-smallest left 
+number with the second-smallest right number, and so on.
+
+Within each pair, figure out how far apart the two numbers are; you'll need to add up all of those distances. 
+For example, if you pair up a 3 from the left list with a 7 from the right list, the distance apart is 4; if you pair 
+up a 9 with a 3, the distance apart is 6.
+
+In the example list above, the pairs and distances would be as follows:
+
+- The smallest number in the left list is 1, and the smallest number in the right list is 3. The distance between them is 2.
+- The second-smallest number in the left list is 2, and the second-smallest number in the right list is another 3. The distance between them is 1.
+- The third-smallest number in both lists is 3, so the distance between them is 0.
+- The next numbers to pair up are 3 and 4, a distance of 1.
+- The fifth-smallest numbers in each list are 3 and 5, a distance of 2.
+- Finally, the largest number in the left list is 4, while the largest number in the right list is 9; these are a distance 5 apart.
+
+To find the total distance between the left list and the right list, add up the distances between all of the pairs you 
+found. In the example above, this is `2 + 1 + 0 + 1 + 2 + 5`, a total distance of `11`!
+
+Your actual left and right lists contain many location IDs. What is the total distance between your lists?
+
+##  --- Part Two  ---
+
+<!--- Pass here the description for part two --->
+

internal/puzzles/solutions/2024/day01/testdata/input.txt

@@ -0,0 +1,6 @@
+3   4
+4   3
+2   5
+1   3
+3   9
+3   3

internal/puzzles/solutions/register_2024.go

@@ -0,0 +1,9 @@
+package solutions
+
+import (
+	/*
+		2024 solutions.
+	*/
+	// register day01 solution.
+	_ "github.com/obalunenko/advent-of-code/internal/puzzles/solutions/2024/day01"
+)