Skip to content

Commit 0278eec

Browse files
guanguansguanguans
committed
refactor(collectors): Replace function calls with Utils methods
- Refactor memory size and duration formatting by utilizing Utils methods. - Replace direct calls to human_bytes and human_milliseconds with their corresponding methods from the Utils class for improved readability and maintainability. - This change standardizes usage of utility functions across the application.
1 parent 59fb318 commit 0278eec

25 files changed

+202
-193
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ vendor/
88
.phpunit.result.cache
99
clover.xml
1010
composer.lock
11+
laravel
1112
phpunit.xml
1213
psalm.xml
1314
tests.*

‎rector.php‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -153,18 +153,20 @@
153153
'phpstan-ignore-next-line',
154154
'psalm-suppress',
155155
])
156-
->withConfiguredRule(MethodCallToStaticCallRector::class, [
157-
new MethodCallToStaticCall(AbstractChannel::class, 'applyContentToConfiguration', Utils::class, 'applyContentToConfiguration'),
158-
new MethodCallToStaticCall(AbstractChannel::class, 'applyConfigurationToObject', Utils::class, 'applyConfigurationToObject'),
159-
])
156+
// ->withConfiguredRule(MethodCallToStaticCallRector::class, [
157+
// new MethodCallToStaticCall(AbstractChannel::class, 'applyContentToConfiguration', Utils::class, 'applyContentToConfiguration'),
158+
// new MethodCallToStaticCall(AbstractChannel::class, 'applyConfigurationToObject', Utils::class, 'applyConfigurationToObject'),
159+
// ])
160160
->withConfiguredRule(RenameClassRector::class, [
161161
Carbon::class => IlluminateCarbon::class,
162162
])
163163
->withConfiguredRule(StaticCallToFuncCallRector::class, [
164164
new StaticCallToFuncCall(Str::class, 'of', 'str'),
165165
])
166166
// ->withConfiguredRule(FuncCallToStaticCallRector::class, [
167-
// new FuncCallToStaticCall('str', Str::class, 'of'),
167+
// // new FuncCallToStaticCall('str', Str::class, 'of'),
168+
// new FuncCallToStaticCall('Guanguans\\LaravelExceptionNotify\\Support\\human_bytes', Utils::class, 'humanBytes'),
169+
// new FuncCallToStaticCall('Guanguans\\LaravelExceptionNotify\\Support\\human_milliseconds', Utils::class, 'humanMilliseconds'),
168170
// ])
169171
->withConfiguredRule(
170172
ScalarValueToConstFetchRector::class,
@@ -225,16 +227,13 @@ static function (array $carry, mixed $value, string $name) use ($class): array {
225227
'Guanguans\Notify\Foundation\Support\rescue' => 'Guanguans\LaravelExceptionNotify\Support\rescue',
226228
'Pest\Faker\fake' => 'fake',
227229
'Pest\Faker\faker' => 'faker',
228-
'rescue' => 'Guanguans\LaravelExceptionNotify\Support\rescue',
229230
'test' => 'it',
230231
] + array_reduce(
231232
[
232-
'make',
233233
'env_explode',
234234
'json_pretty_encode',
235-
'hydrate_pipe',
236-
'human_bytes',
237-
'human_milliseconds',
235+
'make',
236+
'rescue',
238237
],
239238
static function (array $carry, string $func): array {
240239
/** @see https://github.com/laravel/framework/blob/11.x/src/Illuminate/Support/functions.php */

‎src/Collectors/AbstractCollector.php‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ public function name(): string
2828

2929
public static function fallbackName(): string
3030
{
31-
return ucwords((string) str(class_basename(static::class))
32-
->beforeLast(str(class_basename(self::class))->remove('Abstract'))
33-
->snake(' '));
31+
return str(class_basename(static::class))
32+
->beforeLast('Collector')
33+
->headline()
34+
->toString();
3435
}
3536
}

‎src/Collectors/ApplicationCollector.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313

1414
namespace Guanguans\LaravelExceptionNotify\Collectors;
1515

16+
use Guanguans\LaravelExceptionNotify\Support\Utils;
1617
use Illuminate\Container\Container;
1718
use Illuminate\Support\Carbon;
18-
use function Guanguans\LaravelExceptionNotify\Support\human_bytes;
1919

2020
class ApplicationCollector extends AbstractCollector
2121
{
@@ -35,7 +35,7 @@ public function collect(): array
3535
'debug' => $this->container->hasDebugModeEnabled(),
3636
'locale' => $this->container->getLocale(),
3737
'in console' => $this->container->runningInConsole(),
38-
'memory' => human_bytes(memory_get_peak_usage(true)),
38+
'memory' => Utils::humanBytes(memory_get_peak_usage(true)),
3939
];
4040
}
4141
}

‎src/Collectors/RequestBasicCollector.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313

1414
namespace Guanguans\LaravelExceptionNotify\Collectors;
1515

16+
use Guanguans\LaravelExceptionNotify\Support\Utils;
1617
use Illuminate\Http\Request;
17-
use function Guanguans\LaravelExceptionNotify\Support\human_milliseconds;
1818

1919
class RequestBasicCollector extends AbstractCollector
2020
{
@@ -29,7 +29,7 @@ public function collect(): array
2929
'controller action' => $this->request->route()?->getActionName(),
3030
'duration' => blank($startTime = \defined('LARAVEL_START') ? LARAVEL_START : $this->request->server('REQUEST_TIME_FLOAT'))
3131
? 'Unknown'
32-
: human_milliseconds((microtime(true) - $startTime) * 1000),
32+
: Utils::humanMilliseconds((microtime(true) - $startTime) * 1000),
3333
];
3434
}
3535
}

‎src/Collectors/RequestFileCollector.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313

1414
namespace Guanguans\LaravelExceptionNotify\Collectors;
1515

16+
use Guanguans\LaravelExceptionNotify\Support\Utils;
1617
use Illuminate\Http\Request;
1718
use Illuminate\Http\UploadedFile;
18-
use function Guanguans\LaravelExceptionNotify\Support\human_bytes;
1919

2020
class RequestFileCollector extends AbstractCollector
2121
{
@@ -33,7 +33,7 @@ public function collect(): array
3333
'name' => $uploadedFile->getClientOriginalName(),
3434
'type' => $uploadedFile->getMimeType(),
3535
'error' => $uploadedFile->getError(),
36-
'size' => human_bytes($uploadedFile->getSize()),
36+
'size' => Utils::humanBytes($uploadedFile->getSize()),
3737
];
3838
});
3939

‎src/Support/Utils.php‎

Lines changed: 41 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,6 @@
1919

2020
class Utils
2121
{
22-
public static function applyContentToConfiguration(array $configuration, string $content): array
23-
{
24-
array_walk_recursive($configuration, static function (mixed &$value) use ($content): void {
25-
\is_string($value) and $value = str_replace(
26-
[Template::TITLE, Template::CONTENT],
27-
[config('exception-notify.title'), $content],
28-
$value
29-
);
30-
});
31-
32-
return $configuration;
33-
}
34-
3522
public static function applyConfigurationToObject(object $object, array $configuration, ?array $except = null): object
3623
{
3724
return collect($configuration)
@@ -92,4 +79,45 @@ public static function applyConfigurationToObject(object $object, array $configu
9279
return $extender($object);
9380
});
9481
}
82+
83+
public static function applyContentToConfiguration(array $configuration, string $content): array
84+
{
85+
array_walk_recursive($configuration, static function (mixed &$value) use ($content): void {
86+
\is_string($value) and $value = str_replace(
87+
[Template::TITLE, Template::CONTENT],
88+
[config('exception-notify.title'), $content],
89+
$value
90+
);
91+
});
92+
93+
return $configuration;
94+
}
95+
96+
/**
97+
* @see https://stackoverflow.com/a/23888858/1580028
98+
*/
99+
public static function humanBytes(int $bytes, int $decimals = 2): string
100+
{
101+
$size = ['B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
102+
$factor = (int) floor((\strlen((string) $bytes) - 1) / 3);
103+
104+
if (0 === $factor) {
105+
$decimals = 0;
106+
}
107+
108+
return \sprintf("%.{$decimals}f %s", $bytes / (1024 ** $factor), $size[$factor]);
109+
}
110+
111+
public static function humanMilliseconds(float $milliseconds, int $precision = 2): string
112+
{
113+
if (1 > $milliseconds) {
114+
return \sprintf('%s μs', round($milliseconds * 1000, $precision));
115+
}
116+
117+
if (1000 > $milliseconds) {
118+
return \sprintf('%s ms', round($milliseconds, $precision));
119+
}
120+
121+
return \sprintf('%s s', round($milliseconds / 1000, $precision));
122+
}
95123
}

‎src/Support/helpers.php‎

Lines changed: 32 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,38 @@
1717
use Illuminate\Support\Arr;
1818
use Illuminate\Support\Facades\Log;
1919

20+
if (!\function_exists('Guanguans\LaravelExceptionNotify\Support\env_explode')) {
21+
/**
22+
* @noinspection LaravelFunctionsInspection
23+
*/
24+
function env_explode(string $key, mixed $default = null, string $delimiter = ',', int $limit = \PHP_INT_MAX): mixed
25+
{
26+
$env = env($key, $default);
27+
28+
if (\is_string($env)) {
29+
return $env ? explode($delimiter, $env, $limit) : [];
30+
}
31+
32+
return $env;
33+
}
34+
}
35+
36+
if (!\function_exists('Guanguans\LaravelExceptionNotify\Support\json_pretty_encode')) {
37+
/**
38+
* @param int<1, 4194304> $depth
39+
*
40+
* @throws \JsonException
41+
*/
42+
function json_pretty_encode(mixed $value, int $options = 0, int $depth = 512): string
43+
{
44+
return json_encode(
45+
$value,
46+
\JSON_PRETTY_PRINT | \JSON_UNESCAPED_UNICODE | \JSON_UNESCAPED_SLASHES | \JSON_THROW_ON_ERROR | \JSON_FORCE_OBJECT | $options,
47+
$depth
48+
);
49+
}
50+
}
51+
2052
if (!\function_exists('Guanguans\LaravelExceptionNotify\Support\make')) {
2153
/**
2254
* @see https://github.com/laravel/framework/blob/12.x/src/Illuminate/Foundation/helpers.php
@@ -80,67 +112,3 @@ function rescue(callable $callback, mixed $rescue = null, mixed $log = true): mi
80112
}
81113
}
82114
}
83-
84-
if (!\function_exists('Guanguans\LaravelExceptionNotify\Support\env_explode')) {
85-
/**
86-
* @noinspection LaravelFunctionsInspection
87-
*/
88-
function env_explode(string $key, mixed $default = null, string $delimiter = ',', int $limit = \PHP_INT_MAX): mixed
89-
{
90-
$env = env($key, $default);
91-
92-
if (\is_string($env)) {
93-
return $env ? explode($delimiter, $env, $limit) : [];
94-
}
95-
96-
return $env;
97-
}
98-
}
99-
100-
if (!\function_exists('Guanguans\LaravelExceptionNotify\Support\json_pretty_encode')) {
101-
/**
102-
* @param int<1, 4194304> $depth
103-
*
104-
* @throws \JsonException
105-
*/
106-
function json_pretty_encode(mixed $value, int $options = 0, int $depth = 512): string
107-
{
108-
return json_encode(
109-
$value,
110-
\JSON_PRETTY_PRINT | \JSON_UNESCAPED_UNICODE | \JSON_UNESCAPED_SLASHES | \JSON_THROW_ON_ERROR | \JSON_FORCE_OBJECT | $options,
111-
$depth
112-
);
113-
}
114-
}
115-
116-
if (!\function_exists('Guanguans\LaravelExceptionNotify\Support\human_bytes')) {
117-
/**
118-
* @see https://stackoverflow.com/a/23888858/1580028
119-
*/
120-
function human_bytes(int $bytes, int $decimals = 2): string
121-
{
122-
$size = ['B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
123-
$factor = (int) floor((\strlen((string) $bytes) - 1) / 3);
124-
125-
if (0 === $factor) {
126-
$decimals = 0;
127-
}
128-
129-
return \sprintf("%.{$decimals}f %s", $bytes / (1024 ** $factor), $size[$factor]);
130-
}
131-
}
132-
133-
if (!\function_exists('Guanguans\LaravelExceptionNotify\Support\human_milliseconds')) {
134-
function human_milliseconds(float $milliseconds, int $precision = 2): string
135-
{
136-
if (1 > $milliseconds) {
137-
return \sprintf('%s μs', round($milliseconds * 1000, $precision));
138-
}
139-
140-
if (1000 > $milliseconds) {
141-
return \sprintf('%s ms', round($milliseconds, $precision));
142-
}
143-
144-
return \sprintf('%s s', round($milliseconds / 1000, $precision));
145-
}
146-
}

‎tests/Channels/AbstractChannelTest.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
it('can report', function (): void {
2525
(fn (): bool => $this->isRunningInConsole = false)->call(app());
26-
expect($this->app->make(ExceptionNotifyManager::class)->driver('dump'))
26+
expect(resolve(ExceptionNotifyManager::class)->driver('dump'))
2727
->report(new RuntimeException('testing'))
2828
->toBeNull();
2929
})->group(__DIR__, __FILE__);

‎tests/Channels/ChannelTest.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828
it('can not report', function (): void {
2929
config()->set('exception-notify.rate_limiter.max_attempts', 0);
30-
expect($this->app->make(ExceptionNotifyManager::class))
30+
expect(resolve(ExceptionNotifyManager::class))
3131
->report(new RuntimeException('testing'))
3232
->toBeNull();
3333
})->group(__DIR__, __FILE__);
@@ -41,7 +41,7 @@
4141
Log::info($reportedEvent::class);
4242
});
4343

44-
expect($this->app->make(ExceptionNotifyManager::class))
44+
expect(resolve(ExceptionNotifyManager::class))
4545
->report(new RuntimeException('testing'))
4646
->toBeNull();
4747
})->group(__DIR__, __FILE__);

0 commit comments

Comments
 (0)