chore: template cleanup

(cherry picked from commit 8a8be969bb) Signed-off-by: Matej Focko <me@mfocko.xyz>
2024-12-01 12:01:30 +00:00 · 2024-12-01 12:01:30 +00:00 · 7605be196a
commit 7605be196a
parent a4cc41918e
9 changed files with 12 additions and 454 deletions
--- a/.github/readme/cover.png
+++ b/.github/readme/cover.png
--- a/.github/readme/livestream.png
+++ b/.github/readme/livestream.png
--- a/.github/readme/run.png
+++ b/.github/readme/run.png
--- a/.github/template-cleanup/README.md
+++ b/.github/template-cleanup/README.md
@ -1,25 +0,0 @@
 # %NAME%
 Welcome to the Advent of Code[^aoc] Kotlin project created by [%ACTOR%][github] using the [Advent of Code Kotlin Template][template] delivered by JetBrains.
 In this repository, %ACTOR% is about to provide solutions for the puzzles using [Kotlin][kotlin] language.
 If you're stuck with Kotlin-specific questions or anything related to this template, check out the following resources:
 - [Kotlin docs][docs]
 - [Kotlin Slack][slack]
 - Template [issue tracker][issues]
 [^aoc]:
    [Advent of Code][aoc] – An annual event of Christmas-oriented programming challenges started December 2015.
    Every year since then, beginning on the first day of December, a programming puzzle is published every day for twenty-five days.
    You can solve the puzzle and provide an answer using the language of your choice.
 [aoc]: https://adventofcode.com
 [docs]: https://kotlinlang.org/docs/home.html
 [github]: https://github.com/%ACTOR%
 [issues]: https://github.com/kotlin-hands-on/advent-of-code-kotlin-template/issues
 [kotlin]: https://kotlinlang.org
 [slack]: https://surveys.jetbrains.com/s3/kotlin-slack-sign-up
 [template]: https://github.com/kotlin-hands-on/advent-of-code-kotlin-template
--- a/.github/template-cleanup/settings.gradle.kts
+++ b/.github/template-cleanup/settings.gradle.kts
@ -1,7 +0,0 @@
 rootProject.name = "%NAME%"
 dependencyResolutionManagement {
    repositories {
        mavenCentral()
    }
 }
--- a/.github/workflows/template-cleanup.yml
+++ b/.github/workflows/template-cleanup.yml
@ -1,70 +0,0 @@
 # GitHub Actions Workflow responsible for cleaning up the Advent of Code Kotlin Template repository from
 # the template-specific files and configurations. This workflow is supposed to be triggered automatically
 # when a new template-based repository has been created.
 name: Template Cleanup
 on:
  push:
    branches: [main]
 jobs:
  # Run cleaning process only if workflow is triggered by the non-"advent-of-code-kotlin-template" repository.
  template-cleanup:
    name: Template Cleanup
    runs-on: ubuntu-latest
    if: github.event.repository.name != 'advent-of-code-kotlin-template'
    permissions:
      contents: write
    steps:
      # Check out current repository
      - name: Fetch Sources
        uses: actions/checkout@v4
      # Cleanup project
      - name: Cleanup
        run: |
          export LC_CTYPE=C
          export LANG=C
          # Prepare variables
          NAME="${GITHUB_REPOSITORY##*/}"
          ACTOR=$(echo $GITHUB_ACTOR | tr '[:upper:]' '[:lower:]')
          SAFE_NAME=$(echo $NAME | sed 's/[^a-zA-Z0-9]//g' | tr '[:upper:]' '[:lower:]')
          SAFE_ACTOR=$(echo $ACTOR | sed 's/[^a-zA-Z0-9]//g' | tr '[:upper:]' '[:lower:]')
          GROUP="com.github.$SAFE_ACTOR.$SAFE_NAME"
          # Replace placeholders in the template-cleanup files
          sed -i "s/%ACTOR%/$ACTOR/g" .github/template-cleanup/*
          sed -i "s/%NAME%/$NAME/g" .github/template-cleanup/*
          sed -i "s/%REPOSITORY%/${GITHUB_REPOSITORY/\//\\/}/g" .github/template-cleanup/*
          sed -i "s/%GROUP%/$GROUP/g" .github/template-cleanup/*
          # Move content
          cp -R .github/template-cleanup/* .
          # Cleanup
          rm -rf \
            .github/readme \
            .github/template-cleanup \
            .github/workflows/template-cleanup.yml \
            LICENSE
          # Remove leftover empty directories
          find . -type d -empty -delete
      # Commit modified files
      - name: Commit files
        run: |
          git config --local user.email "action@github.com"
          git config --local user.name "GitHub Action"
          git add .
          git commit -m "Template cleanup"
      # Push changes
      - name: Push changes
        uses: ad-m/github-push-action@master
        with:
          branch: main
          github_token: ${{ secrets.GITHUB_TOKEN }}
--- a/201
+++ b/201
@ -1,201 +0,0 @@
                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/
   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
   1. Definitions.
      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.
      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.
      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.
      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.
      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.
      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.
      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).
      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.
      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."
      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.
   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.
   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.
   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:
      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and
      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and
      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and
      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.
      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.
   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.
   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.
   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.
   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.
   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.
   END OF TERMS AND CONDITIONS
   APPENDIX: How to apply the Apache License to your work.
      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.
   Copyright [yyyy] [name of copyright owner]
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
       http://www.apache.org/licenses/LICENSE-2.0
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
--- a/README.md
+++ b/README.md
@ -1,164 +1,25 @@
-# Advent of Code Kotlin Template
+# advent-of-code-2024
-[Advent of Code][aoc] – an annual event in December since 2015.
+Welcome to the Advent of Code[^aoc] Kotlin project created by [mfocko][github] using the [Advent of Code Kotlin Template][template] delivered by JetBrains.
 Every year since then, with the first day of December, a programming puzzles contest is published every day for twenty-five days.
 A set of Christmas-oriented challenges provides any input you have to use to answer using the language of your choice.
 We offer you a template prepared to use with [Kotlin][kotlin] language within this repository.
-![][file:cover]
+In this repository, mfocko is about to provide solutions for the puzzles using [Kotlin][kotlin] language.
-## Live Streams
+If you're stuck with Kotlin-specific questions or anything related to this template, check out the following resources:
 Join us as we solve the Advent of Code challenges live on stream!
 Follow along to see step-by-step solutions, participate in problem-solving, and learn new strategies to tackle the puzzles.
 Whether you're stuck on a particular problem or just looking to improve your Kotlin skills, our live streams are here to help.
 [Watch the live streams here!][youtube-playlist]
 [![][file:livestream]][youtube-playlist]
 ## Workflow
 **Advent of Code Kotlin Template** is a particular type of GitHub repository that lets you speed up the setup phase and start writing your AoC solutions immediately.
 The general idea is straightforward – to create a new project based on this template, you need to log in to your GitHub account and use the **Use this template** green button.
 And remember – **do not fork it!**
 After creating a new project based on this template in your account, a dedicated GitHub Actions workflow will start and clean up the code from redundant files.
 It will also personalize code to use your username and project name in namespaces and Gradle properties.
 How cool is that?
 You can clone it within the IntelliJ IDEA whenever the [@actions-user][actions-user] actor pushes the second commit to your repository.
 > [!IMPORTANT]
 >
 > Right after opening the project in IntelliJ IDEA, verify if you use at least **Java 11** as Project SDK.
 > To do that, visit [Project Structure Settings][docs-project-structure] (<kbd>⌘ Cmd</kbd><kbd>;</kbd> on macOS or <kbd>Ctrl</kbd><kbd>Alt</kbd><kbd>Shift</kbd><kbd>S</kbd> on Windows/Linux).
 From now on, everything's in your hands!
 Join the [Advent of Code][aoc] contest to solve the *Day 01* as soon as it is published.
 Copy the `Day01.kt` solution file for the following days and increment the day number.
 > [!NOTE]
 >
 > Remember to join the Kotlin contest!
 >
 > To do that, edit your project's _About_ section with ⚙️ icon and add the `aoc-2024-in-kotlin` topic to your project.
 >
 > **We will find your repository and count you in our giveaway.**
 ## Setup
 After you create a new project based on the current template repository using the **Use this template** button, a bare minimal scaffold will appear in your GitHub account with the following structure:
 ```
 .
 ├── README.md               README file
 ├── build.gradle.kts        Gradle configuration created with Kotlin DSL
 ├── settings.gradle.kts     Gradle project settings
 ├── gradle*                 Gradle wrapper files
 └── src
    ├── Day01.kt            An empty implementation for the first AoC day
    ├── Utils.kt            A set of utility methods shared across your days
    │                       
    │                       (create those files manually)
    ├── Day01.txt           An empty file for the Day 01 input data
    └── Day01_test.txt      An optional Day 01 test input data used for checks
 ```
 > [!NOTE]
 >
 > All task input files (`src/*.txt`) are excluded from the repository with `.gitignore` – we should not post them publicly, as [Eric Wastl requested for](https://twitter.com/ericwastl/status/1465805354214830081).
 When the first puzzle appears, go to the `Day01.kt`, and for each `part1` and `part2` function, provide an algorithm implementation using the `input` data loaded from the `src/Day01.txt` file.
 This input data is common for both parts, and you can find it at the bottom of each day on the [Advent of Code][aoc] page.
 To read the input data, you can go with the `readInput(name: String)` utility method provided in the [`Utils.kt`][file:utils] file, like:
 ```kotlin
 fun main() {
    fun part1(input: List<String>): Int {
        return input.size
    }
    val input = readInput("Day01")
    println(part1(input))
 }
 ```
 ## Running
 To call the algorithm you're implementing, click the green Play button next to the `fun main()` definition.
 ![img.png](.github/readme/run.png)
 > [!IMPORTANT]
 >
 > Create relevant files Before running tasks or tests, like: `src/Day01.txt` or `src/Day01_test.txt`.
 The [`Utils.kt`][file:utils] file also contains the `String.md5()` method for generating MD5 hash out of the given string and expects more helper functions for the sake of the [KISS principle][kiss].
 Each puzzle describes some test conditions, a small portion of the information that helps check if the produced value for the given test input is valid.
 To handle that case, you can put such an input into a separate file and perform a check against the output, like:
 ```kotlin
 fun main() {
    // ...
    val testInput = readInput("Day01_test")
    check(part1(testInput) == 13)
 }
 ```
 The current approach of providing both `part1` and `part2` solutions within the single `Day##.kt` file may sometimes bring a disadvantage due to the first solution calculation when we expect to work on the second part only.
 With simple cases that don't consume too much of your time and resources that can be almost unnoticeable, but when the solution takes seconds, it is worth considering breaking the daily solution into two separated pieces, like `Day07_part1.kt` and `Day07_part2.kt`.
 The final result of your algorithm will be printed on the screen so that you can pass it to the Advent of Code website.
 To go with the next day, place the `Day02.txt` file into the `src` with relevant input data and create a `Day02.kt` file with a similar code scaffold:
 ```kotlin
 fun main() {
    fun part1(input: List<String>): Int {
        return 0
    }
    fun part2(input: List<String>): Int {
        return 0
    }
    val input = readInput("Day02")
    println(part1(input))
    println(part2(input))
 }
 ```
 > [!NOTE]
 >
 > There is a fork of this repository available that utilizes the Amper tool for project configuration, recently [introduced by JetBrains][amper].
 >
 > For more, see [Advent of Code Kotlin Template — Amper][amper-template] project.
 ## Getting help
 If you are stuck with Kotlin-specific questions or anything related to this template, check out the following resources:
 - [Kotlin docs][docs]
 - [Kotlin Slack][slack]
 - Template [issue tracker][issues]
-[actions-user]: https://github.com/actions-user
+[^aoc]:
    [Advent of Code][aoc] – An annual event of Christmas-oriented programming challenges started December 2015.
    Every year since then, beginning on the first day of December, a programming puzzle is published every day for twenty-five days.
    You can solve the puzzle and provide an answer using the language of your choice.
 [aoc]: https://adventofcode.com
 [amper]: https://blog.jetbrains.com/blog/2023/11/09/amper-improving-the-build-tooling-user-experience/
 [amper-template]: https://github.com/kotlin-hands-on/advent-of-code-kotlin-template-amper
 [docs]: https://kotlinlang.org/docs/home.html
-[docs-project-structure]: https://www.jetbrains.com/help/idea/project-settings-and-structure.html
+[github]: https://github.com/mfocko
 [issues]: https://github.com/kotlin-hands-on/advent-of-code-kotlin-template/issues
 [kiss]: https://en.wikipedia.org/wiki/KISS_principle
 [kotlin]: https://kotlinlang.org
 [slack]: https://surveys.jetbrains.com/s3/kotlin-slack-sign-up
-[file:cover]: .github/readme/cover.png
+[template]: https://github.com/kotlin-hands-on/advent-of-code-kotlin-template
 [file:livestream]: .github/readme/livestream.png
 [file:utils]: src/Utils.kt
 [youtube-playlist]: https://www.youtube.com/playlist?list=PLlFc5cFwUnmwHaD3-qeoLHnho_PY2g9JX
--- a/settings.gradle.kts
+++ b/settings.gradle.kts
@ -1,4 +1,4 @@
-rootProject.name = "Advent of Code Kotlin Template"
+rootProject.name = "advent-of-code-2024"
 dependencyResolutionManagement {
    repositories {