Merge pull request #4 from Jaspaul/feature/database-storage

[Feature] Database Storage

Author: Jaspaul

.gitignore

@@ -1,3 +1,4 @@
 vendor
 composer.lock
 .php_cs.cache
+coverage

composer.json

@@ -13,7 +13,9 @@
     "require": {
         "php": ">=7.0",
         "illuminate/cache": "^5.3",
+        "illuminate/config": "^5.3",
         "illuminate/console": "^5.3",
+        "illuminate/database": "^5.3",
         "illuminate/support": "^5.3",
         "opensoft/rollout": "^2.2"
     },

phpunit.xml

@@ -18,4 +18,7 @@
             <directory suffix=".php">./src/</directory>
         </whitelist>
     </filter>
+    <php>
+        <env name="APP_KEY" value="^J#@5t24wEugLfkEQRJ6W042heex66YA"/>
+    </php>
 </phpunit>

readme.md

@@ -12,10 +12,6 @@ A Laravel package for [opensoft/rollout](https://github.com/opensoft/rollout)
 composer require jaspaul/laravel-rollout
 ```
 
-### Setting up a Cache
-
-Be sure to [enable the cache](https://laravel.com/docs/5.4/cache) for your Laravel application. This package uses the cache to store the rollout settings.
-
 ### Configuring the Service Provider
 
 Open config/app.php and register the required service provider above your application providers.
@@ -28,6 +24,35 @@ Open config/app.php and register the required service provider above your applic
 ]
 ```
 
+### Setting up Storage
+
+#### Publish the Configuration
+
+```sh
+php artisan vendor:publish --provider 'Jaspaul\LaravelRollout\ServiceProvider'
+```
+
+#### Setting up a Cache
+
+If you intend to use cache to store the settings for rollout, be sure to [enable the cache](https://laravel.com/docs/5.4/cache) for your Laravel application. Note if you are using the cache, a cache clear during deployment will cause your rollout settings to be purged. If you require persistence for these settings use the option below.
+
+#### Setting up Persistent Storage
+
+This will allow you to have rollout settings be persisted even if you clear the application cache for every deployment.
+
+##### Running the Migrations
+
+```sh
+php artisan migrate
+```
+
+##### Configuring your Environment
+
+```
+ROLLOUT_STORAGE=database
+ROLLOUT_TABLE=rollout
+```
+
 ### Implementing Interfaces
 
 Your rollout users must implement the `\Jaspaul\LaravelRollout\Helpers\User` interface. Often this will be your main user object:

resources/config/laravel-rollout.php

@@ -0,0 +1,6 @@
+<?php
+
+return [
+    'storage' => env('ROLLOUT_STORAGE', 'cache'),
+    'table' => env('ROLLOUT_TABLE', 'rollout')
+];

resources/migrations/2017_05_24_000000_create_rollout_table.php

@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateRolloutTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('rollout', function (Blueprint $table) {
+            $table->string('key')->unique();
+            $table->text('value');
+            $table->integer('expiration');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('rollout');
+    }
+}

src/ServiceProvider.php

@@ -3,12 +3,17 @@
 namespace Jaspaul\LaravelRollout;
 
 use Opensoft\Rollout\Rollout;
+use Illuminate\Cache\Repository;
+use Illuminate\Cache\DatabaseStore;
 use Jaspaul\LaravelRollout\Drivers\Cache;
+use Illuminate\Database\ConnectionInterface;
+use Illuminate\Contracts\Encryption\Encrypter;
 use Jaspaul\LaravelRollout\Console\ListCommand;
 use Jaspaul\LaravelRollout\Console\CreateCommand;
 use Jaspaul\LaravelRollout\Console\DeleteCommand;
 use Jaspaul\LaravelRollout\Console\AddUserCommand;
 use Jaspaul\LaravelRollout\Console\EveryoneCommand;
+use Illuminate\Contracts\Config\Repository as Config;
 use Jaspaul\LaravelRollout\Console\DeactivateCommand;
 use Jaspaul\LaravelRollout\Console\PercentageCommand;
 use Jaspaul\LaravelRollout\Console\RemoveUserCommand;
@@ -23,8 +28,25 @@ class ServiceProvider extends IlluminateServiceProvider
      */
     public function boot()
     {
+        $this->publishConfigurations();
+
+        $this->loadMigrations();
+
         $this->app->singleton(Rollout::class, function ($app) {
-            return new Rollout(new Cache($app->make('cache.store')));
+            $config = $app->make(Config::class);
+
+            if ($config->get('laravel-rollout.storage') === 'database') {
+                $connection = $app->make(ConnectionInterface::class);
+                $encrypter = $app->make(Encrypter::class);
+                $table = $config->get('laravel-rollout.table');
+
+                $repository = new Repository(new DatabaseStore($connection, $encrypter, $table));
+                $driver = new Cache($repository);
+            } else {
+                $driver = new Cache($app->make('cache.store'));
+            }
+
+            return new Rollout($driver);
         });
 
         $this->commands([
@@ -38,4 +60,26 @@ public function boot()
             RemoveUserCommand::class
         ]);
     }
+
+    /**
+     * Adds our configuration file to the publishes array.
+     *
+     * @return void
+     */
+    protected function publishConfigurations()
+    {
+        $this->publishes([
+            __DIR__.'/../resources/config/laravel-rollout.php' => config_path('laravel-rollout.php'),
+        ]);
+    }
+
+    /**
+     * Loads our migrations.
+     *
+     * @return void
+     */
+    protected function loadMigrations()
+    {
+        $this->loadMigrationsFrom(__DIR__.'/../resources/migrations');
+    }
 }

tests/ServiceProviderTest.php

@@ -7,11 +7,14 @@
 use Illuminate\Container\Container;
 use Illuminate\Contracts\Cache\Repository;
 use Jaspaul\LaravelRollout\ServiceProvider;
+use Illuminate\Database\ConnectionInterface;
+use Illuminate\Contracts\Encryption\Encrypter;
 use Jaspaul\LaravelRollout\Console\ListCommand;
 use Jaspaul\LaravelRollout\Console\CreateCommand;
 use Jaspaul\LaravelRollout\Console\DeleteCommand;
 use Jaspaul\LaravelRollout\Console\AddUserCommand;
 use Jaspaul\LaravelRollout\Console\EveryoneCommand;
+use Illuminate\Contracts\Config\Repository as Config;
 use Jaspaul\LaravelRollout\Console\DeactivateCommand;
 use Jaspaul\LaravelRollout\Console\PercentageCommand;
 use Jaspaul\LaravelRollout\Console\RemoveUserCommand;
@@ -43,8 +46,17 @@ function ensure_a_service_provider_can_be_constructed()
     /**
      * @test
      */
-    function booting_registers_a_rollout_singleton_into_the_container()
+    function booting_registers_a_cache_backed_rollout_singleton_into_the_container()
     {
+        $this->container->singleton(Config::class, function ($app) {
+            $config = Mockery::mock(Config::class);
+            $config->shouldReceive('get')
+                ->with('laravel-rollout.storage')
+                ->andReturn('cache');
+
+            return $config;
+        });
+
         $this->container->singleton('cache.store', function ($app) {
             return Mockery::mock(Repository::class);
         });
@@ -58,12 +70,40 @@ function booting_registers_a_rollout_singleton_into_the_container()
     /**
      * @test
      */
-    function booting_registers_our_commands()
+    function booting_registers_a_database_backed_rollout_singleton_into_the_container()
     {
-        $this->container->singleton('cache.store', function ($app) {
-            return Mockery::mock(Repository::class);
+        $this->container->singleton(Config::class, function ($app) {
+            $config = Mockery::mock(Config::class);
+            $config->shouldReceive('get')
+                ->with('laravel-rollout.storage')
+                ->andReturn('database');
+
+            $config->shouldReceive('get')
+                ->with('laravel-rollout.table')
+                ->andReturn('rollout');
+
+            return $config;
+        });
+
+        $this->container->singleton(ConnectionInterface::class, function ($app) {
+            return Mockery::mock(ConnectionInterface::class);
+        });
+
+        $this->container->singleton(Encrypter::class, function ($app) {
+            return Mockery::mock(Encrypter::class);
         });
 
+        $this->serviceProvider->boot();
+
+        $result = $this->container->make(Rollout::class);
+        $this->assertInstanceOf(Rollout::class, $result);
+    }
+
+    /**
+     * @test
+     */
+    function booting_registers_our_commands()
+    {
         $serviceProvider = new TestServiceProvider($this->container);
         $serviceProvider->boot();