refactor: rename setter methods to use 'with' prefix for clarity

guanguans · guanguans · commit 8640903a6dff · 2025-11-27T23:04:07.000+08:00
- Changed 'setSoarBinary' to 'withSoarBinary' for consistency.
- Updated 'setSudoPassword' to 'withSudoPassword' for clarity.
- Renamed 'setPipe' to 'withPipe' to align with new naming convention.
- Modified 'setTap' to 'withTap' for improved readability.

Signed-off-by: guanguans &lt;ityaozm@gmail.com&gt;
diff --git a/README.md b/README.md
@@ -509,7 +509,7 @@ array:9 [
 
 ```php
 // Fatal error: Uncaught Symfony\Component\Process\Exception\ProcessFailedException: The command "'/Users/yaozm/Documents/develop/soar-php/bin/soar.darwin-arm64' '-report-type=json' '-query=SELECT * FROM `foo`;'" failed. Exit Code: 2(Misuse of shell builtins) Working directory: /Users/yaozm/Documents/develop/soar-php Output: ================ Error Output: ================ panic: runtime error: invalid memory address or nil pointer dereference [signal SIGSEGV: segmentation violation code=0x2 addr=0x0 pc=0x104d22798] goroutine 1 [running]: github.com/pingcap/tidb/util/memory.MemTotalNormal() pkg/mod/github.com/pingcap/tidb@v1.1.0-beta.0.20210601085537-5d7c852770eb/util/memory/meminfo.go:41 +0x68 github.com/pingcap/tidb/util/memory.init.0() pkg/mod/github.com/pingcap/tidb@v1.1.0-beta.0.20210601085537-5d7c852770eb/util/memory/meminfo.go:134 +0x184 in /Users/yaozm/Documents/develop/soar-php/vendor/symfony/process/Process.php:273
-$soar->setSudoPassword('your sudo password'); // Set a sudo password to run the soar command with sudo to avoid the above errors.
+$soar->withSudoPassword('your sudo password'); // With a sudo password to run the soar command with sudo to avoid the above errors.
 ```
 </details>
 
diff --git a/src/Concerns/ConcreteMagic.php b/src/Concerns/ConcreteMagic.php
@@ -39,7 +39,7 @@ public function __serialize(): array
     public function __unserialize(array $data): void
     {
         $this->setOptions($data['options']);
-        $this->setSoarBinary($data['soarBinary']);
+        $this->withSoarBinary($data['soarBinary']);
     }
 
     public function __debugInfo(): array
diff --git a/src/Concerns/HasSoarBinary.php b/src/Concerns/HasSoarBinary.php
@@ -28,7 +28,7 @@ public function getSoarBinary(): string
         return $this->soarBinary;
     }
 
-    public function setSoarBinary(string $soarBinary): self
+    public function withSoarBinary(string $soarBinary): self
     {
         if (!is_file($soarBinary)) {
             throw new InvalidArgumentException("The [$soarBinary] is not a file.");
diff --git a/src/Concerns/HasSudoPassword.php b/src/Concerns/HasSudoPassword.php
@@ -27,7 +27,7 @@ public function getSudoPassword(): ?string
         return $this->sudoPassword;
     }
 
-    public function setSudoPassword(
+    public function withSudoPassword(
         #[\SensitiveParameter]
         ?string $sudoPassword
     ): self {
diff --git a/src/Concerns/WithRunable.php b/src/Concerns/WithRunable.php
@@ -26,14 +26,14 @@ trait WithRunable
     /** @var null|callable(Process):void */
     protected $tap;
 
-    public function setPipe(?callable $pipe): self
+    public function withPipe(?callable $pipe): self
     {
         $this->pipe = $pipe;
 
         return $this;
     }
 
-    public function setTap(?callable $tap): self
+    public function withTap(?callable $tap): self
     {
         $this->tap = $tap;
 
diff --git a/src/Soar.php b/src/Soar.php
@@ -37,7 +37,7 @@ class Soar implements \ArrayAccess, \Stringable, Contracts\Soar
     public function __construct(array $options = [], ?string $soarBinary = null)
     {
         $this->setOptions($options);
-        $this->setSoarBinary($soarBinary ?? $this->defaultSoarBinary());
+        $this->withSoarBinary($soarBinary ?? $this->defaultSoarBinary());
     }
 
     /**
diff --git a/tests/Concerns/HasSoarBinaryTest.php b/tests/Concerns/HasSoarBinaryTest.php
@@ -26,9 +26,9 @@
 })->group(__DIR__, __FILE__);
 
 it('will throw InvalidArgumentException when set not a file', function (): void {
-    Soar::make()->setSoarBinary('soar-binary');
+    Soar::make()->withSoarBinary('soar-binary');
 })->group(__DIR__, __FILE__)->throws(InvalidArgumentException::class, 'The [soar-binary] is not a file.');
 
 it('will throw InvalidArgumentException when set not a executable file', function (): void {
-    Soar::make()->setSoarBinary(__FILE__);
+    Soar::make()->withSoarBinary(__FILE__);
 })->group(__DIR__, __FILE__)->throws(InvalidArgumentException::class, \sprintf('The file [%s] is not executable.', __FILE__));
diff --git a/tests/Concerns/HasSudoPasswordTest.php b/tests/Concerns/HasSudoPasswordTest.php
@@ -22,6 +22,6 @@
 
 it('can set sudo password', function (): void {
     expect(Soar::make())
-        ->setSudoPassword($sudoPassword = 'foo')
+        ->withSudoPassword($sudoPassword = 'foo')
         ->getSudoPassword()->toBe($sudoPassword);
 })->group(__DIR__, __FILE__);
diff --git a/tests/Concerns/WithRunableTest.php b/tests/Concerns/WithRunableTest.php
@@ -46,7 +46,7 @@ protected function shouldApplySudoPassword(): bool
         {
             return OS::isUnix();
         }
-    })->setSudoPassword('foo')->help();
+    })->withSudoPassword('foo')->help();
 })
     ->group(__DIR__, __FILE__)
     ->throws(ProcessFailedException::class, implode(\PHP_EOL, [
@@ -61,7 +61,7 @@ protected function shouldApplySudoPassword(): bool
 it('can run soar process with tapper', function (): void {
     expect(Soar::make())
         ->withVersion(true)
-        ->setTap(static function (Process $process): void {
+        ->withTap(static function (Process $process): void {
             $process->setTimeout(3);
         })
         ->run(static function (string $type, string $line): void {

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public function __serialize(): array`
`39`	`39`	`public function __unserialize(array $data): void`
`40`	`40`	`{`
`41`	`41`	`$this->setOptions($data['options']);`
`42`		`- $this->setSoarBinary($data['soarBinary']);`
	`42`	`+ $this->withSoarBinary($data['soarBinary']);`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`public function __debugInfo(): array`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public function getSoarBinary(): string`
`28`	`28`	`return $this->soarBinary;`
`29`	`29`	`}`
`30`	`30`
`31`		`- public function setSoarBinary(string $soarBinary): self`
	`31`	`+ public function withSoarBinary(string $soarBinary): self`
`32`	`32`	`{`
`33`	`33`	`if (!is_file($soarBinary)) {`
`34`	`34`	`throw new InvalidArgumentException("The [$soarBinary] is not a file.");`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public function getSudoPassword(): ?string`
`27`	`27`	`return $this->sudoPassword;`
`28`	`28`	`}`
`29`	`29`
`30`		`- public function setSudoPassword(`
	`30`	`+ public function withSudoPassword(`
`31`	`31`	`#[\SensitiveParameter]`
`32`	`32`	`?string $sudoPassword`
`33`	`33`	`): self {`
Original file line number	Diff line number	Diff line change
`@@ -26,14 +26,14 @@ trait WithRunable`
`26`	`26`	`/** @var null\|callable(Process):void */`
`27`	`27`	`protected $tap;`
`28`	`28`
`29`		`- public function setPipe(?callable $pipe): self`
	`29`	`+ public function withPipe(?callable $pipe): self`
`30`	`30`	`{`
`31`	`31`	`$this->pipe = $pipe;`
`32`	`32`
`33`	`33`	`return $this;`
`34`	`34`	`}`
`35`	`35`
`36`		`- public function setTap(?callable $tap): self`
	`36`	`+ public function withTap(?callable $tap): self`
`37`	`37`	`{`
`38`	`38`	`$this->tap = $tap;`
`39`	`39`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ class Soar implements \ArrayAccess, \Stringable, Contracts\Soar`
`37`	`37`	`public function __construct(array $options = [], ?string $soarBinary = null)`
`38`	`38`	`{`
`39`	`39`	`$this->setOptions($options);`
`40`		`- $this->setSoarBinary($soarBinary ?? $this->defaultSoarBinary());`
	`40`	`+ $this->withSoarBinary($soarBinary ?? $this->defaultSoarBinary());`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`/**`