Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inmanturbo/functional-library
https://github.com/inmanturbo/functional-library
Last synced: 9 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/inmanturbo/functional-library
- Owner: inmanturbo
- License: mit
- Created: 2024-08-12T17:11:57.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-19T21:59:47.000Z (3 months ago)
- Last Synced: 2024-10-14T05:25:21.556Z (25 days ago)
- Language: PHP
- Size: 36.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# create closure libraries with ease for functional programming with php
[](https://packagist.org/packages/inmanturbo/functional-library)
[](https://github.com/inmanturbo/functional-library/actions/workflows/run-tests.yml)
[](https://packagist.org/packages/inmanturbo/functional-library)
This package makes it easy to export and autoload a library of anonymous functions or collections of anonymous functions using composer.
## Installation
You can install the package via composer:
```bash
composer require inmanturbo/functional-library
```
## Usage
To create a library you can use the `HasFunctionalLibrary` trait, then you just have to implement
a static library method with named bool parameters for your available functions.
You then call `static::getLibrary` with all your parameters as its `args`.
Finally, you create a static method called `closures()` with an associative array of your anonymous
functions with (string) keys corresponding to your library method's named params.
## Example
```php
use Inmanturbo\FunctionalLibrary\HasFunctionalLibrary;
class ExampleLibrary
{
use HasFunctionalLibrary;
public static function library(bool $addOne = false, bool $addTwo = false)
{
return static::getLibrary(...func_get_args());
}
public static function closures()
{
return [
'addOne' => fn(int $number): int => $number + 1,
'addTwo' => fn(int $number): int => $number + 2,
];
}
}
```
## Example Usage
The above example creates the following testable api (using pest):
```php
[$addOne, $addTwo] = ExampleLibrary::library(addOne: true, addTwo: true);
expect($addOne(0))->toBe(1);
expect($addTwo(0))->toBe(2);
// Test a single option
$addOne = ExampleLibrary::library(addOne: true);
expect($addOne(0))->toBe(1);
// Test no options (should return all available options)
[$addOne, $addTwo] = ExampleLibrary::library();
expect($addOne(0))->toBe(1);
expect($addTwo(0))->toBe(2);
```
Now you can put your anonymous functions into scoped static libraries and find them using static analysis by their named arguments, or by inspecting the `closures()` method's return value.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [inmanturbo](https://github.com/inmanturbo)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.