Merge pull request #60 from tyrsson/tweak-docs

Tweak docs for new namespaces

Author: tyrsson

README.md

@@ -6,8 +6,8 @@ A Command Bus implementation for Mezzio applications, providing a clean way to h
 
 ### Core Components
 
-- [CmdBus](docs/cmdbus.md) - The main command bus implementation
-- [CmdBusInterface](docs/cmdbus-interface.md) - Command bus contract
+- [CommandBus](docs/commandbus.md) - The main command bus implementation
+- [CommandBusInterface](docs/commandbus-interface.md) - Command bus contract
 - [MiddlewarePipe](docs/middleware-pipe.md) - Middleware pipeline management
 - [MiddlewarePipelineInterface](docs/middleware-pipeline-interface.md) - Pipeline contract
 - [CommandHandlerFactory](docs/command-handler-factory.md) - Factory for command handlers
@@ -22,7 +22,7 @@ A Command Bus implementation for Mezzio applications, providing a clean way to h
 
 ### Container Factories
 
-- [CmdBusFactory](docs/container/cmdbus-factory.md) - Service factory for CmdBus
+- [CommandBusFactory](docs/container/cmdbus-factory.md) - Service factory for CmdBus
 - [CommandHandlerFactoryFactory](docs/container/command-handler-factory-factory.md) - Factory for CommandHandlerFactory
 - [CommandHandlerMiddlewareFactory](docs/container/command-handler-middleware-factory.md) - Factory for CommandHandlerMiddleware
 - [MiddlewarePipeFactory](docs/container/middleware-pipe-factory.md) - Factory for MiddlewarePipe

docs/command-handler-interface.md

@@ -61,4 +61,4 @@ final class CreateUserHandler implements CommandHandlerInterface
 - [CommandInterface](command-interface.md) - Commands that handlers process
 - [CommandHandlerFactory](command-handler-factory.md) - Factory for resolving handlers
 - [CommandHandlerMiddleware](middleware/command-handler-middleware.md) - Middleware that executes handlers
-- [CmdBusInterface](cmdbus-interface.md) - Interface that extends this one
+- [CommandBusInterface](CommandBus-interface.md) - Interface that extends this one

docs/command-interface.md

@@ -62,5 +62,5 @@ final readonly class CreateUserCommand implements CommandInterface
 ## Related Components
 
 - [CommandHandlerInterface](command-handler-interface.md) - Handlers that process commands
-- [CmdBusInterface](cmdbus-interface.md) - Bus that dispatches commands
+- [CommandBusInterface](CommandBus-interface.md) - Bus that dispatches commands
 - [MiddlewareInterface](middleware-interface.md) - Middleware that can intercept commands

docs/cmdbus-interface.md docs/commandbus-interface.mddocs/cmdbus-interface.md renamed to docs/commandbus-interface.md

@@ -1,15 +1,15 @@
-# CmdBusInterface
+# CommandBusInterface
 
 The core contract defining the command bus behavior in the cmd-bus library.
 
 ## Overview
 
-`CmdBusInterface` extends `CommandHandlerInterface` to provide a unified contract for command processing. This interface ensures that any command bus implementation can handle commands consistently.
+`CommandBusInterface` extends `CommandHandlerInterface` to provide a unified contract for command processing. This interface ensures that any command bus implementation can handle commands consistently.
 
 ## Class Definition
 
 ```php
-interface CmdBusInterface extends CommandHandlerInterface
+interface CommandBusInterface extends CommandHandlerInterface
 {
 }
 ```
@@ -24,7 +24,7 @@ public function handle(CommandInterface $command): mixed;
 
 ## Purpose
 
-The `CmdBusInterface` serves as:
+The `CommandBusInterface` serves as:
 
 1. **Abstraction Layer** - Allows different command bus implementations
 2. **Dependency Injection Target** - Services can depend on the interface rather than concrete implementations
@@ -38,7 +38,7 @@ The `CmdBusInterface` serves as:
 class OrderHandler
 {
     public function __construct(
-        private CmdBusInterface $commandBus
+        private CommandBusInterface $commandBus
     ) {}
 
     public function handle(ServerRequestInterface $request): ResponseInterface
@@ -67,7 +67,7 @@ class OrderHandler
 class ProcessCommandMiddleware implements MiddlewareInterface
 {
     public function __construct(
-        private CmdBusInterface $commandBus
+        private CommandBusInterface $commandBus
     ) {}
 
     public function process(
@@ -88,10 +88,10 @@ class ProcessCommandMiddleware implements MiddlewareInterface
 
 ## Default Implementation
 
-The library provides a default implementation via the `CmdBus` class:
+The library provides a default implementation via the `CommandBus` class:
 
 ```php
-final class CmdBus implements CmdBusInterface
+final class CommandBus implements CommandBusInterface
 {
     public function handle(CommandInterface $command): mixed
     {
@@ -102,7 +102,7 @@ final class CmdBus implements CmdBusInterface
 
 ## Related Components
 
-- [CmdBus](cmdbus.md) - Default implementation of this interface
+- [CommandBus](CommandBus.md) - Default implementation of this interface
 - [CommandHandlerInterface](command-handler-interface.md) - Parent interface
 - [CommandInterface](command-interface.md) - Interface for commands
-- [CmdBusFactory](container/cmdbus-factory.md) - Factory for creating command bus instances
+- [CommandBusFactory](container/CommandBus-factory.md) - Factory for creating command bus instances

docs/cmdbus.md docs/commandbus.mddocs/cmdbus.md renamed to docs/commandbus.md

@@ -1,15 +1,15 @@
-# CmdBus
+# CommandBus
 
 The main command bus implementation that orchestrates command processing through a middleware pipeline.
 
 ## Overview
 
-`CmdBus` is the primary entry point for command processing. It accepts commands and delegates their execution to a configured middleware pipeline. This class provides a clean interface for command dispatch while allowing flexible middleware composition.
+`CommandBus` is the primary entry point for command processing. It accepts commands and delegates their execution to a configured middleware pipeline. This class provides a clean interface for command dispatch while allowing flexible middleware composition.
 
 ## Class Definition
 
 ```php
-final class CmdBus implements CmdBusInterface
+final class CommandBus implements CommandBusInterface
 {
     public function __construct(
         private MiddlewarePipelineInterface&MiddlewarePipe $pipeline
@@ -46,12 +46,12 @@ Processes a command through the configured middleware pipeline.
 
 ```php
 use App\Command\CreateUserCommand;
-use Webware\CommandBus\CmdBusInterface;
+use Webware\CommandBus\CommandBusInterface;
 
 class UserHandler
 {
     public function __construct(
-        private CmdBusInterface $commandBus
+        private CommandBusInterface $commandBus
     ) {}
 
     public function createAction(): ResponseInterface
@@ -70,7 +70,7 @@ class UserHandler
 
 ## Related Components
 
-- [CmdBusInterface](cmdbus-interface.md) - The interface this class implements
+- [CommandBusInterface](CommandBus-interface.md) - The interface this class implements
 - [MiddlewarePipe](middleware-pipe.md) - The pipeline component used internally
-- [CmdBusFactory](container/cmdbus-factory.md) - Factory for creating instances
+- [CommandBusFactory](container/CommandBus-factory.md) - Factory for creating instances
 - [CommandInterface](command-interface.md) - Interface all commands must implement

docs/config-provider.md

@@ -96,12 +96,12 @@ The ConfigProvider automatically registers these services:
 
 ### Core Services
 
-- `CmdBusInterface` → `CmdBus`
+- `CommandBusInterface` → `CommandBus`
 - `MiddlewarePipelineInterface` → `MiddlewarePipe`
 
 ### Factories
 
-- `CmdBus` → `Container\CmdBusFactory`
+- `CommandBus` → `Container\CommandBusFactory`
 - `CommandHandlerFactory` → `Container\CommandHandlerFactoryFactory`
 - `MiddlewarePipe` → `Container\MiddlewarePipeFactory`
 - `CommandHandlerMiddleware` → `Container\CommandHandlerMiddlewareFactory`
@@ -133,7 +133,7 @@ The ConfigProvider automatically registers these services:
 
 ## Related Components
 
-- [CmdBus](cmdbus.md) - Main service configured by this provider
+- [CommandBus](CommandBus.md) - Main service configured by this provider
 - [MiddlewarePipe](middleware-pipe.md) - Pipeline service configured by this provider
 - [CommandHandlerFactory](command-handler-factory.md) - Factory for resolving handlers
 - [Container Factories](container/) - Service factories registered by this provider

docs/container/cmdbus-factory.md docs/container/commandbus-factory.mddocs/container/cmdbus-factory.md renamed to docs/container/commandbus-factory.md

@@ -1,24 +1,24 @@
-# CmdBusFactory
+# CommandBusFactory
 
-Factory class for creating `CmdBus` instances with proper dependency injection via Laminas ServiceManager.
+Factory class for creating `CommandBus` instances with proper dependency injection via Laminas ServiceManager.
 
 ## Overview
 
-`CmdBusFactory` is a Laminas ServiceManager factory that creates and configures `CmdBus` instances. It handles dependency resolution and ensures the command bus is properly initialized with its required middleware pipeline.
+`CommandBusFactory` is a Laminas ServiceManager factory that creates and configures `CommandBus` instances. It handles dependency resolution and ensures the command bus is properly initialized with its required middleware pipeline.
 
 ## Class Definition
 
 ```php
-final class CmdBusFactory
+final class CommandBusFactory
 {
-    public function __invoke(ContainerInterface $container): CmdBus;
+    public function __invoke(ContainerInterface $container): CommandBus;
 }
 ```
 
 ## Implementation
 
 ```php
-public function __invoke(ContainerInterface $container): CmdBus
+public function __invoke(ContainerInterface $container): CommandBus
 {
     if (!$container->has(MiddlewarePipelineInterface::class)) {
         throw ServiceNotFoundException::fromService(MiddlewarePipelineInterface::class);
@@ -27,7 +27,7 @@ public function __invoke(ContainerInterface $container): CmdBus
     /** @var MiddlewarePipelineInterface&MiddlewarePipe $middlewarePipeline */
     $middlewarePipeline = $container->get(MiddlewarePipelineInterface::class);
 
-    return new CmdBus($middlewarePipeline);
+    return new CommandBus($middlewarePipeline);
 }
 ```
 
@@ -46,10 +46,10 @@ The factory is automatically registered by the `ConfigProvider`:
 ```php
 // In ConfigProvider::getDependencies()
 'factories' => [
-    CmdBus::class => Container\CmdBusFactory::class,
+    CommandBus::class => Container\CommandBusFactory::class,
 ],
 'aliases' => [
-    CmdBusInterface::class => CmdBus::class,
+    CommandBusInterface::class => CommandBus::class,
 ],
 ```
 
@@ -60,10 +60,10 @@ The factory is automatically registered by the `ConfigProvider`:
 return [
     'dependencies' => [
         'factories' => [
-            Webware\CommandBus\CmdBus::class => Webware\CommandBus\Container\CmdBusFactory::class,
+            Webware\CommandBus\CommandBus::class => Webware\CommandBus\Container\CommandBusFactory::class,
         ],
         'aliases' => [
-            Webware\CommandBus\CmdBusInterface::class => Webware\CommandBus\CmdBus::class,
+            Webware\CommandBus\CommandBusInterface::class => Webware\CommandBus\CommandBus::class,
         ],
     ],
 ];
@@ -73,21 +73,21 @@ return [
 
 ```php
 // In your application code
-$commandBus = $container->get(CmdBusInterface::class);
+$commandBus = $container->get(CommandBusInterface::class);
 
 // Or directly
-$commandBus = $container->get(CmdBus::class);
+$commandBus = $container->get(CommandBus::class);
 ```
 
 ### Factory in Action
 
 ```php
 use Psr\Container\ContainerInterface;
-use Webware\CommandBus\Container\CmdBusFactory;
+use Webware\CommandBus\Container\CommandBusFactory;
 
 // Container setup (typically handled by Mezzio/Laminas)
 $container = new ServiceManager();
-$factory = new CmdBusFactory();
+$factory = new CommandBusFactory();
 
 // Factory creates the command bus
 $commandBus = $factory($container);
@@ -104,7 +104,7 @@ $result = $commandBus->handle($command);
 class ExampleRequestHandler
 {
     public function __construct(
-        private CmdBusInterface $commandBus
+        private CommandBusInterface $commandBus
     ) {}
 
     public function handle(ServerRequestInterface $request): ResponseInterface
@@ -137,7 +137,7 @@ class ExampleRequestHandlerFactory implements FactoryInterface
         array $options = null
     ): ExampleRequestHandler {
         return new ExampleRequestHandler(
-            $container->get(CmdBusInterface::class) // Uses CmdBusFactory internally
+            $container->get(CommandBusInterface::class) // Uses CommandBusFactory internally
         );
     }
 }
@@ -149,7 +149,7 @@ class ExampleRequestHandlerFactory implements FactoryInterface
 class UserService
 {
     public function __construct(
-        private CmdBusInterface $commandBus
+        private CommandBusInterface $commandBus
     ) {}
 
     public function createUser(array $userData): User
@@ -228,10 +228,10 @@ Always inject the interface rather than the concrete class:
 
 ```php
 // ✅ Good - depends on interface
-public function __construct(private CmdBusInterface $commandBus) {}
+public function __construct(private CommandBusInterface $commandBus) {}
 
 // ❌ Bad - depends on implementation
-public function __construct(private CmdBus $commandBus) {}
+public function __construct(private CommandBus $commandBus) {}
 ```
 
 ### 2. Configure All Dependencies
@@ -241,7 +241,7 @@ Ensure all middleware and handlers have proper factories:
 ```php
 'dependencies' => [
     'factories' => [
-        CmdBus::class => CmdBusFactory::class,
+        CommandBus::class => CommandBusFactory::class,
         MiddlewarePipe::class => MiddlewarePipeFactory::class,
         CommandHandlerMiddleware::class => CommandHandlerMiddlewareFactory::class,
         // Your custom services...
@@ -252,7 +252,7 @@ Ensure all middleware and handlers have proper factories:
 
 ## Related Components
 
-- [CmdBus](../cmdbus.md) - The service this factory creates
+- [CommandBus](../CommandBus.md) - The service this factory creates
 - [MiddlewarePipeFactory](middleware-pipe-factory.md) - Factory for the required middleware pipeline
 - [ConfigProvider](../config-provider.md) - Registers this factory
 - [ServiceNotFoundException](../exception/service-not-found-exception.md) - Exception thrown for missing dependencies

docs/getting-started.md

@@ -5,7 +5,7 @@ A comprehensive guide to using the cmd-bus Command Bus library in your Mezzio ap
 ## Installation
 
 ```bash
-composer require php-cmd/cmd-bus
+composer require webware/command-bus
 ```
 
 ## Quick Setup
@@ -110,14 +110,14 @@ return [
 // src/User/RequestHandler/CreateUserHandler.php
 namespace App\User\RequestHandler;
 
-use Webware\CommandBus\CmdBusInterface;
+use Webware\CommandBus\CommandBusInterface;
 use Laminas\Diactoros\Response\JsonResponse;
 
 // Note that this is a request handler, not a command handler
 class CreateUserHandler
 {
     public function __construct(
-        private CmdBusInterface $commandBus
+        private CommandBusInterface $commandBus
     ) {}
 
     public function handle(ServerRequestInterface $request): ResponseInterface