Skip to content

Commit

Permalink
Merge pull request #12 from mirfilip/hotfix/ability-to-create-invalid…
Browse files Browse the repository at this point in the history 
…-enums

Hotfix/ability to create invalid enums
  • Loading branch information
@mnapoli
mnapoli committed Feb 10, 2015
2 parents 5fa55b5 + dae119a commit 82d35ba
Show file tree
Hide file tree
Showing 3 changed files with 87 additions and 40 deletions.
11 changes: 6 additions & 5 deletions src/Enum.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
* Create an enum by implementing this class and adding class constants.
*
* @author Matthieu Napoli <matthieu@mnapoli.fr>
* @author Daniel Costa <danielcosta@gmail.com
* @author Daniel Costa <danielcosta@gmail.com>
* @author Mirosław Filip <mirfilip@gmail.com>
*/
abstract class Enum
{
Expand All @@ -22,7 +23,7 @@ abstract class Enum
* @var mixed
*/
protected $value;

/**
* Store existing constants in a static cache per object.
*
Expand All @@ -39,7 +40,7 @@ abstract class Enum
*/
public function __construct($value)
{
if (!in_array($value, self::toArray())) {
if (!$this->isValid($value)) {
throw new \UnexpectedValueException("Value '$value' is not part of the enum " . get_called_class());
}

Expand Down Expand Up @@ -106,7 +107,7 @@ public static function toArray()
*/
public static function isValid($value)
{
return in_array($value, self::toArray());
return in_array($value, self::toArray(), true);
}

/**
Expand All @@ -118,7 +119,7 @@ public static function isValid($value)
*/
public static function isValidKey($key)
{
return in_array($key, self::keys());
return in_array($key, self::keys(), true);
}

/**
Expand Down
16 changes: 15 additions & 1 deletion tests/EnumFixture.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,25 @@
* @method static EnumFixture BAR()
* @method static EnumFixture NUMBER()
*
* @author Daniel Costa <danielcosta@gmail.com
* @method static EnumFixture PROBLEMATIC_NUMBER()
* @method static EnumFixture PROBLEMATIC_NULL()
* @method static EnumFixture PROBLEMATIC_EMPTY_STRING()
* @method static EnumFixture PROBLEMATIC_BOOLEAN_FALSE()
*
* @author Daniel Costa <danielcosta@gmail.com>
* @author Mirosław Filip <mirfilip@gmail.com>
*/
class EnumFixture extends Enum
{
const FOO = "foo";
const BAR = "bar";
const NUMBER = 42;

/**
* Values that are known to cause problems when used with soft typing
*/
const PROBLEMATIC_NUMBER = 0;
const PROBLEMATIC_NULL = null;
const PROBLEMATIC_EMPTY_STRING = '';
const PROBLEMATIC_BOOLEAN_FALSE = false;
}
100 changes: 66 additions & 34 deletions tests/EnumTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@

/**
* @author Matthieu Napoli <matthieu@mnapoli.fr>
* @author Daniel Costa <danielcosta@gmail.com
* @author Daniel Costa <danielcosta@gmail.com>
* @author Mirosław Filip <mirfilip@gmail.com>
*/
class EnumTest extends \PHPUnit_Framework_TestCase
{
Expand Down Expand Up @@ -38,42 +39,44 @@ public function testGetKey()
}

/**
* @expectedException \UnexpectedValueException
* @dataProvider invalidValueProvider
*/
public function testInvalidValueString()
public function testCreatingEnumWithInvalidValue($value)
{
new EnumFixture("test");
}
$this->setExpectedException(
'\UnexpectedValueException',
'Value \'' . $value . '\' is not part of the enum MyCLabs\Tests\Enum\EnumFixture'
);

/**
* @expectedException \UnexpectedValueException
*/
public function testInvalidValueInt()
{
new EnumFixture(1234);
new EnumFixture($value);
}

/**
* @expectedException \UnexpectedValueException
* Contains values not existing in EnumFixture
* @return array
*/
public function testInvalidValueEmpty()
{
new EnumFixture(null);
public function invalidValueProvider() {
return array(
"string" => array('test'),
"int" => array(1234),
);
}

/**
* __toString()
* @dataProvider toStringProvider
*/
public function testToString()
public function testToString($expected, $enumObject)
{
$value = new EnumFixture(EnumFixture::FOO);
$this->assertEquals(EnumFixture::FOO, (string) $value);

$value = new EnumFixture(EnumFixture::BAR);
$this->assertEquals(EnumFixture::BAR, (string) $value);
$this->assertSame($expected, (string) $enumObject);
}

$value = new EnumFixture(EnumFixture::NUMBER);
$this->assertEquals((string) EnumFixture::NUMBER, (string) $value);
public function toStringProvider() {
return array(
array(EnumFixture::FOO, new EnumFixture(EnumFixture::FOO)),
array(EnumFixture::BAR, new EnumFixture(EnumFixture::BAR)),
array((string) EnumFixture::NUMBER, new EnumFixture(EnumFixture::NUMBER)),
);
}

/**
Expand All @@ -82,13 +85,17 @@ public function testToString()
public function testKeys()
{
$values = EnumFixture::keys();
$this->assertInternalType("array", $values);
$expectedValues = array(
"FOO",
"BAR",
"NUMBER",
"PROBLEMATIC_NUMBER",
"PROBLEMATIC_NULL",
"PROBLEMATIC_EMPTY_STRING",
"PROBLEMATIC_BOOLEAN_FALSE",
);
$this->assertEquals($expectedValues, $values);

$this->assertSame($expectedValues, $values);
}

/**
Expand All @@ -97,13 +104,17 @@ public function testKeys()
public function testToArray()
{
$values = EnumFixture::toArray();
$this->assertInternalType("array", $values);
$expectedValues = array(
"FOO" => EnumFixture::FOO,
"BAR" => EnumFixture::BAR,
"NUMBER" => EnumFixture::NUMBER,
"FOO" => EnumFixture::FOO,
"BAR" => EnumFixture::BAR,
"NUMBER" => EnumFixture::NUMBER,
"PROBLEMATIC_NUMBER" => EnumFixture::PROBLEMATIC_NUMBER,
"PROBLEMATIC_NULL" => EnumFixture::PROBLEMATIC_NULL,
"PROBLEMATIC_EMPTY_STRING" => EnumFixture::PROBLEMATIC_EMPTY_STRING,
"PROBLEMATIC_BOOLEAN_FALSE" => EnumFixture::PROBLEMATIC_BOOLEAN_FALSE,
);
$this->assertEquals($expectedValues, $values);

$this->assertSame($expectedValues, $values);
}

/**
Expand All @@ -128,11 +139,29 @@ public function testBadStaticAccess()

/**
* isValid()
* @dataProvider isValidProvider
*/
public function testIsValid()
public function testIsValid($value, $isValid)
{
$this->assertTrue(EnumFixture::isValid('foo'));
$this->assertFalse(EnumFixture::isValid('baz'));
$this->assertSame($isValid, EnumFixture::isValid($value));
}

public function isValidProvider() {
return array(
/**
* Valid values
*/
array('foo', true),
array(42, true),
array(null, true),
array(0, true),
array('', true),
array(false, true),
/**
* Invalid values
*/
array('baz', false)
);
}

/**
Expand All @@ -150,6 +179,9 @@ public function testIsValidKey()
public function testSearch()
{
$this->assertEquals('FOO', EnumFixture::search('foo'));
$this->assertNotEquals('FOO', EnumFixture::isValidKey('baz'));
/**
* @see https://github.com/myclabs/php-enum/issues/9
*/
$this->assertEquals(EnumFixture::PROBLEMATIC_NUMBER, EnumFixture::search(1));
}
}

0 comments on commit 82d35ba

Please sign in to comment.