Skip to content

Commit c7b5362

Browse files
jkowalleckjkowalleck
authored
rename metaData -> metadata (#149)
Signed-off-by: Jan Kowalleck <[email protected]> Signed-off-by: Jan Kowalleck <[email protected]>
1 parent b1503a3 commit c7b5362

21 files changed

+124
-121
lines changed

‎HISTORY.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ API changes
2828
* Changed some methods to no longer throw `\InvalidArgumentException`. (via [#125])
2929
PhpDoc annotations were updated, so that code analysis tools should pick up.
3030
This was possible by enforcing correct typing on PHP8 language level.
31+
* BREAKING: Every occurrence of `[mM]etaData` with a capital "D" was renamed to `[mM]metadata` with a small "d". ([#133] via [#131], [#149])
32+
This affected class names, method names, variable names, property names, file names, documentation - everything.
3133
* `\CycloneDX\Core\Enum` namespace
3234
* Added class constant `ExternalReferenceType::RELEASE_NOTES` to reflect CycloneDX v1.4 ([#57] via [#65])
3335
* `\CycloneDX\Core\Models` namespace
@@ -56,7 +58,7 @@ API changes
5658
* BREAKING: Removed this class (via [#125], [#131])
5759
* `MetaData` class
5860
* BREAKING: renamed class to `Metadata` ([#133] via [#131])
59-
Even though PHP is case-insensitive with class names, autoloaders are not. Therefore, this is considered a breaking change.
61+
Even though PHP is case-insensitive with class names, autoloaders may be case-sensitive. Therefore, this is considered a breaking change.
6062
* BREAKING: changed methods `{get,set}Tools()` so that their parameter & return type is non-nullable, was nullable ([#66] via [#131])
6163
* `Tool` class
6264
* BREAKING: renamed methods `{get,set}ExternalReferenceRepository()` -> `{get,set}ExternalReferences()` ([#133] via [#131])
@@ -137,6 +139,7 @@ API changes
137139
[#143]: https://github.com/CycloneDX/cyclonedx-php-library/pull/143
138140
[#144]: https://github.com/CycloneDX/cyclonedx-php-library/pull/144
139141
[#146]: https://github.com/CycloneDX/cyclonedx-php-library/pull/146
142+
[#149]: https://github.com/CycloneDX/cyclonedx-php-library/pull/149
140143

141144
## 1.6.3 - 2022-09-15
142145

‎src/Core/Serialization/DOM/NormalizerFactory.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,9 @@ public function makeForHash(): Normalizers\HashNormalizer
106106
return new Normalizers\HashNormalizer($this);
107107
}
108108

109-
public function makeForMetaData(): Normalizers\MetaDataNormalizer
109+
public function makeForMetadata(): Normalizers\MetadataNormalizer
110110
{
111-
return new Normalizers\MetaDataNormalizer($this);
111+
return new Normalizers\MetadataNormalizer($this);
112112
}
113113

114114
public function makeForToolRepository(): Normalizers\ToolRepositoryNormalizer

‎src/Core/Serialization/DOM/Normalizers/BomNormalizer.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public function normalize(Bom $bom): DOMElement
5959
$this->simpleDomAppendChildren(
6060
$element,
6161
[
62-
$this->normalizeMetaData($bom->getMetadata()),
62+
$this->normalizeMetadata($bom->getMetadata()),
6363
$this->normalizeComponents($bom->getComponents()),
6464
$this->normalizeExternalReferences($bom),
6565
$this->normalizeDependencies($bom),
@@ -79,15 +79,15 @@ private function normalizeComponents(ComponentRepository $components): DOMElemen
7979
);
8080
}
8181

82-
private function normalizeMetaData(Metadata $metaData): ?DOMElement
82+
private function normalizeMetadata(Metadata $metadata): ?DOMElement
8383
{
8484
$factory = $this->getNormalizerFactory();
8585

86-
if (false === $factory->getSpec()->supportsMetaData()) {
86+
if (false === $factory->getSpec()->supportsMetadata()) {
8787
return null;
8888
}
8989

90-
$elem = $factory->makeForMetaData()->normalize($metaData);
90+
$elem = $factory->makeForMetadata()->normalize($metadata);
9191

9292
return $elem->hasChildNodes()
9393
? $elem
@@ -100,7 +100,7 @@ private function normalizeExternalReferences(Bom $bom): ?DOMElement
100100

101101
$extRefs = $bom->getExternalReferences();
102102

103-
if (false === $factory->getSpec()->supportsMetaData()) {
103+
if (false === $factory->getSpec()->supportsMetadata()) {
104104
// prevent possible information loss: metadata cannot be rendered -> put it to bom
105105
$mcr = $bom->getMetadata()->getComponent()?->getExternalReferences();
106106
if (null !== $mcr) {

‎src/Core/Serialization/DOM/Normalizers/MetaDataNormalizer.php‎ renamed to ‎src/Core/Serialization/DOM/Normalizers/MetadataNormalizer.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,19 @@
3333
/**
3434
* @author jkowalleck
3535
*/
36-
class MetaDataNormalizer extends _BaseNormalizer
36+
class MetadataNormalizer extends _BaseNormalizer
3737
{
3838
use SimpleDomTrait;
3939

40-
public function normalize(Metadata $metaData): DOMElement
40+
public function normalize(Metadata $metadata): DOMElement
4141
{
4242
return $this->simpleDomAppendChildren(
4343
$this->getNormalizerFactory()->getDocument()->createElement('metadata'),
4444
[
4545
// timestamp
46-
$this->normalizeTools($metaData->getTools()),
46+
$this->normalizeTools($metadata->getTools()),
4747
// authors
48-
$this->normalizeComponent($metaData->getComponent()),
48+
$this->normalizeComponent($metadata->getComponent()),
4949
// manufacture
5050
// supplier
5151
]

‎src/Core/Serialization/JSON/NormalizerFactory.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,9 @@ public function makeForHash(): Normalizers\HashNormalizer
9494
return new Normalizers\HashNormalizer($this);
9595
}
9696

97-
public function makeForMetaData(): Normalizers\MetaDataNormalizer
97+
public function makeForMetadata(): Normalizers\MetadataNormalizer
9898
{
99-
return new Normalizers\MetaDataNormalizer($this);
99+
return new Normalizers\MetadataNormalizer($this);
100100
}
101101

102102
public function makeForToolRepository(): Normalizers\ToolRepositoryNormalizer

‎src/Core/Serialization/JSON/Normalizers/BomNormalizer.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public function normalize(Bom $bom): array
4646
'bomFormat' => self::BOM_FORMAT,
4747
'specVersion' => $factory->getSpec()->getVersion(),
4848
'version' => $bom->getVersion(),
49-
'metadata' => $this->normalizeMetaData($bom->getMetadata()),
49+
'metadata' => $this->normalizeMetadata($bom->getMetadata()),
5050
'components' => $factory->makeForComponentRepository()->normalize($bom->getComponents()),
5151
'externalReferences' => $this->normalizeExternalReferences($bom),
5252
'dependencies' => $this->normalizeDependencies($bom),
@@ -55,15 +55,15 @@ public function normalize(Bom $bom): array
5555
);
5656
}
5757

58-
private function normalizeMetaData(Metadata $metaData): ?array
58+
private function normalizeMetadata(Metadata $metadata): ?array
5959
{
6060
$factory = $this->getNormalizerFactory();
6161

62-
if (false === $factory->getSpec()->supportsMetaData()) {
62+
if (false === $factory->getSpec()->supportsMetadata()) {
6363
return null;
6464
}
6565

66-
$data = $factory->makeForMetaData()->normalize($metaData);
66+
$data = $factory->makeForMetadata()->normalize($metadata);
6767

6868
return empty($data)
6969
? null
@@ -76,7 +76,7 @@ private function normalizeExternalReferences(Bom $bom): ?array
7676

7777
$extRefs = $bom->getExternalReferences();
7878

79-
if (false === $factory->getSpec()->supportsMetaData()) {
79+
if (false === $factory->getSpec()->supportsMetadata()) {
8080
// prevent possible information loss: metadata cannot be rendered -> put it to bom
8181
$mcr = $bom->getMetadata()->getComponent()?->getExternalReferences();
8282
if (null !== $mcr) {

‎src/Core/Serialization/JSON/Normalizers/MetaDataNormalizer.php‎ renamed to ‎src/Core/Serialization/JSON/Normalizers/MetadataNormalizer.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,18 @@
3232
/**
3333
* @author jkowalleck
3434
*/
35-
class MetaDataNormalizer extends _BaseNormalizer
35+
class MetadataNormalizer extends _BaseNormalizer
3636
{
3737
use NullAssertionTrait;
3838

39-
public function normalize(Metadata $metaData): array
39+
public function normalize(Metadata $metadata): array
4040
{
4141
return array_filter(
4242
[
4343
// timestamp
44-
'tools' => $this->normalizeTools($metaData->getTools()),
44+
'tools' => $this->normalizeTools($metadata->getTools()),
4545
// authors
46-
'component' => $this->normalizeComponent($metaData->getComponent()),
46+
'component' => $this->normalizeComponent($metadata->getComponent()),
4747
// manufacture
4848
// supplier
4949
],

‎tests/Core/Models/BomTest.php‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,20 +96,20 @@ public function testVersionSetterInvalidValue(Bom $bom): void
9696

9797
// endregion version setter&getter
9898

99-
// region metaData setter&getter
99+
// region metadata setter&getter
100100

101101
/**
102102
* @depends testConstruct
103103
*/
104-
public function testMetaDataSetterGetter(Bom $bom): void
104+
public function testMetadataSetterGetter(Bom $bom): void
105105
{
106-
$metaData = $this->createStub(Metadata::class);
107-
$actual = $bom->setMetadata($metaData);
106+
$metadata = $this->createStub(Metadata::class);
107+
$actual = $bom->setMetadata($metadata);
108108
self::assertSame($bom, $actual);
109-
self::assertSame($metaData, $bom->getMetadata());
109+
self::assertSame($metadata, $bom->getMetadata());
110110
}
111111

112-
// endregion metaData setter&getter
112+
// endregion metadata setter&getter
113113

114114
// region externalReferenceRepository setter&getter
115115

‎tests/Core/Models/MetadataTest.php‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,31 +37,31 @@ class MetadataTest extends TestCase
3737
{
3838
public function testConstructor(): Metadata
3939
{
40-
$metaData = new Metadata();
40+
$metadata = new Metadata();
4141

42-
self::assertCount(0, $metaData->getTools());
43-
self::assertNull($metaData->getComponent());
42+
self::assertCount(0, $metadata->getTools());
43+
self::assertNull($metadata->getComponent());
4444

45-
return $metaData;
45+
return $metadata;
4646
}
4747

4848
/**
4949
* @depends testConstructor
5050
*/
51-
public function testGetterSetterTools(Metadata $metaData): void
51+
public function testGetterSetterTools(Metadata $metadata): void
5252
{
5353
$tools = $this->createStub(ToolRepository::class);
54-
$metaData->setTools($tools);
55-
self::assertSame($tools, $metaData->getTools());
54+
$metadata->setTools($tools);
55+
self::assertSame($tools, $metadata->getTools());
5656
}
5757

5858
/**
5959
* @depends testConstructor
6060
*/
61-
public function testSetterSetterComponent(Metadata $metaData): void
61+
public function testSetterSetterComponent(Metadata $metadata): void
6262
{
6363
$component = $this->createStub(Component::class);
64-
$metaData->setComponent($component);
65-
self::assertSame($component, $metaData->getComponent());
64+
$metadata->setComponent($component);
65+
self::assertSame($component, $metadata->getComponent());
6666
}
6767
}

‎tests/Core/Serialization/DOM/NormalizerFactoryTest.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,12 +155,12 @@ public function testMakeForHash(NormalizerFactory $factory): void
155155
/**
156156
* @depends testConstructor
157157
*
158-
* @uses \CycloneDX\Core\Serialization\DOM\Normalizers\MetaDataNormalizer
158+
* @uses \CycloneDX\Core\Serialization\DOM\Normalizers\MetadataNormalizer
159159
*/
160-
public function testMakeForMetaData(NormalizerFactory $factory): void
160+
public function testMakeForMetadata(NormalizerFactory $factory): void
161161
{
162-
$normalizer = $factory->makeForMetaData();
163-
self::assertInstanceOf(Normalizers\MetaDataNormalizer::class, $normalizer);
162+
$normalizer = $factory->makeForMetadata();
163+
self::assertInstanceOf(Normalizers\MetadataNormalizer::class, $normalizer);
164164
self::assertSame($factory, $normalizer->getNormalizerFactory());
165165
}
166166

0 commit comments

Comments
 (0)