Rename useDevelopmentMode to enableDebugging

The new name removes any relation between running environment and debugging controls. Signed-off-by: Luís Cobucci <[email protected]>
lcobucci · Nov 10, 2024 · 6aecee7 · 6aecee7
1 parent c36e18c
commit 6aecee7
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 5 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -34,7 +34,7 @@ $testContainer = $builder->getTestContainer();
 * `ContainerBuilder#addPass()`: Adds an instance of a [Compiler Pass](compiler-passes.md) to be processed
 * `ContainerBuilder#addDelayedPass()`: Adds a reference (class name and constructor arguments) of a [Compiler Pass](compiler-passes.md) to be processed
 * `ContainerBuilder#addPackage()`: Adds a reference (class name and constructor arguments) of a [Package](packages.md) to be processed
-* `ContainerBuilder#useDevelopmentMode()`: Optimises the generate container for development purposes (configures the compiler to track file changes and update the cache)
+* `ContainerBuilder#enableDebugging()`: Configures the compiler to track file changes and update the cache, optimised for local development purposes
 * `ContainerBuilder#setDumpDir()`: Configures the directory to be used to dump the cache files
 * `ContainerBuilder#setParameter()`: Configures a dynamic parameter
 * `ContainerBuilder#setBaseClass()`: Modifies which class should be used as base class for the container
@@ -59,8 +59,8 @@ require __DIR__ . '/../vendor/autoload.php';
 $builder     = ContainerBuilder::xml(__FILE__, __NAMESPACE__);
 $projectRoot = dirname(__DIR__);
 
-if (getenv('APPLICATION_MODE', true) === 'development') {
-    $builder->useDevelopmentMode();
+if (getenv('APP_PROFILE') !== 'prod') {
+    $builder->enableDebugging();
 }
 
 return $builder->setDumpDir($projectRoot . '/var/tmp')

diff --git a/src/Builder.php b/src/Builder.php
@@ -55,9 +55,18 @@ public function addPackage(string $className, array $constructArguments = []): B
 
     /**
      * Mark the container to be used as development mode
+     *
+     * @deprecated this method will be removed in favour of a more explicit name.
+     *
+     * @see enableDebugging
      */
     public function useDevelopmentMode(): Builder;
 
+    /**
+     * Configure the container to track file updates
+     */
+    public function enableDebugging(): Builder;
+
     /**
      * Configures the dump directory
      */

diff --git a/src/ContainerBuilder.php b/src/ContainerBuilder.php
@@ -145,6 +145,11 @@ public function addPackage(string $className, array $constructArguments = []): B
     }
 
     public function useDevelopmentMode(): Builder
+    {
+        return $this->enableDebugging();
+    }
+
+    public function enableDebugging(): Builder
     {
         $this->parameterBag->set('app.devmode', true);
 

diff --git a/test/ContainerBuilderTest.php b/test/ContainerBuilderTest.php
@@ -177,11 +177,11 @@ public function setBaseClassShouldConfigureTheBaseClassAndReturnSelf(): void
     }
 
     #[PHPUnit\Test]
-    public function useDevelopmentModeShouldChangeTheParameterAndReturnSelf(): void
+    public function enableDebuggingShouldChangeTheParameterAndReturnSelf(): void
     {
         $builder = new ContainerBuilder($this->config, $this->generator, $this->parameterBag);
 
-        self::assertSame($builder, $builder->useDevelopmentMode());
+        self::assertSame($builder, $builder->enableDebugging());
         self::assertTrue($this->parameterBag->get('app.devmode'));
     }