Reorganize the project with a containers-first mindset.

Author: mhavelant

Diff for: example.env renamed to .env

@@ -1,3 +1,9 @@
+# @file: Env variables for local development. Update as needed.
+# In case you need sensitive data, e.g. some external API keys,
+# you can add a .local.env file, add it to gitignore and add it
+# to the required services (e.g. php) with the env_file key
+# in the docker-compose.yml file.
+# Alternatively, use a docker-compse.local.yml
 PROJECT_NAME=damopen
 PROJECT_BASE_URL=damopen.docker.localhost
 
@@ -15,7 +21,7 @@ DRUPAL_HASH_SALT="<random string - at least 72 characters long>"
 DRUPAL_DATABASE_NAME=drupal
 DRUPAL_DATABASE_USERNAME=drupal
 DRUPAL_DATABASE_PASSWORD=drupal
-DRUPAL_DATABASE_HOST=mariadb
+DRUPAL_DATABASE_HOST=db
 DRUPAL_DATABASE_PORT=3306
 
 DB_ROOT_PASSWORD=drupal

Diff for: .gitignore

@@ -1,52 +1,15 @@
-# Ignore directories generated by Composer
-drush/contrib
-vendor
-bin
-web/core
-web/libraries
-web/modules/contrib
-web/themes/contrib
-web/profiles/contrib
-
-# Ignore Drupal's file directory
-web/sites/default/files
-private/*
-private_files/*
-tmp/*
-
 # Ignore files generated by PhpStorm
 .idea
 
 # Ignore apple stuff
 .DS_Store
 
-# Ignore configuration files that may contain sensitive information.
-web/sites/*/settings.local.php
-web/sites/*/settings.devdesktop.php
-web/sites/*/services*.yml
-
-# Ignore paths that contain user-generated content.
-web/sites/*/files
-web/sites/*/private
-web/sites/*/private_files
-
-# Ignore SimpleTest multi-site environment.
-web/sites/simpletest
-
-# Ignore Acquia Dev Desktop configs.
-web/sites/*.dd
-
 # Ignore .env files as they are personal
-/.env
 .editorconfig
 .gitattributes
 
-docker-compose.local.yml
-
-drush/local
+tmp
+vendor
 
-/settings/*.php
-!/settings/settings.proxy.php
-!/settings/settings.trusted-hosts.php
-# As this is just a bootstrap file here with sensitive values fetched from the env we can and should add it to git.
-!/web/sites/default/settings.php
+.local.env
+docker-compose.local.yml

Diff for: README.md

@@ -8,6 +8,13 @@ This template was based on the following:
 - [Drupal recommended project](https://www.drupal.org/docs/develop/using-composer/starting-a-site-using-drupal-composer-project-templates)
 - [Thunder distro](https://github.com/thunder/thunder-project).
 
+## Structure
+
+- `app`: the actual Drupal folder. This is the only folder mounted into the docker container, installing Drupal, adding dependencies, using drush, etc. should be executed from here.
+    - Note, in a containerized environment this is the only folder that should be available to the image at build time.
+    - Git root should still be the project root.
+- `docker`: contains Dockerfiles and some helpers for building the images 
+
 ## Installation
 
 Note: These commands have been tested on linux (ubuntu), they might need changes to work on other systems.
@@ -36,29 +43,46 @@ For a specific release:
 DAMOPEN_PROJECT_DIR=my-damopen-project; mkdir "${DAMOPEN_PROJECT_DIR}" && docker run --rm -u "$(id -u)":"$(id -g)" -w /app --mount type=bind,src="$(pwd)"/"${DAMOPEN_PROJECT_DIR}",dst=/app brainsum/damopen-php:7.4-dev-4.22.1 composer create-project brainsum/damopen-project=2.0.x-dev .
 ```
 
-Note: The wodby/drupal-php image is just an example.
-Note: Using an image with the `hirak/prestissimo` composer package will speed up the process, although it also might break things (see: <https://github.com/drupal-composer/drupal-scaffold/issues/101>).
+This creates the base structure. After the project installed, you need to enter go to the `app` folder and use `composer install`.
+
+Note: Drupal released 9.2, but the damopen distro applies a patch that's not compatible with that version. If `composer install` fails, you can work around this by adding the following to `app/composer.json` / extra (See: `cweagans/composer-patches`) and running it again:
+```json
+"patches": {
+    "Implement a generic revision UI (Drupal 9.2)": "https://www.drupal.org/files/issues/2021-03-24/2350939-164.patch"
+},
+"patches-ignore": {
+    "brainsum/damopen": {
+        "drupal/core": {
+            "Implement a generic revision UI": "https://www.drupal.org/files/issues/2021-02-04/2350939-156-9.1.x.patch"
+        }
+    }
+},
+```
 
 ## Setup
 
 ### Environment variables
 
-By default, the project depends on some environment variables. See the [settings.php scaffold file](./composer/damopen/assets/default.settings.php) as well the files in the [settings folder](./settings).
+By default, the project depends on some environment variables. See the [settings.php](./app/web/sites/default/settings.php) as well the files in the [settings folder](./app/settings).
 
 ### (Optional) Docker-compose
 
-If you want to use docker-compose for development, you should copy `example.env` as `.env`, e.g `cp example.env .env`. Update its contents as required.
+If you want to use docker-compose for development, you should update `.env` as needed (e.g. replaceing damopen with your project's name, adding the hash salt, ...).
 
 For starting and stopping the environment you can use the helper scripts provided with the project (`startup.sh` and `shutdown.sh`). These also look for a `docker-compose.local.yml` file so you can version control a generic config file and do local overrides (e.g ports, mounts).
 
 ### Drush
 
-Copy `drush/example.drush.yml` as `drush/drush.yml`. Update its contents as required.
+Copy `app/drush/example.drush.yml` as `app/drush/drush.yml` and update its contents as required.
 
 ### Filesystem permission fixes
 
 E.g. on linux, you must fix file and directory permissions as well, e.g for "private_files", "web/sites/default/files", "tmp", ...
 
+### Additional settings files
+
+`app/settings/example` contains multiple pre-defined settings files. Copy `settings.local.php` to `settings` to bootstrap your local settings, `web/sites/default/settings.php` automatically includes it, if present. This helps avoid issues with file permissions for the main `settings.php`.
+
 ### Install
 
 Use `drush site-install --account-pass=somestrongpass [email protected] --site-name=DAMopen damopen -y`

Diff for: app/.dockerignore

@@ -0,0 +1,11 @@
+/web/core
+/web/libraries
+/web/modules/contrib
+/web/themes/contrib
+/web/profiles/contrib
+/web/sites/default/files
+/private_files
+/tmp
+/drush/contrib
+/drush/local
+/vendor

Diff for: app/.gitignore

@@ -0,0 +1,44 @@
+/web/.csslintrc
+/web/.eslintignore
+/web/.eslintrc.json
+/web/.ht.router.php
+/web/.htaccess
+/web/INSTALL.txt
+/web/README.txt
+/web/autoload.php
+/web/example.gitignore
+/web/index.php
+/web/update.php
+/web/web.config
+
+# Ignore SimpleTest multi-site environment.
+/web/sites/simpletest
+# Ignore Acquia Dev Desktop configs.
+/web/sites/*.dd
+
+/web/sites/default/default.services.yml
+/web/sites/default/default.settings.php
+/web/sites/development.services.yml
+/web/sites/example.settings.local.php
+/web/sites/example.sites.php
+
+/settings/*.php
+!/settings/settings.proxy.php
+!/settings/settings.trusted-hosts.php
+
+# Ignore directories generated by Composer
+/drush/contrib
+/drush/local
+
+/vendor
+/bin
+/web/core
+/web/libraries
+/web/modules/contrib
+/web/themes/contrib
+/web/profiles/contrib
+
+# Ignore Drupal's file directory
+/web/sites/default/files
+/private_files
+/tmp

Diff for: app/composer.json

@@ -0,0 +1,98 @@
+{
+    "name": "brainsum/damopen-drupal",
+    "description": "Drupal application for DAMOpen.",
+    "type": "project",
+    "license": "GPL-2.0-or-later",
+    "authors": [
+        {
+            "name": "mhavelant",
+            "email": "[email protected]"
+        }
+    ],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "config": {
+        "apcu-autoloader": true,
+        "optimize-autoloader": true,
+        "sort-packages": true
+    },
+    "repositories": {
+        "drupal-8": {
+            "type": "composer",
+            "url": "https://packages.drupal.org/8"
+        },
+        "asset-packagist": {
+            "type": "composer",
+            "url": "https://asset-packagist.org"
+        }
+    },
+    "require": {
+        "php": "^7.3",
+        "brainsum/damopen": "^1.0.0",
+        "composer/installers": "^1.11.0",
+        "cweagans/composer-patches": "^1.7.0",
+        "drupal/admin_toolbar": "^3.0.0",
+        "drupal/adminimal_admin_toolbar": "^1.11.0",
+        "drupal/core-composer-scaffold": "^9.1.8",
+        "drupal/core-recommended": "^9.1.8",
+        "drupal/exception_mailer": "^3.0@beta",
+        "drupal/maillog": "^1.0@beta",
+        "drush/drush": "^10.5.0",
+        "oomphinc/composer-installers-extender": "^2.0.0"
+    },
+    "require-dev": {
+        "drupal-composer/drupal-security-advisories": "8.x-dev",
+        "drupal/console": "^1.9.7",
+        "drupal/core-dev": "^9.1.8",
+        "drupal/devel": "^4.1.1",
+        "drupal/devel_entity_updates": "^3.0.1",
+        "drupal/devel_php": "^1.3.0",
+        "roave/security-advisories": "dev-master"
+    },
+    "conflict": {
+        "drupal/drupal": "*"
+    },
+    "extra": {
+        "enable-patching": true,
+        "composer-exit-on-patch-failure": true,
+        "patches": {},
+        "drupal-scaffold": {
+            "locations": {
+                "web-root": "web/"
+            },
+            "file-mapping": {
+                "[web-root]/sites/default/settings.php": false,
+                "[web-root]/sites/default/services.yml": false,
+                "[web-root]/sites/.gitignore": false,
+                "[web-root]/sites/README.txt": false,
+                "[web-root]/modules/.gitignore": false,
+                "[web-root]/modules/README.txt": false,
+                "[web-root]/profiles/.gitignore": false,
+                "[web-root]/profiles/README.txt": false,
+                "[web-root]/themes/.gitignore": false,
+                "[web-root]/themes/README.txt": false,
+                "[web-root]/robots.txt": false
+            },
+            "initial": {
+                ".editorconfig": "[web-root]/.editorconfig",
+                ".gitattributes": "[web-root]/.gitattributes"
+            }
+        },
+        "installer-paths": {
+            "web/core": ["type:drupal-core"],
+            "web/libraries/{$name}": [
+                "type:drupal-library",
+                "type:bower-asset",
+                "type:npm-asset"
+            ],
+            "web/modules/contrib/{$name}": ["type:drupal-module"],
+            "web/profiles/contrib/{$name}": ["type:drupal-profile"],
+            "web/themes/contrib/{$name}": ["type:drupal-theme"],
+            "drush/Commands/contrib/{$name}": ["type:drupal-drush"],
+            "web/modules/custom/{$name}": ["type:drupal-custom-module"],
+            "web/profiles/custom/{$name}": ["type:drupal-custom-profile"],
+            "web/themes/custom/{$name}": ["type:drupal-custom-theme"]
+        },
+        "installer-types": ["bower-asset", "npm-asset"]
+    }
+}