feat

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

Author: jkowalleck

src/builders/fromPath.node.ts

@@ -21,12 +21,10 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
  * Node-specifics.
  */
 
-import {readdirSync, readFileSync} from "fs";
+import {readdirSync} from "fs";
 import {join, relative, resolve} from "path";
 
-import {getMimeForTextFile} from "../_helpers/mime";
-import {AttachmentEncoding} from "../enums/attachmentEncoding";
-import {Attachment} from "../models/attachment";
+import type {AttachmentFactory} from "../factories/fromPath.node";
 import {NamedLicense} from "../models/license";
 
 
@@ -36,6 +34,12 @@ import {NamedLicense} from "../models/license";
  */
 export class LicenseEvidenceBuilder {
 
+  readonly #afac: AttachmentFactory
+
+  constructor(afac: AttachmentFactory) {
+    this.#afac = afac
+  }
+
   readonly #LICENSE_FILENAME_PATTERN = /^(?:UN)?LICEN[CS]E|.\.LICEN[CS]E$|^NOTICE$/i
 
   /**
@@ -47,10 +51,6 @@ export class LicenseEvidenceBuilder {
    * @returns {@link NamedLicense} on success
    */
   public fromFile(file: string, relativeFrom: string | undefined = undefined): NamedLicense | undefined {
-    const contentType = getMimeForTextFile(file)
-    if (contentType === undefined) {
-      return undefined
-    }
     let lname
     if ( relativeFrom === undefined) {
       lname = `file: ${file}`
@@ -59,26 +59,19 @@ export class LicenseEvidenceBuilder {
       file = resolve(relativeFrom, file)
       lname = `file: ${relative(relativeFrom, file)}`
     }
-    return new NamedLicense(
-      `file: ${lname}`,
-      {
-        text: new Attachment(
-          // may throw if `readFileSync()` fails
-          readFileSync(file).toString('base64'),
-          {
-            contentType,
-            encoding: AttachmentEncoding.Base64
-          }
-        )
-      })
+    const text = this.#afac.fromTextFile(file)
+    if (text === undefined) {
+      return undefined
+    }
+    return new NamedLicense(lname, {text})
   }
 
   /**
    * Returns a generator for license evidences.
    * Throws errors, if dir cannot be inspected.
    *
    * @param dir - path to inspect
-   * @param relativeFrom - path the dir shall be relative to
+   * @param relativeFrom - path the dir and files shall be relative to
    */
   public * fromDir(dir: string, relativeFrom: string | undefined = undefined): Generator<NamedLicense> {
     if ( relativeFrom !== undefined) {

src/factories/fromPath.node.ts

@@ -0,0 +1,55 @@
+/*!
+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.
+*/
+
+/**
+ * Node-specifics.
+ */
+
+import {readFileSync} from "fs";
+
+import {getMimeForTextFile} from "../_helpers/mime";
+import {AttachmentEncoding} from "../enums/attachmentEncoding";
+import {Attachment} from "../models/attachment";
+
+
+
+/**
+ * Node-specific AttachmentFactory.
+ */
+export class AttachmentFactory {
+
+  public fromFile(file: string, contentType: string): Attachment {
+    return new Attachment(
+          // may throw if `readFileSync()` fails
+          readFileSync(file).toString('base64'),
+          {
+            contentType,
+            encoding: AttachmentEncoding.Base64
+          })
+  }
+
+  public fromTextFile(file: string): Attachment | undefined {
+    const contentType = getMimeForTextFile(file)
+    if (contentType === undefined) {
+      return undefined
+    }
+    return this.fromFile(file, contentType)
+  }
+
+}