Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RTM] Use the contao.web_dir parameter in the Combiner #679

Merged
merged 5 commits into from
Jan 23, 2017
Merged

[RTM] Use the contao.web_dir parameter in the Combiner #679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e9d12e9
Use the contao.web_dir parameter in the Combiner
ausi Jan 23, 2017
5105e90
Add tests for Combiner
ausi Jan 23, 2017
696148b
Use the Filesystem class for webdir validation
ausi Jan 23, 2017
e7a9b11
Fix the coding style.
leofeyer Jan 23, 2017
de445c4
Fix the coding style.
leofeyer Jan 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 30 additions & 11 deletions src/Resources/contao/library/Contao/Combiner.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
namespace Contao;

use Leafo\ScssPhp\Compiler;
use Symfony\Component\Filesystem\Filesystem;


/**
Expand Down Expand Up @@ -73,12 +74,29 @@ class Combiner extends \System
*/
protected $arrFiles = array();

/**
* Web dir relative to TL_ROOT
* @var string
*/
protected $strWebDir;


/**
* Public constructor required
*/
public function __construct()
{
$fs = new Filesystem();
$container = \System::getContainer();
$strWebDir = rtrim($fs->makePathRelative($container->getParameter('contao.web_dir'), TL_ROOT), '/');

if (strncmp($strWebDir, '../', 3) === 0 || $strWebDir == '..')
{
throw new \RuntimeException(sprintf('Web dir "%s" is not inside TL_ROOT', $container->getParameter('contao.web_dir')));
}

$this->strWebDir = $strWebDir . '/';

parent::__construct();
}

Expand Down Expand Up @@ -115,26 +133,27 @@ public function add($strFile, $strVersion=null, $strMedia='all')
throw new \LogicException('You cannot mix different file types. Create another Combiner object instead.');
}

// Prevent duplicates
if (isset($this->arrFiles[$strFile]))
{
return;
}

// Check the source file
if (!file_exists(TL_ROOT . '/' . $strFile))
{
// Handle public bundle resources
if (file_exists(TL_ROOT . '/web/' . $strFile))
// Handle public bundle resources in web/
if (file_exists(TL_ROOT . '/' . $this->strWebDir . $strFile))
{
$strFile = 'web/' . $strFile;
@trigger_error('Paths relative to the webdir are deprecated and will no longer work in Contao 5.0.', E_USER_DEPRECATED);
$strFile = $this->strWebDir . $strFile;
}
else
{
return;
}
}

// Prevent duplicates
if (isset($this->arrFiles[$strFile]))
{
return;
}

// Default version
if ($strVersion === null)
{
Expand Down Expand Up @@ -212,9 +231,9 @@ public function getFileUrls()
$name = $arrFile['name'];

// Strip the web/ prefix (see #328)
if (strncmp($name, 'web/', 4) === 0)
if (strncmp($name, $this->strWebDir, strlen($this->strWebDir)) === 0)
{
$name = substr($name, 4);
$name = substr($name, strlen($this->strWebDir));
}

// Add the media query (see #7070)
Expand Down
236 changes: 236 additions & 0 deletions tests/Contao/CombinerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,236 @@
<?php

/*
* This file is part of Contao.
*
* Copyright (c) 2005-2016 Leo Feyer
*
* @license LGPL-3.0+
*/

namespace Contao\CoreBundle\Test\Contao;

use Contao\Combiner;
use Contao\Config;
use Contao\CoreBundle\Test\TestCase;
use Contao\System;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Filesystem\Filesystem;

/**
* Tests the Combiner class.
*
* @author Martin Auswöger <martin@auswoeger.com>
*
* @runTestsInSeparateProcesses
* @preserveGlobalState disabled
* @group legacy
*/
class CombinerTest extends TestCase
{
/**
* @var string
*/
private static $rootDir;

/**
* @var ContainerInterface
*/
private $container;

/**
* {@inheritdoc}
*/
public static function setUpBeforeClass()
{
self::$rootDir = $this->getRootDir().'/tmp';

$fs = new Filesystem();
$fs->mkdir(self::$rootDir);
$fs->mkdir(self::$rootDir.'/assets');
$fs->mkdir(self::$rootDir.'/assets/css');
$fs->mkdir(self::$rootDir.'/system');
$fs->mkdir(self::$rootDir.'/system/tmp');
$fs->mkdir(self::$rootDir.'/web');
}

/**
* {@inheritdoc}
*/
public static function tearDownAfterClass()
{
$fs = new Filesystem();
$fs->remove(self::$rootDir);
}

/**
* {@inheritdoc}
*/
protected function setUp()
{
parent::setUp();

define('TL_ERROR', 'ERROR');
define('TL_ROOT', self::$rootDir);
define('TL_ASSETS_URL', '');

$this->container = $this->mockContainerWithContaoScopes();
$this->container->setParameter('contao.web_dir', self::$rootDir.'/web');

System::setContainer($this->container);
}

/**
* Tests the object instantiation.
*/
public function testConstruct()
{
$this->assertInstanceOf('Contao\Combiner', new Combiner());
}

/**
* Tests the object instantiation with a web same as the TL_ROOT.
*/
public function testWebDirSameAsRoot()
{
$this->container->setParameter('contao.web_dir', self::$rootDir);

$this->assertInstanceOf('Contao\Combiner', new Combiner());
}

/**
* Tests the object instantiation with a web dir parent of TL_ROOT.
*/
public function testWebDirParentOfRoot()
{
$this->container->setParameter('contao.web_dir', dirname(self::$rootDir));

$this->setExpectedException('RuntimeException', dirname(self::$rootDir));

new Combiner();
}

/**
* Tests the object instantiation with a web dir outside TL_ROOT.
*/
public function testWebDirOutsideRoot()
{
$this->container->setParameter('contao.web_dir', '/not/in/root/dir');

$this->setExpectedException('RuntimeException', '/not/in/root/dir');

new Combiner();
}

/**
* Tests the CSS combiner.
*/
public function testCombineCss()
{
file_put_contents(static::$rootDir.'/file1.css', 'file1 { background: url("foo.bar") }');
file_put_contents(static::$rootDir.'/web/file2.css', 'web/file2');
file_put_contents(static::$rootDir.'/file3.css', 'file3');
file_put_contents(static::$rootDir.'/web/file3.css', 'web/file3');

$combiner = new Combiner();
$combiner->add('file1.css');
$combiner->addMultiple(['file2.css', 'file3.css']);

$this->assertEquals([
'file1.css',
'file2.css" media="screen',
'file3.css" media="screen',
], $combiner->getFileUrls());

$combinedFile = $combiner->getCombinedFile();

$this->assertRegExp('/^assets\/css\/[a-z0-9]+\.css$/', $combinedFile);

$this->assertEquals(
"file1 { background: url(\"../../foo.bar\") }\n@media screen{\nweb/file2\n}\n@media screen{\nfile3\n}\n",
file_get_contents(static::$rootDir.'/'.$combinedFile)
);

Config::set('debugMode', true);

$markup = $combiner->getCombinedFile();

$this->assertEquals(
'file1.css"><link rel="stylesheet" href="file2.css" media="screen"><link rel="stylesheet" href="file3.css" media="screen',
$markup
);
}

/**
* Tests the SCSS combiner.
*/
public function testCombineScss()
{
file_put_contents(static::$rootDir.'/file1.scss', '$color: red; @import "file1_sub";');
file_put_contents(static::$rootDir.'/file1_sub.scss', 'body { color: $color }');
file_put_contents(static::$rootDir.'/file2.scss', 'body { color: green }');

$combiner = new Combiner();
$combiner->add('file1.scss');
$combiner->add('file2.scss');

$this->assertEquals([
'assets/css/file1.scss.css',
'assets/css/file2.scss.css',
], $combiner->getFileUrls());

$combinedFile = $combiner->getCombinedFile();

$this->assertRegExp('/^assets\/css\/[a-z0-9]+\.css$/', $combinedFile);

$this->assertEquals(
"body{color:red}\nbody{color:green}\n",
file_get_contents(static::$rootDir.'/'.$combinedFile)
);

Config::set('debugMode', true);

$markup = $combiner->getCombinedFile();

$this->assertEquals(
'assets/css/file1.scss.css"><link rel="stylesheet" href="assets/css/file2.scss.css',
$markup
);
}

/**
* Tests the JS Combiner.
*/
public function testCombineJs()
{
file_put_contents(static::$rootDir.'/file1.js', 'file1();');
file_put_contents(static::$rootDir.'/web/file2.js', 'file2();');

$combiner = new Combiner();
$combiner->add('file1.js');
$combiner->add('file2.js');

$this->assertEquals([
'file1.js',
'file2.js',
], $combiner->getFileUrls());

$combinedFile = $combiner->getCombinedFile();

$this->assertRegExp('/^assets\/js\/[a-z0-9]+\.js$/', $combinedFile);

$this->assertEquals(
"file1();\nfile2();\n",
file_get_contents(static::$rootDir.'/'.$combinedFile)
);

Config::set('debugMode', true);

$markup = $combiner->getCombinedFile();

$this->assertEquals(
'file1.js"></script><script src="file2.js',
$markup
);
}
}
1 change: 1 addition & 0 deletions tests/TestCase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ protected function mockContainerWithContaoScopes($scope = null)
$container->setParameter('kernel.cache_dir', $this->getCacheDir());
$container->setParameter('kernel.debug', false);
$container->setParameter('contao.root_dir', $this->getRootDir());
$container->setParameter('contao.web_dir', $this->getRootDir().'/web');
$container->setParameter('contao.image.bypass_cache', false);
$container->setParameter('contao.image.target_path', 'assets/images');
$container->setParameter('contao.image.valid_extensions', ['jpg', 'svg', 'svgz']);
Expand Down