I'm trying to follow/learn TDD. I'm using PHPUnit. At the moment I'm writing small, very simple classes/projects simply for taking it all in.
At the moment I'm writing a play card setup.
So to start it, I wrote this test, as I would avoid repetition in my card suits, I decided that the test should be for an abstract class which the suits could extend from.
The pattern of the classes, hopefully, are obvious when you get to the end of the post.
BaseSuitTest.php
use Cards\French\Suits\BaseSuit as Card;
class BaseSuitTest extends PHPUnit_Framework_TestCase
{
protected $Card;
public function setUp()
{
$this->Card = $this->getMockForAbstractClass('Cards\French\Suits\BaseSuit', [10]);
}
/**
* @expectedException InvalidArgumentException
*/
public function testConstructThrowsExceptionIfFirstArgLessThan1()
{
$Card = $this->getMockForAbstractClass('Cards\French\Suits\BaseSuit', [0]);
}
/**
* @expectedException InvalidArgumentException
*/
public function testConstructThrowsExceptionIfFirstArgHigherThan13()
{
$Card = $this->getMockForAbstractClass('Cards\French\Suits\BaseSuit', [14]);
}
public function testGetSuitReturnsClassName()
{
$suit = $this->Card->getSuit();
$this->assertSame( get_class($this->Card), $suit);
}
public function testGetValueReturnsValue()
{
$value = $this->Card->getValue();
$this->assertSame(10, $value);
}
}
Afterwards I wrote the following file, making all tests pass. As this point I'm also thinking if I should implement a CardInterface to the BaseSuit (and should I write a test to check for the implementation or is this not part of the tests). I decided not to.
BaseSuit.php
namespace Cards\French\Suits;
abstract class BaseSuit
{
const MIN_VALUE = 1;
const MAX_VALUE = 13;
protected $value;
public function __construct($value)
{
if( $this->isWithinValueRange($value) === false)
throw new \InvalidArgumentException('The value must be higer than 0 and less than 14 (1-13) Given ' . $value);
$this->value = $value;
}
protected function isWithinValueRange($value)
{
if($value < self::MIN_VALUE OR $value > self::MAX_VALUE)
return false;
return true;
}
public function getSuit()
{
return get_class($this);
}
public function getValue()
{
return $this->value;
}
}
Finally I started to make tests for the actual classes/suits that would extend from the base class.
The test is very very similar to those in the BaseSuit, which is already annoying me inside my head.
HeartTest.php
use Cards\French\Suits\Heart as Heart;
class HeartTest extends PHPUnit_Framework_TestCase
{
protected $Heart;
public function setUp()
{
$this->Heart = new Heart(10);
}
/**
* @expectedException InvalidArgumentException
*/
public function testConstructThrowsExceptionIfFirstArgLessThan1()
{
$Heart = new Heart(0);
}
/**
* @expectedException InvalidArgumentException
*/
public function testConstructThrowsExceptionIfFirstArgHigherThan13()
{
$Heart = new Heart(14);
}
public function testGetSuitReturnsClassName()
{
$suit = $this->Heart->getSuit();
$this->assertSame( get_class($this->Heart), $suit);
}
public function testGetValueReturnsValue()
{
$value = $this->Heart->getValue();
$this->assertSame(10, $value);
}
}
I once again write my code so the tests pass.
Heart.php
namespace Cards\French\Suits;
class Heart extends BaseSuit {}
All tests pass but all is not cool. I would like to avoid the repetition in the tests for suits that extend from the BaseSuit (like Heart).
My intial thought was to rename the methods in the BaseSuit to protected And then extending from this test. Here is an example of one of the BaseSuit tests renamed.
A refactored method in BaseSuit.php
/**
* @expectedException InvalidArgumentException
*/
protected function constructThrowsExceptionIfFirstArgLessThan1($class)
{
// .. i have not written this code, it just a figment of my imagination.
}
This is where I split. I'm unsure on how to continue.
Moving the tests in the BaseSuitTest to protected methods would mean I would either loose the current public test methods. This could be fixed my making new tests method which calls the protected methods.
Code examples, refactoring suggetions, pattern suggestion and whatever constructive pops inside your head while reading this would be much to my appreciation.
I have been recommended to use a provider for the tests that run on the same method. Smart, I will do this is in the future, but I'm not able to see how this could fix my situation. Simply when its the abstract BaseSuit, I want to use getMockForAbstract in the test and when it is the suits, well i just I should be more like the HeartTest. I need help understanding how to implement this the right way.
