TASK: Add tests for mapping class

* Add minimum phpdoc.
* Add tests.
* Fix issue in class.
* Fix phpmd issues.
This commit is contained in:
Daniel Siepmann 2017-05-04 11:58:49 +02:00
parent 8db7a8bb1f
commit 666bbdb26a
Signed by: Daniel Siepmann
GPG key ID: 33D6629915560EF4
5 changed files with 168 additions and 13 deletions

View file

@ -31,6 +31,7 @@
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit": "5.7.*", "phpunit/phpunit": "5.7.*",
"mikey179/vfsStream": "1.6.*",
"symfony/finder": "3.2.*", "symfony/finder": "3.2.*",
"phpmd/phpmd": "2.6.*", "phpmd/phpmd": "2.6.*",
"pdepend/pdepend": "2.5.*" "pdepend/pdepend": "2.5.*"

View file

@ -69,15 +69,32 @@ final class LegacyClassnameMapping
// Singleton implementation - End // Singleton implementation - End
/** /**
* Contains mappings as defined by composer for alias mapping.
* @var array * @var array
*/ */
protected $typo3Mappings = []; protected $typo3Mappings = [];
/**
* @var array
*/
protected $typo3MappingsKeys = []; protected $typo3MappingsKeys = [];
/**
* @var array
*/
protected $mappings = []; protected $mappings = [];
/**
* @var array
*/
protected $mappingsKeys = []; protected $mappingsKeys = [];
/**
* @var bool
*/
protected $dirty = false;
/**
* @param array $originalArray
* @param array $targetVariable
*/
protected function buildKeyArray($originalArray, &$targetVariable) protected function buildKeyArray($originalArray, &$targetVariable)
{ {
foreach (array_keys($originalArray) as $key) { foreach (array_keys($originalArray) as $key) {
@ -109,7 +126,6 @@ final class LegacyClassnameMapping
*/ */
public function getNewClassname($classname) public function getNewClassname($classname)
{ {
$lowerVersion = strtolower($classname);
if ($this->isLegacyTypo3Classname($classname) || $this->isLegacyTypo3Classname(strtolower($classname))) { if ($this->isLegacyTypo3Classname($classname) || $this->isLegacyTypo3Classname(strtolower($classname))) {
return $this->typo3Mappings[$this->getTypo3MappingKey($classname)]; return $this->typo3Mappings[$this->getTypo3MappingKey($classname)];
} }
@ -117,6 +133,10 @@ final class LegacyClassnameMapping
return $this>mappings[$this->getLegacyMappingKey($classname)]; return $this>mappings[$this->getLegacyMappingKey($classname)];
} }
/**
* @param string $classname
* @return string
*/
protected function getTypo3MappingKey($classname) protected function getTypo3MappingKey($classname)
{ {
$lowerVersion = strtolower($classname); $lowerVersion = strtolower($classname);
@ -127,6 +147,10 @@ final class LegacyClassnameMapping
return $classname; return $classname;
} }
/**
* @param string $classname
* @return string
*/
protected function getLegacyMappingKey($classname) protected function getLegacyMappingKey($classname)
{ {
$lowerVersion = strtolower($classname); $lowerVersion = strtolower($classname);
@ -137,11 +161,19 @@ final class LegacyClassnameMapping
return $classname; return $classname;
} }
/**
* @param string $classname
* @return bool
*/
protected function isLegacyTypo3Classname($classname) protected function isLegacyTypo3Classname($classname)
{ {
return isset($this->typo3MappingsKeys[$classname]); return isset($this->typo3MappingsKeys[$classname]);
} }
/**
* @param string $classname
* @return bool
*/
protected function isLegacyMappingClassname($classname) protected function isLegacyMappingClassname($classname)
{ {
return isset($this->mappingsKeys[$classname]); return isset($this->mappingsKeys[$classname]);
@ -159,6 +191,21 @@ final class LegacyClassnameMapping
public function addLegacyClassname($legacyClassname, $newClassname) public function addLegacyClassname($legacyClassname, $newClassname)
{ {
$this->mappings[$legacyClassname] = $newClassname; $this->mappings[$legacyClassname] = $newClassname;
$this->mappingsKeys[strtolower($legacyClassname)] = $legacyClassname;
$this->dirty = true;
}
public function persistMappings()
{
if ($this->dirty === false) {
return;
}
file_put_contents(
Options::getMappingFile(),
'<?php' . PHP_EOL . 'return ' . var_export($this->mappings, true) . ';' . PHP_EOL
);
$this->dirty = false;
} }
/** /**
@ -166,16 +213,6 @@ final class LegacyClassnameMapping
*/ */
public function __destruct() public function __destruct()
{ {
// For some reasons desctruct is called multiple times, while construct $this->persistMappings();
// is called once. Until we know the issue and fix it, this is our
// workaround to not break the file and do stuff in an unkown instance.
if ($this !== static::$instance) {
return;
}
file_put_contents(
Options::getMappingFile(),
'<?php' . PHP_EOL . 'return ' . var_export($this->mappings, true) . ';'
);
} }
} }

View file

@ -0,0 +1,110 @@
<?php
namespace Typo3Update\Tests\Feature;
/*
* Copyright (C) 2017 Daniel Siepmann <coding@daniel-siepmann.de>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*/
use PHPUnit\Framework\TestCase;
use Typo3Update\Feature\LegacyClassnameMapping;
use org\bovigo\vfs\vfsStream;
class LegacyClassnameMappingTest extends TestCase
{
/**
* @var \org\bovigo\vfs\vfsStreamDirectory
*/
protected $fileSystem;
/**
* @var LegacyClassnameMapping
*/
protected $subject;
/**
* @param string $fileName
* @return string
*/
protected function getFixturePath($fileName)
{
return implode(DIRECTORY_SEPARATOR, [
__DIR__, '..', 'Fixtures', 'Standards','Typo3Update',
'Feature', 'LegacyClassnameMapping', $fileName,
]);
}
public function setUp()
{
$this->fileSystem = vfsStream::setup('root', null, [
'LegacyClassnames.php' => file_get_contents($this->getFixturePath('MappingContent.php')),
]);
$GLOBALS['PHP_CODESNIFFER_CONFIG_DATA'] = [
'mappingFile' => vfsStream::url('root/LegacyClassnames.php'),
];
$this->subject = LegacyClassnameMapping::getInstance();
}
/**
* @test
*/
public function insensitivityLookupWorks()
{
$this->assertFalse(
$this->subject->isLegacyClassname('Tx_About_Controller_Aboutcontroller', false),
'Classname was returned to be legacy but should not due to lowercase version and case sensitivity.'
);
$this->assertTrue(
$this->subject->isLegacyClassname('Tx_About_Controller_Aboutcontroller'),
'Classname was not returned to be legacy but should due to case insensitivity.'
);
}
/**
* @test
*/
public function addingLegacyClassnamesWillAdjustLookupAndBePersisted()
{
$this->assertFalse(
$this->subject->isLegacyClassname('Tx_ExtName_Controller_ExampleController'),
'Classname is not configured but returned to be legacy.'
);
$this->subject->addLegacyClassname('Tx_ExtName_Controller_ExampleController', '\\Vendor\\ExtName\\Controller\\ExampleController');
$this->assertTrue(
$this->subject->isLegacyClassname('Tx_ExtName_Controller_ExampleController'),
'Classname is configured but not returned to be legacy.'
);
$this->subject->persistMappings();
$this->assertSame(
file_get_contents($this->getFixturePath('ExpectedMappingContent.php')),
file_get_contents(vfsStream::url('root/LegacyClassnames.php')),
'Persisted mappings are not as expected.'
);
}
public function tearDown()
{
unset($this->subject);
unset($this->fileSystem);
}
}

View file

@ -0,0 +1,4 @@
<?php
return array (
'Tx_ExtName_Controller_ExampleController' => '\\Vendor\\ExtName\\Controller\\ExampleController',
);

View file

@ -0,0 +1,3 @@
<?php
return array (
);