spekulatius/laravel-powertools

A personal collection of Laravel Helpers, my powertools.

0.3.2 2023-08-07 10:21 UTC

This package is auto-updated.

Last update: 2024-11-07 13:13:47 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

This is a personal collection of handy helpers, tools, and utilities that I've used across various Laravel projects. However, please note that these are intended for personal use and development, so please use at your own risk.

Features

maskSensitiveData: Collection Makro to mask sensitive data

maskSensitiveData Laravel Collection macro and provides the functionality to mask sensitive data in a collection. The macro prepares masked fields regular expressions for use, and applies the mask to the sensitive data based on the regexes and custom fields. It maps over the collection and replaces any data matching the regular expressions with a mask value of [masked]. This functionality is useful when dealing with collections of sensitive data and is designed to keep the sensitive data secure.

Usage:

collect(['password' => 'this really should not be logged...'])
  ->maskSensitiveData()
  ->toArray();

// 'password' => '[masked]'

ToLog: Model Trait to log context

The ToLog trait is a simple trait to add to models that allows you to summarize model data as logging context. It's essentially a slimmed-down version of the ->toArray() method, and it's meant to be used in a similar approach similar to \Log::error('....', $entry->toLog());. Already runs maskSensitiveData by design.

SelfDeletingTemporaryDirectory

An extension of Spaties TemporaryDirectory to delete itself after 120 minutes (configurable).

use Spekulatius\LaravelPowertools\Helpers\SelfDeletingTemporaryDirectory;

// ...

$tempDir = new SelfDeletingTemporaryDirectory;

// use like TemporaryDirectory from Spatie.

My common way to use this:

$tempFile = (new SelfDeletingTemporaryDirectory)->create()->path('temp.zip');

Compatibility

This project has been tested on Laravel 10 using PHP 8.1 or 8.2. It should work on Laravel 9 as well, although it has not been tested on that version.

Installation

You can install the package via composer:

composer require spekulatius/laravel-powertools

You can publish the config file with:

php artisan vendor:publish --tag="laravel-powertools-config"

Testing

The project is roughly tested on Laravel 10.

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.