Skip to content

Commit 0dcccad

Browse files
andreas-hiltiandreas-hilti
authored
chore: Cleanup to fix several issues pointed out by Codacy (#359)
Signed-off-by: andreas hilti <[email protected]>
1 parent 97fe22d commit 0dcccad

34 files changed

+224
-110
lines changed

‎.markdownlint.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"MD013": {
3+
"code_blocks": false
4+
}
5+
}

‎benchmark/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
Just a little project to help with benchmarking and performance tuning.
44

5-
`dotnet run --configuration Release`
5+
`dotnet run --configuration Release`

‎docs/articles/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -141,4 +141,4 @@ using (var outputFile = File.OpenWrite("bom-1.3.json"))
141141
bom.SpecVersion = SpecificationVersion.v1_3;
142142
Json.Serializer.Serialize(bom, outputFile);
143143
}
144-
```
144+
```

‎docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ Tests are automatically run on Windows, MacOS and Linux for every pull request.
5656
And build warnings will break the build.
5757

5858
If you are having trouble debugging a test that is failing for a platform you
59-
don't have access to please us know.
59+
don't have access to please us know.

‎docs/namespaces/CycloneDX.Exceptions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
uid: CycloneDX.Exceptions
33
summary: *content
44
---
5-
Namespace containing all custom exceptions the `CycloneDX.Core` library uses.
5+
Namespace containing all custom exceptions the `CycloneDX.Core` library uses.

‎docs/namespaces/CycloneDX.Json.Converters.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ uid: CycloneDX.Json.Converters.v1_2
33
summary: *content
44
---
55
Namespace containing all custom JSON converters required for serialization and
6-
deserialization.
6+
deserialization.

‎docs/namespaces/CycloneDX.Json.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
uid: CycloneDX.Json
33
summary: *content
44
---
5-
Namespace containing all JSON specific functionality. Including serialization, deserialization, and validation.
5+
Namespace containing all JSON specific functionality. Including serialization, deserialization, and validation.

‎docs/namespaces/CycloneDX.Models.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
uid: CycloneDX.Models
33
summary: *content
44
---
5-
Namespace containing all CycloneDX data models.
5+
Namespace containing all CycloneDX data models.

‎docs/namespaces/CycloneDX.Protobuf.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
uid: CycloneDX.Json
33
summary: *content
44
---
5-
Namespace containing all Protocol Buffer specific functionality. Including serialization and deserialization.
5+
Namespace containing all Protocol Buffer specific functionality. Including serialization and deserialization.

‎docs/namespaces/CycloneDX.Utils.Exceptions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
uid: CycloneDX.Utils.Exceptions
33
summary: *content
44
---
5-
Namespace containing all custom exceptions the `CycloneDX.Utils` library uses.
5+
Namespace containing all custom exceptions the `CycloneDX.Utils` library uses.

‎docs/namespaces/CycloneDX.Utils.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
uid: CycloneDX.Utils
33
summary: *content
44
---
5-
Namespace containing utility methods that operate on CycloneDX BOMs.
5+
Namespace containing utility methods that operate on CycloneDX BOMs.

‎docs/namespaces/CycloneDX.Xml.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
uid: CycloneDX.Xml
33
summary: *content
44
---
5-
Namespace containing all XML specific functionality. Including serialization, deserialization, and validation.
5+
Namespace containing all XML specific functionality. Including serialization, deserialization, and validation.

‎docs/namespaces/CycloneDX.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
uid: CycloneDX
33
summary: *content
44
---
5-
The base CycloneDX namespace.
5+
The base CycloneDX namespace.

‎src/CycloneDX.Core/BomUtils.cs

+28-6
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,10 @@ internal static Bom CopyBomAndDowngrade(Bom bom)
156156
bomCopy.Properties = null;
157157
bomCopy.Formulation = null;
158158

159-
if (bomCopy.Metadata != null) bomCopy.Metadata.Lifecycles = null;
159+
if (bomCopy.Metadata != null)
160+
{
161+
bomCopy.Metadata.Lifecycles = null;
162+
}
160163

161164
if (bomCopy.Compositions != null)
162165
{
@@ -177,7 +180,10 @@ internal static Bom CopyBomAndDowngrade(Bom bom)
177180
{
178181
component.ModelCard = null;
179182
component.Data = null;
180-
if ((int)component.Type > 8) component.Type = Component.Classification.Library;
183+
if ((int)component.Type > 8)
184+
{
185+
component.Type = Component.Classification.Library;
186+
}
181187
});
182188

183189
EnumerateAllServices(bomCopy, (service) =>
@@ -425,15 +431,21 @@ public static void EnumerateAllEvidence(Bom bom, Action<Evidence> callback)
425431
{
426432
EnumerateAllComponents(bom, (component) =>
427433
{
428-
if (component.Evidence != null) callback(component.Evidence);
434+
if (component.Evidence != null)
435+
{
436+
callback(component.Evidence);
437+
}
429438
});
430439
}
431440

432441
public static void EnumerateAllLicenses(Bom bom, Action<License> callback)
433442
{
434443
EnumerateAllLicenseChoices(bom, (licenseChoice) =>
435444
{
436-
if (licenseChoice.License != null) callback(licenseChoice.License);
445+
if (licenseChoice.License != null)
446+
{
447+
callback(licenseChoice.License);
448+
}
437449
});
438450
}
439451

@@ -496,7 +508,9 @@ public static void EnumerateAllOrganizationalEntity(Bom bom, Action<Organization
496508
foreach (var annotation in bom.Annotations)
497509
{
498510
if (annotation.Annotator?.Organization != null)
511+
{
499512
callback(annotation.Annotator.Organization);
513+
}
500514
}
501515
}
502516

@@ -511,7 +525,10 @@ public static void EnumerateAllOrganizationalEntity(Bom bom, Action<Organization
511525
});
512526
EnumerateAllComponents(bom, (component) =>
513527
{
514-
if (component.Supplier != null) callback(component.Supplier);
528+
if (component.Supplier != null)
529+
{
530+
callback(component.Supplier);
531+
}
515532

516533

517534
component.ModelCard?.Considerations?.EnvironmentalConsiderations?.EnergyConsumptions?
@@ -529,7 +546,10 @@ public static void EnumerateAllOrganizationalEntity(Bom bom, Action<Organization
529546
});
530547
EnumerateAllServices(bom, (service) =>
531548
{
532-
if (service.Provider != null) callback(service.Provider);
549+
if (service.Provider != null)
550+
{
551+
callback(service.Provider);
552+
}
533553
});
534554
}
535555

@@ -577,7 +597,9 @@ public static void EnumerateAllToolChoices(Bom bom, Action<ToolChoices> callback
577597
EnumerateAllVulnerabilities(bom, (vuln) =>
578598
{
579599
if (vuln.Tools != null)
600+
{
580601
callback(vuln.Tools);
602+
}
581603
});
582604
}
583605

‎src/CycloneDX.Core/Models/Annotation.cs

+8-2
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,10 @@ public List<string> Subjects
4747
{
4848
if (XmlSubjects == null) return null;
4949
var result = new List<string>();
50-
foreach (var subject in XmlSubjects) result.Add(subject.Ref);
50+
foreach (var subject in XmlSubjects)
51+
{
52+
result.Add(subject.Ref);
53+
}
5154
return result;
5255
}
5356
set
@@ -59,7 +62,10 @@ public List<string> Subjects
5962
else
6063
{
6164
XmlSubjects = new List<XmlAnnotationSubject>();
62-
foreach (var subject in value) XmlSubjects.Add(new XmlAnnotationSubject() { Ref = subject});
65+
foreach (var subject in value)
66+
{
67+
XmlSubjects.Add(new XmlAnnotationSubject { Ref = subject });
68+
}
6369
}
6470
}
6571
}

‎src/CycloneDX.Core/Models/Service.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -120,10 +120,10 @@ public ServiceDataChoices XmlData
120120
{
121121
get
122122
{
123-
if (Data == null) return null;
123+
if (Data == null) { return null; }
124124
if (SpecVersion < SpecificationVersion.v1_5)
125125
{
126-
var result = new ServiceDataChoices()
126+
var result = new ServiceDataChoices
127127
{
128128
SpecVersion = SpecVersion,
129129
DataClassifications = new List<DataClassification>()

‎src/CycloneDX.Core/Models/ServiceDataChoices.cs

+6-2
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ public void ReadXml(XmlReader reader)
5050
{
5151
if (reader.LocalName == "classification")
5252
{
53-
if (this.DataClassifications == null) this.DataClassifications = new List<DataClassification>();
53+
if (this.DataClassifications == null) { this.DataClassifications = new List<DataClassification>(); }
5454
var serializer = Xml.Serializer.GetElementSerializer<DataClassification>(SpecVersion, "classification");
5555
var dataClassification = (DataClassification)serializer.Deserialize(reader);
5656
this.DataClassifications.Add(dataClassification);
5757
}
5858
if (reader.LocalName == "dataflow")
5959
{
60-
if (this.DataFlows == null) this.DataFlows = new List<DataFlow>();
60+
if (this.DataFlows == null) { this.DataFlows = new List<DataFlow>(); }
6161
var serializer = Xml.Serializer.GetElementSerializer<DataFlow>(SpecVersion, "dataflow");
6262
var dataflow = (DataFlow)serializer.Deserialize(reader);
6363
this.DataFlows.Add(dataflow);
@@ -72,14 +72,18 @@ public void WriteXml(System.Xml.XmlWriter writer)
7272
{
7373
var serializer = Xml.Serializer.GetElementSerializer<DataClassification>(SpecVersion, "classification");
7474
foreach (var dc in this.DataClassifications)
75+
{
7576
serializer.Serialize(writer, dc);
77+
}
7678
}
7779

7880
if (this.DataFlows != null)
7981
{
8082
var serializer = Xml.Serializer.GetElementSerializer<DataFlow>(SpecVersion, "dataflow");
8183
foreach (var df in this.DataFlows)
84+
{
8285
serializer.Serialize(writer, df);
86+
}
8387
}
8488
}
8589

‎src/CycloneDX.Core/Models/ToolChoices.cs

+18-3
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,21 @@ public void ReadXml(XmlReader reader)
6161
if (reader.LocalName == "tool")
6262
{
6363
#pragma warning disable 618
64-
if (this.Tools == null) this.Tools = new List<Tool>();
64+
if (this.Tools == null)
65+
{
66+
this.Tools = new List<Tool>();
67+
}
6568
var serializer = Xml.Serializer.GetElementSerializer<Tool>(SpecVersion, "tool");
6669
var tool = (Tool)serializer.Deserialize(reader);
6770
#pragma warning restore 618
6871
this.Tools.Add(tool);
6972
}
7073
if (reader.LocalName == "components")
7174
{
72-
if (this.Components == null) this.Components = new List<Component>();
75+
if (this.Components == null)
76+
{
77+
this.Components = new List<Component>();
78+
}
7379
var serializer = Xml.Serializer.GetElementSerializer<Component>(SpecVersion, "component");
7480
reader.ReadStartElement();
7581
while (reader.LocalName == "component")
@@ -81,7 +87,10 @@ public void ReadXml(XmlReader reader)
8187
}
8288
if (reader.LocalName == "services")
8389
{
84-
if (this.Services == null) this.Services = new List<Service>();
90+
if (this.Services == null)
91+
{
92+
this.Services = new List<Service>();
93+
}
8594
var serializer = Xml.Serializer.GetElementSerializer<Service>(SpecVersion, "service");
8695
reader.ReadStartElement();
8796
while (reader.LocalName == "service")
@@ -102,15 +111,19 @@ public void WriteXml(System.Xml.XmlWriter writer) {
102111
var serializer = Xml.Serializer.GetElementSerializer<Tool>(SpecVersion, "tool");
103112
#pragma warning restore 618
104113
foreach (var tool in this.Tools)
114+
{
105115
serializer.Serialize(writer, tool);
116+
}
106117
}
107118

108119
if (this.Components != null)
109120
{
110121
writer.WriteStartElement("components");
111122
var serializer = Xml.Serializer.GetElementSerializer<Component>(SpecVersion, "component");
112123
foreach (var component in this.Components)
124+
{
113125
serializer.Serialize(writer, component);
126+
}
114127
writer.WriteEndElement();
115128
}
116129

@@ -119,7 +132,9 @@ public void WriteXml(System.Xml.XmlWriter writer) {
119132
writer.WriteStartElement("services");
120133
var serializer = Xml.Serializer.GetElementSerializer<Service>(SpecVersion, "service");
121134
foreach (var service in this.Services)
135+
{
122136
serializer.Serialize(writer, service);
137+
}
123138
writer.WriteEndElement();
124139
}
125140
}

‎src/CycloneDX.Core/Protobuf/Serializer.Deserialization.cs

+27-15
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ public static Bom Deserialize(Stream protobufStream)
4040
{
4141
bom.Metadata.Timestamp = DateTime.SpecifyKind(bom.Metadata.Timestamp.Value, DateTimeKind.Utc);
4242
}
43-
43+
4444
CleanupEmptyArrays(bom);
45-
45+
4646
return bom;
4747
}
4848

@@ -59,7 +59,7 @@ public static Bom Deserialize(byte[] bytes)
5959
var bom = Deserialize(ms);
6060
return bom;
6161
}
62-
62+
6363
private static void CleanupEmptyArrays(Bom bom)
6464
{
6565
if (bom.Metadata?.Authors?.Count == 0)
@@ -115,7 +115,7 @@ private static void CleanupEmptyArrays(Bom bom)
115115
bom.Dependencies = null;
116116
}
117117
}
118-
118+
119119
private static void CleanupEmptyArrays(Component component)
120120
{
121121
if (component.Hashes?.Count == 0)
@@ -166,23 +166,35 @@ private static void CleanupEmptyArrays(Service service)
166166

167167
private static void CleanupEmptyArrays(Pedigree pedigree)
168168
{
169-
if (pedigree.Commits?.Count == 0) pedigree.Commits = null;
170-
if (pedigree.Patches?.Count == 0) pedigree.Patches = null;
169+
if (pedigree.Commits?.Count == 0) { pedigree.Commits = null; }
170+
if (pedigree.Patches?.Count == 0) { pedigree.Patches = null; }
171171

172-
if (pedigree.Ancestors?.Count == 0) pedigree.Ancestors = null;
172+
if (pedigree.Ancestors?.Count == 0) { pedigree.Ancestors = null; }
173173
if (pedigree.Ancestors != null)
174-
foreach (var component in pedigree.Ancestors)
175-
CleanupEmptyArrays(component);
174+
{
175+
foreach (var component in pedigree.Ancestors)
176+
{
177+
CleanupEmptyArrays(component);
178+
}
179+
}
176180

177-
if (pedigree.Descendants?.Count == 0) pedigree.Descendants = null;
181+
if (pedigree.Descendants?.Count == 0) { pedigree.Descendants = null; }
178182
if (pedigree.Descendants != null)
179-
foreach (var component in pedigree.Descendants)
180-
CleanupEmptyArrays(component);
183+
{
184+
foreach (var component in pedigree.Descendants)
185+
{
186+
CleanupEmptyArrays(component);
187+
}
188+
}
181189

182-
if (pedigree.Variants?.Count == 0) pedigree.Variants = null;
190+
if (pedigree.Variants?.Count == 0) { pedigree.Variants = null; }
183191
if (pedigree.Variants != null)
184-
foreach (var component in pedigree.Variants)
185-
CleanupEmptyArrays(component);
192+
{
193+
foreach (var component in pedigree.Variants)
194+
{
195+
CleanupEmptyArrays(component);
196+
}
197+
}
186198
}
187199
}
188200
}

0 commit comments

Comments
 (0)