chore/code style (#9)

* add cs

* add things for pcov

* add new targets

* update dockerfile

* cs fixes

* fix cs

Author: nick-zh

.circleci/config.yml

@@ -0,0 +1,21 @@
+version: 2.1
+
+orbs:
+  ci-caching: jobcloud/ci-caching@3.0
+  ci-php: jobcloud/ci-php@2.0
+
+workflows:
+  test-avsc-json-converter:
+    jobs:
+      - ci-caching/build-docker-images:
+          dockerComposeFile: "./docker/docker-compose.yml"
+      - ci-php/install-dependencies:
+          dockerComposeFile: "./docker/docker-compose.yml"
+          dependencyCheckSumFile: "./composer.json"
+          requires:
+            - ci-caching/build-docker-images
+      - ci-php/code-style:
+          dockerComposeFile: "./docker/docker-compose.yml"
+          dependencyCheckSumFile: "./composer.json"
+          requires:
+            - ci-php/install-dependencies

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [nick-zh]

Makefile

@@ -0,0 +1,37 @@
+.PHONY: clean code-style pcov-enable pcov-disable
+.DEFAULT_GOAL := code-style
+
+PHPCS = ./vendor/bin/phpcs --extensions=php
+
+clean:
+	rm -rf ./build ./vendor
+
+code-style: pcov-disable
+	mkdir -p build/logs/phpcs
+	${PHPCS}
+
+update-dependencies:
+	composer update
+
+install-dependencies:
+	composer install
+
+install-dependencies-lowest:
+	composer install --prefer-lowest
+
+pcov-enable:
+	sudo php-ext-enable pcov
+
+pcov-disable:
+	sudo php-ext-disable pcov
+
+help:
+	# Usage:
+	#   make <target> [OPTION=value]
+	#
+	# Targets:
+	#   clean               		Cleans the coverage and the vendor directory
+	#   code-style          		Check codestyle using phpcs
+	#   help                		You're looking at it!
+	#   pcov-enable         		Enable pcov
+	#   pcov-disable        		Disable pcov

composer.json

@@ -30,6 +30,9 @@
         "symfony/console": "^5.3",
         "pimple/pimple": "^3.5"
     },
+    "require-dev": {
+        "squizlabs/php_codesniffer": "^3.6"
+    },
     "bin": [
         "bin/avsc-to-json"
     ],

docker/.env

@@ -0,0 +1 @@
+COMPOSE_PROJECT_NAME=avsc-json-converter

docker/dev/php/Dockerfile

@@ -0,0 +1,30 @@
+FROM php:7.4-cli-alpine3.14
+
+ARG HOST_USER_ID
+ARG HOST_USER
+
+# PHP: Copy configuration files & remove dist files
+RUN mkdir /phpIni
+COPY files/bin/ /usr/local/bin/
+COPY files/php/ /phpIni
+
+# Install required packages
+RUN apk --no-cache upgrade && \
+    apk --no-cache add bash git sudo autoconf gcc g++ make
+
+RUN adduser -u $HOST_USER_ID -D -H $HOST_USER && \
+    echo "ALL ALL=NOPASSWD: ALL" >> /etc/sudoers && \
+    addgroup $HOST_USER www-data
+
+# COMPOSER: install binary
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/bin --filename=composer
+
+# PHP: Install php extensions
+RUN pecl channel-update pecl.php.net && \
+    pecl install pcov && \
+    php-ext-enable pcov
+
+USER $HOST_USER
+
+WORKDIR /var/www/html
+

docker/dev/php/files/bin/php-ext-disable

@@ -0,0 +1,11 @@
+#!/bin/bash
+if [ $# -eq 0 ]
+  then
+    echo "Please pass a php module name"
+    exit
+fi
+
+for phpmod in "$@"
+do
+    rm -f /usr/local/etc/php/conf.d/*$phpmod*.ini
+done

docker/dev/php/files/bin/php-ext-enable

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+if [[ ${#} -eq 0 ]] ; then
+    echo -e "\\nPHP module name required!\\n"
+    exit 1
+fi
+
+for phpmod in "${@}" ; do
+
+    files=($(find /phpIni -type f -iname "*${phpmod}*.ini" -exec ls -1 '{}' +))
+
+    for i in "${files[@]}" ; do
+        ln -s "${i}" /usr/local/etc/php/conf.d
+    done
+
+    if [[ ${#files[@]} -eq 0 ]] ; then
+        docker-php-ext-enable "${phpmod}"
+    fi
+
+done

docker/dev/php/files/php/20-pcov.ini

@@ -0,0 +1 @@
+extension=pcov.so

docker/docker-compose.yml

@@ -0,0 +1,13 @@
+version: '3.2'
+services:
+  php:
+    build:
+      context: ./dev/php
+      args:
+        HOST_USER: ${USER}
+        HOST_USER_ID: ${USER_ID}
+    container_name: avsc-json-converter
+    hostname: avsc-json-converter
+    tty: true
+    volumes:
+      - ../:/var/www/html