refactor: move non-public API into a sub-namespace called _internal…

…, so that its reliability is obvious.

Signed-off-by: Jan Kowalleck <[email protected]>

HISTORY.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 
 ## unreleased
 
+* Misc
+  * Moved non-public API into a sub-namespace called `_internal`, so that its reliability is obvious. 
+
 ## 4.2.0 - 2023-09-04
 
 * Added

src/Plugin.php

@@ -31,8 +31,6 @@
 use Composer\Plugin\PluginInterface;
 
 /**
- * @internal
- *
  * @author jkowalleck
  *
  * @psalm-suppress UnusedClass
@@ -67,9 +65,9 @@ public function getCapabilities(): array
     public function getCommands(): array
     {
         return [
-            new MakeBom\Command(
+            new _internal\MakeBom\Command(
                 'CycloneDX:make-sbom',
-                new MakeBom\Options(),
+                new _internal\MakeBom\Options(),
                 new Factory()
             ),
         ];

src/MakeBom/Builder.php → src/_internal/MakeBom/Builder.php

@@ -21,7 +21,7 @@
  * Copyright (c) OWASP Foundation. All Rights Reserved.
  */
 
-namespace CycloneDX\Composer\MakeBom;
+namespace CycloneDX\Composer\_internal\MakeBom;
 
 use Composer\Composer;
 use Composer\Package\CompletePackageInterface;
@@ -31,7 +31,7 @@
 use Composer\Repository\InstalledRepositoryInterface;
 use Composer\Repository\LockArrayRepository;
 use Composer\Semver\Constraint\MatchAllConstraint;
-use CycloneDX\Composer\Properties;
+use CycloneDX\Composer\_internal\Properties;
 use CycloneDX\Core\Enums;
 use CycloneDX\Core\Factories\LicenseFactory;
 use CycloneDX\Core\Models;

src/MakeBom/Command.php → src/_internal/MakeBom/Command.php

@@ -21,7 +21,7 @@
  * Copyright (c) OWASP Foundation. All Rights Reserved.
  */
 
-namespace CycloneDX\Composer\MakeBom;
+namespace CycloneDX\Composer\_internal\MakeBom;
 
 use Composer\Command\BaseCommand;
 use Composer\Factory as ComposerFactory;

src/MakeBom/Errors/OptionError.php → src/_internal/MakeBom/Errors/OptionError.php

@@ -21,7 +21,7 @@
  * Copyright (c) OWASP Foundation. All Rights Reserved.
  */
 
-namespace CycloneDX\Composer\MakeBom\Errors;
+namespace CycloneDX\Composer\_internal\MakeBom\Errors;
 
 use DomainException;
 

src/MakeBom/Errors/OutputError.php → src/_internal/MakeBom/Errors/OutputError.php

@@ -21,7 +21,7 @@
  * Copyright (c) OWASP Foundation. All Rights Reserved.
  */
 
-namespace CycloneDX\Composer\MakeBom\Errors;
+namespace CycloneDX\Composer\_internal\MakeBom\Errors;
 
 use Exception;
 

src/MakeBom/Errors/ValidationError.php → src/_internal/MakeBom/Errors/ValidationError.php

@@ -21,7 +21,7 @@
  * Copyright (c) OWASP Foundation. All Rights Reserved.
  */
 
-namespace CycloneDX\Composer\MakeBom\Errors;
+namespace CycloneDX\Composer\_internal\MakeBom\Errors;
 
 use Exception;
 

src/MakeBom/Options.php → src/_internal/MakeBom/Options.php

@@ -21,7 +21,7 @@
  * Copyright (c) OWASP Foundation. All Rights Reserved.
  */
 
-namespace CycloneDX\Composer\MakeBom;
+namespace CycloneDX\Composer\_internal\MakeBom;
 
 use CycloneDX\Core\Spec\Format;
 use CycloneDX\Core\Spec\Version;

src/Properties.php → src/_internal/Properties.php

@@ -21,7 +21,7 @@
  * Copyright (c) OWASP Foundation. All Rights Reserved.
  */
 
-namespace CycloneDX\Composer;
+namespace CycloneDX\Composer\_internal;
 
 /**
  * CDX properties' names and well-known values - specific to this very tool.

src/_internal/README.md

@@ -0,0 +1,5 @@
+# INTERNAL
+
+All in here is to be treated non-public API.  
+All code in here might change without any notice during version upgrades.
+No backwards compatibility is guaranteed.

tests/Functional/PluginTest.php

@@ -26,8 +26,8 @@
 use Composer\Plugin\Capability\CommandProvider;
 use Composer\Plugin\Capable;
 use Composer\Plugin\PluginInterface;
-use CycloneDX\Composer\MakeBom\Command;
-use CycloneDX\Composer\MakeBom\Options;
+use CycloneDX\Composer\_internal\MakeBom\Command;
+use CycloneDX\Composer\_internal\MakeBom\Options;
 use CycloneDX\Composer\Plugin;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\CoversNothing;

tests/Integration/CommandMakeSbomAsExpectedTest.php

@@ -23,9 +23,9 @@
 
 namespace CycloneDX\Tests\Integration;
 
-use CycloneDX\Composer\MakeBom\Builder;
-use CycloneDX\Composer\MakeBom\Command;
-use CycloneDX\Composer\MakeBom\Options;
+use CycloneDX\Composer\_internal\MakeBom\Builder;
+use CycloneDX\Composer\_internal\MakeBom\Command;
+use CycloneDX\Composer\_internal\MakeBom\Options;
 use CycloneDX\Composer\Plugin;
 use Generator;
 use PHPUnit\Framework\Attributes\CoversClass;

tests/Integration/CommandMakeSbomFailsTest.php

@@ -23,9 +23,9 @@
 
 namespace CycloneDX\Tests\Integration;
 
-use CycloneDX\Composer\MakeBom\Builder;
-use CycloneDX\Composer\MakeBom\Command;
-use CycloneDX\Composer\MakeBom\Options;
+use CycloneDX\Composer\_internal\MakeBom\Builder;
+use CycloneDX\Composer\_internal\MakeBom\Command;
+use CycloneDX\Composer\_internal\MakeBom\Options;
 use CycloneDX\Composer\Plugin;
 use Generator;
 use PHPUnit\Framework\Attributes\CoversClass;

tests/Integration/CommandMakeSbomTest.php

@@ -23,9 +23,9 @@
 
 namespace CycloneDX\Tests\Integration;
 
-use CycloneDX\Composer\MakeBom\Builder;
-use CycloneDX\Composer\MakeBom\Command;
-use CycloneDX\Composer\MakeBom\Options;
+use CycloneDX\Composer\_internal\MakeBom\Builder;
+use CycloneDX\Composer\_internal\MakeBom\Command;
+use CycloneDX\Composer\_internal\MakeBom\Options;
 use CycloneDX\Composer\Plugin;
 use Generator;
 use PHPUnit\Framework\Attributes\CoversClass;

tests/Integration/CommandTestCase.php

@@ -24,7 +24,7 @@
 namespace CycloneDX\Tests\Integration;
 
 use Composer\Console\Application;
-use CycloneDX\Composer\MakeBom\Command;
+use CycloneDX\Composer\_internal\MakeBom\Command;
 use PHPUnit\Framework\TestCase;
 
 abstract class CommandTestCase extends TestCase

tests/Unit/MakeBom/BuilderTest.php

@@ -25,7 +25,7 @@
 
 use Composer\Factory as ComposerFactory;
 use Composer\IO\NullIO;
-use CycloneDX\Composer\MakeBom\Builder;
+use CycloneDX\Composer\_internal\MakeBom\Builder;
 use CycloneDX\Composer\Plugin;
 use CycloneDX\Core\Enums;
 use CycloneDX\Core\Models;

tests/Unit/MakeBom/OptionsTest.php

@@ -23,7 +23,7 @@
 
 namespace CycloneDX\Tests\Unit\MakeBom;
 
-use CycloneDX\Composer\MakeBom\Options;
+use CycloneDX\Composer\_internal\MakeBom\Options;
 use CycloneDX\Core\Spec\Format;
 use CycloneDX\Core\Spec\Version;
 use DomainException;