Merge pull request #19 from ericdowell/redis-driver

Redis Toggle Provider

Author: ericdowell

.circleci/config.yml

@@ -3,6 +3,7 @@ jobs:
   build:
     docker:
       - image: ericdowell/laravel-circleci
+      - image: redis:latest
     environment:
       TZ: "/usr/share/zoneinfo/America/Chicago"
     steps:

composer.json

@@ -34,7 +34,6 @@
     },
     "scripts": {
         "test": [
-            "@php vendor/orchestra/testbench-core/create-sqlite-db",
             "phpunit --colors=always"
         ]
     },
@@ -51,6 +50,9 @@
             "dev-master": "1.8-dev"
         }
     },
+    "suggest": {
+        "ext-redis": "Required to use the Redis driver."
+    },
     "config": {
         "preferred-install": "dist",
         "sort-packages": true,

config/feature-toggle.php

@@ -37,7 +37,8 @@
      | status. The first provider to have a feature toggle defined, active
      | or not, will be used as the status value.
      |
-     | Default Drivers: "conditional", "eloquent", "local", "querystring"
+     | Default Drivers: "conditional", "eloquent", "local", "querystring",
+     |                  "redis"
      |
      */
 
@@ -71,15 +72,17 @@
      | Additional Feature Toggle Drivers
      |--------------------------------------------------------------------------
      |
-     | Classmap of drivers to load within the 'feature-api.*' container namespace.
+     | Classmap of drivers that can be used in the "providers" config key above.
+     | Drivers will be registered within the 'feature-api.*' container namespace.
      |
      | The driver class must implement FeatureToggle\Contracts\ToggleProvider.
      |
-     | By default the following drivers are loaded:
+     | By default the following drivers are registered:
      | - 'conditional' => \FeatureToggle\ConditionalToggleProvider::class,
      | - 'eloquent' => \FeatureToggle\EloquentToggleProvider::class,
      | - 'local' => \FeatureToggle\LocalToggleProvider::class,
      | - 'querystring' => \FeatureToggle\QueryStringToggleProvider::class,
+     | - 'redis' => \FeatureToggle\RedisToggleProvider::class,
      |
      */
 

helpers.php

@@ -1,16 +1,24 @@
 <?php
 
 use FeatureToggle\Api;
+use FeatureToggle\Concerns\Toggle;
 use FeatureToggle\Contracts\Api as FeatureToggleApi;
-use FeatureToggle\Traits\Toggle;
 
 if (! function_exists('feature_toggle_api')) {
     /**
+     * @param  string|null  $provider
      * @return FeatureToggleApi|Api
+     * @throws RuntimeException
      */
-    function feature_toggle_api()
+    function feature_toggle_api(?string $provider = null)
     {
-        return app(FeatureToggleApi::class);
+        /** @var FeatureToggleApi|Api $featureToggleApi */
+        $featureToggleApi = app(FeatureToggleApi::class);
+        if (! $provider) {
+            return $featureToggleApi;
+        }
+
+        return $featureToggleApi->getProvider($provider);
     }
 }
 

phpunit.xml

@@ -41,6 +41,6 @@
         <env name="APP_ENV" value="testing"/>
         <env name="APP_DEBUG" value="true"/>
         <env name="APP_KEY" value="base64:oPF0DoJcm8nOjTkN9vk3kZYw6Z0f+cP+poFKhtQZiFU="/>
-        <env name="DB_CONNECTION" value="sqlite"/>
+        <env name="DB_CONNECTION" value="testing"/>
     </php>
 </phpunit>

readme.md

@@ -35,6 +35,7 @@ A simple feature toggle api for Laravel applications.
     - [QueryString Toggle Provider](#querystring-toggle-provider)
         - [Configure Query String Keys](#configure-query-string-keys)
         - [Add Api Key Authorization](#add-api-key-authorization)
+    - [Redis Toggle Provider](#redis-toggle-provider)
 - [Frontend Feature Toggle Api](#frontend-feature-toggle-api)
 - [Road Map](#road-map)
 
@@ -115,7 +116,7 @@ Or you can use the normal `@if` blade directive and call `feature_toggle` functi
 @endif
 // OR
 @if(feature_toggle('Example', 'off'))
-    // do soemthing
+    // do something
 @endif
 ```
 
@@ -207,6 +208,7 @@ The default feature toggle providers are as follows:
 - `eloquent`
 - `local` (config)
 - `querystring`
+- `redis`
 
 You can access these directly via:
 ```php
@@ -420,12 +422,38 @@ may configure the driver with a `token`/api key. By default the query string inp
     [
         'driver' => 'querystring',
         'apiKey' => env('FEATURE_TOGGLE_API_KEY'),
-        // Optionally change to sometihing different than 'feature_token'.
+        // Optionally change to something different.
         // 'apiInputKey' => 'feature_toggle_api_token',
     ],
 ],
 ```
 
+### Redis Toggle Provider
+To use the `redis` driver you will need to update the `feature-toggle` config/`setProviders` method call,
+place the following within the `providers` key:
+```php
+'providers' => [
+    [
+        'driver' => 'redis',
+    ],
+],
+```
+
+There are three options that can be configured:
+- `key`, defaults to `feature_toggles`
+- `prefix`, defaults to `null`
+- `connection`, defaults to `default`
+```php
+'providers' => [
+    [
+        'driver' => 'querystring',
+        'key' => 'toggles', // Optional, otherwise 'feature_toggles'
+        'prefix' => 'feature', // Optional
+        'connection' => 'toggles', // Must match key in database.redis.{connection}
+    ],
+],
+```
+
 ## Frontend Feature Toggle Api
 Place the following in your main layout blade template in the `<head>` tag.
 ```blade
@@ -501,4 +529,6 @@ class App extends Component {
     - [x] Blade
     - [x] Middleware
     - [x] Validation
+- [ ] Create/update toggles via common contract interface.
+- [ ] Create Command to create/update toggles to be active/inactive.
 - [ ] Classmap Feature Toggles (FeatureToggleServiceProvider similar to AuthServiceProvider $policies).

src/Api.php

@@ -4,11 +4,11 @@
 
 namespace FeatureToggle;
 
+use FeatureToggle\Concerns\HasStaticOptions;
+use FeatureToggle\Concerns\ToggleProvider;
 use FeatureToggle\Contracts\Api as ApiContract;
 use FeatureToggle\Contracts\Toggle as ToggleContract;
 use FeatureToggle\Contracts\ToggleProvider as ToggleProviderContract;
-use FeatureToggle\Traits\HasStaticOptions;
-use FeatureToggle\Traits\ToggleProvider;
 use Illuminate\Contracts\Container\BindingResolutionException;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
@@ -117,6 +117,14 @@ public function getQueryStringProvider(): QueryStringToggleProvider
         return $this->getProvider(QueryStringToggleProvider::NAME);
     }
 
+    /**
+     * @return ToggleProviderContract|RedisToggleProvider
+     */
+    public function getRedisProvider(): RedisToggleProvider
+    {
+        return $this->getProvider(RedisToggleProvider::NAME);
+    }
+
     /**
      * @param  string  $name
      * @param  callable  $condition

src/Traits/HasStaticOptions.php src/Concerns/HasStaticOptions.phpsrc/Traits/HasStaticOptions.php renamed to src/Concerns/HasStaticOptions.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace FeatureToggle\Traits;
+namespace FeatureToggle\Concerns;
 
 use Illuminate\Support\Arr;
 

src/Traits/Toggle.php src/Concerns/Toggle.phpsrc/Traits/Toggle.php renamed to src/Concerns/Toggle.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace FeatureToggle\Traits;
+namespace FeatureToggle\Concerns;
 
 /**
  * @property string $name

src/Traits/ToggleProvider.php src/Concerns/ToggleProvider.phpsrc/Traits/ToggleProvider.php renamed to src/Concerns/ToggleProvider.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace FeatureToggle\Traits;
+namespace FeatureToggle\Concerns;
 
 use FeatureToggle\Contracts\Toggle as ToggleContract;
 use FeatureToggle\Contracts\ToggleProvider as ToggleProviderContract;