From bc3b9a58d3b7d8f56e52e5498829d4386ce86a5b Mon Sep 17 00:00:00 2001
From: Hannes Giesenow <hannes.giesenow@elbformat.de>
Date: Mon, 4 Dec 2023 18:08:26 +0100
Subject: [PATCH] Added docker setup

---
 .github/workflows/docker-image-main.yml    | 42 ++++++++++++++++++++++
 .github/workflows/docker-image-release.yml | 41 +++++++++++++++++++++
 README.md                                  |  6 ++++
 docker-compose.yml                         |  7 ++++
 docker/Dockerfile                          |  8 +++++
 src/CLI/Arguments.php                      | 12 +++----
 6 files changed, 110 insertions(+), 6 deletions(-)
 create mode 100644 .github/workflows/docker-image-main.yml
 create mode 100644 .github/workflows/docker-image-release.yml
 create mode 100644 docker-compose.yml
 create mode 100644 docker/Dockerfile

diff --git a/.github/workflows/docker-image-main.yml b/.github/workflows/docker-image-main.yml
new file mode 100644
index 00000000..8189d0a3
--- /dev/null
+++ b/.github/workflows/docker-image-main.yml
@@ -0,0 +1,42 @@
+name: Create and publish a Docker image
+
+on:
+  push:
+    branches: [main]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        with:
+          context: .
+          file: docker/Dockerfile
+          push: true
+          tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
+          labels: ${{ steps.meta.outputs.labels }}
\ No newline at end of file
diff --git a/.github/workflows/docker-image-release.yml b/.github/workflows/docker-image-release.yml
new file mode 100644
index 00000000..35d34ecd
--- /dev/null
+++ b/.github/workflows/docker-image-release.yml
@@ -0,0 +1,41 @@
+name: Create and publish a Docker image
+
+on:
+  - "release"
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        with:
+          context: .
+          file: docker/Dockerfile
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
\ No newline at end of file
diff --git a/README.md b/README.md
index 6fe34df5..330f42a8 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,12 @@
 
 ## Installation
 
+### Docker
+Simply scan your project with docker
+```
+docker run ghcr.io/elbformat/phpcpd:latest --version
+```
+
 This tool is distributed as a [PHP Archive (PHAR)](https://php.net/phar):
 
 ```bash
diff --git a/docker-compose.yml b/docker-compose.yml
new file mode 100644
index 00000000..520918da
--- /dev/null
+++ b/docker-compose.yml
@@ -0,0 +1,7 @@
+version: "3"
+services:
+  php:
+    image: php:8.2-alpine
+    volumes:
+      - .:/var/www
+    working_dir: /var/www
\ No newline at end of file
diff --git a/docker/Dockerfile b/docker/Dockerfile
new file mode 100644
index 00000000..59b25462
--- /dev/null
+++ b/docker/Dockerfile
@@ -0,0 +1,8 @@
+FROM php:8.2-alpine
+WORKDIR /var/www
+COPY composer.json /var/www/composer.json
+COPY phpcpd /var/www/phpcpd
+COPY tools/composer /var/www/tools/composer
+COPY src /var/www/src
+RUN /var/www/tools/composer install
+ENTRYPOINT ["/var/www/phpcpd","${@}"]
\ No newline at end of file
diff --git a/src/CLI/Arguments.php b/src/CLI/Arguments.php
index cbe4f296..14f9d45f 100644
--- a/src/CLI/Arguments.php
+++ b/src/CLI/Arguments.php
@@ -12,17 +12,17 @@
 final class Arguments
 {
     /**
-     * @psalm-var list<string>
+     * @psalm-var list<non-empty-string>
      */
     private $directories;
 
     /**
-     * @psalm-var list<string>
+     * @psalm-var list<non-empty-string>
      */
     private $suffixes;
 
     /**
-     * @psalm-var list<string>
+     * @psalm-var list<non-empty-string>
      */
     private $exclude;
 
@@ -76,7 +76,7 @@ public function __construct(array $directories, array $suffixes, array $exclude,
     }
 
     /**
-     * @psalm-return list<string>
+     * @psalm-return list<non-empty-string>
      */
     public function directories(): array
     {
@@ -84,7 +84,7 @@ public function directories(): array
     }
 
     /**
-     * @psalm-return list<string>
+     * @psalm-return list<non-empty-string>
      */
     public function suffixes(): array
     {
@@ -92,7 +92,7 @@ public function suffixes(): array
     }
 
     /**
-     * @psalm-return list<string>
+     * @psalm-return list<non-empty-string>
      */
     public function exclude(): array
     {