Skip to content

Add tests for ResultRendererFactory class #126

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

Merged
merged 2 commits into from
Oct 4, 2016
Merged

Add tests for ResultRendererFactory class #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c18f32
Add tests for ResultRendererFactory class
TheoKouzelis Oct 3, 2016
bc185c3
Fix PSR-2 Style issues in ComposerCheckTest and PatchableExercise
TheoKouzelis Oct 4, 2016
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
9 changes: 7 additions & 2 deletions src/Factory/ResultRendererFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ class ResultRendererFactory
*/
public function registerRenderer($resultClass, $rendererClass)
{
if (!class_implements($resultClass, ResultInterface::class)) {
if (!$this->isImplementationNameOfClass($resultClass, ResultInterface::class)) {
throw new InvalidArgumentException;
}

if (!class_implements($rendererClass, ResultRendererInterface::class)) {
if (!$this->isImplementationNameOfClass($rendererClass, ResultRendererInterface::class)) {
throw new InvalidArgumentException;
}

Expand All @@ -61,4 +61,9 @@ public function create(ResultInterface $result)

return new $this->mappings[$class]($result);
}

protected function isImplementationNameOfClass($implementationName, $className)
{
return is_string($implementationName) && is_subclass_of($implementationName, $className);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey @TheoKouzelis what is the advantage of is_subclass_of instead of class_implements ?

Copy link
Contributor Author

@TheoKouzelis TheoKouzelis Oct 4, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think class_implements returns an array of interfaces that the given class implements. http://php.net/manual/en/function.class-implements.php

So I think the previous code started to fail because the following statement would be true if the class implemented any interface and not specifically ResultInterface::class

!class_implements($resultClass, ResultInterface::class)

I think the code could have also been refactored to the following but I thought is_subclass_ofseemed more direct

!in_array(ResultInterface::class, class_implements($resultClass))

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh wow - so it never worked 😂 - nice find!

}
}
2 changes: 1 addition & 1 deletion test/Asset/PatchableExercise.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public function getProblem()
*/
public function tearDown()
{

// TODO: Implement tearDown() method.
}

/**
Expand Down
1 change: 0 additions & 1 deletion test/Check/ComposerCheckTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ public function setUp()

$this->assertTrue($this->check->canRun(ExerciseType::CGI()));
$this->assertTrue($this->check->canRun(ExerciseType::CLI()));

}

public function testExceptionIsThrownIfNotValidExercise()
Expand Down
90 changes: 90 additions & 0 deletions test/Factory/ResultRendererFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
<?php

namespace PhpSchool\PhpWorkshopTest\Factory;

use PhpSchool\PhpWorkshop\Exception\InvalidArgumentException;
use PhpSchool\PhpWorkshop\Factory\ResultRendererFactory;
use PhpSchool\PhpWorkshop\ResultRenderer\ResultRendererInterface;
use PhpSchool\PhpWorkshop\Result\ResultInterface;
use PHPUnit_Framework_TestCase;
use RuntimeException;

/**
* Class ResultsRendererFactoryTest
* @package PhpSchool\PhpWorkshopTest\Factory
* @author Aydin Hassan <[email protected]>
*/
class ResultsRendererFactoryTest extends PHPUnit_Framework_TestCase
{
/**
* @expectedException InvalidArgumentException
*/
public function testRegisterRendererRequiresResultInterface()
{
$resultClass = get_class($this->createMock(PHPUnit_Framework_TestCase::class));
$rendererClass = get_class($this->createMock(ResultRendererInterface::class));
$factory = new ResultRendererFactory();

$factory->registerRenderer($resultClass, $rendererClass);
}

/**
* @expectedException InvalidArgumentException
*/
public function testRegisterRendererRequiresResultRendererInterface()
{
$resultClass = get_class($this->createMock(ResultInterface::class));
$rendererClass = get_class($this->createMock(PHPUnit_Framework_TestCase::class));
$factory = new ResultRendererFactory();

$factory->registerRenderer($resultClass, $rendererClass);
}

/**
* @expectedException InvalidArgumentException
*/
public function testRegisterRendererRequiresResultClassToBeString()
{
$resultClass = $this->createMock(ResultInterface::class);
$rendererClass = get_class($this->createMock(ResultRendererInterface::class));
$factory = new ResultRendererFactory();

$factory->registerRenderer($resultClass, $rendererClass);
}

/**
* @expectedException InvalidArgumentException
*/
public function testRegisterRendererRequiresRendererClassToBeString()
{
$resultClass = get_class($this->createMock(ResultInterface::class));
$rendererClass = $this->createMock(ResultRendererInterface::class);
$factory = new ResultRendererFactory();

$factory->registerRenderer($resultClass, $rendererClass);
}

/**
* @expectedException RuntimeException
*/
public function testCreateRequiresMappingToClassName()
{
$resultClass = $this->createMock(ResultInterface::class);
$factory = new ResultRendererFactory();

$factory->create($resultClass);
}

public function testCreateReturnsMappedRendererInterface()
{
$resultClass = $this->createMock(ResultInterface::class);
$resultClassName = get_class($resultClass);
$rendererClassName = get_class($this->createMock(ResultRendererInterface::class));
$factory = new ResultRendererFactory();
$factory->registerRenderer($resultClassName, $rendererClassName);

$returnedRenderer = $factory->create($resultClass);

$this->assertInstanceOf($rendererClassName, $returnedRenderer);
}
}