Add ability to explicitly inject RedisSentinelManager by contract

Signed-off-by: Cy Rossignol <[email protected]>

Author: cyrossignol

README.md

@@ -39,6 +39,7 @@ Contents
      - [Hybrid Configuration][s-hybrid-config]
  - [Override the Standard Redis API][s-override-redis-api]
  - [Executing Redis Commands (RedisSentinel Facade)][s-facade]
+     - [Dependency Injection][s-dependency-injection]
  - [Testing](#testing)
  - [License](#license)
  - [Appendix: Environment Variables][s-appx-env-vars]
@@ -625,6 +626,37 @@ In Lumen, add the alias to *bootstrap/app.php*:
 class_alias('Monospice\LaravelRedisSentinel\RedisSentinel', 'RedisSentinel');
 ```
 
+### Dependency Injection
+
+For those that prefer to declare the Redis Sentinel manager as a dependency of
+a class rather than using the facade, we can type-hint the interface that the
+container will resolve when building an object from the container:
+
+```php
+use Monospice\LaravelRedisSentinel\Contracts\Factory as RedisSentinel;
+...
+public function __construct(RedisSentinel $sentinel)
+{
+    $sentinel->get('some-key');
+}
+```
+
+The above explicitly requests an instance of the package's Sentinel service. If
+we [override the Redis API][s-override-redis-api], we can use the standard
+Redis contract instead, and the application will inject the appropriate service
+based on the configuration:
+
+```php
+use Illuminate\Contracts\Redis\Factory as Redis;
+...
+public function __construct(Redis $redis)
+{
+    // Either a Sentinel connection or a standard Redis connection depending on
+    // the value of REDIS_DRIVER or config('database.redis.driver'):
+    $redis->get('some-key');
+}
+```
+
 Testing
 -------
 
@@ -948,6 +980,7 @@ Sentinel Documentation][sentinel].
 
 [s-appx-env-vars]: #appendix-environment-variables
 [s-appx-examples]: #appendix-configuration-examples
+[s-dependency-injection]: #dependency-injection
 [s-dev-vs-prod-example]: #development-vs-production
 [s-env-config]: #environment-based-configuration
 [s-env-config-examples]: #environment-based-configuration-examples

src/Contracts/Factory.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Monospice\LaravelRedisSentinel\Contracts;
+
+use Illuminate\Contracts\Redis\Factory as RedisFactoryContract;
+
+interface Factory extends RedisFactoryContract
+{
+}

src/Manager/VersionedRedisSentinelManager.php

@@ -6,6 +6,7 @@
 use Illuminate\Support\Arr;
 use InvalidArgumentException;
 use Monospice\LaravelRedisSentinel\Connectors;
+use Monospice\LaravelRedisSentinel\Contracts\Factory;
 
 /**
  * Contains common functionality for the RedisSentinelManager implementations
@@ -17,7 +18,9 @@
  * @license  See LICENSE file
  * @link     http://github.com/monospice/laravel-redis-sentinel-drivers
  */
-abstract class VersionedRedisSentinelManager extends RedisManager
+abstract class VersionedRedisSentinelManager
+    extends RedisManager
+    implements Factory
 {
     /**
      * Get the Redis Connection instance represented by the specified name

src/RedisSentinelManager.php

@@ -2,7 +2,7 @@
 
 namespace Monospice\LaravelRedisSentinel;
 
-use Illuminate\Contracts\Redis\Factory;
+use Monospice\LaravelRedisSentinel\Contracts\Factory;
 use Monospice\LaravelRedisSentinel\Manager\VersionedRedisSentinelManager;
 use Monospice\SpicyIdentifiers\DynamicMethod;
 

src/RedisSentinelServiceProvider.php

@@ -10,6 +10,7 @@
 use Illuminate\Support\Arr;
 use Illuminate\Support\ServiceProvider;
 use Monospice\LaravelRedisSentinel\Configuration\Loader as ConfigurationLoader;
+use Monospice\LaravelRedisSentinel\Contracts\Factory;
 use Monospice\LaravelRedisSentinel\RedisSentinelManager;
 
 /**
@@ -58,6 +59,23 @@ public function register()
     {
         $this->config = ConfigurationLoader::load($this->app);
 
+        $this->registerServices();
+
+        // If we want Laravel's Redis API to use Sentinel, we'll return an
+        // instance of the RedisSentinelManager when requesting the "redis"
+        // service:
+        if ($this->config->shouldOverrideLaravelRedisApi) {
+            $this->registerOverrides();
+        }
+    }
+
+    /**
+     * Register the core Redis Sentinel connection manager.
+     *
+     * @return void
+     */
+    protected function registerServices()
+    {
         $this->app->singleton('redis-sentinel', function ($app) {
             $class = $this->config->getVersionedRedisSentinelManagerClass();
             $config = $this->config->get('database.redis-sentinel', [ ]);
@@ -66,12 +84,11 @@ public function register()
             return new RedisSentinelManager(new $class($driver, $config));
         });
 
-        // If we want Laravel's Redis API to use Sentinel, we'll return an
-        // instance of the RedisSentinelManager when requesting the "redis"
-        // service:
-        if ($this->config->shouldOverrideLaravelRedisApi) {
-            $this->registerOverrides();
-        }
+        $this->app->singleton('redis-sentinel.manager', function ($app) {
+            return $app->make('redis-sentinel')->getVersionedManager();
+        });
+
+        $this->app->alias('redis-sentinel', Factory::class);
     }
 
     /**
@@ -87,7 +104,7 @@ protected function registerOverrides()
         });
 
         $this->app->bind('redis.connection', function ($app) {
-            return $app->make('redis-sentinel')->connection();
+            return $app->make('redis-sentinel.manager')->connection();
         });
     }
 
@@ -140,7 +157,7 @@ protected function addRedisSentinelBroadcaster()
     {
         $this->app->make(BroadcastFactory::class)
             ->extend('redis-sentinel', function ($app, $conf) {
-                $redis = $app->make('redis-sentinel')->getVersionedManager();
+                $redis = $app->make('redis-sentinel.manager');
                 $connection = Arr::get($conf, 'connection', 'default');
 
                 return new RedisBroadcaster($redis, $connection);
@@ -158,7 +175,7 @@ protected function addRedisSentinelCacheStore()
         $cache = $this->app->make('cache');
 
         $cache->extend('redis-sentinel', function ($app, $conf) use ($cache) {
-            $redis = $app->make('redis-sentinel')->getVersionedManager();
+            $redis = $app->make('redis-sentinel.manager');
             $prefix = $app->make('config')->get('cache.prefix');
             $connection = Arr::get($conf, 'connection', 'default');
             $store = new RedisStore($redis, $prefix, $connection);
@@ -195,7 +212,7 @@ protected function addRedisSentinelSessionHandler()
     protected function addRedisSentinelQueueConnector()
     {
         $this->app->make('queue')->extend('redis-sentinel', function () {
-            $redis = $this->app->make('redis-sentinel')->getVersionedManager();
+            $redis = $this->app->make('redis-sentinel.manager');
 
             return new RedisConnector($redis);
         });

tests/RedisSentinelManagerTest.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Contracts\Redis\Factory as RedisFactory;
 use Illuminate\Redis\Connections\Connection;
+use Monospice\LaravelRedisSentinel\Contracts\Factory as RedisSentinelFactory;
 use Monospice\LaravelRedisSentinel\Manager\VersionedRedisSentinelManager;
 use Monospice\LaravelRedisSentinel\RedisSentinelManager;
 use Mockery;
@@ -58,6 +59,11 @@ public function testImplementsRedisFactoryForSwapability()
         $this->assertInstanceOf(RedisFactory::class, $this->manager);
     }
 
+    public function testIsRedisSentinelFactory()
+    {
+        $this->assertInstanceOf(RedisSentinelFactory::class, $this->manager);
+    }
+
     public function testGetsVersionedRedisSentinelManagerInstance()
     {
         $this->assertInstanceOf(

tests/RedisSentinelServiceProviderTest.php

@@ -6,6 +6,8 @@
 use Illuminate\Contracts\Broadcasting\Factory as BroadcastFactory;
 use Illuminate\Contracts\Redis\Factory as RedisFactory;
 use Illuminate\Redis\RedisManager;
+use Monospice\LaravelRedisSentinel\Contracts\Factory as RedisSentinelFactory;
+use Monospice\LaravelRedisSentinel\Manager\VersionedRedisSentinelManager;
 use Monospice\LaravelRedisSentinel\RedisSentinelManager;
 use Monospice\LaravelRedisSentinel\RedisSentinelServiceProvider;
 use Monospice\LaravelRedisSentinel\Tests\Support\ApplicationFactory;
@@ -84,6 +86,31 @@ public function testRegistersWithApplication()
 
         $service = $this->app->make('redis-sentinel');
 
+        $this->assertInstanceOf(RedisSentinelManager::class, $service);
+        $this->assertInstanceOf(RedisFactory::class, $service);
+        $this->assertInstanceOf(RedisSentinelFactory::class, $service);
+    }
+
+    public function testRegistersVersionedManagerWithApplication()
+    {
+        $this->provider->register();
+
+        $this->assertArrayHasKey('redis-sentinel.manager', $this->app);
+
+        $service = $this->app->make('redis-sentinel.manager');
+
+        $this->assertInstanceOf(RedisFactory::class, $service);
+        $this->assertInstanceOf(RedisSentinelFactory::class, $service);
+    }
+
+    public function testAliasesContractForInjection()
+    {
+        $this->provider->register();
+
+        $this->assertArrayHasKey(RedisSentinelFactory::class, $this->app);
+
+        $service = $this->app->make(RedisSentinelFactory::class);
+
         $this->assertInstanceOf(RedisSentinelManager::class, $service);
         $this->assertInstanceOf(RedisFactory::class, $service);
     }
@@ -96,6 +123,7 @@ public function testRegisterPreservesStandardRedisApi()
         $redisService = $this->app->make('redis');
 
         $this->assertInstanceOf(RedisManager::class, $redisService);
+        $this->assertNotInstanceOf(RedisSentinelManager::class, $redisService);
     }
 
     public function testRegisterOverridesStandardRedisApi()
@@ -107,6 +135,7 @@ public function testRegisterOverridesStandardRedisApi()
         $redisService = $this->app->make('redis');
 
         $this->assertInstanceOf(RedisSentinelManager::class, $redisService);
+        $this->assertInstanceOf(RedisSentinelFactory::class, $redisService);
     }
 
     public function testBootExtendsBroadcastConnections()

tests/VersionedRedisSentinelManagerTest.php

@@ -3,8 +3,10 @@
 namespace Monospice\LaravelRedisSentinel\Tests;
 
 use Closure;
+use Illuminate\Contracts\Redis\Factory as RedisFactory;
 use Illuminate\Redis\RedisManager;
 use InvalidArgumentException;
+use Monospice\LaravelRedisSentinel\Contracts\Factory as RedisSentinelFactory;
 use Monospice\LaravelRedisSentinel\Manager;
 use Monospice\LaravelRedisSentinel\Tests\Support\ApplicationFactory;
 use PHPUnit_Framework_TestCase as TestCase;
@@ -55,6 +57,16 @@ public function testExtendsRedisManagerForSwapability()
         $this->assertInstanceOf(RedisManager::class, $this->manager);
     }
 
+    public function testIsRedisFactory()
+    {
+        $this->assertInstanceOf(RedisFactory::class, $this->manager);
+    }
+
+    public function testIsRedisSentinelFactory()
+    {
+        $this->assertInstanceOf(RedisSentinelFactory::class, $this->manager);
+    }
+
     public function testCreatesSentinelPredisClientsForEachConnection()
     {
         $client1 = $this->manager->connection('connection1');