feature #5 Add LazyChainProvider for lazy loading providers (sstok)

This PR was merged into the 1.0-dev branch. Discussion ---------- | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | Fixes #2 | License | MIT Commits ------- 9dc1ef3 Add LazyChainProvider for lazy loading providers
rollerworks · Aug 21, 2017 · f655fdc · f655fdc
2 parents ed8e4d1 + 9dc1ef3
commit f655fdc
Show file tree

Hide file tree

Showing 5 changed files with 186 additions and 25 deletions.
diff --git a/docs/blacklist.md b/docs/blacklist.md
@@ -110,6 +110,18 @@ $blacklistProvider = new ChainProvider([
 ]);
 ```
 
+### LazyChainProvider
+
+Alternatively it's recommended to use the `Rollerworks\Component\PasswordStrength\Blacklist\LazyChainProvider`
+as this allows to load providers lazy (and thus preventing opening resources unneeded).
+
+```php
+$container = ...; // \Psr\Container\ContainerInterface
+$serviceIds = ['provider1']; // An array of service-id's to use for lazy loading providers. 
+
+$blacklistProvider = new LazyChainProvider($container, $serviceIds);
+```
+
 ## Updating the blacklist database
 
 To update your blacklist providers with new entries (or purge outdated outdated entries)

diff --git a/src/Blacklist/LazyChainProvider.php b/src/Blacklist/LazyChainProvider.php
@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the RollerworksPasswordStrengthValidator package.
+ *
+ * (c) Sebastiaan Stok <s.stok@rollerscapes.net>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Rollerworks\Component\PasswordStrength\Blacklist;
+
+use Psr\Container\ContainerInterface;
+
+/**
+ * Chained blacklist provider.
+ *
+ * @author Sebastiaan Stok <s.stok@rollerscapes.net>
+ */
+final class LazyChainProvider implements BlacklistProviderInterface
+{
+    private $container;
+    private $providers;
+
+    /**
+     * Constructor.
+     *
+     * @param ContainerInterface $container
+     * @param string[]           $providers
+     */
+    public function __construct(ContainerInterface $container, array $providers)
+    {
+        $this->container = $container;
+        $this->providers = $providers;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * Runs trough all the providers until one returns true.
+     */
+    public function isBlacklisted($password)
+    {
+        foreach ($this->providers as $provider) {
+            if (true === $this->container->get($provider)->isBlacklisted($password)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}
diff --git a/tests/BlackListMockProviderTrait.php b/tests/BlackListMockProviderTrait.php
@@ -0,0 +1,52 @@
+<?php
+
+/*
+ * This file is part of the RollerworksPasswordStrengthValidator package.
+ *
+ * (c) Sebastiaan Stok <s.stok@rollerscapes.net>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Rollerworks\Component\PasswordStrength\Tests;
+
+use Prophecy\Argument;
+use Prophecy\Prophecy\ObjectProphecy;
+use Psr\Container\ContainerInterface;
+use Rollerworks\Component\PasswordStrength\Blacklist\BlacklistProviderInterface;
+
+/**
+ * Trait BlackListMockProviderTrait.
+ *
+ * @method ObjectProphecy prophesize($class)
+ */
+trait BlackListMockProviderTrait
+{
+    protected function createMockedProvider($blacklisted)
+    {
+        $mockProvider = $this->prophesize(BlacklistProviderInterface::class);
+        $mockProvider->isBlacklisted($blacklisted)->willReturn(true);
+        $mockProvider->isBlacklisted(Argument::any())->willReturn(false);
+
+        return $mockProvider->reveal();
+    }
+
+    /**
+     * @param array $loaders
+     *
+     * @return ContainerInterface|object
+     */
+    protected function createLoadersContainer(array $loaders)
+    {
+        $loadersProphecy = $this->prophesize(ContainerInterface::class);
+        $loadersProphecy->has(Argument::any())->willReturn(false);
+
+        foreach ($loaders as $name => $loader) {
+            $loadersProphecy->has($name)->willReturn(true);
+            $loadersProphecy->get($name)->willReturn($loader);
+        }
+
+        return $loadersProphecy->reveal();
+    }
+}
diff --git a/tests/Blacklist/LazyChainProviderTest.php b/tests/Blacklist/LazyChainProviderTest.php
@@ -0,0 +1,66 @@
+<?php
+
+/*
+ * This file is part of the RollerworksPasswordStrengthValidator package.
+ *
+ * (c) Sebastiaan Stok <s.stok@rollerscapes.net>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Rollerworks\Component\PasswordStrength\Tests\Blacklist;
+
+use PHPUnit\Framework\TestCase;
+use Rollerworks\Component\PasswordStrength\Blacklist\BlacklistProviderInterface;
+use Rollerworks\Component\PasswordStrength\Blacklist\LazyChainProvider;
+use Rollerworks\Component\PasswordStrength\Tests\BlackListMockProviderTrait;
+
+final class LazyChainProviderTest extends TestCase
+{
+    use BlackListMockProviderTrait;
+
+    public function testBlackList()
+    {
+        $loader1 = $this->createMockedProvider('foobar');
+        $loader2 = $this->createMockedProvider('god');
+
+        $this->createLoadersContainer(['first' => $loader1, 'second' => $loader2]);
+
+        $provider = new LazyChainProvider(
+            $this->createLoadersContainer(['first' => $loader1, 'second' => $loader2]),
+            ['first', 'second']
+        );
+
+        self::assertTrue($provider->isBlacklisted('god'));
+        self::assertTrue($provider->isBlacklisted('foobar'));
+
+        self::assertFalse($provider->isBlacklisted('tests'));
+        self::assertFalse($provider->isBlacklisted(null));
+        self::assertFalse($provider->isBlacklisted(false));
+    }
+
+    public function testStopsLoadingOnFirstHit()
+    {
+        $loader1 = $this->createMockedProvider('foobar');
+        $loader2 = $this->createNotExpectedMockedProvider();
+
+        $this->createLoadersContainer(['first' => $loader1, 'second' => $loader2]);
+
+        $provider = new LazyChainProvider(
+            $this->createLoadersContainer(['first' => $loader1, 'second' => $loader2]),
+            ['first', 'second']
+        );
+
+        self::assertTrue($provider->isBlacklisted('foobar'));
+    }
+
+    protected function createNotExpectedMockedProvider()
+    {
+        // Prophesize acts funny...
+        $mock = $this->createMock(BlacklistProviderInterface::class);
+        $mock->expects(self::never())->method('isBlacklisted');
+
+        return $mock;
+    }
+}
diff --git a/tests/Validator/BlacklistValidationTest.php b/tests/Validator/BlacklistValidationTest.php
@@ -11,17 +11,17 @@
 
 namespace Rollerworks\Component\PasswordStrength\Tests\Validator;
 
-use Prophecy\Argument;
-use Psr\Container\ContainerInterface;
 use Rollerworks\Component\PasswordStrength\Blacklist\ArrayProvider;
-use Rollerworks\Component\PasswordStrength\Blacklist\BlacklistProviderInterface;
+use Rollerworks\Component\PasswordStrength\Tests\BlackListMockProviderTrait;
 use Rollerworks\Component\PasswordStrength\Validator\Constraints\Blacklist;
 use Rollerworks\Component\PasswordStrength\Validator\Constraints\BlacklistValidator;
 use Symfony\Component\Validator\Exception\RuntimeException;
 use Symfony\Component\Validator\Test\ConstraintValidatorTestCase;
 
 class BlacklistValidationTest extends ConstraintValidatorTestCase
 {
+    use BlackListMockProviderTrait;
+
     public function getMock($originalClassName, $methods = [], array $arguments = [], $mockClassName = '', $callOriginalConstructor = true, $callOriginalClone = true, $callAutoload = true, $cloneArguments = false, $callOriginalMethods = false, $proxyTarget = null)
     {
         if (func_num_args() === 1 && preg_match('/^Symfony\\\\Component\\\\([a-z]+\\\\)+[a-z]+Interface$/i', $originalClassName)) {
@@ -137,26 +137,4 @@ public function testThrowsExceptionWhenNoProvidersWereGiven()
 
         $this->validator->validate('dope', new Blacklist(['message' => 'myMessage', 'provider' => 'array']));
     }
-
-    private function createMockedProvider($blacklisted)
-    {
-        $mockProvider = $this->prophesize(BlacklistProviderInterface::class);
-        $mockProvider->isBlacklisted($blacklisted)->willReturn(true);
-        $mockProvider->isBlacklisted(Argument::any())->willReturn(false);
-
-        return $mockProvider->reveal();
-    }
-
-    private function createLoadersContainer(array $loaders)
-    {
-        $loadersProphecy = $this->prophesize(ContainerInterface::class);
-        $loadersProphecy->has(Argument::any())->willReturn(false);
-
-        foreach ($loaders as $name => $loader) {
-            $loadersProphecy->has($name)->willReturn(true);
-            $loadersProphecy->get($name)->willReturn($loader);
-        }
-
-        return $loadersProphecy->reveal();
-    }
 }