Merge pull request #7 from ensi-platform/ensitech-74

Ensitech 74

.git_hooks/post-checkout/01-install-dependencies.sh

@@ -0,0 +1 @@
+../scripts/install-dependencies.sh

.git_hooks/post-merge/01-install-dependencies.sh

@@ -0,0 +1 @@
+../scripts/install-dependencies.sh

.git_hooks/pre-commit/01-lint-php.sh

@@ -0,0 +1 @@
+../scripts/lint-php.sh

.git_hooks/pre-commit/02-php-cs-fixer.sh

@@ -0,0 +1 @@
+../scripts/php-cs-fixer.sh

.git_hooks/pre-push/01-composer-validate.sh

@@ -0,0 +1 @@
+../scripts/composer-validate.sh

.git_hooks/pre-push/02-phpstan.sh

@@ -0,0 +1 @@
+../scripts/phpstan.sh

.git_hooks/pre-push/03-test-code.sh

@@ -0,0 +1 @@
+../scripts/test-code.sh

.git_hooks/scripts/composer-validate.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# Validate composer.json before commit
+
+ESC_SEQ="\x1b["
+COL_RESET=$ESC_SEQ"39;49;00m"
+COL_RED=$ESC_SEQ"0;31m"
+COL_GREEN=$ESC_SEQ"0;32m"
+COL_YELLOW=$ESC_SEQ"0;33m"
+
+echo
+printf "$COL_YELLOW%s$COL_RESET\n" "Running pre-push hook: \"composer-validate\""
+
+VALID=$(composer validate --strict --no-check-publish --no-check-all | grep "is valid")
+
+if [ "$VALID" != "" ]; then
+    echo "Okay"
+    exit 0
+else
+    printf "$COL_RED%s$COL_RESET\r\n" "Composer validate check failed."
+    exit 1
+fi

.git_hooks/scripts/install-dependencies.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+# - 'composer update' if changed composer.json
+
+ESC_SEQ="\x1b["
+COL_RESET=$ESC_SEQ"39;49;00m"
+COL_RED=$ESC_SEQ"0;31m"
+COL_GREEN=$ESC_SEQ"0;32m"
+COL_YELLOW=$ESC_SEQ"0;33m"
+
+changed_files="$(git diff-tree -r --name-only --no-commit-id HEAD@{1} HEAD)"
+
+check_run() {
+    echo "$changed_files" | grep -q "$1" && echo " * changes detected in $1" && echo " * running $2" && eval "$2"
+}
+
+check_run composer.json "composer update"
+exit 0

.git_hooks/scripts/lint-php.sh

@@ -0,0 +1,45 @@
+#!/bin/bash
+
+# Lint all added php-files via 'php -l'
+
+ROOT_DIR="$(pwd)/"
+LIST=$(git diff-index --cached --name-only --diff-filter=ACMR HEAD)
+ERRORS_BUFFER=""
+ESC_SEQ="\x1b["
+COL_RESET=$ESC_SEQ"39;49;00m"
+COL_RED=$ESC_SEQ"0;31m"
+COL_GREEN=$ESC_SEQ"0;32m"
+COL_YELLOW=$ESC_SEQ"0;33m"
+COL_BLUE=$ESC_SEQ"0;34m"
+COL_MAGENTA=$ESC_SEQ"0;35m"
+COL_CYAN=$ESC_SEQ"0;36m"
+
+echo
+printf "$COL_YELLOW%s$COL_RESET\n" "Running pre-commit hook: \"php-linter\""
+
+for file in $LIST
+do
+    EXTENSION=$(echo "$file" | grep  -E ".php$|.module$|.inc$|.install$")
+    if [ "$EXTENSION" != "" ]; then
+        ERRORS=$(php -l $ROOT_DIR$file 2>&1 | grep "Parse error")
+        if [ "$ERRORS" != "" ]; then
+            if [ "$ERRORS_BUFFER" != "" ]; then
+                ERRORS_BUFFER="$ERRORS_BUFFER\n$ERRORS"
+            else
+                ERRORS_BUFFER="$ERRORS"
+            fi
+            echo "Syntax errors found in file: $file "
+        fi
+    fi
+done
+if [ "$ERRORS_BUFFER" != "" ]; then
+    echo
+    echo "These errors were found in try-to-commit files: "
+    echo -e $ERRORS_BUFFER
+    echo
+    printf "$COL_RED%s$COL_RESET\r\n\r\n" "Can't commit, fix errors first."
+    exit 1
+else
+    echo "Okay"
+    exit 0
+fi

.git_hooks/scripts/php-cs-fixer.sh

@@ -0,0 +1,61 @@
+#!/bin/bash
+
+# Check code style via '.php-cs-fixer.php'
+
+EXECUTABLE_NAME=php-cs-fixer
+EXECUTABLE_COMMAND=fix
+CONFIG_FILE=.php-cs-fixer.php
+CONFIG_FILE_PARAMETER='--config'
+ROOT=`pwd`
+ESC_SEQ="\x1b["
+COL_RESET=$ESC_SEQ"39;49;00m"
+COL_RED=$ESC_SEQ"0;31m"
+COL_GREEN=$ESC_SEQ"0;32m"
+COL_YELLOW=$ESC_SEQ"0;33m"
+COL_BLUE=$ESC_SEQ"0;34m"
+COL_MAGENTA=$ESC_SEQ"0;35m"
+COL_CYAN=$ESC_SEQ"0;36m"
+
+echo ""
+printf "$COL_YELLOW%s$COL_RESET\n" "Running pre-commit hook: \"php-cs-fixer\""
+
+# possible locations
+locations=(
+  $ROOT/bin/$EXECUTABLE_NAME
+  $ROOT/vendor/bin/$EXECUTABLE_NAME
+)
+
+for location in ${locations[*]}
+do
+  if [[ -x $location ]]; then
+    EXECUTABLE=$location
+    break
+  fi
+done
+
+if [[ ! -x $EXECUTABLE ]]; then
+  echo "executable $EXECUTABLE_NAME not found, exiting..."
+  echo "if you're sure this is incorrect, make sure they're executable (chmod +x)"
+  exit
+fi
+
+echo "using \"$EXECUTABLE_NAME\" located at $EXECUTABLE"
+$EXECUTABLE --version
+
+if [[ -f $ROOT/$CONFIG_FILE ]]; then
+  CONFIG=$ROOT/$CONFIG_FILE
+  echo "config file located at $CONFIG loaded"
+fi
+
+FILES=`git status --porcelain | grep -e '^[AM]\(.*\).php$' | cut -c 3- | sed -e "s/_ide_helper.php$//" | sed -e "s/_ide_helper_models.php$//" | sed -e "s/.phpstorm.meta.php$//" | tr '\n' ' ' | sed 's/ *$//g'`
+if [ -z "$FILES" ]; then
+    echo "No php files found to fix."
+else
+    echo "Fixing files ${FILES} in project";
+    if [[ -f $CONFIG ]]; then
+      $EXECUTABLE $EXECUTABLE_COMMAND $CONFIG_FILE_PARAMETER=$CONFIG ${FILES};
+    else
+      $EXECUTABLE $EXECUTABLE_COMMAND ${FILES};
+    fi
+    git add ${FILES}
+fi

.git_hooks/scripts/phpstan.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# Run composer phpstan
+
+ESC_SEQ="\x1b["
+COL_RESET=$ESC_SEQ"39;49;00m"
+COL_RED=$ESC_SEQ"0;31m"
+COL_GREEN=$ESC_SEQ"0;32m"
+COL_YELLOW=$ESC_SEQ"0;33m"
+
+echo
+printf "$COL_YELLOW%s$COL_RESET\n" "Running pre-push hook: \"phpstan\""
+
+if composer phpstan; then
+    echo "Okay"
+    exit 0
+else
+    printf "$COL_RED%s$COL_RESET\r\n" "phpstan analysis failed."
+    exit 1
+fi

.git_hooks/scripts/test-code.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# Run composer test
+
+ESC_SEQ="\x1b["
+COL_RESET=$ESC_SEQ"39;49;00m"
+COL_RED=$ESC_SEQ"0;31m"
+COL_GREEN=$ESC_SEQ"0;32m"
+COL_YELLOW=$ESC_SEQ"0;33m"
+
+echo
+printf "$COL_YELLOW%s$COL_RESET\n" "Running pre-push hook: \"test-code\""
+
+if composer test; then
+    echo "Okay"
+    exit 0
+else
+    printf "$COL_RED%s$COL_RESET\r\n" "Tests failed."
+    exit 1
+fi

.github/CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
+world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
+quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open
+source projects are used by many developers, who may have entirely different needs to your own. Think about
+whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+**Happy coding**!

.github/SECURITY.md

@@ -0,0 +1,3 @@
+# Security Policy
+
+If you discover any security related issues, please email [email protected] instead of using the issue tracker.

.github/workflows/php-cs-fixer.yml

@@ -0,0 +1,23 @@
+name: Check & fix styling
+
+on: [push]
+
+jobs:
+  php-cs-fixer:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Run PHP CS Fixer
+        uses: docker://oskarstark/php-cs-fixer-ga
+        with:
+          args: --config=.php-cs-fixer.php --allow-risky=yes
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Fix styling

.github/workflows/run-tests.yml

@@ -0,0 +1,51 @@
+name: run-tests
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        php: [8.1, 8.2, 8.3]
+        laravel: [9.*, 10.*, 11.*]
+        exclude:
+          - laravel: 11.*
+            php: 8.1
+
+    name: P${{ matrix.php }} - L${{ matrix.laravel }}
+
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
+          coverage: none
+
+      - name: Setup problem matchers
+        run: |
+          echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+          echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+      - name: Install dependencies
+        run: |
+          composer require "laravel/framework:${{ matrix.laravel }}" --no-interaction --no-update
+          composer update --prefer-stable --prefer-dist --no-interaction
+
+      - name: Composer Validate
+        run: ./.git_hooks/scripts/composer-validate.sh
+
+      - name: Execute tests
+        run: composer test-ci
+
+      - name: Execute phpstan
+        run: ./.git_hooks/scripts/phpstan.sh