TDP-1887 Improve documentation.

Author: derekrprice

.gitignore

@@ -23,3 +23,4 @@ Homestead.json
 .phpunit.result.cache
 
 /.vscode/
+junit.xml

README.md

@@ -1 +1,44 @@
-# laravel-feature-toggle
+# Abstract Feature Flags from Providers
+This package allows you to implement feature flags in Laravel.  Right now the only supported implementation is split.io.
+
+## Basic Usage
+### Change Behavior Based on a Flag
+    use PartechGSS\Laravel\FeatureToggle\Contracts\FeatureToggleClient;
+
+    $client = resolve(FeatureToggleClient::class);
+    switch ($client->getTreatment('my_flag')) {
+        case "on":
+            do_a_thing();
+            break;
+
+        default:
+            do_another_thing();
+            break;
+    }
+
+### Retrieve Configuration Attached to a Treatment
+    $treatmentWithConfig = $client->getTreatmentWithConfig('my_flag');
+    $treatment = $treatmentWithConfig['treatment'];
+    $config = $treatmentWithConfig['config'];
+    set_some_css_options($config);
+
+### Retrieve Multiple Flags in a Batch
+    $treatments = $client->getTreatments(['my_flag', 'another_flag']);
+    switch($treatments['my_flag']) {
+        ...
+    }
+
+### Retrieve Configurations in a Batch
+    $treatmentsWithConfig = $client->getTreatmentsWithConfig('my_flag');
+    $treatment = $treatmentsWithConfig['my_flag']['treatment'];
+    $config = $treatmentsWithConfig['my_flgag']['config'];
+    set_some_css_options($config);
+
+## Installation
+You can install the package via Composer:
+
+    composer require partechgss/laravel-feature-toggles
+
+## Testing
+
+    composer test

composer.json

@@ -15,6 +15,9 @@
         "orchestra/testbench": "^5.3",
         "phpunit/phpunit": "^9.2"
     },
+    "scripts": {
+        "test": "phpunit"
+    },
     "extra": {
         "laravel": {
             "providers": [

config/feature-toggle.php

@@ -22,7 +22,7 @@
                 ]
             ],
 
-            'log' => ['adapter' => 'stdout', 'level' => 'error']
+            'log' => ['adapter' => 'syslog', 'level' => 'error']
         ]
     ]
 ];

phpunit.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <php>
+        <server name="APP_ENV" value="testing"/>
+        <server name="BCRYPT_ROUNDS" value="4"/>
+        <server name="CACHE_DRIVER" value="array"/>
+        <server name="MAIL_DRIVER" value="array"/>
+        <server name="QUEUE_CONNECTION" value="sync"/>
+        <server name="SESSION_DRIVER" value="array"/>
+    </php>
+    <logging>
+        <log type="junit" target="./junit.xml"/>
+    </logging>
+</phpunit>

tests/SplitIOTest.php

@@ -23,16 +23,29 @@ protected function getPackageProviders($app)
      */
     public function it_renders_the_control_treatment() {
         $toggleClient = app(FeatureToggleClient::class);
+        $toggleClient->setKey("[email protected]");
         $this->assertEquals("control", $toggleClient->getTreatment("AintNoSuchFlag"));
     }
 
+    /**
+     * Test that the control treatment is returned when the user has not been set.
+     * @test
+     * @return void
+     */
+    public function it_renders_the_control_treatment_without_key() {
+        config()->set('feature-toggle.splitio.factory.log.adapter', 'void');
+        $toggleClient = app(FeatureToggleClient::class);
+        $this->assertEquals("control", $toggleClient->getTreatment("FancyFeatureFlag"));
+    }
+
     /**
      * Test that an 'off' treatment can be returned.
      * @test
      * @return void
      */
     public function it_renders_an_off_treatment() {
         $toggleClient = app(FeatureToggleClient::class);
+        $toggleClient->setKey("[email protected]");
         $this->assertEquals("off", $toggleClient->getTreatment("FancyFeatureFlag"));
     }