Initial commit

Author: DaveLiddament

.github/workflows/full-checks.yml

@@ -0,0 +1,53 @@
+name: "Full checks"
+
+on:
+  schedule:
+    - cron: '0 10 * * *'
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  full-checks:
+    name: "PHP version ${{ matrix.php-version }}"
+
+    runs-on: ${{ matrix.operating-system }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php-version:
+          - "8.2"
+          - "8.3"
+          - "8.4"
+        operating-system:
+          - "ubuntu-22.04"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          php-version: "${{ matrix.php-version }}"
+          tools: composer
+
+      - name: Get composer cache directory
+        id: composercache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composercache.outputs.dir }}
+          key: "php-${{ matrix.php-version }}-${{ hashFiles('**/composer.lock') }}"
+          restore-keys: "php-${{ matrix.php-version }}-${{ hashFiles('**/composer.lock') }}"
+
+      - name: "Install dependencies"
+        run: "composer install --no-interaction --no-progress"
+
+      - name: "Full CI"
+        run: "composer all-checks"
+

.gitignore

@@ -0,0 +1,3 @@
+vendor/
+.phpunit.cache
+.idea/

Dockerfile

@@ -0,0 +1,34 @@
+ARG PHP_VERSION
+FROM php:${PHP_VERSION}cli
+
+# Increase memory limit
+RUN echo 'memory_limit = -1' >> /usr/local/etc/php/conf.d/docker-php-memlimit.ini
+
+# install Composer
+COPY ./docker/composer.sh /root/
+
+RUN <<EOF
+set -eux;
+apt-get update;
+apt-get install -y  \
+    git  \
+    zip;
+rm -rf /var/lib/apt/lists/*;
+cd /root/;
+chmod 755 composer.sh;
+/root/composer.sh;
+mv /root/composer.phar /usr/local/bin/composer;
+rm /root/composer.sh;
+EOF
+
+# install Xdebug
+ARG XDEBUG_ENABLED=1
+
+RUN <<EOF
+if [ $XDEBUG_ENABLED -eq 1 ]; then
+    pecl install xdebug;
+    docker-php-ext-enable xdebug;
+fi
+EOF
+
+WORKDIR /app/

LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License (MIT)
+
+Copyright (c) 2024 Dave Liddament
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,72 @@
+# Rector custom rules tutorial
+
+This repository contains the code to support [Dave Liddament](https://twitter.com/daveliddament)'s Rector custom rules tutorial.
+
+
+## Pre tutorial setup
+
+1. Set up an environment with either PHP 8.2 or 8.3.
+1. Clone this repository.
+1. Run: `composer install`
+1. Run all the checks. There is a composer script for this: `composer run-script all-checks`
+
+You should see something similar to this:
+
+```
+$ composer run-script all-checks 
+> composer validate --strict
+./composer.json is valid
+> vendor/bin/phpunit
+PHPUnit 11.4.1 by Sebastian Bergmann and contributors.
+
+Runtime:       PHP 8.2.24
+Configuration: /home/dave/LampBristol/personal/rector-course/phpunit.xml
+
+.                                                                   1 / 1 (100%)
+
+Time: 00:00.002, Memory: 8.00 MB
+
+OK (1 test, 1 assertion)
+```
+
+You're all good to go!
+
+## Docker images
+
+There are docker files that have been tested on docker for [MacOS](https://docs.docker.com/desktop/install/mac-install/).
+
+### Build the container
+
+```shell
+docker compose build
+```
+
+
+### Start the container
+
+```shell
+docker compose up -d
+```
+
+
+### Run docker commands
+
+```shell
+docker compose exec php82 <command>
+```
+
+E.g.
+
+```shell
+# Composer install
+docker compose exec php82 composer install
+
+# Run all CI checks
+docker compose exec php82 composer all-checks
+
+# Run the tests
+docker compose exec php82 vendor/bin/phpunit
+
+# Run rector
+docker compose exec php82 vendor/bin/rector
+```

composer.json

@@ -0,0 +1,40 @@
+{
+    "name": "dave-liddament/rector-custom-rules-workshop",
+    "description": "Repo to support the rector custom rules workshop",
+    "type": "project",
+    "require": {
+        "php": ">=8.2 <8.5"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^11.4",
+        "rector/rector": "^2.0.16"
+    },
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "DaveLiddament\\RectorCustomRulesWorkshop\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "DaveLiddament\\RectorCustomRulesWorkshop\\Test\\": "tests/",
+            "Utils\\Rector\\": "utils/rector/src",
+            "Utils\\Rector\\Tests\\": "utils/rector/tests"
+        }
+    },
+    "authors": [
+        {
+            "name": "Dave Liddament",
+            "email": "[email protected]"
+        }
+    ],
+    "scripts": {
+        "all-checks": [
+            "composer validate --strict",
+            "@test"
+        ],
+        "test": [
+            "vendor/bin/phpunit"
+        ]
+    }
+}