Add a command to list available rules

php bin/console progressive:rules

Available rules:
    enabled
    env
    partial
    roles
    unanimous
    users

Command/ListRulesCommand.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Af\ProgressiveBundle\Command;
+
+use Progressive\Rule\RuleInterface;
+use Progressive\Rule\StoreInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ListRulesCommand extends Command
+{
+    private $store;
+    protected static $defaultName = 'progressive:rules';
+
+    public function __construct(StoreInterface $store)
+    {
+        parent::__construct();
+
+        $this->store = $store;
+    }
+
+    protected function configure()
+    {
+        $this
+            ->setDescription('List the available rules.')
+            ->setHelp(
+                <<<'EOF'
+The <info>%command.name%</info> command lists all the rules provided by Progressive:
+
+    <info>php %command.full_name%</info>
+EOF
+            )
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $rules = $this->store->list();
+
+        if (empty($rules)) {
+            $output->writeln('<error>No available rules.</error>');
+
+            return Command::SUCCESS;
+        }
+
+        usort($rules, function (RuleInterface $a, RuleInterface $b) {
+            return strnatcmp($a->getName(), $b->getName());
+        });
+
+        $output->writeln('<comment>Available rules:</comment>');
+
+        foreach ($rules as $rule) {
+            $output->writeln(sprintf('  <info>%s</info>', $rule->getName()));
+        }
+
+        return Command::SUCCESS;
+    }
+}

README.md

@@ -264,3 +264,18 @@ If you specify the name of the feature, its configuration will be displayed:
       env: dev, preprod
       roles: ROLE_DEV
 ```
+
+### `progressive:rules`
+
+The command `progressive:rules` lists the rules provided by Progressive:
+
+```bash
+  $ php bin/console progressive:rules
+  Available rules:
+    enabled
+    env
+    partial
+    roles
+    unanimous
+    users
+```

Resources/config/console.xml

@@ -9,5 +9,9 @@
             <argument type="service" id="Progressive\Progressive"/>
             <tag name="console.command"/>
         </service>
+        <service id="Af\ProgressiveBundle\Command\ListRulesCommand">
+            <argument type="service" id="Progressive\Rule\Store"/>
+            <tag name="console.command"/>
+        </service>
     </services>
 </container>

composer.json

@@ -11,7 +11,7 @@
         }
     ],
     "require": {
-        "antfroger/progressive": "^1.0",
+        "antfroger/progressive": "^1.2",
         "symfony/config": "^5.2",
         "symfony/console": "^5.2",
         "symfony/dependency-injection": "^5.2",

tests/Command/ListRulesCommandTest.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Af\ProgressiveBundle\Tests\Command;
+
+use Af\ProgressiveBundle\Command\ListRulesCommand;
+use PHPUnit\Framework\TestCase;
+use Progressive\Rule\Store;
+use Symfony\Component\Console\Tester\CommandTester;
+
+class ListRulesCommandTest extends TestCase
+{
+    private $tester;
+
+    protected function setUp(): void
+    {
+        $store = new Store();
+
+        $command = new ListRulesCommand($store);
+        $command->setName('progressive:rules');
+
+        $this->tester = new CommandTester($command);
+    }
+
+    public function testListRules(): void
+    {
+        $this->tester->execute([]);
+
+        $this->assertSame(
+            <<<EOF
+Available rules:
+  enabled
+  partial
+  unanimous
+
+EOF,
+            $this->tester->getDisplay()
+        );
+    }
+}