Add Unleash and Feature facades (#24)

Author: dshafik

.gitignore

@@ -1,4 +1,5 @@
 /vendor
+/.idea
 
 .phpunit.result.cache
 phpunit.xml

README.md

@@ -24,7 +24,6 @@ Documentation for configuration can be found in [config/unleash.php](https://git
 ## Usage
 
 ```php
-
 use \MikeFrancis\LaravelUnleash\Unleash;
 
 $unleash = app(Unleash::class);
@@ -37,9 +36,49 @@ if ($unleash->isFeatureDisabled('myAwesomeFeature')) {
  // Check back later for more features!
 }
 
+$feature = $unleash->getFeature('myAwesomeFeature');
+
 $allFeatures = $unleash->getFeatures();
 ```
 
+### Facades
+
+You can use the `Unleash` facade:
+
+```php
+use Unleash;
+
+if (Unleash::isFeatureEnabled('myAwesomeFeature')) {
+ // Congratulations, you can see this awesome feature!
+}
+
+if (Unleash::isFeatureDisabled('myAwesomeFeature')) {
+ // Check back later for more features!
+}
+
+$feature = Unleash::getFeature('myAwesomeFeature');
+
+$allFeatures = Unleash::getFeatures();
+```
+
+or use the generically named `Feature` facade:
+
+```php
+use Feature;
+
+if (Feature::enabled('myAwesomeFeature')) {
+ // Congratulations, you can see this awesome feature!
+}
+
+if (Feature::disabled('myAwesomeFeature')) {
+ // Check back later for more features!
+}
+
+$feature = Feature::get('myAwesomeFeature');
+
+$allFeatures = Feature::all();
+```
+
 ### Blade
 
 Blade directive for checking if a feature is **enabled**:

composer.json

@@ -32,7 +32,11 @@
  "laravel": {
  "providers": [
  "MikeFrancis\\LaravelUnleash\\ServiceProvider"
- ]
+ ],
+ "aliases": {
+ "Unleash": "MikeFrancis\\LaravelUnleash\\Facades\\Unleash",
+ "Feature": "MikeFrancis\\LaravelUnleash\\Facades\\Feature"
+ }
  }
  }
 }

src/Client.php

@@ -11,7 +11,7 @@ public function __construct(Config $config)
  {
  parent::__construct(
  [
- 'base_uri' => $config->get('unleash.url'),
+  'base_uri' => $config->get('unleash.url'),
  ]
  );
  }

src/Facades/Feature.php

@@ -0,0 +1,32 @@
+<?php
+namespace MikeFrancis\LaravelUnleash\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+class Feature extends Facade
+{
+ public static function enabled(string $feature, ...$args): bool
+ {
+ return static::isFeatureEnabled($feature, ...$args);
+ }
+
+ public static function disabled(string $feature, ...$args): bool
+ {
+ return static::isFeatureDisabled($feature, ...$args);
+ }
+
+ public static function all(): array
+ {
+ return static::getFeatures();
+ }
+
+ public static function get(string $name)
+ {
+ return static::getFeature($name);
+ }
+
+ protected static function getFacadeAccessor()
+ {
+ return 'unleash';
+ }
+}

src/Facades/Unleash.php

@@ -0,0 +1,12 @@
+<?php
+namespace MikeFrancis\LaravelUnleash\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+class Unleash extends Facade
+{
+ protected static function getFacadeAccessor()
+ {
+ return 'unleash';
+ }
+}

src/ServiceProvider.php

@@ -15,6 +15,10 @@ class ServiceProvider extends IlluminateServiceProvider
  public function register()
  {
  $this->mergeConfigFrom($this->getConfigPath(), 'unleash');
+ $this->app->singleton('unleash', function ($app) {
+ $client = $app->make(Client::class);
+ return $app->make(Unleash::class, ['client' => $client]);
+ });
  }
 
  /**
@@ -26,11 +30,10 @@ public function boot()
  {
  $this->publishes(
  [
- $this->getConfigPath() => config_path('unleash.php'),
+  $this->getConfigPath() => config_path('unleash.php'),
  ]
  );
 
-
  Blade::if(
  'featureEnabled',
  function (string $feature) {