refactor: introduce can handle pattern

src/opossum_lib/core/input_reader.py

@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from opossum_lib.core.input_file import InputFile
+from opossum_lib.core.input_format_reader import InputFormatReader
+from opossum_lib.core.opossum_model import Opossum
+from opossum_lib.opossum.opossum_format_reader import OpossumFormatReader
+from opossum_lib.scancode.scancode_format_reader import ScancodeFormatReader
+
+
+class InputReader:
+    input_format_readers: list[InputFormatReader] = [
+        OpossumFormatReader(),
+        ScancodeFormatReader(),
+    ]
+
+    def read(self, input_file: InputFile) -> Opossum:
+        for input_format_reader in self.input_format_readers:
+            if input_format_reader.can_handle(input_file.type):
+                return input_format_reader.read(input_file.path)
+        raise NotImplementedError(f"Unsupported file type: {input_file.type}")

src/opossum_lib/core/opossum_generator.py

@@ -4,43 +4,24 @@
 
 from pathlib import Path
 
-from opossum_lib.core.input_file import InputFile
+from opossum_lib.core.input_reader import InputReader
 from opossum_lib.core.opossum_generation_arguments import OpossumGenerationArguments
-from opossum_lib.core.opossum_model import Opossum
 from opossum_lib.opossum.file_generation import OpossumFileWriter
-from opossum_lib.opossum.opossum_file_content import OpossumFileContent
-from opossum_lib.opossum.opossum_format_reader import OpossumFormatReader
-from opossum_lib.scancode.scancode_format_reader import ScancodeFormatReader
 
 
 class OpossumGenerator:
-    opossum_format_reader: OpossumFormatReader = OpossumFormatReader()
-    scancode_format_reader: ScancodeFormatReader = ScancodeFormatReader()
+    input_reader: InputReader = InputReader()
 
     def generate(
         self, opossum_generation_arguments: OpossumGenerationArguments
     ) -> None:
         opossum_generation_arguments.validate_input_and_exit_on_error()
         input_files = opossum_generation_arguments.generate_input_file_list()
-        opossum_generation_arguments.add_outfile_ending_and_warn_on_existing_outfile()
 
-        opossum_file_content = self._convert_after_valid_input(input_files)
-        OpossumFileWriter.write_opossum_information_to_file(
+        opossum = self.input_reader.read(input_files[0])
+
+        opossum_file_content = opossum.to_opossum_file_format()
+        opossum_generation_arguments.add_outfile_ending_and_warn_on_existing_outfile()
+        OpossumFileWriter.write(
             opossum_file_content, Path(opossum_generation_arguments.outfile)
         )
-
-    def _convert_after_valid_input(
-        self,
-        input_file_list: list[InputFile],
-    ) -> OpossumFileContent:
-        input_file = input_file_list[0]
-
-        return self._read_to_internal_format(input_file).to_opossum_file_format()
-
-    def _read_to_internal_format(self, input_file: InputFile) -> Opossum:
-        if self.scancode_format_reader.can_handle(input_file.type):
-            return self.scancode_format_reader.read(input_file.path)
-        elif self.opossum_format_reader.can_handle(input_file.type):
-            return self.opossum_format_reader.read(input_file.path)
-        else:
-            raise NotImplementedError(f"Unsupported file type: {input_file.type}")

src/opossum_lib/opossum/file_generation.py

@@ -14,9 +14,7 @@
 
 class OpossumFileWriter:
     @staticmethod
-    def write_opossum_information_to_file(
-        opossum_file_content: OpossumFileContent, file_path: Path
-    ) -> None:
+    def write(opossum_file_content: OpossumFileContent, file_path: Path) -> None:
         with ZipFile(
             file_path, "w", compression=ZIP_DEFLATED, compresslevel=COMPRESSION_LEVEL
         ) as zip_file:

tests/test_cli.py

@@ -177,9 +177,7 @@ def test_cli_no_output_file_provided(opossum_file_faker: OpossumFileFaker) -> No
     with runner.isolated_filesystem():
         file_path = "input.opossum"
         opossum_file = opossum_file_faker.opossum_file_content()
-        OpossumFileWriter.write_opossum_information_to_file(
-            opossum_file, Path(file_path)
-        )
+        OpossumFileWriter.write(opossum_file, Path(file_path))
         result = runner.invoke(
             generate,
             "--opossum " + file_path,
@@ -197,9 +195,7 @@ def test_cli_warning_if_outfile_already_exists(
     with runner.isolated_filesystem():
         file_path = "input.opossum"
         opossum_file = opossum_file_faker.opossum_file_content()
-        OpossumFileWriter.write_opossum_information_to_file(
-            opossum_file, Path(file_path)
-        )
+        OpossumFileWriter.write(opossum_file, Path(file_path))
         with open("output.opossum", "w") as f:
             f.write("")
         result = runner.invoke(

tests/test_opossum/test_file_generation.py

@@ -19,9 +19,7 @@ def test_only_input_information_available_writes_only_input_information(
     )
     output_path = tmp_path / "output.opossum"
 
-    OpossumFileWriter.write_opossum_information_to_file(
-        opossum_file_content, output_path
-    )
+    OpossumFileWriter.write(opossum_file_content, output_path)
 
     with ZipFile(output_path, "r") as zip_file:
         assert zip_file.namelist() == [INPUT_JSON_NAME]
@@ -33,9 +31,7 @@ def test_input_and_output_information_available_writes_both(
     opossum_file_content = opossum_file_faker.opossum_file_content()
     output_path = tmp_path / "output.opossum"
 
-    OpossumFileWriter.write_opossum_information_to_file(
-        opossum_file_content, output_path
-    )
+    OpossumFileWriter.write(opossum_file_content, output_path)
 
     with ZipFile(output_path, "r") as zip_file:
         assert INPUT_JSON_NAME in zip_file.namelist()