Support for loading methods on classes

Author: knivey

README.md

@@ -17,6 +17,7 @@ composer require knivey/cmdr
 ## Documentation & Examples
 
 Setup the command router object and find commands
+
 ```php
 use knivey\cmdr;
 $router = new cmdr\Cmdr();
@@ -31,14 +32,15 @@ function exampleFunc($additonal, $arguments, cmdr\Request $request) {
 }
 
 //Do this AFTER all functions you want to load are defined
-$router->loadFuncsByAttributes();
+$router->loadFuncs();
 
 // This will return what the command function returns
 // Exceptions can be throw if the args given don't pass the syntax
 $router->call('example', 'arguments given to cmd', $additional, $arguments);
 ```
 Note that command names cannot contain a # in them.
 
+To load public methods from a class object use `loadMethods($obj)`
 ### Argument Syntax Rules
 *  `<arg>` is a required arg
 *  `<arg>...` required multiword arg, must be last in list

src/Cmdr.php

@@ -31,41 +31,47 @@ function get(string $command, string $text) : Request|false {
 	    return new Request($args, $cmd);
     }
 
-    function loadMethodsByAttributes(object $obj) {
-	    //TODO
+    function loadMethods(object $obj) {
+	    $objRef = new \ReflectionObject($obj);
+	    foreach($objRef->getMethods(\ReflectionMethod::IS_PUBLIC) as $rf) {
+            $this->attrAddCmd($rf, [$obj, $rf->name]);
+        }
+    }
+
+    protected function attrAddCmd($rf, $f) {
+        $cmdAttr = $rf->getAttributes(attributes\Cmd::class);
+        if (count($cmdAttr) == 0)
+            return;
+        $cmdAttr = $cmdAttr[0]->newInstance();
+        $syntaxAttr = $rf->getAttributes(attributes\Syntax::class);
+        $syntax = '';
+        $callWrapper = null;
+        $callWrapperPre = [];
+        $callWrapperPost = [];
+        if (isset($syntaxAttr[0])) {
+            $sa = $syntaxAttr[0]->newInstance();
+            $syntax = $sa->syntax;
+        }
+        $callWrapAttr = $rf->getAttributes(attributes\CallWrap::class);
+        if (isset($callWrapAttr[0])) {
+            $cw = $callWrapAttr[0]->newInstance();
+            $callWrapper = $cw->caller;
+            $callWrapperPre = $cw->preArgs;
+            $callWrapperPost = $cw->postArgs;
+        }
+        foreach ($cmdAttr->args as $command) {
+            if ($callWrapper != null)
+                $this->cmds[$command] = new Cmd($command, $callWrapper, [...$callWrapperPre, $f], $callWrapperPost, $syntax);
+            else
+                $this->cmds[$command] = new Cmd($command, $f, $callWrapperPre, $callWrapperPost, $syntax);
+        }
     }
 
-    function loadFuncsByAttributes() {
+    function loadFuncs() {
 	    $funcs = get_defined_functions(true)["user"];
 	    foreach ($funcs as $f) {
 	        $rf = new \ReflectionFunction($f);
-	        //all commands should at least have Cmd attribute
-	        $cmdAttr = $rf->getAttributes(attributes\Cmd::class);
-	        if(count($cmdAttr) == 0)
-	            continue;
-	        $cmdAttr = $cmdAttr[0]->newInstance();
-            $syntaxAttr = $rf->getAttributes(attributes\Syntax::class);
-            $syntax = '';
-            $callWrapper = null;
-            $callWrapperPre = [];
-            $callWrapperPost = [];
-            if(isset($syntaxAttr[0])) {
-                $sa = $syntaxAttr[0]->newInstance();
-                $syntax = $sa->syntax;
-            }
-            $callWrapAttr = $rf->getAttributes(attributes\CallWrap::class);
-            if(isset($callWrapAttr[0])) {
-                $cw = $callWrapAttr[0]->newInstance();
-                $callWrapper = $cw->caller;
-                $callWrapperPre = $cw->preArgs;
-                $callWrapperPost = $cw->postArgs;
-            }
-            foreach ($cmdAttr->args as $command) {
-                if($callWrapper != null)
-                    $this->cmds[$command] = new Cmd($command, $callWrapper, [...$callWrapperPre, $f], $callWrapperPost, $syntax);
-                else
-                    $this->cmds[$command] = new Cmd($command, $f, $callWrapperPre, $callWrapperPost, $syntax);
-            }
+	        $this->attrAddCmd($rf, $f);
         }
     }
 

tests/CmdrTest.php

@@ -83,7 +83,7 @@ public function testBadNameException()
         $cmdr->add('#test', $lol);
     }
 
-    public function testLoadFuncsByAttributes()
+    public function testLoadFuncs()
     {
         global $testFunc;
         $cnt = 0;
@@ -93,12 +93,27 @@ function ($req) use(&$cnt) {
                 $this->assertEquals('abc def', $req->args['foo']);
                 $cnt++;
             };
-        $cmdr->loadFuncsByAttributes();
+        $cmdr->loadFuncs();
         $cmdr->call('testattrs', 'abc def');
         $cmdr->call('noexist', 'abc def');
         $this->assertEquals(1, $cnt);
     }
 
+    public function testLoadMethods()
+    {
+        global $testFunc;
+        $cnt = 0;
+        $cmdr = new Cmdr();
+        $testFunc =
+            function ($req) use(&$cnt) {
+                $cnt++;
+            };
+        $obj = new weeclass();
+        $cmdr->loadMethods($obj);
+        $cmdr->call('wee', '');
+        $this->assertEquals(1, $cnt);
+    }
+
     public function testPrePost()
     {
         $cmdr = new Cmdr();
@@ -129,9 +144,22 @@ public function testCallWrapAttribute()
             $cnt++;
         };
 
-        $cmdr->loadFuncsByAttributes();
+        $cmdr->loadFuncs();
         $cmdr->call('testCallWrap', 'abc def');
         $this->assertEquals(1, $cnt);
+
+
+        $obj = new weeclass();
+        $testFunc = function ($func, $req) use(&$cnt, $obj) {
+            //php namespace&functions are lowered internally
+            $this->assertEquals([$obj, 'eew'], $func);
+            $cnt++;
+        };
+        $cmdr = new Cmdr();
+        $cnt = 0;
+        $cmdr->loadMethods($obj);
+        $cmdr->call('eew', 'abc def');
+        $this->assertEquals(1, $cnt);
     }
 }
 
@@ -154,3 +182,18 @@ function wrapTestFunc(...$args) {
     $testFunc(...$args);
 };
 
+
+// not sure phpunit supports mocking with attributes yet
+class weeclass {
+    #[Cmd('wee')]
+    public function example($req) {
+        global $testFunc;
+        $testFunc($req);
+    }
+
+    #[Cmd('eew')]
+    #[CallWrap(__namespace__.'\wrapTestFunc')]
+    public function eew($req) {
+    }
+}
+