Rename HwFinder to HwLogicalFinder (#45)

This better reflects what it does.
theofidry · Dec 7, 2022 · fc1cdf5 · fc1cdf5
1 parent 72b7d5d
commit fc1cdf5
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -43,10 +43,10 @@ $cores = (new CpuCoreCounter($finders))->getCount();
 
 ```php
 // Use CPUInfo first & don't use Nproc
-use Fidry\CpuCoreCounter\CpuInfoFinder;use Fidry\CpuCoreCounter\HwFinder;use Fidry\CpuCoreCounter\WindowsWmicFinder;$finders = [
+use Fidry\CpuCoreCounter\CpuInfoFinder;use Fidry\CpuCoreCounter\HwLogicalFinder;use Fidry\CpuCoreCounter\WindowsWmicFinder;$finders = [
     new CpuInfoFinder(),
     new WindowsWmicFinder(),
-    new HwFinder(),
+    new HwLogicalFinder(),
 ];
 
 $cores = (new CpuCoreCounter($finders))->getCount();

diff --git a/src/CpuCoreCounter.php b/src/CpuCoreCounter.php
@@ -74,7 +74,7 @@ public static function getDefaultFinders(): array
         return [
             new NProcFinder(),
             new WindowsWmicFinder(),
-            new HwFinder(),
+            new HwLogicalFinder(),
             new CpuInfoFinder(),
         ];
     }

diff --git a/src/HwFinder.php → src/HwLogicalFinder.php b/src/HwFinder.php → src/HwLogicalFinder.php
@@ -23,12 +23,12 @@
 use const FILTER_VALIDATE_INT;
 
 /**
- * Find the number of CPU cores for Linux, BSD and OSX.
+ * Find the number of logical CPU cores for Linux, BSD and OSX.
  *
  * @see https://github.com/paratestphp/paratest/blob/c163539818fd96308ca8dc60f46088461e366ed4/src/Runners/PHPUnit/Options.php#L903-L909
  * @see https://opensource.apple.com/source/xnu/xnu-792.2.4/libkern/libkern/sysctl.h.auto.html
  */
-final class HwFinder implements CpuCoreFinder
+final class HwLogicalFinder implements CpuCoreFinder
 {
     /**
      * @return positive-int|null

diff --git a/tests/HwFinderTest.php → tests/HwLogicalFinderTest.php b/tests/HwFinderTest.php → tests/HwLogicalFinderTest.php
@@ -13,15 +13,15 @@
 
 namespace Fidry\CpuCoreCounter\Test;
 
-use Fidry\CpuCoreCounter\HwFinder;
+use Fidry\CpuCoreCounter\HwLogicalFinder;
 use PHPUnit\Framework\TestCase;
 
 /**
- * @covers \Fidry\CpuCoreCounter\HwFinder
+ * @covers \Fidry\CpuCoreCounter\HwLogicalFinder
  *
  * @internal
  */
-final class HwFinderTest extends TestCase
+final class HwLogicalFinderTest extends TestCase
 {
     /**
      * @dataProvider processProvider
@@ -30,7 +30,7 @@ public function test_it_can_count_the_number_of_cpu_cores(
         string $process,
         ?int $expected
     ): void {
-        $actual = HwFinder::countCpuCores($process);
+        $actual = HwLogicalFinder::countCpuCores($process);
 
         self::assertSame($expected, $actual);
     }