Add docs, handle year directory

Author: obalunenko

cmd/aoc-cli/main.go

@@ -12,7 +12,7 @@ import (
 	"github.com/pkg/errors"
 
 	"github.com/oleg-balunenko/advent-of-code/puzzles"
-	_ "github.com/oleg-balunenko/advent-of-code/puzzles/solutions/day01"
+	_ "github.com/oleg-balunenko/advent-of-code/puzzles/solutions/2019/day01"
 )
 
 const (

input/day01.txt input/2019/day01.txtinput/day01.txt renamed to input/2019/day01.txt

@@ -1,3 +1,4 @@
+// Package day01 solves https://adventofcode.com/2019/day/1
 package day01
 
 import (
@@ -10,27 +11,27 @@ import (
 	"github.com/oleg-balunenko/advent-of-code/puzzles"
 )
 
-type solver struct {
+type solution struct {
 	name string
 }
 
 func init() {
 	const puzzleName = "day01"
 
-	puzzles.Register(puzzleName, solver{
+	puzzles.Register(puzzleName, solution{
 		name: puzzleName,
 	})
 }
 
-func (s solver) Part1(input io.Reader) (string, error) {
+func (s solution) Part1(input io.Reader) (string, error) {
 	return calc(input, calcPart1)
 }
 
-func (s solver) Part2(input io.Reader) (string, error) {
+func (s solution) Part2(input io.Reader) (string, error) {
 	return calc(input, calcPart2)
 }
 
-func (s solver) Name() string {
+func (s solution) Name() string {
 	return s.name
 }
 

input/day02.txt input/2019/day02.txtinput/day02.txt renamed to input/2019/day02.txt

@@ -215,7 +215,7 @@ func Test_solver_Part1(t *testing.T) {
 		tt := tt
 
 		t.Run(tt.name, func(t *testing.T) {
-			s := solver{
+			s := solution{
 				name: tt.fields.name,
 			}
 			input := readerFromFile(t, tt.args.inputPath)
@@ -265,7 +265,7 @@ func Test_solver_Part2(t *testing.T) {
 		tt := tt
 
 		t.Run(tt.name, func(t *testing.T) {
-			s := solver{
+			s := solution{
 				name: tt.fields.name,
 			}
 			input := readerFromFile(t, tt.args.inputPath)

puzzles/solutions/day01/fuel.go puzzles/solutions/2019/day01/solution.gopuzzles/solutions/day01/fuel.go renamed to puzzles/solutions/2019/day01/solution.go

@@ -0,0 +1,21 @@
+// Package declares common interface for puzzle solutions and functionality for register and run them.
+package solutions
+
+// Each solution should implement `Solver` interface, be implemented udnder separate package and contain `init()`
+// function that will register that solution in list of all solvers.
+
+// 	type solver struct {
+//		name string
+//	}
+//
+//	func init() {
+// 		const puzzleName = "day01"
+// 		puzzles.Register(puzzleName, solver{
+//		name: puzzleName,
+//		})
+// 	}
+
+// Then to register solution in the list of all solutions: make a blank import of package with puzzle solution
+// at main.go
+//
+// _ "github.com/oleg-balunenko/advent-of-code/puzzles/solutions/day01"