Merge pull request #1 from ensi-platform/task-77886

#77886

Author: arrilot

.git_hooks/post-checkout/install-dependecies.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+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 --quiet "$1" && echo " * changes detected in $1" && echo " * running $2" && eval "$2"
+}
+ 
+check_run composer.lock "composer install"
+check_run package-lock.json "npm install"
+exit 0

.git_hooks/post-merge/install-dependecies.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+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 --quiet "$1" && echo " * changes detected in $1" && echo " * running $2" && eval "$2"
+}
+ 
+check_run composer.lock "composer install"
+check_run package-lock.json "npm install"
+exit 0

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

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+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/pre-commit/php-cs-fixer.sh

@@ -0,0 +1,59 @@
+#!/bin/bash
+
+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/pre-push/composer-validate.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# validate composer 
+
+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/pre-push/var-dump-checker.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+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: \"var-dump-checker\""
+
+./vendor/bin/var-dump-check --laravel --exclude bootstrap --exclude node_modules --exclude vendor .
+
+# If the grep command has no hits - echo a warning and exit with non-zero status.
+if [ $? == 1 ]; then
+    printf "$COL_RED%s$COL_RESET\r\n\r\n" "Some var_dump usage found. Please fix your code"
+    exit 1
+fi
+
+echo "Okay"
+exit 0

.gitignore

@@ -5,6 +5,7 @@
 *.komodoproject
 .vscode
 .phpunit.result.cache
+.php-cs-fixer.cache
 composer.lock
 
 build

.huskyrc.json

@@ -0,0 +1,8 @@
+{
+    "hooks": {
+        "post-checkout": ".git_hooks/post-checkout/install-dependecies.sh",
+        "post-merge": ".git_hooks/post-merge/install-dependecies.sh",
+        "pre-commit": ".git_hooks/pre-commit/lint-php.sh && .git_hooks/pre-commit/php-cs-fixer.sh",
+        "pre-push": ".git_hooks/pre-push/composer-validate.sh && .git_hooks/pre-push/var-dump-checker.sh && composer test"
+    }
+}

.php-cs-fixer.php

@@ -0,0 +1,41 @@
+<?php
+
+$finder = Symfony\Component\Finder\Finder::create()
+    ->in([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->name('*.php')
+    ->notName('*.blade.php')
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true);
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PSR2' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'ordered_imports' => ['sort_algorithm' => 'alpha'],
+        'no_unused_imports' => true,
+        'trailing_comma_in_multiline' => true,
+        'phpdoc_scalar' => true,
+        'unary_operator_spaces' => true,
+        'blank_line_before_statement' => [
+            'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'],
+        ],
+        'phpdoc_single_line_var_spacing' => true,
+        'phpdoc_var_without_name' => true,
+        'class_attributes_separation' => [
+            'elements' => [
+                'method' => 'one',
+            ],
+        ],
+        'method_argument_space' => [
+            'on_multiline' => 'ensure_fully_multiline',
+            'keep_multiple_spaces_after_comma' => true,
+        ],
+        'single_trait_insert_per_statement' => true,
+        'no_whitespace_in_blank_line' => true,
+        'method_chaining_indentation' => true,
+
+    ])
+    ->setFinder($finder);

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2020-present Ensi
+Copyright (c) 2020-present Greensight
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal