[Chore] Bit number helpers (alexjustesen#1199)

Author: alexjustesen

app/Filament/Resources/ResultResource.php

@@ -59,12 +59,12 @@ public static function form(Form $form): Form
                             Forms\Components\TextInput::make('download')
                                 ->label('Download')
                                 ->afterStateHydrated(function (TextInput $component, Result $record) {
-                                    $component->state(! blank($record->download) ? Number::fileSizeBits(bits: $record->download_bits, precision: 2, perSecond: true) : '');
+                                    $component->state(! blank($record->download) ? Number::toBitRate(bits: $record->download_bits, precision: 2) : '');
                                 }),
                             Forms\Components\TextInput::make('upload')
                                 ->label('Upload')
                                 ->afterStateHydrated(function (TextInput $component, Result $record) {
-                                    $component->state(! blank($record->upload) ? Number::fileSizeBits(bits: $record->upload_bits, precision: 2, perSecond: true) : '');
+                                    $component->state(! blank($record->upload) ? Number::toBitRate(bits: $record->upload_bits, precision: 2) : '');
                                 }),
                             Forms\Components\TextInput::make('ping')
                                 ->label('Ping (ms)'),
@@ -132,10 +132,10 @@ public static function table(Table $table): Table
                     ->toggleable()
                     ->sortable(),
                 Tables\Columns\TextColumn::make('download')
-                    ->getStateUsing(fn (Result $record): ?string => ! blank($record->download) ? Number::fileSizeBits(bits: $record->download_bits, precision: 2, perSecond: true) : null)
+                    ->getStateUsing(fn (Result $record): ?string => ! blank($record->download) ? Number::toBitRate(bits: $record->download_bits, precision: 2) : null)
                     ->sortable(),
                 Tables\Columns\TextColumn::make('upload')
-                    ->getStateUsing(fn (Result $record): ?string => ! blank($record->upload) ? Number::fileSizeBits(bits: $record->upload_bits, precision: 2, perSecond: true) : null)
+                    ->getStateUsing(fn (Result $record): ?string => ! blank($record->upload) ? Number::toBitRate(bits: $record->upload_bits, precision: 2) : null)
                     ->sortable(),
                 Tables\Columns\TextColumn::make('ping')
                     ->toggleable()

app/Filament/Widgets/StatsOverviewWidget.php

@@ -45,9 +45,9 @@ protected function getCards(): array
 
         if (! $previous) {
             return [
-                Stat::make('Latest download', fn (): string => ! blank($this->result) ? Number::fileSizeBits(bits: $this->result->download_bits, precision: 2, perSecond: true) : 'n/a')
+                Stat::make('Latest download', fn (): string => ! blank($this->result) ? Number::toBitRate(bits: $this->result->download_bits, precision: 2) : 'n/a')
                     ->icon('heroicon-o-arrow-down-tray'),
-                Stat::make('Latest upload', fn (): string => ! blank($this->result) ? Number::fileSizeBits(bits: $this->result->upload_bits, precision: 2, perSecond: true) : 'n/a')
+                Stat::make('Latest upload', fn (): string => ! blank($this->result) ? Number::toBitRate(bits: $this->result->upload_bits, precision: 2) : 'n/a')
                     ->icon('heroicon-o-arrow-up-tray'),
                 Stat::make('Latest ping', fn (): string => ! blank($this->result) ? number_format($this->result->ping, 2).' ms' : 'n/a')
                     ->icon('heroicon-o-clock'),
@@ -59,12 +59,12 @@ protected function getCards(): array
         $pingChange = percentChange($this->result->ping, $previous->ping, 2);
 
         return [
-            Stat::make('Latest download', fn (): string => ! blank($this->result) ? Number::fileSizeBits(bits: $this->result->download_bits, precision: 2, perSecond: true) : 'n/a')
+            Stat::make('Latest download', fn (): string => ! blank($this->result) ? Number::toBitRate(bits: $this->result->download_bits, precision: 2) : 'n/a')
                 ->icon('heroicon-o-arrow-down-tray')
                 ->description($downloadChange > 0 ? $downloadChange.'% faster' : abs($downloadChange).'% slower')
                 ->descriptionIcon($downloadChange > 0 ? 'heroicon-m-arrow-trending-up' : 'heroicon-m-arrow-trending-down')
                 ->color($downloadChange > 0 ? 'success' : 'danger'),
-            Stat::make('Latest upload', fn (): string => ! blank($this->result) ? Number::fileSizeBits(bits: $this->result->upload_bits, precision: 2, perSecond: true) : 'n/a')
+            Stat::make('Latest upload', fn (): string => ! blank($this->result) ? Number::toBitRate(bits: $this->result->upload_bits, precision: 2) : 'n/a')
                 ->icon('heroicon-o-arrow-up-tray')
                 ->description($uploadChange > 0 ? $uploadChange.'% faster' : abs($uploadChange).'% slower')
                 ->descriptionIcon($uploadChange > 0 ? 'heroicon-m-arrow-trending-up' : 'heroicon-m-arrow-trending-down')

app/Helpers/Number.php

@@ -7,14 +7,29 @@
 class Number extends SupportNumber
 {
     /**
-     * Convert the given number to its file size equivalent in bits.
+     * Convert the given number to its largest bit order of magnitude.
+     *
+     * Reference: https://en.wikipedia.org/wiki/Bit
      */
-    public static function fileSizeBits(int|float $bits, int $precision = 0, ?int $maxPrecision = null, bool $perSecond = false): string
+    public static function bitsToHuman(int|float $bits, int $precision = 0, ?int $maxPrecision = null): string
     {
-        $units = match ($perSecond) {
-            true => ['Bps', 'Kbps', 'Mbps', 'Gbps', 'Tbps', 'Pbps', 'Ebps', 'Zbps', 'Ybps'],
-            default => ['B', 'Kb', 'Mb', 'Gb', 'Tb', 'Pb', 'Eb', 'Zb', 'Yb']
-        };
+        $units = ['B', 'Kb', 'Mb', 'Gb', 'Tb', 'Pb', 'Eb', 'Zb', 'Yb'];
+
+        for ($i = 0; ($bits / 1000) > 0.9 && ($i < count($units) - 1); $i++) {
+            $bits /= 1000;
+        }
+
+        return sprintf('%s %s', static::format($bits, $precision, $maxPrecision), $units[$i]);
+    }
+
+    /**
+     * Convert the given number to its largest bit rate order of magnitude.
+     *
+     * Reference: https://en.wikipedia.org/wiki/Bit_rate
+     */
+    public static function toBitRate(int|float $bits, int $precision = 0, ?int $maxPrecision = null): string
+    {
+        $units = ['Bps', 'Kbps', 'Mbps', 'Gbps', 'Tbps', 'Pbps', 'Ebps', 'Zbps', 'Ybps'];
 
         for ($i = 0; ($bits / 1000) > 0.9 && ($i < count($units) - 1); $i++) {
             $bits /= 1000;