Add whitelist and blacklist implementations

joelwurtz · joelwurtz · commit a6349e8a5d80 · 2019-04-07T14:48:42.000+02:00
diff --git a/src/Symfony/Component/Serializer/Extractor/BlacklistPropertyListExtractor.php b/src/Symfony/Component/Serializer/Extractor/BlacklistPropertyListExtractor.php
@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Serializer\Extractor;
+
+use Symfony\Component\PropertyInfo\PropertyListExtractorInterface;
+
+/**
+ * Remove properties given a blacklist in the context.
+ *
+ * @author Joel Wurtz <joel.wurtz@gmail.com>
+ */
+final class BlacklistPropertyListExtractor implements PropertyListExtractorInterface
+{
+    public const ATTRIBUTES = 'ignored_attributes';
+
+    private $extractor;
+
+    public function __construct(PropertyListExtractorInterface $extractor)
+    {
+        $this->extractor = $extractor;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getProperties($class, array $context = [])
+    {
+        $properties = $this->extractor->getProperties($class, $context);
+
+        if (null === $properties) {
+            return null;
+        }
+
+        $blacklist = $context[self::ATTRIBUTES] ?? null;
+
+        if (null === $blacklist) {
+            return $properties;
+        }
+
+        return array_diff($properties, $blacklist);
+    }
+}
diff --git a/src/Symfony/Component/Serializer/Extractor/WhitelistPropertyListExtractor.php b/src/Symfony/Component/Serializer/Extractor/WhitelistPropertyListExtractor.php
@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Serializer\Extractor;
+
+use Symfony\Component\PropertyInfo\PropertyListExtractorInterface;
+
+/**
+ * Allow properties given a whitelist in the context.
+ *
+ * @author Joel Wurtz <joel.wurtz@gmail.com>
+ */
+final class WhitelistPropertyListExtractor implements PropertyListExtractorInterface
+{
+    public const ATTRIBUTES = 'attributes';
+
+    private $extractor;
+
+    public function __construct(PropertyListExtractorInterface $extractor)
+    {
+        $this->extractor = $extractor;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getProperties($class, array $context = [])
+    {
+        $properties = $this->extractor->getProperties($class, $context);
+
+        if (null === $properties) {
+            return null;
+        }
+
+        $whitelist = $context[self::ATTRIBUTES] ?? null;
+
+        if (null === $whitelist) {
+            return $properties;
+        }
+
+        return array_intersect($properties, $whitelist);
+    }
+}
diff --git a/src/Symfony/Component/Serializer/Tests/Extractor/BlacklistPropertyListExtractorTest.php b/src/Symfony/Component/Serializer/Tests/Extractor/BlacklistPropertyListExtractorTest.php
@@ -0,0 +1,66 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Serializer\Tests\Extractor;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\PropertyInfo\PropertyListExtractorInterface;
+use Symfony\Component\Serializer\Extractor\BlacklistPropertyListExtractor;
+
+class BlacklistPropertyListExtractorTest extends TestCase
+{
+    public function testRemoveAttributes()
+    {
+        $extractor = $this
+            ->getMockBuilder(PropertyListExtractorInterface::class)
+            ->getMock()
+        ;
+
+        $extractor->method('getProperties')->willReturn([
+            'foo',
+            'bar',
+            'baz'
+        ]);
+
+        $blacklist = new BlacklistPropertyListExtractor($extractor);
+        $properties = $blacklist->getProperties('SomeClass');
+
+        $this->assertInternalType('array', $properties);
+        $this->assertContains('foo', $properties);
+        $this->assertContains('bar', $properties);
+        $this->assertContains('baz', $properties);
+
+        $properties = $blacklist->getProperties('SomeClass', [
+            BlacklistPropertyListExtractor::ATTRIBUTES => ['foo', 'bar', 'dummy'],
+        ]);
+
+        $this->assertInternalType('array', $properties);
+        $this->assertNotContains('foo', $properties);
+        $this->assertNotContains('bar', $properties);
+        $this->assertNotContains('dummy', $properties);
+        $this->assertContains('baz', $properties);
+    }
+
+    public function testNullProperties()
+    {
+        $extractor = $this
+            ->getMockBuilder(PropertyListExtractorInterface::class)
+            ->getMock()
+        ;
+
+        $extractor->method('getProperties')->willReturn(null);
+
+        $blacklist = new BlacklistPropertyListExtractor($extractor);
+        $properties = $blacklist->getProperties('SomeClass');
+
+        $this->assertNull($properties);
+    }
+}
diff --git a/src/Symfony/Component/Serializer/Tests/Extractor/WhitelistPropertyListExtractorTest.php b/src/Symfony/Component/Serializer/Tests/Extractor/WhitelistPropertyListExtractorTest.php
@@ -0,0 +1,73 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Serializer\Tests\Extractor;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\PropertyInfo\PropertyListExtractorInterface;
+use Symfony\Component\Serializer\Extractor\WhitelistPropertyListExtractor;
+
+class WhitelistPropertyListExtractorTest extends TestCase
+{
+    public function testAllowAttributes()
+    {
+        $extractor = $this
+            ->getMockBuilder(PropertyListExtractorInterface::class)
+            ->getMock()
+        ;
+
+        $extractor->method('getProperties')->willReturn([
+            'foo',
+            'bar',
+            'baz'
+        ]);
+
+        $blacklist = new WhitelistPropertyListExtractor($extractor);
+        $properties = $blacklist->getProperties('SomeClass');
+
+        $this->assertInternalType('array', $properties);
+        $this->assertContains('foo', $properties);
+        $this->assertContains('bar', $properties);
+        $this->assertContains('baz', $properties);
+
+        $properties = $blacklist->getProperties('SomeClass', [
+            WhitelistPropertyListExtractor::ATTRIBUTES => ['foo', 'bar', 'dummy'],
+        ]);
+
+        $this->assertInternalType('array', $properties);
+        $this->assertContains('foo', $properties);
+        $this->assertContains('bar', $properties);
+        $this->assertNotContains('dummy', $properties);
+        $this->assertNotContains('baz', $properties);
+
+        $properties = $blacklist->getProperties('SomeClass', [
+            WhitelistPropertyListExtractor::ATTRIBUTES => [],
+        ]);
+
+        $this->assertInternalType('array', $properties);
+        $this->assertEmpty($properties);
+    }
+
+    public function testNullProperties()
+    {
+        $extractor = $this
+            ->getMockBuilder(PropertyListExtractorInterface::class)
+            ->getMock()
+        ;
+
+        $extractor->method('getProperties')->willReturn(null);
+
+        $blacklist = new WhitelistPropertyListExtractor($extractor);
+        $properties = $blacklist->getProperties('SomeClass');
+
+        $this->assertNull($properties);
+    }
+}
