Merge pull request #1365 from mlocati/enable-commands-with-underscore

Enable using commands containing underscores
php-telegram-bot · Nov 7, 2022 · f79c799 · f79c799
2 parents 5de35f7 + 392f949
commit f79c799
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 18 deletions.
diff --git a/src/Telegram.php b/src/Telegram.php
@@ -283,18 +283,17 @@ public function getCommandsList(): array
 
                 foreach ($files as $file) {
                     //Remove "Command.php" from filename
-                    $command      = $this->sanitizeCommand(substr($file->getFilename(), 0, -11));
-                    $command_name = mb_strtolower($command);
+                    $command      = $this->classNameToCommandName(substr($file->getFilename(), 0, -4));
 
-                    if (array_key_exists($command_name, $commands)) {
+                    if (array_key_exists($command, $commands)) {
                         continue;
                     }
 
                     require_once $file->getPathname();
 
                     $command_obj = $this->getCommandObject($command, $file->getPathname());
                     if ($command_obj instanceof Command) {
-                        $commands[$command_name] = $command_obj;
+                        $commands[$command] = $command_obj;
                     }
                 }
             } catch (Exception $e) {
@@ -334,7 +333,7 @@ public function getCommandClassName(string $auth, string $command, string $filep
             return null;
         }
 
-        $command_class = $command_namespace . '\\' . $this->ucFirstUnicode($command) . 'Command';
+        $command_class = $command_namespace . '\\' . $this->commandNameToClassName($command);
 
         if (class_exists($command_class)) {
             return $command_class;
@@ -678,7 +677,7 @@ public function executeCommand(string $command): ServerResponse
     }
 
     /**
-     * Sanitize Command
+     * @deprecated
      *
      * @param string $command
      *
@@ -1285,4 +1284,35 @@ public function getUpdateFilter(): ?callable
     {
         return $this->update_filter;
     }
+
+    /**
+     * Converts the name of a class into the name of a command.
+     *
+     * @param string $class For example FooBarCommand
+     *
+     * @return string for example foo_bar. In case of errors, returns an empty string
+     */
+    protected function classNameToCommandName(string $class): string
+    {
+        // 7 is the length of 'Command'
+        if (substr($class, -7) !== 'Command') {
+            return '';
+        }
+        return mb_strtolower(preg_replace('/(.)(?=[\p{Lu}])/u', '$1_', substr($class, 0, -7)));
+    }
+
+    /**
+     * Converts a command name into the name of a class.
+     *
+     * @param string $command For example foo_bar
+     *
+     * @return string for example FooBarCommand. In case of errors, returns an empty string
+     */
+    protected function commandNameToClassName(string $command): string
+    {
+        if ($command === '') {
+            return '';
+        }
+        return str_replace(' ', '', $this->ucWordsUnicode(str_replace('_', ' ', $command))) . 'Command';
+    }
 }
diff --git a/tests/Unit/Commands/CustomTestCommands/DummyAdminCommand.php b/tests/Unit/Commands/CustomTestCommands/DummyAdminCommand.php
@@ -16,14 +16,14 @@
 use Longman\TelegramBot\Request;
 
 /**
- * Test "/dummyadmin" command
+ * Test "/dummy_admin" command
  */
 class DummyAdminCommand extends AdminCommand
 {
     /**
      * @var string
      */
-    protected $name = 'dummyadmin';
+    protected $name = 'dummy_admin';
 
     /**
      * @var string
@@ -33,7 +33,7 @@ class DummyAdminCommand extends AdminCommand
     /**
      * @var string
      */
-    protected $usage = '/dummyadmin';
+    protected $usage = '/dummy_admin';
 
     /**
      * Command execute method

diff --git a/tests/Unit/Commands/CustomTestCommands/DummySystemCommand.php b/tests/Unit/Commands/CustomTestCommands/DummySystemCommand.php
@@ -16,14 +16,14 @@
 use Longman\TelegramBot\Request;
 
 /**
- * Test "/dummysystem" command
+ * Test "/dummy_system" command
  */
 class DummySystemCommand extends SystemCommand
 {
     /**
      * @var string
      */
-    protected $name = 'dummysystem';
+    protected $name = 'dummy_system';
 
     /**
      * @var string
@@ -33,7 +33,7 @@ class DummySystemCommand extends SystemCommand
     /**
      * @var string
      */
-    protected $usage = '/dummysystem';
+    protected $usage = '/dummy_system';
 
     /**
      * Command execute method

diff --git a/tests/Unit/Commands/CustomTestCommands/DummyUserCommand.php b/tests/Unit/Commands/CustomTestCommands/DummyUserCommand.php
@@ -16,14 +16,14 @@
 use Longman\TelegramBot\Request;
 
 /**
- * Test "/dummyuser" command
+ * Test "/dummy_user" command
  */
 class DummyUserCommand extends UserCommand
 {
     /**
      * @var string
      */
-    protected $name = 'dummyuser';
+    protected $name = 'dummy_user';
 
     /**
      * @var string
@@ -33,7 +33,7 @@ class DummyUserCommand extends UserCommand
     /**
      * @var string
      */
-    protected $usage = '/dummyuser';
+    protected $usage = '/dummy_user';
 
     /**
      * Command execute method

diff --git a/tests/Unit/TelegramTest.php b/tests/Unit/TelegramTest.php
@@ -170,9 +170,9 @@ public function testAddCustomCommandsClass(): void
         ]);
 
         $command_classes = $tg->getCommandClasses();
-        self::assertCount(1, $command_classes['System']);
-        self::assertCount(1, $command_classes['Admin']);
-        self::assertCount(1, $command_classes['User']);
+        self::assertSame(['dummy_system' => 'Dummy\SystemCommands\DummySystemCommand'], $command_classes['System']);
+        self::assertSame(['dummy_admin' => 'Dummy\AdminCommands\DummyAdminCommand'], $command_classes['Admin']);
+        self::assertSame(['dummy_user' => 'Dummy\UserCommands\DummyUserCommand'], $command_classes['User']);
     }
 
     public function testSettingDownloadUploadPaths(): void