Group for CLI.

Author: dereuromark

docs/Authorization.md

@@ -594,7 +594,7 @@ If you need to build a navigation that includes publicly accessible actions, you
 The plugin offers a convenience CLI command to sync ACL for any new controller. It will automatically skip controllers that are whitelisted as public (non authenticated).
 
 ```
-bin/cake tiny_auth_sync {your default roles, comma separated}
+bin/cake tiny_auth sync {your default roles, comma separated}
 ```
 
 This will then add any missing controller with `* = ...` for all actions and you can then manually fine-tune.
@@ -606,7 +606,7 @@ This will then add any missing controller with `* = ...` for all actions and you
 Add any role to any command and action:
 
 ```
-bin/cake tiny_auth_add {Controller} {Action} {roles, comma separated}
+bin/cake tiny_auth add {Controller} {Action} {roles, comma separated}
 ```
 
 It will skip if the roles are already present for this controller and action.

src/Command/TinyAuthAddCommand.php renamed to src/Command/AddCommand.php

@@ -17,13 +17,13 @@
  * or updating specific controller/action permissions for given roles.
  *
  * Usage examples:
- * - `bin/cake tiny_auth_add Articles index user,admin` - Allow users and admins to access Articles::index
- * - `bin/cake tiny_auth_add Articles` - Interactive mode, prompts for action and roles
- * - `bin/cake tiny_auth_add Articles "*" "*"` - Allow all roles to access all Articles actions
+ * - `bin/cake tiny_auth add Articles index user,admin` - Allow users and admins to access Articles::index
+ * - `bin/cake tiny_auth add Articles` - Interactive mode, prompts for action and roles
+ * - `bin/cake tiny_auth add Articles "*" "*"` - Allow all roles to access all Articles actions
  *
  * @see config/auth_acl.ini - The file that gets modified by this command
  */
-class TinyAuthAddCommand extends Command {
+class AddCommand extends Command {
 
 	/**
 	 * @inheritDoc
@@ -96,13 +96,13 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
 			. 'This command modifies: config/auth_acl.ini (or custom path via TinyAuth.aclFilePath)' . PHP_EOL
 			. PHP_EOL
 			. 'Examples:' . PHP_EOL
-			. '  bin/cake tiny_auth_add Articles index user,admin' . PHP_EOL
+			. '  bin/cake tiny_auth add Articles index user,admin' . PHP_EOL
 			. '    → Adds: [Articles] index = user, admin' . PHP_EOL
 			. PHP_EOL
-			. '  bin/cake tiny_auth_add Articles "*" admin' . PHP_EOL
+			. '  bin/cake tiny_auth add Articles "*" admin' . PHP_EOL
 			. '    → Adds: [Articles] * = admin' . PHP_EOL
 			. PHP_EOL
-			. '  bin/cake tiny_auth_add MyPlugin.Admin/Articles edit admin' . PHP_EOL
+			. '  bin/cake tiny_auth add MyPlugin.Admin/Articles edit admin' . PHP_EOL
 			. '    → Adds: [MyPlugin.Admin/Articles] edit = admin',
 		)->addArgument('controller', [
 			'help' => 'Controller name (Plugin.Prefix/Name) without Controller suffix.',

src/Command/TinyAuthSyncCommand.php renamed to src/Command/SyncCommand.php

@@ -17,13 +17,13 @@
  * have entries in the ACL INI file (default: config/auth_acl.ini).
  *
  * Usage examples:
- * - `bin/cake tiny_auth_sync user,admin` - Add all controllers with access for user and admin roles
- * - `bin/cake tiny_auth_sync "*" -p all` - Add all controllers (including plugins) with access for all roles
- * - `bin/cake tiny_auth_sync user -d` - Dry run, shows what would be added without modifying files
+ * - `bin/cake tiny_auth sync user,admin` - Add all controllers with access for user and admin roles
+ * - `bin/cake tiny_auth sync "*" -p all` - Add all controllers (including plugins) with access for all roles
+ * - `bin/cake tiny_auth sync user -d` - Dry run, shows what would be added without modifying files
  *
  * @see config/auth_acl.ini - The file that gets modified by this command
  */
-class TinyAuthSyncCommand extends Command {
+class SyncCommand extends Command {
 
 	/**
 	 * @inheritDoc
@@ -88,13 +88,13 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
 			. '  3. Preserve existing entries (never overwrites)' . PHP_EOL
 			. PHP_EOL
 			. 'Examples:' . PHP_EOL
-			. '  bin/cake tiny_auth_sync user,admin' . PHP_EOL
+			. '  bin/cake tiny_auth sync user,admin' . PHP_EOL
 			. '    → Adds all missing controllers with: * = user, admin' . PHP_EOL
 			. PHP_EOL
-			. '  bin/cake tiny_auth_sync "*" -p all' . PHP_EOL
+			. '  bin/cake tiny_auth sync "*" -p all' . PHP_EOL
 			. '    → Adds all missing controllers (including plugins) with: * = *' . PHP_EOL
 			. PHP_EOL
-			. '  bin/cake tiny_auth_sync admin -d' . PHP_EOL
+			. '  bin/cake tiny_auth sync admin -d' . PHP_EOL
 			. '    → Dry run - shows what would be added without modifying files',
 		)->addArgument('roles', [
 			'help' => 'Role names, comma separated, e.g. `user,admin`.' . ($roles ? PHP_EOL . 'Available roles: ' . implode(', ', $roles) . '.' : ''),

src/Sync/Adder.php

@@ -13,7 +13,7 @@
 /**
  * Helper class for adding specific ACL entries to the INI configuration file.
  *
- * Used by TinyAuthAddCommand to modify auth_acl.ini file with new or updated
+ * Used by AddCommand to modify auth_acl.ini file with new or updated
  * controller/action/role mappings.
  *
  * @internal

src/TinyAuthPlugin.php

@@ -2,7 +2,10 @@
 
 namespace TinyAuth;
 
+use Cake\Console\CommandCollection;
 use Cake\Core\BasePlugin;
+use TinyAuth\Command\AddCommand;
+use TinyAuth\Command\SyncCommand;
 
 /**
  * Plugin for TinyAuth
@@ -24,4 +27,15 @@ class TinyAuthPlugin extends BasePlugin {
 	 */
 	protected bool $routesEnabled = false;
 
+	/**
+	 * @param \Cake\Console\CommandCollection $commands The command collection to add to.
+	 * @return \Cake\Console\CommandCollection
+	 */
+	public function console(CommandCollection $commands): CommandCollection {
+		$commands->add('tiny_auth add', AddCommand::class);
+		$commands->add('tiny_auth sync', SyncCommand::class);
+
+		return $commands;
+	}
+
 }

tests/TestCase/Command/TinyAuthAddCommandTest.php renamed to tests/TestCase/Command/AddCommandTest.php

@@ -8,7 +8,7 @@
 use Cake\TestSuite\TestCase;
 use TinyAuth\Filesystem\Folder;
 
-class TinyAuthAddCommandTest extends TestCase {
+class AddCommandTest extends TestCase {
 
 	use ConsoleIntegrationTestTrait;
 
@@ -40,7 +40,7 @@ public function testAdd() {
 		$folder = new Folder();
 		$folder->copy('/tmp' . DS . 'src' . DS . 'Controller' . DS, ['from' => TESTS . 'test_app' . DS . 'Controller' . DS]);
 
-		$this->exec('tiny_auth_add Some action foo,bar -d -v');
+		$this->exec('tiny_auth add Some action foo,bar -d -v');
 
 		$this->assertExitCode(Command::CODE_SUCCESS);
 		$this->assertOutputContains('[Some]');

tests/TestCase/Command/TinyAuthSyncCommandTest.php renamed to tests/TestCase/Command/SyncCommandTest.php

@@ -8,7 +8,7 @@
 use Cake\TestSuite\TestCase;
 use TinyAuth\Filesystem\Folder;
 
-class TinyAuthSyncCommandTest extends TestCase {
+class SyncCommandTest extends TestCase {
 
 	use ConsoleIntegrationTestTrait;
 
@@ -40,7 +40,7 @@ public function testSync() {
 		$folder = new Folder();
 		$folder->copy('/tmp' . DS . 'src' . DS . 'Controller' . DS, ['from' => TESTS . 'test_app' . DS . 'Controller' . DS]);
 
-		$this->exec('tiny_auth_sync foo,bar -d -v');
+		$this->exec('tiny_auth sync foo,bar -d -v');
 
 		$this->assertExitCode(Command::CODE_SUCCESS);
 		$this->assertOutputContains('index = admin');