add getters for construtor parameters (#145)

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

Author: jkowalleck

HISTORY.md

@@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file.
 
 ## unreleased
 
+* Added
+  * Getters/properties that represent the corresponding parameters of class constructor. (via [#145])
+    * `Builders.FromPackageJson.ComponentBuilder.extRefFactory`,  
+      `Builders.FromPackageJson.ComponentBuilder.licenseFactory`
+    * `Builders.FromPackageJson.ToolBuilder.extRefFactory`
+    * `Factories.PackageUrlFactory.type`
+    * `Serialize.BomRefDiscriminator.prefix`
+    * `Serialize.JsonSerializer.normalizerFactory`
+    * `Serialize.XmlBaseSerializer.normalizerFactory`,  
+      `Serialize.XmlSerializer.normalizerFactory`
+
+[#145]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/145
+
 ## 1.1.0 - 2022-07-29
 
 * Added

src/builders/fromPackageJson.node.ts

@@ -33,6 +33,10 @@ export class ToolBuilder {
     this.#extRefFactory = extRefFactory
   }
 
+  get extRefFactory (): Factories.FromPackageJson.ExternalReferenceFactory {
+    return this.#extRefFactory
+  }
+
   makeTool (data: PackageJson): Models.Tool | undefined {
     const [name, vendor] = typeof data.name === 'string'
       ? splitNameGroup(data.name)
@@ -61,6 +65,14 @@ export class ComponentBuilder {
     this.#licenseFactory = licenseFactory
   }
 
+  get extRefFactory (): Factories.FromPackageJson.ExternalReferenceFactory {
+    return this.#extRefFactory
+  }
+
+  get licenseFactory (): Factories.LicenseFactory {
+    return this.#licenseFactory
+  }
+
   makeComponent (data: PackageJson, type: Enums.ComponentType = Enums.ComponentType.Library): Models.Component | undefined {
     if (typeof data.name !== 'string') {
       return undefined

src/factories/packageUrl.ts

@@ -22,15 +22,19 @@ import { PackageURL } from 'packageurl-js'
 import { ExternalReferenceType } from '../enums'
 
 export class PackageUrlFactory {
-  readonly #type: string
+  readonly #type: PackageURL['type']
 
   constructor (type: PackageURL['type']) {
     this.#type = type
   }
 
+  get type (): PackageURL['type'] {
+    return this.#type
+  }
+
   makeFromComponent (component: Component): PackageURL | undefined {
-    const qualifiers: { [key: string]: string } = {}
-    let subpath: string | undefined
+    const qualifiers: PackageURL['qualifiers'] = {}
+    let subpath: PackageURL['subpath']
 
     for (const e of component.externalReferences) {
       if (e.type === ExternalReferenceType.VCS) {

src/serialize/bomRefDiscriminator.ts

@@ -31,6 +31,11 @@ export class BomRefDiscriminator {
     this.#prefix = prefix
   }
 
+  get prefix (): string {
+    return this.#prefix
+  }
+
+  /** Iterate over the bomRefs. */
   [Symbol.iterator] (): IterableIterator<BomRef> {
     return this.#originalValues.keys()
   }

src/serialize/json/normalize.ts

@@ -104,6 +104,10 @@ abstract class Base implements Normalizer {
     this._factory = factory
   }
 
+  get factory (): Factory {
+    return this._factory
+  }
+
   abstract normalize (data: object, options: NormalizerOptions): object | undefined
 }
 

src/serialize/jsonSerializer.ts

@@ -42,6 +42,10 @@ export class JsonSerializer extends BaseSerializer<Normalized.Bom> {
     this.#normalizerFactory = normalizerFactory
   }
 
+  get normalizerFactory (): NormalizerFactory {
+    return this.#normalizerFactory
+  }
+
   protected _normalize (
     bom: Bom,
     options: NormalizerOptions = {}

src/serialize/xml/normalize.ts

@@ -104,6 +104,10 @@ abstract class Base implements Normalizer {
     this._factory = factory
   }
 
+  get factory (): Factory {
+    return this._factory
+  }
+
   /**
    * @param {*} data
    * @param {NormalizerOptions} options

src/serialize/xmlBaseSerializer.ts

@@ -42,6 +42,10 @@ export abstract class XmlBaseSerializer extends BaseSerializer<SimpleXml.Element
     this.#normalizerFactory = normalizerFactory
   }
 
+  get normalizerFactory (): NormalizerFactory {
+    return this.#normalizerFactory
+  }
+
   protected _normalize (
     bom: Bom,
     options: NormalizerOptions = {}

tests/_helpers/stringFunctions.js

@@ -34,5 +34,12 @@ module.exports = {
   upperCamelCase: s => s.replace(
     /\b\w/g,
     f => f.slice(-1).toUpperCase()
-  ).replace(/\W/g, '')
+  ).replace(/\W/g, ''),
+
+  /**
+   * Generate a random string of length.
+   * @param {number} length
+   * @return {string}
+   */
+  randomString: length => Math.random().toString(32).substring(2, 2 + length)
 }

tests/unit/Builders.FromPackageJson.ComponentBuilder.spec.js

@@ -0,0 +1,42 @@
+'use strict'
+/*!
+This file is part of CycloneDX JavaScript Library.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+SPDX-License-Identifier: Apache-2.0
+Copyright (c) OWASP Foundation. All Rights Reserved.
+*/
+
+const assert = require('assert')
+const { suite, test } = require('mocha')
+
+const {
+  Builders: { FromPackageJson: { ComponentBuilder } },
+  Factories: {
+    FromPackageJson: { ExternalReferenceFactory },
+    LicenseFactory
+  }
+} = require('../../')
+
+suite('Builders.FromPackageJson.ToolBuilder', () => {
+  test('construct', () => {
+    const extRefFactory = new ExternalReferenceFactory()
+    const licenseFactory = new LicenseFactory()
+
+    const actual = new ComponentBuilder(extRefFactory, licenseFactory)
+
+    assert.strictEqual(actual.extRefFactory, extRefFactory)
+    assert.strictEqual(actual.licenseFactory, licenseFactory)
+  })
+})

tests/unit/Builders.FromPackageJson.ToolBuilder.spec.js

@@ -0,0 +1,37 @@
+'use strict'
+/*!
+This file is part of CycloneDX JavaScript Library.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+SPDX-License-Identifier: Apache-2.0
+Copyright (c) OWASP Foundation. All Rights Reserved.
+*/
+
+const assert = require('assert')
+const { suite, test } = require('mocha')
+
+const {
+  Builders: { FromPackageJson: { ToolBuilder } },
+  Factories: { FromPackageJson: { ExternalReferenceFactory } }
+} = require('../../')
+
+suite('Builders.FromPackageJson.ToolBuilder', () => {
+  test('construct', () => {
+    const extRefFactory = new ExternalReferenceFactory()
+
+    const actual = new ToolBuilder(extRefFactory)
+
+    assert.strictEqual(actual.extRefFactory, extRefFactory)
+  })
+})

tests/unit/Factories.PackageUrlFactory.spec.js

@@ -0,0 +1,38 @@
+'use strict'
+/*!
+This file is part of CycloneDX JavaScript Library.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+SPDX-License-Identifier: Apache-2.0
+Copyright (c) OWASP Foundation. All Rights Reserved.
+*/
+
+const assert = require('assert')
+const { suite, test } = require('mocha')
+
+const {
+  Factories: { PackageUrlFactory }
+} = require('../../')
+
+const { randomString } = require('../_helpers/stringFunctions')
+
+suite('Builders.FromPackageJson.ToolBuilder', () => {
+  test('construct', () => {
+    const type = randomString(5)
+
+    const actual = new PackageUrlFactory(type)
+
+    assert.strictEqual(actual.type, type)
+  })
+})

tests/unit/Serialize.BomRefDiscriminator.spec.js

@@ -26,7 +26,25 @@ const {
   Serialize: { BomRefDiscriminator }
 } = require('../../')
 
+const { randomString } = require('../_helpers/stringFunctions')
+
 suite('Serialize.BomRefDiscriminator', () => {
+  test('constructor', () => {
+    const bomRef1 = new BomRef()
+    const bomRef2 = new BomRef('foo')
+    const prefix = randomString(10)
+
+    /* eslint-disable-next-line no-unused-vars */
+    const actual = new BomRefDiscriminator([bomRef1, bomRef2], prefix)
+
+    assert.strictEqual(actual.prefix, prefix)
+
+    const actualBomRefs = Array.from(actual) // convert the iterator to a list
+    assert.strictEqual(actualBomRefs.length, 2)
+    assert.strictEqual(actualBomRefs.includes(bomRef1), true)
+    assert.strictEqual(actualBomRefs.includes(bomRef2), true)
+  })
+
   test('does not alter BomRef.value unintended', () => {
     const bomRef1 = new BomRef()
     const bomRef2 = new BomRef('foo')

tests/unit/Serialize.JsonSerializer.spec.js

@@ -0,0 +1,41 @@
+'use strict'
+/*!
+This file is part of CycloneDX JavaScript Library.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+SPDX-License-Identifier: Apache-2.0
+Copyright (c) OWASP Foundation. All Rights Reserved.
+*/
+
+const assert = require('assert')
+const { suite, test } = require('mocha')
+
+const {
+  Serialize: {
+    JsonSerializer,
+    JSON: { Normalize: { Factory } }
+  },
+  Spec: { Spec1dot4 }
+
+} = require('../../')
+
+suite('Serialize.JsonSerializer', () => {
+  test('constructor', () => {
+    const normalizerFactory = new Factory(Spec1dot4)
+
+    const actual = new JsonSerializer(normalizerFactory)
+
+    assert.strictEqual(actual.normalizerFactory, normalizerFactory)
+  })
+})

tests/unit/Serialize.XmlBaseSerializer.spec.js

@@ -0,0 +1,43 @@
+'use strict'
+/*!
+This file is part of CycloneDX JavaScript Library.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+SPDX-License-Identifier: Apache-2.0
+Copyright (c) OWASP Foundation. All Rights Reserved.
+*/
+
+const assert = require('assert')
+const { suite, test } = require('mocha')
+
+const {
+  Serialize: {
+    XmlBaseSerializer,
+    XML: { Normalize: { Factory } }
+  },
+  Spec: { Spec1dot4 }
+
+} = require('../../')
+
+suite('Serialize.XmlBaseSerializer', () => {
+  test('constructor', () => {
+    const normalizerFactory = new Factory(Spec1dot4)
+
+    class MySerializer extends XmlBaseSerializer {}
+
+    const actual = new MySerializer(normalizerFactory)
+
+    assert.strictEqual(actual.normalizerFactory, normalizerFactory)
+  })
+})