Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[1.x] Add ability to resolve feature instance. #118

Merged
merged 2 commits into from
Aug 7, 2024
Merged

[1.x] Add ability to resolve feature instance. #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d56d0c5
Enable retrieval of feature implementation
timacdonald Aug 6, 2024
b63a2bc
Formatting
timacdonald Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions src/Drivers/Decorator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,13 @@ class Decorator implements CanListStoredFeatures, Driver
*/
protected $cache;

/**
* Map of feature names to their implementations.
*
* @var array<string, mixed>
*/
protected $nameMap = [];

/**
* Create a new driver decorator instance.
*
Expand Down Expand Up @@ -122,6 +129,10 @@ public function define($feature, $resolver = null): void
$this->container->make($feature)->name ?? $feature,
new LazilyResolvedFeature($feature),
];

$this->nameMap[$feature] = $resolver->feature;
} else {
$this->nameMap[$feature] = $resolver;
}

$this->driver->define($feature, function ($scope) use ($feature, $resolver) {
Expand Down Expand Up @@ -488,6 +499,27 @@ public function name($feature)
return $this->resolveFeature($feature);
}

/**
* Retrieve the feature's class.
*
* @param string $feature
* @return mixed
*/
public function instance($name)
{
$feature = $this->nameMap[$name] ?? $name;

if (is_string($feature) && class_exists($feature)) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be amazing if we could add an enum check here as well 😄

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would that do, @cosmastech?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I misunderstood this, disregard:

Would love to have the ability to call Feature::define(FeatureFlagEnum::NewFeature, fn() => false), but maybe that's not really what this PR is aiming for.

return $this->container->make($feature);
}

if ($feature instanceof Closure || $feature instanceof Lottery) {
return $feature;
}

return fn () => $feature;
}

/**
* Resolve the feature name and ensure it is defined.
*
Expand Down
24 changes: 24 additions & 0 deletions tests/Feature/ArrayDriverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace Tests\Feature;

use Closure;
use Illuminate\Container\Container;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Config;
Expand Down Expand Up @@ -1154,6 +1155,29 @@ public function test_it_can_list_stored_features()

$this->assertSame(Feature::stored(), ['bar']);
}

public function test_it_can_resolve_feature_instance()
{
Feature::define(MyFeature::class);
$this->assertInstanceOf(MyFeature::class, Feature::instance('my-feature'));
$this->assertInstanceOf(MyFeature::class, Feature::instance(MyFeature::class));

Feature::define(MyUnnamedFeature::class);
$this->assertInstanceOf(MyUnnamedFeature::class, Feature::instance(MyUnnamedFeature::class));

Feature::define('closure-based-feature', $closure = fn () => true);
$this->assertSame($closure, Feature::instance('closure-based-feature'));

Feature::define('value-based-feature', '123');
$feature = Feature::instance('value-based-feature');
$this->assertInstanceOf(Closure::class, $feature);
$this->assertSame('123', $feature());

Feature::define('lottery-based-feature', Lottery::odds(1, 1)->winner(fn () => '345'));
$feature = Feature::instance('lottery-based-feature');
$this->assertInstanceOf(Lottery::class, $feature);
$this->assertSame('345', $feature());
}
}

class MyFeature
Expand Down