README

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:

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

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):

[$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

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

inmanturbo / functional-library

Maintainers

Details