Realllow usage of php 7.2+, CI using github actions, demoprojects and other improvements

.gitattributes

@@ -0,0 +1,10 @@
+# See https://php.watch/articles/composer-gitattributes
+/.github           export-ignore
+/demo              export-ignore
+/tests             export-ignore
+
+/.gitignore        export-ignore
+/.gitattributes    export-ignore
+/.travis.yml       export-ignore
+/phpstan.neon.dist export-ignore
+/phpunit.xml.dist  export-ignore

.github/workflows/ci.yml

@@ -0,0 +1,113 @@
+# This file was heavily based on the ci-file from SymfonyCasts/verify-email-bundle
+#
+# See https://github.com/SymfonyCasts/verify-email-bundle
+#     https://github.com/SymfonyCasts/verify-email-bundle/blob/main/.github/workflows/ci.yml
+
+name: CI
+on:
+  push:
+    branches: ['main','master']
+  pull_request:
+
+jobs:
+  static-analysis:
+    name: Static Analysis
+    runs-on: ubuntu-18.04
+
+    steps:
+      - name: "Checkout code"
+        uses: "actions/checkout@v2"
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          coverage: "none"
+          php-version: "8.0"
+
+      - name: "Validate composer.json"
+        run: "composer validate --strict --no-check-lock"
+
+      - name: "Validate php-files"
+        run:  "php -l src && php -l tests"
+
+      - name: "Composer install"
+        uses: "ramsey/composer-install@v2"
+        with:
+            composer-options: "--prefer-stable"
+            dependency-versions: 'highest'
+
+      - name: "PHPStan"
+        run:  "vendor/bin/phpstan analyze"
+
+      - name: "PHPCompatibility"
+        run:  "vendor/bin/phpcs src/ tests/ --standard=PHPCompatibility --runtime-set testVersion 7.2-8.1"
+
+  tests:
+    name: "Tests ${{ matrix.php-version }} ${{ matrix.dependency-versions }}"
+    runs-on: ubuntu-18.04
+    needs: static-analysis
+
+    strategy:
+      fail-fast: false
+      matrix:
+        # normal, highest, non-dev installs
+        php-version: ['7.2', '7.3', '7.4', '8.0', '8.1']
+        composer-options: ['--prefer-stable']
+        dependency-versions: ['highest']
+        include:
+          # testing lowest PHP version with lowest dependencies
+          - php-version: '7.2.5'
+            dependency-versions: 'lowest'
+            composer-options: '--prefer-lowest'
+
+    steps:
+      - name: "Checkout code"
+        uses: "actions/checkout@v2"
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          coverage: "none"
+          php-version: "${{ matrix.php-version }}"
+
+#      - name: Install Global Dependencies
+#        run: |
+#          composer global require --no-progress --no-scripts --no-plugins symfony/flex >=1.x
+
+      - name: "Composer install"
+        uses: "ramsey/composer-install@v2"
+        with:
+          dependency-versions: "${{ matrix.dependency-versions }}"
+          composer-options: "--prefer-dist --no-progress"
+
+      - name: Unit Tests
+        run: vendor/bin/phpunit
+
+      - name: Install symlinks for demo's
+        uses: "ramsey/composer-install@v2"
+        with:
+          dependency-versions: "${{ matrix.dependency-versions }}"
+          composer-options: "--prefer-dist --no-progress"
+          working-directory: "demo"
+
+      - name: Demo symfony4.4 - Install  dependencies
+        uses: "ramsey/composer-install@v2"
+        with:
+          dependency-versions: "${{ matrix.dependency-versions }}"
+          composer-options: "--prefer-dist --no-progress"
+          working-directory: "demo/symfony4.4"
+
+      - name: Demo symfony4.4 - Unit Tests
+        run: demo/symfony4.4/vendor/bin/simple-phpunit -c demo/symfony4.4/phpunit.xml.dist
+
+      - name: Demo symfony6.x - Install  dependencies
+        uses: "ramsey/composer-install@v2"
+        with:
+          dependency-versions: "${{ matrix.dependency-versions }}"
+          composer-options: "--prefer-dist --no-progress"
+          working-directory: "demo/symfony6.x"
+        if: ${{ startsWith(matrix.php-version , '8.') }}
+
+      - name: Demo symfony6.x - Unit Tests
+        run: demo/symfony6.x/vendor/bin/simple-phpunit -c demo/symfony6.x/phpunit.xml.dist
+        if: ${{ startsWith(matrix.php-version , '8.') }}

.gitignore

@@ -1,3 +1,5 @@
 .idea/
 /composer.lock
 /vendor
+.phpunit.result.cache
+.phpstan-cache/

README.md

@@ -62,3 +62,8 @@ Filename example: `.DefuseEncryptor.key` or `.HaliteEncryptor.key`
 * [Usage](src/Resources/doc/usage.md)
 * [Console commands](src/Resources/doc/commands.md)
 * [Custom encryption class](src/Resources/doc/custom_encryptor.md)
+
+### Demo
+
+Two demo-installations, one using symfony 4.4 and one using symfony 6.x, can be found in this repository in [`demo`](demo).  This demonstrates how to use 
+the application using both annotations and, when using php > 8.0, attributes.

composer.json

@@ -5,19 +5,25 @@
 	"license": "MIT",
 	"description": "Encrypted symfony entity's by verified and standardized libraries",
 	"require": {
-		"php": "^8.0",
+		"php": "^7.2|^8.0",
 		"paragonie/halite": "^4.6",
 		"paragonie/sodium_compat": "^1.5",
 		"doctrine/orm": "^2.5",
+		"doctrine/doctrine-bundle": "^2.0",
 		"symfony/property-access": "^4.1|^5.0|^6.0",
 		"symfony/dependency-injection": "^4.1|^5.0|^6.0",
 		"symfony/yaml": "^4.1|^5.0|^6.0",
 		"symfony/http-kernel": "^4.1|^5.0|^6.0",
-		"symfony/config": "^4.1|^5.0|^6.0"
+		"symfony/config": "^4.1|^5.0|^6.0",
+		"doctrine/annotations": "^1.13"
 	},
 	"require-dev": {
 		"phpunit/phpunit": "^8.0|^9.0",
-		"defuse/php-encryption": "^2.1"
+		"defuse/php-encryption": "^2.1",
+		"doctrine/cache": "^1.11",
+		"phpstan/phpstan": "^1.4",
+		"jetbrains/phpstorm-attributes": "^1.0",
+		"phpcompatibility/php-compatibility": "^9.3"
 	},
 	"suggest": {
 		"defuse/php-encryption": "Alternative for halite for use with older php-versions",
@@ -28,9 +34,14 @@
 			"Ambta\\DoctrineEncryptBundle\\": "src/"
 		}
 	},
+	"scripts": {
+		"post-install-cmd": "\"vendor/bin/phpcs\" --config-set installed_paths vendor/phpcompatibility/php-compatibility",
+		"post-update-cmd" : "\"vendor/bin/phpcs\" --config-set installed_paths vendor/phpcompatibility/php-compatibility",
+		"phpcs-compatibility-test" : "vendor/bin/phpcs src/ tests/ --standard=PHPCompatibility --runtime-set testVersion 7.2-8.1"
+	},
 	"autoload-dev": {
 		"psr-4": {
-			"Ambta\\DoctrineEncryptBundle\\Tests\\": "Tests/"
+			"Ambta\\DoctrineEncryptBundle\\Tests\\": "tests/"
 		}
 	},
 	"config": {

demo/.gitignore

@@ -0,0 +1,5 @@
+.idea/
+/composer.lock
+/vendor
+.phpunit.result.cache
+.phpstan-cache/

demo/README.md

@@ -0,0 +1,3 @@
+Run `composer.install` in this directory to create symlinks for the shared files to the demo-projects
+
+If you prefer a copy, use `composer install --no-dev`.

demo/composer.json

@@ -0,0 +1,26 @@
+{
+    "name": "absolute-quantum/doctrine-encrypt-bundle-demo",
+    "description": "Symlinks shared directories",
+    "type": "metapackage",
+    "require": {
+        "kporras07/composer-symlinks": "^1.1"
+    },
+    "scripts": {
+        "post-install-cmd": [
+            "Kporras07\\ComposerSymlinks\\ScriptHandler::createSymlinks"
+        ],
+        "post-update-cmd": [
+            "Kporras07\\ComposerSymlinks\\ScriptHandler::createSymlinks"
+        ]
+    },
+    "extra": {
+        "symlinks": {
+            "shared/templates":     "symfony4.4/templates",
+            "./shared/templates":   "symfony6.x/templates",
+            "shared/var/data.db":   "symfony4.4/var/data.db",
+            "./shared/var/data.db": "symfony6.x/var/data.db",
+            "shared/.Halite.key":   "symfony4.4/.Halite.key",
+            "./shared/.Halite.key": "symfony6.x/.Halite.key"
+        }
+    }
+}

demo/shared/.Halite.key

@@ -0,0 +1 @@
+31400400ce550006e6a149298ed2a9d78d94d9a5aaac68e4b2d86ee0174c4e25ad03983e03d6d958d8f51636cbe221dd21ae6c186058af6b998001a7a04954a14ffc675595ccbdb04602b76dabe84b33d023974e8b8e689a1d03a9affe5abadad18a8861

demo/shared/templates/index.html.twig

@@ -0,0 +1,51 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="UTF-8">
+        <title>{% block title %}Welcome!{% endblock %}</title>
+        <style>
+            table {
+                font-size:16px;
+                font-family: "Trebuchet MS", Arial, Helvetica, sans-serif;
+                border-collapse: collapse;
+                border-spacing: 0;
+                width: 100%;
+            }
+
+            td, th {
+                border: 1px solid #ddd;
+                text-align: left;
+                padding: 8px;
+            }
+
+            tr:nth-child(even){background-color: #f2f2f2}
+
+            th {
+                padding-top: 11px;
+                padding-bottom: 11px;
+                background-color: #04AA6D;
+                color: white;
+            }
+        </style>
+    </head>
+    <body>
+    <h1>Hello World!</h1>
+    <h2>Symfony {{ appVersion }} using php{{ constant('PHP_MAJOR_VERSION')~'.'~constant('PHP_MINOR_VERSION') }}</h2>
+    <table>
+        <tr>
+            <th>Type</th>
+            <th>Name</th>
+            <th>Secret</th>
+            <th>Raw Secret (as stored in DB)</th>
+        </tr>
+        {% for secret in secrets %}
+            <tr>
+                <td>{{ secret.type }}</td>
+                <td>{{ secret.name }}</td>
+                <td>{{ secret.secret }}</td>
+                <td>{{ secret.rawSecret }}</td>
+            </tr>
+        {% endfor %}
+    </table>
+    </body>
+</html>

demo/symfony4.4/.env

@@ -0,0 +1,31 @@
+# In all environments, the following files are loaded if they exist,
+# the latter taking precedence over the former:
+#
+#  * .env                contains default values for the environment variables needed by the app
+#  * .env.local          uncommitted file with local overrides
+#  * .env.$APP_ENV       committed environment-specific defaults
+#  * .env.$APP_ENV.local uncommitted environment-specific overrides
+#
+# Real environment variables win over .env files.
+#
+# DO NOT DEFINE PRODUCTION SECRETS IN THIS FILE NOR IN ANY OTHER COMMITTED FILES.
+#
+# Run "composer dump-env prod" to compile .env files for production use (requires symfony/flex >=1.2).
+# https://symfony.com/doc/current/best_practices.html#use-environment-variables-for-infrastructure-configuration
+
+###> symfony/framework-bundle ###
+APP_ENV=dev
+APP_SECRET=50710977b1177353fb0c574b9ce67051
+#TRUSTED_PROXIES=127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16
+#TRUSTED_HOSTS='^(localhost|example\.com)$'
+###< symfony/framework-bundle ###
+
+###> doctrine/doctrine-bundle ###
+# Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
+# IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml
+#
+# DATABASE_URL="sqlite:///%kernel.project_dir%/var/data.db"
+# DATABASE_URL="mysql://db_user:[email protected]:3306/db_name?serverVersion=5.7"
+DATABASE_PATH="var/data.db"
+DATABASE_URL="sqlite:///%kernel.project_dir%/var/data.db"
+###< doctrine/doctrine-bundle ###

demo/symfony4.4/.gitignore

@@ -0,0 +1,16 @@
+# Ignore symlinks
+/templates
+/var/data.db
+/.Halite.key
+
+# Ignore locked versions of composer
+composer.lock
+###> symfony/framework-bundle ###
+/.env.local
+/.env.local.php
+/.env.*.local
+/config/secrets/prod/prod.decrypt.private.php
+/public/bundles/
+/var/
+/vendor/
+###< symfony/framework-bundle ###

demo/symfony4.4/.phpversion

@@ -0,0 +1 @@
+72

demo/symfony4.4/README.md

@@ -0,0 +1,26 @@
+This demo-installation demonstrates a simple symfony 4.4-application using both annotations and, when using php > 8.0, attributes.
+
+# How to use
+```shell
+# run `composer install` in parent-directory to create symlinks for shared files
+cd ../
+composer install
+cd -
+
+# Install packages
+composer install
+
+# Serve the application
+## Using symfony-cli
+symfony serve
+## Using php-builtin-server ()
+php -S localhost:8000 -t public
+## Other possibility
+### Use a webserver like apache or nginx
+
+
+# Run unittests
+vendor/bin/simple-phpunit
+```
+
+