🎉 First version for PHP Representer

- Adapt CI
- Adapt Dockerfile
- Setup symfony consle application
- Setup PHPUnit tests (100% coverage)
- Implement various normalization:
 - spacing
 - class name
 - array syntax
- Logging

Author: homersimpsons

.dockerignore

@@ -3,3 +3,5 @@
 bin/run-in-docker.sh
 bin/run-tests-in-docker.sh
 tests/
+vendor/
+phpunit-tests/

.github/workflows/continuous_integration.yml

@@ -0,0 +1,32 @@
+name: continuous integration
+
+on: [push, pull_request]
+
+jobs:
+  continuous-integration:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+          tools: composer
+          coverage: pcov
+
+      - name: Get Composer Cache Directory
+        id: composer-cache
+        run: |
+          echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v3
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-composer-
+
+      - run: composer install
+      - run: composer lint
+      - run: composer phpstan
+      - run: composer test

.gitignore

@@ -1,2 +1,8 @@
+.idea/
+build/
+vendor/
+.phpcs-cache
+.phpunit.result.cache
+tests/*/representation.json
 tests/*/representation.txt
 tests/*/mapping.json

Dockerfile

@@ -1,8 +1,12 @@
-FROM alpine:3.10
-
-# TODO: install packages required to run the representer
-RUN apk add --no-cache bash jq
+FROM composer:latest AS builder
 
 WORKDIR /opt/representer
-COPY . .
+COPY . /opt/representer
+
+RUN /usr/bin/composer install --no-dev --no-interaction --no-progress --no-scripts --optimize-autoloader --working-dir=/opt/representer
+
+FROM php:8.1-cli-alpine
+
+COPY --from=builder /opt/representer /opt/representer
+
 ENTRYPOINT ["/opt/representer/bin/run.sh"]

README.md

@@ -1,38 +1,6 @@
-# Exercism Representer Template
+# Exercism PHP Representer
 
-This repository is a [template repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-template-repository) for creating [representers][representers] for [Exercism][exercism] tracks.
-
-## Using the Representer Template
-
-1. Ensure that your track has not already implemented a representer. If there is, there will be a `https://github.com/exercism/<track>-representer` repository (i.e. if your track's slug is `python`, the representer repo would be `https://github.com/exercism/python-representer`)
-2. Follow [GitHub's documentation](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) for creating a repository from a template repository
-   - Name your new repository based on your language track's slug (i.e. if your track is for Python, your representer repo name is `python-representer`)
-3. Remove this [Exercism Representer Template](#exercism-representer-template) section from the `README.md` file
-4. Replace `TRACK_NAME_HERE` with your track's name in the `README.md` file
-5. Build the representer, conforming to the [Representer interface specification](https://github.com/exercism/docs/blob/main/building/tooling/representers/interface.md).
-   - Update the files to match your track's needs. At the very least, you'll need to update `bin/run.sh`, `Dockerfile` and the test solutions in the `tests` directory
-   - Tip: look for `TODO:` comments to point you towards code that need updating
-   - Tip: look for `OPTIONAL:` comments to point you towards code that _could_ be useful
-
-Once you're happy with your representer, [open an issue on the exercism/exercism repo](https://github.com/exercism/exercism/issues/new?title=%5BTRACK%5D+Request+Representer+Repository) to request an official representer repository for your track.
-
-## Default Implementation
-
-The default implementation works as follows:
-
-- The `representation.txt` contains the concatenated solution files
-  - Solution files are separated by an empty line
-  - Solution files are identified via the the `.files.solution[]` property in the `.meta/config.json` file
-- The `mapping.json` contains an empty JSON object (`{}`)
-
-### Normalizations
-
-- Blank files in the solution files are removed in the `representation.txt`
-- Line-based trailing whitespace in the solution files is removed in the `representation.txt`
-
-# Exercism TRACK_NAME_HERE Representer
-
-The Docker image to automatically create a representation for TRACK_NAME_HERE solutions submitted to [Exercism].
+The Docker image to automatically create a representation for PHP solutions submitted to [Exercism].
 
 ## Run the representer
 

bin/run-tests.sh

@@ -25,10 +25,10 @@ for test_dir in tests/*; do
     expect_error="${test_dir_path}/.expect-error"
 
     bin/run.sh "${test_dir_name}" "${test_dir_path}" "${test_dir_path}"
-    exit_code=$?
+    test_exit_code=$?
 
     if [[ -f "${expect_error}" ]]; then
-        if [[ $exit_code -eq 0 ]]; then
+        if [[ $test_exit_code -eq 0 ]]; then
             echo 'Expected non-zero exit code'
             exit_code=1
         fi

bin/run.sh

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env sh
 
 # Synopsis:
 # Run the representer on a solution.
@@ -33,44 +33,4 @@ mkdir -p "${output_dir}"
 
 echo "${slug}: creating representation..."
 
-# TODO: build a representer to generate the representation and mapping files
-
-# As we don't yet analyze the solution files, we'll just concatenate them with
-# leading and trailing empty lines removed
-
-# Start with an empty representation file
-echo -n '' > "${representation_file}" 
-
-solution_files=$(jq -r '.files.solution[]' "${meta_config_json_file}")
-i=0
-
-while read -r relative_solution_file; do
-    solution_file="${input_dir}/${relative_solution_file}"
-
-    ## Error when the solution file doesn't exist
-    if [[ ! -f "${solution_file}" ]]; then
-        >&2 echo "Could not find solution file '${relative_solution_file}'"
-        exit 1
-    fi
-
-    # Add an empty line to separate multiple files
-    if [[ $i > 0 ]]; then
-        echo '' >> "${representation_file}"
-    fi
-
-    # Append the contents of the solution file to the representation file
-    # with any blank lines removed
-    sed -E -e 's/\s*$//' -e '/^$/d' "${solution_file}" >> "${representation_file}"
-
-    i=$((i+1))
-done <<< "${solution_files}"
-
-# Exit if there an error occured while processing the solution files
-if [ $? -ne 0 ]; then
-    exit $?
-fi
-
-# As we don't yet map any identifiers, we'll just output an empty JSON array
-echo '{}' > ${mapping_file}
-
-echo "${slug}: done"
+/usr/local/bin/php /opt/representer/main.php "$@"

composer.json

@@ -0,0 +1,40 @@
+{
+    "name": "exercism/php-representer",
+    "description": "A normalizing representer for Exercism's PHP track.",
+    "version": "0.1.0",
+    "type": "project",
+    "license": "MIT",
+    "require": {
+        "php": "^8.1",
+        "symfony/console": "^6.2",
+        "nikic/php-parser": "^4.15",
+        "psr/log": "^3.0"
+    },
+    "require-dev": {
+        "phpstan/phpstan": "^1.9",
+        "phpunit/phpunit": "^9.5",
+        "squizlabs/php_codesniffer": "^3.7",
+        "doctrine/coding-standard": "^11.1"
+    },
+    "autoload": {
+        "psr-4": {
+            "App\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "App\\Tests\\": "phpunit-tests"
+        }
+    },
+    "scripts": {
+        "phpstan": "phpstan analyse src tests --configuration phpstan.neon --memory-limit=2G",
+        "test": "phpunit",
+        "lint": "phpcs",
+        "lint:fix": "phpcbf"
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
+    }
+}