implement methods to make espeak to speak

.github/workflow/phpunit.yml → .github/workflows/phpunit.yml

@@ -9,11 +9,17 @@ jobs:
       # do not stop on another job's failure
       fail-fast: false
       matrix:
-        php-versions: ['8.0', '8.1', '8.2']
+        php-versions: ['8.2', '8.3']
         coverage: ['xdebug']
         xdebug_mode: ['debug']
     name: php${{ matrix.php-versions }}
     steps:
+      - name: Install Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y espeak-ng
+      - name: Checkout
+        uses: actions/checkout@v4
       - name: Set up php ${{ matrix.php-versions }}
         uses: shivammathur/setup-php@v2
         with:
@@ -26,7 +32,7 @@ jobs:
       - name: PHPUnit
         env:
           XDEBUG_MODE: ${{ matrix.xdebug_mode }}
-        run: ./vendor/bin/phpunit -c phpunit.xml
+        run: composer run test:unit
   upload-coverage:
     needs: phpunit
     runs-on: ubuntu-latest

README.md

@@ -0,0 +1,13 @@
+# PHP wrapper for eSpeak NG
+
+### About eSpeak NG
+
+eSpeak is a free and open-source, cross-platform, compact, software speech synthesizer.
+
+### About eSpeak NG in this project
+
+Thinking about accessibility for visually impaired users when they need to fill out the contact form. We decided to implement the eSpeak NG library, which has the functionality to speak captcha characters.
+
+### Library Documentation
+
+https://github.com/espeak-ng/espeak-ng

composer.json

@@ -26,7 +26,15 @@
         "cs:check": "phpcs --standard=PSR12 -n src tests/Unit",
         "cs:fix": "phpcbf --standard=PSR12 -n src tests/Unit",
         "test:unit": "phpunit --no-coverage",
-        "test:coverage": "XDEBUG_MODE=coverage phpunit"
+        "test:coverage": "XDEBUG_MODE=coverage phpunit",
+        "lint": "find . -name \\*.php -not -path './vendor/*' -not -path './vendor-bin/*' -print0 | xargs -0 -n1 php -l",
+        "post-install-cmd": [
+            "@composer bin all install --ansi",
+            "composer dump-autoload"
+        ],
+        "post-update-cmd": [
+            "composer dump-autoload"
+        ]
     },
     "config": {
         "allow-plugins": {

src/Espeak.php

@@ -2,12 +2,41 @@
 
 namespace Libresign\Espeak;
 
+use InvalidArgumentException;
+
 class Espeak
 {
+    private InputOptions $inputOptions;
+    public function __construct()
+    {
+        $this->inputOptions = new InputOptions();
+    }
+
     public function getVersion()
     {
-        \exec('espeak-ng --version', $output);
-        preg_match('/: (?<version>[\d\.]+) /', $output[0], $matches);
+        $this->setOption('version');
+        $output = $this->execute();
+        preg_match('/: (?<version>[\d\.]+) /', $output, $matches);
         return $matches['version'];
     }
+
+    public function setOption(string $name, ?string $value = null): self
+    {
+        $this->inputOptions->setOption($name, $value);
+        return $this;
+    }
+
+    public function execute(string $argument = ''): string
+    {
+        $options = ' ' . $this->inputOptions;
+        if (strlen($options) === 1) {
+            throw new InvalidArgumentException();
+        }
+        $cmd = 'espeak-ng' . $options;
+        if (strlen($argument) > 0) {
+            $cmd .= ' ' . $argument;
+        }
+        $output = \shell_exec($cmd);
+        return $output;
+    }
 }

src/InputOptions.php

@@ -17,14 +17,23 @@ public function hasOption(string $name)
         return array_key_exists($name, $this->options);
     }
 
+    private function quoteString(string $value): string
+    {
+        $value = str_replace('"', '\"', $value);
+        if (str_contains($value, ' ')) {
+            $value = '"' . $value . '"';
+        }
+        return $value;
+    }
+
     private function nameValueToString(string $name, array $values, string $separator, string $type)
     {
         $return = [];
         foreach ($values as $value) {
             if (empty($value)) {
                 $return[] = $type . $name;
             } else {
-                $return[] = $type . $name . $separator . $value;
+                $return[] = $type . $name . $separator . $this->quoteString($value);
             }
         }
         return implode(' ', $return);

tests/Unit/EspeakTest.php

@@ -2,6 +2,7 @@
 
 namespace Libresign\Test;
 
+use InvalidArgumentException;
 use Libresign\Espeak\Espeak;
 use PHPUnit\Framework\TestCase;
 
@@ -13,4 +14,26 @@ public function testGetVersion()
         $actual = $Espeak->getVersion();
         $this->assertNotEmpty($actual);
     }
+
+    public function testGetVersionUsingOption()
+    {
+        $actual = (new Espeak())
+            ->setOption('version')
+            ->execute();
+        $this->assertMatchesRegularExpression('/: (?<version>[\d\.]+) /', $actual);
+    }
+
+    public function testThrowExceptionWhenOptionIsEmpty()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        (new Espeak())->execute();
+    }
+
+    public function testSpeakWithSuccess()
+    {
+        $actual = (new Espeak())
+            ->setOption('stdout')
+            ->execute('1');
+        $this->assertNotEmpty($actual);
+    }
 }

tests/Unit/InputOptionsTest.php

@@ -43,7 +43,11 @@ public static function dataStringable(): array
             [['test'],'--test'],
             [['t'],'-t'],
             [['t' => '123'],'-t 123'],
+            [['t' => '1 2 3'],'-t "1 2 3"'],
+            [['t' => '1 "2" 3'],'-t "1 \"2\" 3"'],
             [['t' => '123', 't'],'-t 123 -t'],
+            [['test' => '123', 'test'],'--test=123 --test'],
+            [['test' => '123', 'test', 't' => '123', 't'],'--test=123 --test -t 123 -t'],
         ];
     }
 }