feat: add new method getMustOpt for get required opt

Author: inhere

src/Contract/ParserInterface.php

@@ -129,6 +129,16 @@ public function hasInputOpt(string $name): bool;
      */
     public function getOpt(string $name, $default = null);
 
+    /**
+     * Must get an option value by name, will throw exception on not input
+     *
+     * @param string $name
+     * @param string $errMsg
+     *
+     * @return mixed
+     */
+    public function getMustOpt(string $name, string $errMsg = '');
+
     /**
      * @param string $name
      *
@@ -198,9 +208,10 @@ public function getArgDefine($nameOrIndex): array;
     public function getArg($nameOrIndex, $default = null);
 
     /**
-     * Get an argument value by name, will throw exception on not input
+     * Must get an argument value by name, will throw exception on not input
      *
      * @param string|int $nameOrIndex
+     * @param string $errMsg
      *
      * @return mixed
      */

src/Flags.php

@@ -899,10 +899,7 @@ public function hasOpt(string $name): bool
      */
     public function getOpt(string $name, $default = null)
     {
-        $opt = $this->getOption($name);
-        if (!$opt) { // not exist
-            throw new FlagException("flag option '$name' is undefined");
-        }
+        $opt = $this->mustGetOption($name);
 
         if ($opt->hasValue()) {
             return $opt->getValue();
@@ -913,15 +910,29 @@ public function getOpt(string $name, $default = null)
 
     /**
      * @param string $name
-     * @param mixed $value
+     * @param string $errMsg
+     *
+     * @return mixed
      */
-    public function setOpt(string $name, $value): void
+    public function getMustOpt(string $name, string $errMsg = '')
     {
-        $opt = $this->getDefinedOption($name);
-        if (!$opt) { // not exist
-            throw new FlagException("flag option '$name' is undefined");
+        $opt = $this->mustGetOption($name);
+
+        if ($opt->hasValue()) {
+            return $opt->getValue();
         }
 
+        $errMsg = $errMsg ?: "The option '$name' is required";
+        throw new InvalidArgumentException($errMsg);
+    }
+
+    /**
+     * @param string $name
+     * @param mixed $value
+     */
+    public function setOpt(string $name, $value): void
+    {
+        $opt = $this->mustGetOption($name);
         $opt->setValue($value);
     }
 
@@ -931,37 +942,35 @@ public function setOpt(string $name, $value): void
      */
     public function setTrustedOpt(string $name, $value): void
     {
-        $opt = $this->getOption($name);
-        if (!$opt) { // not exist option
-            throw new FlagException("flag option '$name' is undefined");
-        }
-
+        $opt = $this->mustGetOption($name);
         $opt->setTrustedValue($value);
     }
 
     /**
      * @param string $name
      *
-     * @return Option|null
+     * @return array
      */
-    public function getOption(string $name): ?Option
+    public function getOptDefine(string $name): array
     {
-        return $this->options[$name] ?? null;
+        $opt = $this->mustGetOption($name);
+
+        return $opt->toArray();
     }
 
     /**
      * @param string $name
      *
-     * @return array
+     * @return Option
      */
-    public function getOptDefine(string $name): array
+    protected function mustGetOption(string $name): Option
     {
         $opt = $this->getOption($name);
         if (!$opt) { // not exist option
             throw new FlagException("flag option '$name' is undefined");
         }
 
-        return $opt->toArray();
+        return $opt;
     }
 
     /**
@@ -1035,6 +1044,18 @@ public function getOptsHelpData(): array
      *
      * @return Option|null
      */
+    public function getOption(string $name): ?Option
+    {
+        return $this->options[$name] ?? null;
+    }
+
+    /**
+     * Alias of the getOption();
+     *
+     * @param string $name
+     *
+     * @return Option|null
+     */
     public function getDefinedOption(string $name): ?Option
     {
         return $this->options[$name] ?? null;

src/SFlags.php

@@ -807,14 +807,28 @@ public function getOpt(string $name, $default = null)
             return $this->opts[$name];
         }
 
-        $define = $this->optDefines[$name] ?? [];
-        if (!$define) { // not exist option
-            throw new FlagException("flag option '$name' is undefined");
-        }
+        $define = $this->getOptDefine($name);
 
         return $default ?? FlagType::getDefault($define['type']);
     }
 
+    /**
+     * @param string $name
+     * @param string $errMsg
+     *
+     * @return mixed
+     */
+    public function getMustOpt(string $name, string $errMsg = '')
+    {
+        if (isset($this->opts[$name])) {
+            return $this->opts[$name];
+        }
+
+        $this->getOptDefine($name);
+        $errMsg = $errMsg ?: "The option '$name' is required";
+        throw new InvalidArgumentException($errMsg);
+    }
+
     /**
      * @param string $name
      *

test/FlagsParserTest.php

@@ -68,10 +68,19 @@ private function doTestGetOptAndGetArg(FlagsParser $fs): void
         $ok = $fs->parse(['--str-opt1', 'val1', '--int-opt', '335', '233']);
         $this->assertTrue($ok);
         $this->assertSame(335, $fs->getOpt('int-opt'));
+        $this->assertSame(335, $fs->getMustOpt('int-opt'));
         $this->assertSame(233, $fs->getArg('int-arg'));
         $this->assertSame(233, $fs->getMustArg('int-arg'));
         $fs->resetResults();
 
+        // getMustOpt
+        $e = $this->runAndGetException(function (FlagsParser $fs) {
+            $fs->getMustOpt('str-opt');
+        }, $fs);
+
+        $this->assertSame(InvalidArgumentException::class, get_class($e));
+        $this->assertSame("The option 'str-opt' is required", $e->getMessage());
+
         // getMustArg
         $e = $this->runAndGetException(function (FlagsParser $fs) {
             $fs->getMustArg('str-arg');