8000 [PropertyAccess] Added isReadable() and isWritable() by webmozart · Pull Request #10570 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[PropertyAccess] Added isReadable() and isWritable() #10570

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 6 commits into from
Mar 31, 2014
Merged

[PropertyAccess] Added isReadable() and isWritable() #10570

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0488389
[PropertyAccess] Refactored PropertyAccessorTest
webmozart Mar 28, 2014
20e6bf8
[PropertyAccess] Refactored PropertyAccessorCollectionTest
webmozart Mar 28, 2014
6d2af21
[PropertyAccess] Added isReadable() and isWritable()
webmozart Mar 28, 2014
4262707
[PropertyAccess] Fixed CS and added missing documentation
webmozart Mar 28, 2014
9aee2ad
[PropertyAccess] Removed the argument $value from isWritable()
webmozart Mar 30, 2014
f7fb855
[PropertyAccess] Added missing exceptions to phpdoc
webmozart Mar 31, 2014
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
Prev Previous commit
Next Next commit
[PropertyAccess] Refactored PropertyAccessorCollectionTest
  • Loading branch information
@webmozart
webmozart committed Mar 28, 2014
commit 20e6bf8f49e607325fa9b2df62de592ec404a1bf
3 changes: 3 additions & 0 deletions src/Symfony/Component/PropertyAccess/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ CHANGELOG
------

* allowed non alpha numeric characters in second level and deeper object properties names
* [BC BREAK] when accessing an index on an object that does not implement
ArrayAccess, a NoSuchIndexException is now thrown instead of the
semantically wrong NoSuchPropertyException

2.3.0
------
Expand Down
8 changes: 4 additions & 4 deletions src/Symfony/Component/PropertyAccess/PropertyAccessor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,12 +160,12 @@ private function &readPropertiesUntil(&$objectOrArray, PropertyPathInterface $pr
*
* @return mixed The value of the key
*
* @throws NoSuchPropertyException If the array does not implement \ArrayAccess or it is not an array
* @throws NoSuchIndexException If the array does not implement \ArrayAccess or it is not an array
*/
private function &readIndex(&$array, $index)
{
if (!$array instanceof \ArrayAccess && !is_array($array)) {
throw new NoSuchPropertyException(sprintf('Index "%s" cannot be read from object of type "%s" because it doesn\'t implement \ArrayAccess', $index, get_class($array)));
throw new NoSuchIndexException(sprintf('Index "%s" cannot be read from object of type "%s" because it doesn\'t implement \ArrayAccess', $index, get_class($array)));
}

// Use an array instead of an object since performance is very crucial here
Expand Down Expand Up @@ -271,12 +271,12 @@ private function &readProperty(&$object, $property)
* @param string|integer $index The index to write at
* @param mixed $value The value to write
*
* @throws NoSuchPropertyException If the array does not implement \ArrayAccess or it is not an array
* @throws NoSuchIndexException If the array does not implement \ArrayAccess or it is not an array
*/
private function writeIndex(&$array, $index, $value)
{
if (!$array instanceof \ArrayAccess && !is_array($array)) {
throw new NoSuchPropertyException(sprintf('Index "%s" cannot be modified in object of type "%s" because it doesn\'t implement \ArrayAccess', $index, get_class($array)));
throw new NoSuchIndexException(sprintf('Index "%s" cannot be modified in object of type "%s" because it doesn\'t implement \ArrayAccess', $index, get_class($array)));
}

$array[$index] = $value;
Expand Down
150 changes: 23 additions & 127 deletions src/Symfony/Component/PropertyAccess/Tests/PropertyAccessorCollectionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,6 @@ public function getAxes()
}
}

class PropertyAccessorCollectionTest_CarCustomSingular
{
public function addFoo($axis) {}

public function removeFoo($axis) {}

public function getAxes() {}
}

class PropertyAccessorCollectionTest_Engine
{
}

class PropertyAccessorCollectionTest_CarOnlyAdder
{
public function addAxis($axis) {}
Expand All @@ -79,13 +66,6 @@ class PropertyAccessorCollectionTest_CarNoAdderAndRemover
public function getAxes() {}
}

class PropertyAccessorCollectionTest_CarNoAdderAndRemoverWithProperty
{
protected $axes = array();

public function getAxes() {}
}

class PropertyAccessorCollectionTest_CompositeCar
{
public function getStructure() {}
Expand Down Expand Up @@ -116,52 +96,34 @@ protected function setUp()

abstract protected function getCollection(array $array);

public function testGetValueReadsArrayAccess()
public function getValidPropertyPaths()
{
$object = $this->getCollection(array('firstName' => 'Bernhard'));

$this->assertEquals('Bernhard', $this->propertyAccessor->getValue($object, '[firstName]'));
}

public function testGetValueReadsNestedArrayAccess()
{
$object = $this->getCollection(array('person' => array('firstName' => 'Bernhard')));

$this->assertEquals('Bernhard', $this->propertyAccessor->getValue($object, '[person][firstName]'));
return array(
array(array('firstName' => 'Bernhard'), '[firstName]', 'Bernhard'),
array(array('person' => array('firstName' => 'Bernhard')), '[person][firstName]', 'Bernhard'),
);
}

/**
* @expectedException \Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException
* @dataProvider getValidPropertyPaths
*/
public function testGetValueThrowsExceptionIfArrayAccessExpected()
{
$this->propertyAccessor->getValue(new \stdClass(), '[firstName]');
}

public function testSetValueUpdatesArrayAccess()
{
$object = $this->getCollection(array());

$this->propertyAccessor->setValue($object, '[firstName]', 'Bernhard');

$this->assertEquals('Bernhard', $object['firstName']);
}

public function testSetValueUpdatesNestedArrayAccess()
public function testGetValue(array $array, $path, $value)
{
$object = $this->getCollection(array());
$collection = $this->getCollection($array);

$this->propertyAccessor->setValue($object, '[person][firstName]', 'Bernhard');

$this->assertEquals('Bernhard', $object['person']['firstName']);
$this->assertSame($value, $this->propertyAccessor->getValue($collection, $path));
}

/**
* @expectedException \Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException
* @dataProvider getValidPropertyPaths
*/
public function testSetValueThrowsExceptionIfArrayAccessExpected()
public function testSetValue(array $array, $path)
{
$this->propertyAccessor->setValue(new \stdClass(), '[firstName]', 'Bernhard');
$collection = $this->getCollection($array);

$this->propertyAccessor->setValue($collection, $path, 'Updated');

$this->assertSame('Updated', $this->propertyAccessor->getValue($collection, $path));
}

public function testSetValueCallsAdderAndRemoverForCollections()
Expand Down Expand Up @@ -210,32 +172,9 @@ public function testSetValueCallsAdderAndRemoverForNestedCollections()
$this->propertyAccessor->setValue($car, 'structure.axes', $axesAfter);
}

public function testSetValueCallsCustomAdderAndRemover()
{
$this->markTestSkipped('This feature is temporarily disabled as of 2.1');

$car = $this->getMock(__CLASS__.'_CarCustomSingular');
$axesBefore = $this->getCollection(array(1 => 'second', 3 => 'fourth'));
$axesAfter = $this->getCollection(array(0 => 'first', 1 => 'second', 2 => 'third'));

$car->expects($this->at(0))
->method('getAxes')
->will($this->returnValue($axesBefore));
$car->expects($this->at(1))
->method('removeFoo')
->with('fourth');
$car->expects($this->at(2))
->method('addFoo')
->with('first');
$car->expects($this->at(3))
->method('addFoo')
->with('third');

$this->propertyAccessor->setValue($car, 'axes|foo', $axesAfter);
}

/**
* @expectedException \Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException
* @expectedExceptionMessage Found the public method "addAxis()", but did not find a public "removeAxis()" on class Mock_PropertyAccessorCollectionTest_CarOnlyAdder
*/
public function testSetValueFailsIfOnlyAdderFound()
{
Expand All @@ -252,6 +191,7 @@ public function testSetValueFailsIfOnlyAdderFound()

/**
* @expectedException \Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException
* @expectedExceptionMessage Found the public method "removeAxis()", but did not find a public "addAxis()" on class Mock_PropertyAccessorCollectionTest_CarOnlyRemover
*/
public function testSetValueFailsIfOnlyRemoverFound()
{
Expand All @@ -267,58 +207,14 @@ public function testSetValueFailsIfOnlyRemoverFound()
}

/**
* @dataProvider noAdderRemoverData
* @expectedException \Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException
* @expectedExceptionMessage Neither the property "axes" nor one of the methods "addAx()", "addAxe()", "addAxis()", "setAxes()", "__set()" or "__call()" exist and have public access in class "Mock_PropertyAccessorCollectionTest_CarNoAdderAndRemover
*/
public function testNoAdderAndRemoverThrowsSensibleError($car, $path, $message)
{
$axes = $this->getCollection(array(0 => 'first', 1 => 'second', 2 => 'third'));

try {
$this->propertyAccessor->setValue($car, $path, $axes);
$this->fail('An expected exception was not thrown!');
} catch (ExceptionInterface $e) {
$this->assertEquals($message, $e->getMessage());
}
}

public function noAdderRemoverData()
public function testSetValueFailsIfNoAdderAndNoRemoverFound()
{
$data = array();

$car = $this->getMock(__CLASS__.'_CarNoAdderAndRemover');
$propertyPath = 'axes';
$expectedMessage = sprintf(
'Neither the property "axes" nor one of the methods "addAx()", '.
'"addAxe()", "addAxis()", "setAxes()", "__set()" or "__call()" exist and have '.
'public access in class "%s".',
get_class($car)
);
$data[] = array($car, $propertyPath, $expectedMessage);

/*
Temporarily disabled in 2.1

$propertyPath = new PropertyPath('axes|boo');
$expectedMessage = sprintf(
'Neither element "axes" nor method "setAxes()" exists in class '
.'"%s", nor could adders and removers be found based on the '
.'passed singular: %s',
get_class($car),
'boo'
);
$data[] = array($car, $propertyPath, $expectedMessage);
*/

$car = $this->getMock(__CLASS__.'_CarNoAdderAndRemoverWithProperty');
$propertyPath = 'axes';
$expectedMessage = sprintf(
'Neither the property "axes" nor one of the methods "addAx()", '.
'"addAxe()", "addAxis()", "setAxes()", "__set()" or "__call()" exist and have '.
'public access in class "%s".',
get_class($car)
);
$data[] = array($car, $propertyPath, $expectedMessage);
$axes = $this->getCollection(array(0 => 'first', 1 => 'second', 2 => 'third'));

return $data;
$this->propertyAccessor->setValue($car, 'axes', $axes);
}
}
19 changes: 16 additions & 3 deletions src/Symfony/Component/PropertyAccess/Tests/PropertyAccessorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ protected function setUp()

public function getValidPropertyPaths()
{

return array(
array(array('Bernhard', 'Schussek'), '[0]', 'Bernhard'),
array(array('Bernhard', 'Schussek'), '[1]', 'Schussek'),
Expand Down Expand Up @@ -65,7 +64,6 @@ public function getValidPropertyPaths()

public function getPathsWithMissingProperty()
{

return array(
array((object) array('firstName' => 'Bernhard'), 'lastName'),
array((object) array('property' => (object) array('firstName' => 'Bernhard')), 'property.lastName'),
Expand All @@ -86,7 +84,6 @@ public function getPathsWithMissingProperty()

public function getPathsWithMissingIndex()
{

return array(
array(array('firstName' => 'Bernhard'), '[lastName]'),
array(array(), '[index][lastName]'),
Expand Down Expand Up @@ -131,6 +128,14 @@ public function testGetValueThrowsExceptionIfIndexNotFoundAndIndexExceptionsEnab
$this->propertyAccessor->getValue($objectOrArray, $path);
}

/**
* @expectedException \Symfony\Component\PropertyAccess\Exception\NoSuchIndexException
*/
public function testGetValueThrowsExceptionIfNotArrayAccess()
{
$this->propertyAccessor->getValue(new \stdClass(), '[index]');
}

public function testGetValueReadsMagicGet()
{
$this->assertSame('Bernhard', $this->propertyAccessor->getValue(new TestClassMagicGet('Bernhard'), 'magicProperty'));
Expand Down Expand Up @@ -229,6 +234,14 @@ public function testSetValueThrowsNoExceptionIfIndexNotFoundAndIndexExceptionsEn
$this->assertSame('Updated', $this->propertyAccessor->getValue($objectOrArray, $path));
}

/**
* @expectedException \Symfony\Component\PropertyAccess\Exception\NoSuchIndexException
*/
public function testSetValueThrowsExceptionIfNotArrayAccess()
{
$this->propertyAccessor->setValue(new \stdClass(), '[index]', 'Updated');
}

public function testSetValueUpdatesMagicSet()
{
$author = new TestClassMagicGet('Bernhard');
Expand Down
0