Merge branch 'normalize-whitespace' into dev

.github/workflow-scripts/check-trailing-newline

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+# Verify that all text files end in a trailing newline.
+
+# Exit on first failing command.
+set -e
+
+# Exit on unset variable.
+set -u
+
+success=0
+
+function is_plaintext_file() {
+  local file="$1"
+  if [[ $file == *.svg ]]; then
+    echo ""
+    return
+  fi
+  file --brief "${file}" | grep text
+}
+
+# Split strings on newlines.
+IFS='
+'
+for file in $(git ls-files)
+do
+  if [[ -z $(is_plaintext_file "${file}") ]]; then
+    continue
+  fi
+
+  if ! [[ -z "$(tail -c 1 "${file}")" ]]; then
+    printf "File must end in a trailing newline: %s\n" "${file}" >&2
+    success=255
+  fi
+done
+
+exit "${success}"

.github/workflow-scripts/check-trailing-whitespace

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# Check for trailing whitespace at end of lines.
+
+# Exit on first failing command.
+set -e
+# Exit on unset variable.
+set -u
+
+FOUND_TRAILING_WHITESPACE=0
+
+while read -r line; do
+  if grep \
+    "\s$" \
+    --line-number \
+    --with-filename \
+    --binary-files=without-match \
+    --exclude="*.svg" \
+    --exclude="*.eps" \
+    "${line}"; then
+    echo "ERROR: Found trailing whitespace" >&2;
+    FOUND_TRAILING_WHITESPACE=1
+  fi
+done < <(git ls-files)
+
+exit "${FOUND_TRAILING_WHITESPACE}"

.github/workflows/ci.yml

@@ -81,6 +81,20 @@ jobs:
         run: |
           cd src/
           pycodestyle
+  whitespace:
+    runs-on: ubuntu-20.04
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Ensure there are no trailing spaces
+        run: |
+          .github/workflow-scripts/check-trailing-whitespace
+      -
+        name: Ensure all text files end with a trailing newline
+        run: |
+          .github/workflow-scripts/check-trailing-whitespace
 
   tests:
     runs-on: ubuntu-20.04
@@ -158,7 +172,7 @@ jobs:
         path: src/documents/static/frontend/
 
   build-release:
-    needs: [frontend, documentation, tests, codestyle]
+    needs: [frontend, documentation, tests, whitespace, codestyle]
     runs-on: ubuntu-20.04
     steps:
       -
@@ -268,7 +282,7 @@ jobs:
   build-docker-image:
     if: github.event_name == 'push' && (startsWith(github.ref, 'refs/heads/feature-') || github.ref == 'refs/heads/dev' || startsWith(github.ref, 'refs/tags/ng-'))
     runs-on: ubuntu-latest
-    needs: [frontend, tests, codestyle]
+    needs: [frontend, tests, whitespace, codestyle]
     steps:
       -
         name: Prepare

ansible/README.md

@@ -12,27 +12,29 @@ Note that this role requires root access, so either run it in a playbook with a
 
     - hosts: all
       roles:
-        - role: ansible
+        - role: paperless-ng
           become: yes
 
 Role Variables
 --------------
 
 Most configuration variables from paperless-ng itself are available and accept their respective arguments.
-Every `PAPERLESS_*` configuration varaible is lowercased and instead prefixed with `paperlessng_*` in `defaults/main.yml`.
+Every `PAPERLESS_*` configuration variable is lowercased and instead prefixed with `paperlessng_*` in `defaults/main.yml`.
 
-For a full listing including explainations and allowed values, see the current [documentation](https://paperless-ng.readthedocs.io/en/ng-0.9.14/configuration.html).
+For a full listing including explanations and allowed values, see the current [documentation](https://paperless-ng.readthedocs.io/en/latest/configuration.html).
 
 Additional variables available in this role are listed below, along with default values:
 
-    paperlessng_version: 0.9.14
+    paperlessng_version: latest
 
 The [release](https://github.com/jonaswinkler/paperless-ng/releases) archive version of paperless-ng to install.
+`latest` stands for the latest release of paperless-ng.
+To install a specific version of paperless-ng, use the tag name of the release, e. g. `ng-1.4.4`, or specify a branch or commit id.
 
     paperlessng_redis_host: localhost
     paperlessng_redis_port: 6379
 
-Seperate configuration values that combine into `PAPERLESS_REDIS`.
+Separate configuration values that combine into `PAPERLESS_REDIS`.
 
     paperlessng_db_type: sqlite
 
@@ -96,11 +98,11 @@ Example Playbook
     - hosts: all
       become: yes
       vars_files:
-        - vars/main.yml
+        - vars/paperless-ng.yml
       roles:
-        - ansible
+        - paperless-ng
 
-`vars/main.yml`:
+`vars/paperless-ng.yml`:
 
     paperlessng_media_root: /mnt/media/smbshare
 

docs/administration.rst

@@ -149,22 +149,15 @@ Ansible Route
 
 Most of the update process is automated when using the ansible role.
 
-1.  Backup your defined role variables file outside the paperless source-tree:
+1.  Update the role to the target release tag to make sure the ansible scripts are compatible:
 
     .. code:: shell-session
 
-        $ cp ansible/vars.yml ~/vars.yml.old
+        $ ansible-galaxy install git+https://github.com/jonaswinkler/paperless-ng.git,master --force
 
-2.  Pull the release tag you want to update to:
+2.  Update the role variable definitions ``vars/paperless-ng.yml`` (where appropriate).
 
-    .. code:: shell-session
-
-        $ git fetch --all
-        $ git checkout ng-0.9.14
-
-3.  Update the role variable definitions ``ansible/vars.yml`` (where appropriate).
-
-4.  Run the ansible playbook you created created during :ref:`installation <setup-ansible>` again:
+3.  Run the ansible playbook you created created during :ref:`installation <setup-ansible>` again:
 
     .. note::
 

docs/configuration.rst

@@ -622,6 +622,14 @@ PAPERLESS_IGNORE_DATES=<string>
 
     Defaults to an empty string to not ignore any dates.
 
+PAPERLESS_DATE_ORDER=<format>
+    Paperless will try to determine the document creation date from its contents.
+    Specify the date format Paperless should expect to see within your documents.
+
+    This option defaults to DMY which translates to day first, month second, and year
+    last order. Characters D, M, or Y can be shuffled to meet the required order.
+
+
 
 Binaries
 ########

docs/setup.rst

@@ -116,9 +116,7 @@ performs all the steps described in :ref:`setup-docker_hub` automatically.
 
     .. code:: shell-session
 
-        $ wget https://raw.githubusercontent.com/jonaswinkler/paperless-ng/master/install-paperless-ng.sh
-        $ chmod +x install-paperless-ng.sh
-        $ ./install-paperless-ng.sh
+        $ curl -L https://raw.githubusercontent.com/jonaswinkler/paperless-ng/master/install-paperless-ng.sh | bash
 
 .. _setup-docker_hub: