add isOff public method, make getState public

Author: stevethomas

README.md

@@ -77,6 +77,32 @@ if (FeatureFlag::isOn('search-v2')) {
 }
 ```
 
+### Check If A Feature Is Disabled
+#### Blade View
+```php
+@unlessfeature('search-v2')
+    // no new features for you
+@endfeature
+```
+
+#### In Your Code
+```php
+use Codinglabs\FeatureFlags\Facades\FeatureFlag;
+
+if (FeatureFlag::isOff('search-v2')) {
+    // no new features for you
+}
+```
+
+### Get The Underlying Current State
+If you want to know what the underlying `FeatureState` value is:
+```php
+use Codinglabs\FeatureFlags\Facades\FeatureFlag;
+
+// value from Codinglabs\FeatureFlags\Enums\FeatureState
+$featureState = FeatureFlag::getState('search-v2');
+```
+
 ### Updating Feature State
 To change the state of a feature you can call the following methods:
 ```php

src/FeatureFlags.php

@@ -43,7 +43,7 @@ private static function getFeatureModel(string $feature): ?Model
         return null;
     }
 
-    private static function getState(string $feature): FeatureState
+    public static function getState(string $feature): FeatureState
     {
         $featureKey = self::getFeatureCacheKey($feature);
 
@@ -89,6 +89,11 @@ function () use ($feature) {
         };
     }
 
+    public static function isOff(string $feature): bool
+    {
+        return ! self::isOn($feature);
+    }
+
     public static function reset(): void
     {
         self::$dynamicHandlers = [];

tests/FeaturesTest.php

@@ -18,13 +18,20 @@
     FeatureFlag::reset();
 });
 
-it('throws an exception if calling isOn for a feature that does not exist', function () {
+it('throws an exception if calling isOn on a feature that does not exist', function () {
     $this->expectException(MissingFeatureException::class);
 
     FeatureFlag::isOn('some-feature');
     expect(cache()->store('array')->get('testing.some-feature'))->toBeNull();
 });
 
+it('throws an exception if calling isOff on a feature that does not exist', function () {
+    $this->expectException(MissingFeatureException::class);
+
+    FeatureFlag::isOff('some-feature');
+    expect(cache()->store('array')->get('testing.some-feature'))->toBeNull();
+});
+
 it('generates the correct cache key', function () {
     config(['feature-flags.cache_prefix' => 'some-prefix']);
 
@@ -37,6 +44,7 @@
     });
 
     expect(FeatureFlag::isOn('some-feature'))->toBeFalse();
+    expect(FeatureFlag::isOff('some-feature'))->toBeTrue();
     expect(cache()->store('array')->get('testing.some-feature'))->toBeNull();
 });
 
@@ -47,6 +55,7 @@
     ]);
 
     expect(FeatureFlag::isOn('some-feature'))->toBeFalse();
+    expect(FeatureFlag::isOff('some-feature'))->toBeTrue();
     expect(cache()->store('array')->get('testing.some-feature'))->toBe(FeatureState::off()->value);
 });
 
@@ -57,6 +66,7 @@
     ]);
 
     expect(FeatureFlag::isOn('some-feature'))->toBeTrue();
+    expect(FeatureFlag::isOff('some-feature'))->toBeFalse();
     expect(cache()->store('array')->get('testing.some-feature'))->toBe(FeatureState::on()->value);
 });
 
@@ -71,6 +81,7 @@
     });
 
     expect(FeatureFlag::isOn('some-feature'))->toBeTrue();
+    expect(FeatureFlag::isOff('some-feature'))->toBeFalse();
     expect(cache()->store('array')->get('testing.some-feature'))->toBe(FeatureState::dynamic()->value);
 });
 
@@ -85,6 +96,7 @@
     });
 
     expect(FeatureFlag::isOn('some-feature'))->toBeFalse();
+    expect(FeatureFlag::isOff('some-feature'))->toBeTrue();
     expect(cache()->store('array')->get('testing.some-feature'))->toBe(FeatureState::dynamic()->value);
 });
 
@@ -99,6 +111,7 @@
     });
 
     expect(FeatureFlag::isOn('some-feature'))->toBeTrue();
+    expect(FeatureFlag::isOff('some-feature'))->toBeFalse();
     expect(cache()->store('array')->get('testing.some-feature'))->toBe(FeatureState::dynamic()->value);
 });
 
@@ -109,6 +122,26 @@
     ]);
 
     expect(FeatureFlag::isOn('some-feature'))->toBeFalse();
+    expect(FeatureFlag::isOff('some-feature'))->toBeTrue();
+});
+
+it('resolves the current state', function () {
+    Feature::factory()->create([
+        'name' => 'some-off-feature',
+        'state' => FeatureState::off()
+    ]);
+    Feature::factory()->create([
+        'name' => 'some-dynamic-feature',
+        'state' => FeatureState::dynamic()
+    ]);
+    Feature::factory()->create([
+        'name' => 'some-on-feature',
+        'state' => FeatureState::on()
+    ]);
+
+    expect(FeatureFlag::getState('some-off-feature'))->toBe(FeatureState::off());
+    expect(FeatureFlag::getState('some-dynamic-feature'))->toBe(FeatureState::dynamic());
+    expect(FeatureFlag::getState('some-on-feature'))->toBe(FeatureState::on());
 });
 
 it('can update a features state', function () {
@@ -125,6 +158,7 @@
 
     Event::assertDispatched(\Codinglabs\FeatureFlags\Events\FeatureUpdatedEvent::class);
     expect(FeatureFlag::isOn('some-feature'))->toBeTrue();
+    expect(FeatureFlag::isOff('some-feature'))->toBeFalse();
     expect(cache()->store('array')->get('testing.some-feature'))->toBe(FeatureState::on()->value);
 });