NC22 compliant (#59)

Author: R0Wi

.github/workflows/coverage.yml

@@ -20,9 +20,9 @@ jobs:
       matrix:
         php-versions: ['8.0']
         databases: ['sqlite']
-        server-versions: ['stable21']
+        server-versions: ['stable22']
 
-    name: php-coverage
+    name: php${{ matrix.php-versions }}-${{ matrix.databases }}-COVERAGE
 
     steps:
       - name: Checkout server

.github/workflows/lint.yml

@@ -18,7 +18,7 @@ jobs:
       matrix:
         php-versions: ['7.3', '7.4', '8.0']
 
-    name: php-lint-${{ matrix.php-versions }}
+    name: php${{ matrix.php-versions }}-LINT
     steps:
       - uses: actions/checkout@v2
 
@@ -32,14 +32,14 @@ jobs:
         run: composer run lint
 
   nc-app-code-check:
-    name: nc-app-code-check
+    name: nc-app-code-check-${{ matrix.php-versions }}-${{ matrix.databases }}-CODECHECK
     runs-on: ubuntu-20.04
 
     strategy:
       matrix:
         php-versions: ['8.0']
         databases: ['sqlite']
-        server-versions: ['stable21']
+        server-versions: ['stable22']
 
     steps:
     - name: Checkout server

.github/workflows/phpunit.yml

@@ -20,7 +20,7 @@ jobs:
       matrix:
         php-versions: ['8.0']
         databases: ['sqlite']
-        server-versions: ['stable21']
+        server-versions: ['stable22']
 
     name: php${{ matrix.php-versions }}-${{ matrix.databases }}
 
@@ -79,7 +79,7 @@ jobs:
       matrix:
         php-versions: ['7.3', '7.4', '8.0']
         databases: ['mysql']
-        server-versions: ['stable21']
+        server-versions: ['stable22']
 
     name: php${{ matrix.php-versions }}-${{ matrix.databases }}
 
@@ -147,7 +147,7 @@ jobs:
       matrix:
         php-versions: ['8.0']
         databases: ['pgsql']
-        server-versions: ['stable21']
+        server-versions: ['stable22']
 
     name: php${{ matrix.php-versions }}-${{ matrix.databases }}
 

.vscode/launch.json

@@ -9,20 +9,20 @@
             "name": "Listen for XDebug",
             "type": "php",
             "request": "launch",
-            "port": 9000
+            "port": 9003
         },
         {
             "name": "Listen for XDebug (CLI)",
             "type": "php",
             "request": "launch",
-            "port": 9001
+            "port": 9003
         },
         {
             "name": "Run cron.php",
             "type": "php",
             "request": "launch",
             "program": "${workspaceRoot}/../../cron.php",
-            "port": 9001
+            "port": 9003
         },
         {
             "name": "Debug Unittests",
@@ -31,7 +31,7 @@
             "program": "${workspaceRoot}/vendor/phpunit/phpunit/phpunit",
             "args": ["-c", "phpunit.xml"],
             "cwd": "${workspaceRoot}",
-            "port": 9001
+            "port": 9003
         },
         {
             "name": "Debug Integrationtests",
@@ -40,7 +40,7 @@
             "program": "${workspaceRoot}/vendor/phpunit/phpunit/phpunit",
             "args": ["-c", "phpunit.integration.xml"],
             "cwd": "${workspaceRoot}",
-            "port": 9001
+            "port": 9003
         }
     ]
 }

README.md

@@ -4,7 +4,7 @@
 [![codecov](https://codecov.io/gh/R0Wi/workflow_ocr/branch/master/graph/badge.svg)](https://codecov.io/gh/R0Wi/workflow_ocr)
 ![Lint](https://github.com/R0Wi/workflow_ocr/workflows/Lint/badge.svg)
 [![Generic badge](https://img.shields.io/github/v/release/R0Wi/workflow_ocr)](https://github.com/R0Wi/workflow_ocr/releases)
-[![Generic badge](https://img.shields.io/badge/Nextcloud-21-orange)](https://github.com/nextcloud/server)
+[![Generic badge](https://img.shields.io/badge/Nextcloud-22-orange)](https://github.com/nextcloud/server)
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
@@ -21,6 +21,7 @@
 - [Development](#development)
   - [Dev setup](#dev-setup)
   - [Debugging](#debugging)
+  - [`docker`-based setup](#docker-based-setup)
   - [Executing tests](#executing-tests)
   - [Adding a new `OcrProcessor`](#adding-a-new-ocrprocessor)
 - [Limitations](#limitations)
@@ -84,7 +85,7 @@ To **test** if your file gets processed properly you can do the following steps:
 ## How it works
 ### General
 <p align="center">
-  <img width="50%" src="doc/diagramms/general.svg" alt="General diagramm">
+  <img width="50%" src="doc/diagramms/general.png" alt="General diagramm">
 </p>
 
 ### PDF
@@ -118,8 +119,8 @@ when being inside of the debug-tab.
     <img src="doc/img/debug.jpg" alt="VSCode debug profile">
   </p>
 
-To get the debugger profiles working you need to ensure that `XDebug` for `Apache` (or your preferred webserver) is connected to you machine at
-port `9000` while `XDebug` for the PHP CLI should be configured to bind to port `9001`. Depending on your system a possible configuration could
+To get the debugger profiles working you need to ensure that `XDebug` for `Apache` (or your preferred webserver) and `XDebug` for PHP CLI both connect to your machine at
+port `9003`. Depending on your system a possible configuration could
 look like this:
 
 ```ini
@@ -129,7 +130,7 @@ look like this:
 zend_extension=/usr/lib/php/20190902/xdebug.so
 xdebug.remote_enable=1
 xdebug.remote_host=127.0.0.1
-xdebug.remote_port=9001
+xdebug.remote_port=9003
 xdebug.remote_autostart=1
 ```
 
@@ -140,7 +141,7 @@ xdebug.remote_autostart=1
 zend_extension=/usr/lib/php/20190902/xdebug.so
 xdebug.remote_enable=1
 xdebug.remote_host=127.0.0.1
-xdebug.remote_port=9000
+xdebug.remote_port=9003
 xdebug.remote_autostart=1
 ```
 
@@ -158,6 +159,55 @@ If you're looking for some good sources on how to setup `VSCode` + `XDebug` we c
 * https://tighten.co/blog/configure-vscode-to-debug-phpunit-tests-with-xdebug/
 * https://code.visualstudio.com/docs/languages/php
 
+### `docker`-based setup
+If you're interested in a `docker`-based setup we can recommend
+the images from https://github.com/thecodingmachine/docker-images-php which already come with `Apache` and
+`XDebug` installed.
+
+A working `docker-compose.yml`-file could look like this:
+```yaml
+version: '3'
+services:
+  apache_dev:
+    restart: always
+    container_name: apache_dev
+    image: ${IMAGE}-custom
+    build:
+      dockerfile: ./Dockerfile
+      args:
+        IMAGE: ${IMAGE}
+    environment:
+      - PHP_INI_MEMORY_LIMIT=1g
+      - PHP_INI_ERROR_REPORTING=E_ALL
+      - PHP_INI_XDEBUG__START_WITH_REQUEST=yes
+      - PHP_INI_XDEBUG__LOG_LEVEL=7
+      - PHP_EXTENSIONS=xdebug gd intl bcmath gmp imagick
+    volumes:
+      - ./html:/var/www/html
+      - ./000-default.conf:/etc/apache2/sites-enabled/000-default.conf
+    ports:
+      - 80:80
+    networks:
+      - web_dev
+```
+`IMAGE` could be set to `IMAGE=thecodingmachine/php:7.4-v4-apache-node14` and the content of `Dockerfile` might
+look like this:
+
+```dockerfile
+ARG IMAGE
+FROM $IMAGE
+
+USER root
+RUN    apt-get update \
+    && apt-get install -y make ocrmypdf tesseract-ocr-eng tesseract-ocr-deu smbclient \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* /usr/share/doc/*
+USER docker
+```
+> :information_source: Please note that these are just
+working snippets which you might have to modify to fit
+your needs.
+
 ### Executing tests
 To execute the implemented PHPUnit tests you can use one of the following commands:
 

appinfo/info.xml

@@ -6,7 +6,7 @@
 	<summary>OCR processing via workflow</summary>
 	<description>This app makes it possible to process various files via OCR algorithms.
 	The processing is done via workflow-engine and can therefore easily be customized.</description>
-	<version>1.21.0</version>
+	<version>1.22.0</version>
 	<licence>agpl</licence>
 	<author mail="ro.windey@gmail.com">Robin Windey</author>
 	<namespace>WorkflowOcr</namespace>
@@ -22,6 +22,6 @@
 	<repository type="git">https://github.com/R0Wi/workflow_ocr.git</repository>
 	<screenshot>https://github.com/R0Wi/workflow_ocr/blob/eb2d65e9610406bbab22c4c8dda1cea015b5c791/doc/img/usage_1.jpg?raw=true</screenshot>
 	<dependencies>
-		<nextcloud min-version="21" max-version="21" />
+		<nextcloud min-version="22" max-version="22" />
 	</dependencies>
 </info>