Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tbali0524/advent-of-code-solutions
Advent of Code solutions in PHP by TBali
https://github.com/tbali0524/advent-of-code-solutions
advent-of-code php
Last synced: 6 days ago
JSON representation
Advent of Code solutions in PHP by TBali
- Host: GitHub
- URL: https://github.com/tbali0524/advent-of-code-solutions
- Owner: tbali0524
- License: mit
- Created: 2022-10-24T15:56:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-24T09:39:55.000Z (12 days ago)
- Last Synced: 2024-06-24T11:12:31.536Z (12 days ago)
- Topics: advent-of-code, php
- Language: PHP
- Homepage: https://adventofcode.com
- Size: 8.25 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-advent-of-code - tbali0524/advent-of-code-solutions - 2024--06--24-brightgreen) (2023 / Solutions)
README
# Advent of Code solutions in PHP by TBali
* [AoC website](https://adventofcode.com/)
* My AoC username: `tbali0524`
* [Puzzle list](puzzles.md) with topics and my completion status
* Some [memes](memes.md) from AoC subreddit
* Link to this repo on [GitHub](https://github.com/tbali0524/advent-of-code-solutions)
## Installation
The solutions are using only the standard php library, they have NO 3rd-party package dependencies.
However, [Composer](https://getcomposer.org/) is used for its class autoloader:
```sh
composer install
```
Note: Some solutions require more memory than what a default PHP installation provides, so it is recommended to set `memory_limit = -1` in `php.ini`.
## Batch solution runner
Run solutions from the project base directory with:
```sh
php src/aoc.php [LANGUAGE] [YEAR] [DAY]
```
| Argument | Effect |
|:-------------------------------|:----------------------------------------------------|
| `LANGUAGE` given | invoke interpreter with standalone solution scripts |
| `all` given as the `LANGUAGE` | invoke standalone solution scripts in all languages |
| `LANGUAGE` not given | invoke class-based PHP solutions |
| none of `YEAR` and `DAY` given | run all solutions |
| only `YEAR` given | run all solutions for that season only |
| both `YEAR` and `DAY` given | run a specific solution |
On Windows, the shortcut `.\aoc.bat [LANGUAGE] [YEAR] [DAY]` also works.
Possible values for `LANGUAGE`:
_all, dart, f#, go, groovy, java, javascript, lua, perl, php, python, ruby, scala_.
## Puzzle input
* Directory pattern: `input/YYYY/`, where `YYYY` is the year.
* Filename pattern: `AocYYYYDayDD.txt`, where `DD` is the day padded to 2 digits with zero.
* Optional additional example input can be in `AocYYYYDayDDex1.txt`, `AocYYYYDayDDex2.txt`, etc.
* Alternatively, a single string input can be given in the `STRING_INPUT` or `EXAMPLE_STRING_INPUTS` constants in the solution class.
* Additionally, some extra large input can be given in `AocYYYYDayDDlarge1.txt`, `AocYYYYDayDDlarge2.txt`, ...
* These will be run ONLY if the `LARGE_SOLUTIONS` constant array is overriden in the solution class.
## Class-based PHP solutions
* Directory pattern: `src/AocYYYY/`.
* Filename pattern: `AocYYYYDayDD.php`.
* For a new solution, use the template in `src/Aoc2024Day00.php`.
* Solution should implement class `AocYYYYDayDD`, extending `SolutionBase`.
* It should implement the `solve()` method and override the constants in the [Solution](src/Aoc/Solution.php) interface.
* The `solve()` method must be callable repeatedly with different inputs.
* After successful submit, the puzzle answers shall be recorded in the `SOLUTIONS` class constant (for future regression tests).
## Standalone script-based solutions
* Directory pattern: `src/other/AocYYYY/`.
* Filename pattern: `AocYYYYDayDD.ext`.
* (For `PHP` only: the pattern is `AocYYYYDayDDscr.php` to avoid having the same source filename as the class-based solution.)
* The script shall read the input file (if needed), print the problem ID and the solution.
## Custom Composer scripts
The following helper commands are defined in [composer.json](composer.json):
|Command |Description |
|:------------|:-----------|
|start |Run all solutions with AocRunner|
|test |Run solutions and create test coverage report with [PHPUnit](https://www.phpunit.de/)|
|cs |Check coding style compliance to `PSR12` with [PHP_CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer)|
|cs-fixer |Check coding style compliance to `PSR12` plus extra rules with [PHP-CS-Fixer](https://cs.symfony.com/) (no fix applied)|
|cs-fixer-do |Apply coding style fixes with _PHP-CS-Fixer_|
|doc |Create documentation with [phpDocumentor](https://www.phpdoc.org/)|
|lint |Check syntax errors with [Parallel-Lint](https://github.com/php-parallel-lint/PHP-Parallel-Lint)|
|loc |Get code summary report with [phploc](https://github.com/sebastianbergmann/phploc)|
|metrics |Generate code metrics report with [PhpMetrics](https://phpmetrics.github.io/website/)|
|stan |Run static analysis with [PHPStan](https://phpstan.org/)|
|qa |Run code quality checks: _PHP\_CodeSniffer, PHP-CS-Fixer, PHPStan_|
|qa-full |Run all code quality checks: _PHP\_CodeSniffer, PHP-CS-Fixer, PHPStan, Parallel-Lint, PhpMetrics, phpDocumentor, PHPUnit, and run all solutions_|
|open-cover |Open generated test coverage report in browser _(fixed file path)_|
|open-doc |Open generated documentation in browser _(fixed file path)_|
|open-metrics |Open generated code metrics report in browser _(fixed file path)_|
|clean |Delete generated cache and report files in `.tools` and `docs` directories _(Windows only)_|
__Note:__ The above tools are NOT listed in `composer.json` as dev dependencies. Instead, the commands must be available in the `PATH`. See minimum version requirements in the config files.