Merge pull request #394 from continuouspipe/feature/symfony-flex

Add detection and support for Symfony Flex structure

Author: andytson-inviqa

php/shared/usr/local/share/env/40-stack

@@ -40,7 +40,6 @@ export XDEBUG_REMOTE_HOST=${XDEBUG_REMOTE_HOST:-sshforward}
 export XDEBUG_REMOTE_PORT=${XDEBUG_REMOTE_PORT:-9000}
 
 export WORK_DIRECTORY=${WORK_DIRECTORY:-/app}
-export WEB_DIRECTORY=${WEB_DIRECTORY:-web}
 
 export WEB_HOST=${WEB_HOST:-localhost}
 export WEB_HTTP_PORT=${WEB_HTTP_PORT:-80}

php/shared/usr/local/share/env/55-stack

@@ -1,4 +1,5 @@
 #!/bin/bash
+export WEB_DIRECTORY=${WEB_DIRECTORY:-web}
 
 # Relative WEB_DIRECTORY converted to absolute path
 if ! [[ "$WEB_DIRECTORY" =~ ^/ ]]; then

php/shared/usr/local/share/php/common_functions.sh

@@ -29,10 +29,34 @@ do_composer_postinstall_scripts() {
 }
 
 has_composer_package() {
-  if [ ! -f "composer.lock" ]; then
+  if [ ! -f "${WORK_DIRECTORY}/composer.lock" ]; then
     return
   fi
 
-  is_true "$(jq -c '(.packages + .["packages-dev"])[] | select(.name == "'"$1"'") | has("name")' composer.lock)"
+  is_true "$(jq -c '(.packages + .["packages-dev"])[] | select(.name == "'"$1"'") | has("name")' "${WORK_DIRECTORY}/composer.lock")"
+  return "$?"
+}
+
+composer_package_version() {
+  local -r PACKAGE_VERSION="$(jq -c '(.packages + .["packages-dev"])[] | select(.name == "'"$1"'") | .version' "${WORK_DIRECTORY}/composer.lock" | sed 's/^"v\?\(.*\)"/\1/')"
+
+  if [ -z "${PACKAGE_VERSION}" ]; then
+    return 1
+  fi
+
+  echo "${PACKAGE_VERSION}"
+}
+
+composer_package_compare() {
+  local -r PACKAGE="$1"
+  local -r RELATION="$2"
+  local -r COMPARE_VERSION="$3"
+  local -r PACKAGE_VERSION="$(composer_package_version "${PACKAGE}")"
+
+  if [ -z "${PACKAGE_VERSION}" ]; then
+    return 1
+  fi
+
+  dpkg --compare-versions "${PACKAGE_VERSION}" "${RELATION}" "${COMPARE_VERSION}"
   return "$?"
 }

symfony/README.md

@@ -72,6 +72,7 @@ Variable | Description | Expected values | Default
 --- | --- | --- | ----
 SYMFONY_DOCTRINE_MODE | Whether to use Doctrine migrations, schema update or nothing. Automatically detected based on installed composer packages by default | auto/migrations/schema/off | auto
 SYMFONY_ENV | The Symfony env to use, when the app reads this variable | string | prod
+SYMFONY_FLEX | Whether the project uses the symfony/flex component and folder structure | true/false | autodetected based on whether in composer.lock
 SYMFONY_MAJOR_VERSION | The major version of Symfony that will be used | 2, 3 | auto-detected based on location of console script
 SYMFONY_CONSOLE | The location of the Symfony console script | file path | auto-detected
 SYMFONY_WEB_APP_ENV_REWRITE | Whether to use web/app_*.php when SYMFONY_ENV != prod | true, false | false

symfony/usr/local/share/env/30-framework

@@ -4,21 +4,10 @@ export PHP_MEMORY_LIMIT=${PHP_MEMORY_LIMIT:-256M}
 export PHP_OPCACHE_MAX_ACCELERATED_FILES=${PHP_OPCACHE_MAX_ACCELERATED_FILES:-20000}
 export PHP_REALPATH_CACHE_SIZE=${PHP_REALPATH_CACHE_SIZE:-4096K}
 export PHP_REALPATH_CACHE_TTL=${PHP_REALPATH_CACHE_TTL:-600}
-SYMFONY_WEB_APP_ENV_REWRITE=${SYMFONY_WEB_APP_ENV_REWRITE:-false}
-SYMFONY_WEB_APP_ENV_REWRITE="$(convert_to_boolean_string "$SYMFONY_WEB_APP_ENV_REWRITE")"
+export SYMFONY_DOCTRINE_MODE=auto
+SYMFONY_WEB_APP_ENV_REWRITE="$(convert_to_boolean_string "${SYMFONY_WEB_APP_ENV_REWRITE:-false}")"
 export SYMFONY_WEB_APP_ENV_REWRITE
 
-if [ -n "${SYMFONY_APP_ENDPOINT}" ]; then
-  echo "deprecated: SYMFONY_APP_ENDPOINT is deprecated. Please rename to APP_ENDPOINT." >&2
-fi
-
-if [ "$SYMFONY_ENV" == "prod" ] || [ "$SYMFONY_WEB_APP_ENV_REWRITE" != "true" ]; then
-    DEFAULT_APP_ENDPOINT=/app.php
-else
-    DEFAULT_APP_ENDPOINT=/app_${SYMFONY_ENV}.php
-fi
-
-export APP_ENDPOINT_STRICT=${APP_ENDPOINT_STRICT:-true}
-export APP_ENDPOINT=${SYMFONY_APP_ENDPOINT:-${APP_ENDPOINT:-${DEFAULT_APP_ENDPOINT}}}
+deprecate_env_var SYMFONY_APP_ENDPOINT APP_ENDPOINT
 
 export TIDEWAYS_FRAMEWORK=${TIDEWAYS_FRAMEWORK:-symfony}

symfony/usr/local/share/env/45-framework

@@ -1,13 +1,44 @@
 #!/bin/bash
 
-if [ -f "${WORK_DIRECTORY}/bin/console" ]; then
+if has_composer_package 'symfony/symfony'; then
+  SYMFONY_MAJOR_VERSION_GUESS="$(composer_package_version 'symfony/symfony' | cut -d '.' -f 1)"
+elif has_composer_package 'symfony/framework-bundle'; then
+  SYMFONY_MAJOR_VERSION_GUESS="$(composer_package_version 'symfony/framework-bundle' | cut -d '.' -f 1)"
+elif [ -f "${WORK_DIRECTORY}/bin/console" ]; then
   SYMFONY_MAJOR_VERSION_GUESS=3
-  SYMFONY_CONSOLE_DEFAULT=${WORK_DIRECTORY}/bin/console
 else
   SYMFONY_MAJOR_VERSION_GUESS=2
-  SYMFONY_CONSOLE_DEFAULT=${WORK_DIRECTORY}/app/console
 fi
 
 export SYMFONY_MAJOR_VERSION=${SYMFONY_MAJOR_VERSION:-${SYMFONY_MAJOR_VERSION_GUESS}}
+
+if has_composer_package 'symfony/flex'; then
+  SYMFONY_FLEX="$(convert_to_boolean_string "${SYMFONY_FLEX:-true}")"
+else
+  SYMFONY_FLEX="$(convert_to_boolean_string "${SYMFONY_FLEX:-false}")"
+fi
+export SYMFONY_FLEX
+
+if is_true "${SYMFONY_FLEX}"; then
+    DEFAULT_APP_ENDPOINT=/index.php
+    export WEB_DIRECTORY=${WEB_DIRECTORY:-public}
+
+    if is_true "$SYMFONY_WEB_APP_ENV_REWRITE"; then
+        echo 'warning: SYMFONY_WEB_APP_ENV_REWRITE is ignored when using Symfony 4+ folder structure' >&2
+    fi
+elif [ "$SYMFONY_ENV" == "prod" ] || is_false "$SYMFONY_WEB_APP_ENV_REWRITE"; then
+    DEFAULT_APP_ENDPOINT=/app.php
+else
+    DEFAULT_APP_ENDPOINT=/app_${SYMFONY_ENV}.php
+fi
+
+export APP_ENDPOINT_STRICT=${APP_ENDPOINT_STRICT:-true}
+export APP_ENDPOINT=${SYMFONY_APP_ENDPOINT:-${APP_ENDPOINT:-${DEFAULT_APP_ENDPOINT}}}
+
+if [ "${SYMFONY_MAJOR_VERSION}" -ge 3 ]; then
+  SYMFONY_CONSOLE_DEFAULT=${WORK_DIRECTORY}/bin/console
+else
+  SYMFONY_CONSOLE_DEFAULT=${WORK_DIRECTORY}/app/console
+fi
+
 export SYMFONY_CONSOLE=${SYMFONY_CONSOLE:-${SYMFONY_CONSOLE_DEFAULT}}
-export SYMFONY_DOCTRINE_MODE=auto

symfony/usr/local/share/symfony/symfony_functions.sh

@@ -2,7 +2,8 @@
 
 do_symfony_config_create() {
   # Prepare a default parameters.yml. incenteev/parameters-handler can still update it
-  if [ ! -f /app/app/config/parameters.yml ]; then
+  if is_false "${SYMFONY_FLEX}" && [ ! -f /app/app/config/parameters.yml ]; then
+    mkdir -p /app/app/config
     echo 'parameters: {}' > /app/app/config/parameters.yml
   fi
 }
@@ -11,7 +12,6 @@ do_symfony_directory_create() {
   if [ "$SYMFONY_MAJOR_VERSION" -eq 2 ]; then
     mkdir -p /app/app/{cache,logs}
   fi
-  mkdir -p /app/app/config
   mkdir -p /app/var
 }