From 0da00d434af644dd0ac32dc4a7a434ed42572436 Mon Sep 17 00:00:00 2001 From: Kir_Antipov Date: Tue, 14 Mar 2023 11:07:14 +0000 Subject: [PATCH] Made a reader for Forge metadata --- src/loaders/forge/forge-metadata-reader.ts | 16 ++++++++ .../forge/forge-metadata-reader.spec.ts | 41 +++++++++++++++++++ 2 files changed, 57 insertions(+) create mode 100644 src/loaders/forge/forge-metadata-reader.ts create mode 100644 tests/unit/loaders/forge/forge-metadata-reader.spec.ts diff --git a/src/loaders/forge/forge-metadata-reader.ts b/src/loaders/forge/forge-metadata-reader.ts new file mode 100644 index 0000000..8172baa --- /dev/null +++ b/src/loaders/forge/forge-metadata-reader.ts @@ -0,0 +1,16 @@ +import { parse as parseToml } from "toml"; +import { ZippedTextLoaderMetadataReader } from "@/loaders/zipped-loader-metadata-reader"; +import { MODS_TOML, RawForgeMetadata } from "./raw-forge-metadata"; +import { ForgeMetadata } from "./forge-metadata"; + +/** + * A metadata reader that is able to read Forge mod metadata from a zipped file. + */ +export class ForgeMetadataReader extends ZippedTextLoaderMetadataReader { + /** + * Constructs a new {@link ForgeMetadataReader} instance. + */ + constructor() { + super(MODS_TOML, ForgeMetadata.from, parseToml); + } +} diff --git a/tests/unit/loaders/forge/forge-metadata-reader.spec.ts b/tests/unit/loaders/forge/forge-metadata-reader.spec.ts new file mode 100644 index 0000000..ea0f34b --- /dev/null +++ b/tests/unit/loaders/forge/forge-metadata-reader.spec.ts @@ -0,0 +1,41 @@ +import { zipFile } from "@/../tests/utils/zip-utils"; +import mockFs from "mock-fs"; +import { ForgeMetadata } from "@/loaders/forge/forge-metadata"; +import { ForgeMetadataReader } from "@/loaders/forge/forge-metadata-reader"; + +beforeEach(async () => { + mockFs({ + "forge.mod.jar": await zipFile([__dirname, "../../../content/forge/mods.toml"], "META-INF/mods.toml"), + "text.txt": "", + }); +}); + +afterEach(() => { + mockFs.restore(); +}); + +describe("ForgeMetadataReader", () => { + test("successfully reads mods.toml", async () => { + const reader = new ForgeMetadataReader(); + + const metadata = await reader.readMetadataFile("forge.mod.jar"); + + expect(metadata).toBeInstanceOf(ForgeMetadata); + }); + + test("returns undefined if file is not a Forge mod", async () => { + const reader = new ForgeMetadataReader(); + + const metadata = await reader.readMetadataFile("text.txt"); + + expect(metadata).toBeUndefined(); + }); + + test("returns undefined if file does not exist", async () => { + const reader = new ForgeMetadataReader(); + + const metadata = await reader.readMetadataFile("text.json"); + + expect(metadata).toBeUndefined(); + }); +});