Merge pull request #341 from symfony-cmf/sf3-directory-structure

Use the Symfony 3 directory structure

Author: dbu

.gitignore

@@ -1,20 +1,22 @@
-composer.phar
-app/cache/*
-app/logs/*
-app/config/parameters.yml
-app/config/phpcr.yml
-app/bootstrap.php.cache
-app/app.sqlite
-app/check.php
-app/SymfonyRequirements.php
-web/bundles/
-web/js/
-web/css/
-web/media
-web/assetic
-build/
+/app/config/parameters.yml
+/build/
+/phpunit.xml
+/var/*
+!/var/cache
+/var/cache/*
+!var/cache/.gitkeep
+!/var/logs
+/var/logs/*
+!var/logs/.gitkeep
+!/var/sessions
+/var/sessions/*
+!var/sessions/.gitkeep
+!var/SymfonyRequirements.php
 /vendor/
-jackrabbit/
-jackrabbit-standalone-*.jar
-vagrant/.vagrant
-bin/
+/web/bundles/
+
+/app/config/phpcr.yml
+/app/app.sqlite
+/jackrabbit/
+/jackrabbit-standalone-*.jar
+/vagrant/.vagrant

.platform.app.yaml

@@ -5,7 +5,7 @@
 name: php
 
 # The toolstack used to build the application.
-type: php:5.6
+type: php:7.0
 build:
     flavor: symfony
 
@@ -47,24 +47,24 @@ disk: 2048
 
 # The mounts that will be performed when the package is deployed.
 mounts:
-    "/app/cache": "shared:files/cache"
-    "/app/logs": "shared:files/logs"
+    "/var/cache": "shared:files/cache"
+    "/var/logs": "shared:files/logs"
 
 # The hooks that will be performed when the package is deployed.
 hooks:
     build: |
       rm web/app_dev.php
       # place sqlite file into /tmp so that we can write to it during deploy
       sed -i 's@%kernel.root_dir%/app.sqlite@/tmp/app.sqlite@' app/config/parameters.yml
-      app/console --env=prod assets:install -n --no-debug
-      app/console --env=prod assetic:dump -n --no-debug
+      bin/console --env=prod assets:install -n --no-debug
+      bin/console --env=prod assetic:dump -n --no-debug
     deploy: |
       # force clearing the cache
-      rm -rf app/cache
-      app/console doctrine:phpcr:init:dbal --drop --force -n
-      app/console doctrine:phpcr:repository:init -n
-      app/console doctrine:phpcr:fixtures:load -n
-      app/console --env=prod cache:warmup -n --no-debug
+      rm -rf var/cache
+      bin/console doctrine:phpcr:init:dbal --drop --force -n
+      bin/console doctrine:phpcr:repository:init -n
+      bin/console doctrine:phpcr:fixtures:load -n
+      bin/console --env=prod cache:warmup -n --no-debug
 
 runtime:
   extensions:

.styleci.yml

@@ -1,3 +1,6 @@
 preset: symfony
 
 disabled: [phpdoc_to_comment, phpdoc_var_without_name]
+
+finder:
+    exclude: [var]

.travis.yml

@@ -37,11 +37,11 @@ install: if [ "$COMPOSER_INSTALL" != "1" ]; then composer update --no-scripts --
 before_script:
   - cp app/config/phpcr_${TRANSPORT}.yml.dist app/config/phpcr.yml
   - composer run-script post-update-cmd
-  - ./app/tests/travis_${TRANSPORT}.sh
-  - app/console doctrine:phpcr:workspace:create sandbox_test -e=test
-  - app/console doctrine:phpcr:repository:init -e=test
+  - ./tests/travis_${TRANSPORT}.sh
+  - bin/console doctrine:phpcr:workspace:create sandbox_test -e=test
+  - bin/console doctrine:phpcr:repository:init -e=test
 
-script: phpunit -c app
+script: phpunit
 
 notifications:
   irc: "irc.freenode.org#symfony-cmf"

app/AppKernel.php

@@ -84,6 +84,21 @@ public function registerBundles()
         return $bundles;
     }
 
+    public function getRootDir()
+    {
+        return __DIR__;
+    }
+
+    public function getCacheDir()
+    {
+        return dirname(__DIR__).'/var/cache/'.$this->getEnvironment();
+    }
+
+    public function getLogDir()
+    {
+        return dirname(__DIR__).'/var/logs';
+    }
+
     public function registerContainerConfiguration(LoaderInterface $loader)
     {
         $loader->load(__DIR__.'/config/config_'.$this->getEnvironment().'.yml');

app/phpunit.xml.dist

@@ -0,0 +1,143 @@
+#!/usr/bin/env php
+<?php
+
+require_once dirname(__FILE__).'/../var/SymfonyRequirements.php';
+
+$lineSize = 70;
+$symfonyRequirements = new SymfonyRequirements();
+$iniPath = $symfonyRequirements->getPhpIniConfigPath();
+
+echo_title('Symfony Requirements Checker');
+
+echo '> PHP is using the following php.ini file:'.PHP_EOL;
+if ($iniPath) {
+    echo_style('green', '  '.$iniPath);
+} else {
+    echo_style('yellow', '  WARNING: No configuration file (php.ini) used by PHP!');
+}
+
+echo PHP_EOL.PHP_EOL;
+
+echo '> Checking Symfony requirements:'.PHP_EOL.'  ';
+
+$messages = array();
+foreach ($symfonyRequirements->getRequirements() as $req) {
+    /** @var $req Requirement */
+    if ($helpText = get_error_message($req, $lineSize)) {
+        echo_style('red', 'E');
+        $messages['error'][] = $helpText;
+    } else {
+        echo_style('green', '.');
+    }
+}
+
+$checkPassed = empty($messages['error']);
+
+foreach ($symfonyRequirements->getRecommendations() as $req) {
+    if ($helpText = get_error_message($req, $lineSize)) {
+        echo_style('yellow', 'W');
+        $messages['warning'][] = $helpText;
+    } else {
+        echo_style('green', '.');
+    }
+}
+
+if ($checkPassed) {
+    echo_block('success', 'OK', 'Your system is ready to run Symfony projects');
+} else {
+    echo_block('error', 'ERROR', 'Your system is not ready to run Symfony projects');
+
+    echo_title('Fix the following mandatory requirements', 'red');
+
+    foreach ($messages['error'] as $helpText) {
+        echo ' * '.$helpText.PHP_EOL;
+    }
+}
+
+if (!empty($messages['warning'])) {
+    echo_title('Optional recommendations to improve your setup', 'yellow');
+
+    foreach ($messages['warning'] as $helpText) {
+        echo ' * '.$helpText.PHP_EOL;
+    }
+}
+
+echo PHP_EOL;
+echo_style('title', 'Note');
+echo '  The command console could use a different php.ini file'.PHP_EOL;
+echo_style('title', '~~~~');
+echo '  than the one used with your web server. To be on the'.PHP_EOL;
+echo '      safe side, please check the requirements from your web'.PHP_EOL;
+echo '      server using the ';
+echo_style('yellow', 'web/config.php');
+echo ' script.'.PHP_EOL;
+echo PHP_EOL;
+
+exit($checkPassed ? 0 : 1);
+
+function get_error_message(Requirement $requirement, $lineSize)
+{
+    if ($requirement->isFulfilled()) {
+        return;
+    }
+
+    $errorMessage = wordwrap($requirement->getTestMessage(), $lineSize - 3, PHP_EOL.'   ').PHP_EOL;
+    $errorMessage .= '   > '.wordwrap($requirement->getHelpText(), $lineSize - 5, PHP_EOL.'   > ').PHP_EOL;
+
+    return $errorMessage;
+}
+
+function echo_title($title, $style = null)
+{
+    $style = $style ?: 'title';
+
+    echo PHP_EOL;
+    echo_style($style, $title.PHP_EOL);
+    echo_style($style, str_repeat('~', strlen($title)).PHP_EOL);
+    echo PHP_EOL;
+}
+
+function echo_style($style, $message)
+{
+    // ANSI color codes
+    $styles = array(
+        'reset' => "\033[0m",
+        'red' => "\033[31m",
+        'green' => "\033[32m",
+        'yellow' => "\033[33m",
+        'error' => "\033[37;41m",
+        'success' => "\033[37;42m",
+        'title' => "\033[34m",
+    );
+    $supports = has_color_support();
+
+    echo($supports ? $styles[$style] : '').$message.($supports ? $styles['reset'] : '');
+}
+
+function echo_block($style, $title, $message)
+{
+    $message = ' '.trim($message).' ';
+    $width = strlen($message);
+
+    echo PHP_EOL.PHP_EOL;
+
+    echo_style($style, str_repeat(' ', $width).PHP_EOL);
+    echo_style($style, str_pad(' ['.$title.']', $width, ' ', STR_PAD_RIGHT).PHP_EOL);
+    echo_style($style, str_pad($message, $width, ' ', STR_PAD_RIGHT).PHP_EOL);
+    echo_style($style, str_repeat(' ', $width).PHP_EOL);
+}
+
+function has_color_support()
+{
+    static $support;
+
+    if (null === $support) {
+        if (DIRECTORY_SEPARATOR == '\\') {
+            $support = false !== getenv('ANSICON') || 'ON' === getenv('ConEmuANSI');
+        } else {
+            $support = function_exists('posix_isatty') && @posix_isatty(STDOUT);
+        }
+    }
+
+    return $support;
+}

app/tests/travis_jackrabbit.sh

@@ -14,7 +14,7 @@
         "classmap": [ "app/AppKernel.php", "app/AppCache.php" ]
     },
     "autoload-dev": {
-        "classmap": [ "app/tests/WebTestCase.php" ]
+        "psr-4": { "Tests\\": "tests/" }
     },
     "require": {
         "php": "^5.5.9|^7.0",
@@ -72,18 +72,15 @@
             "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installRequirementsFile"
         ]
     },
-    "config": {
-        "bin-dir": "bin"
-    },
     "extra": {
         "symfony-app-dir": "app",
+        "symfony-bin-dir": "bin",
+        "symfony-var-dir": "var",
         "symfony-web-dir": "web",
+        "symfony-tests-dir": "tests",
         "symfony-assets-install": "relative",
         "incenteev-parameters": [
-            {
-                "file": "app/config/parameters.yml",
-                "env-map": {}
-            },
+            { "file": "app/config/parameters.yml" },
             {
                 "file": "app/config/phpcr.yml",
                 "dist-file": "app/config/phpcr_doctrine_dbal.yml.dist"