test: add unit tests to hydrate/values (#573)

<!-- 👋 Hi, thanks for sending a PR to template-typescript-node-package!
💖.
Please fill out all fields below and make sure each item is true and [x]
checked.
Otherwise we may not be able to review your PR. -->

## PR Checklist

- [x] Addresses an existing open issue: fixes #447
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

An ongoing PR for adding unit tests to hydrate components.
currently added:
- `src/hydrate/values/readAuthorIfExists`
- `src/hydrate/values/readOwnerFromGitRemote`
- `src/hydrate/values/readFundingIfExists`

---------

Co-authored-by: Josh Goldberg <[email protected]>

Author: RNR1

src/hydrate/values/getHydrationDefaults.ts

@@ -1,11 +1,10 @@
-import { $ } from "execa";
-
 import type { PartialPackageData } from "./types.js";
 
-import { getNpmAuthor } from "../../shared/getNpmAuthor.js";
 import { readFileSafe } from "../readFileSafe.js";
+import { readAuthorIfExists } from "./readAuthorIfExists.js";
 import { readEmailIfExists } from "./readEmailIfExists.js";
 import { readFundingIfExists } from "./readFundingIfExists.js";
+import { readOwnerFromGitRemote } from "./readOwnerFromGitRemote.js";
 
 export async function getHydrationDefaults() {
 	const existingReadme = await readFileSafe("./README.md", "");
@@ -14,20 +13,10 @@ export async function getHydrationDefaults() {
 	) as PartialPackageData;
 
 	return {
-		author: async () => {
-			const fromPackage =
-				typeof existingPackage.author === "string"
-					? existingPackage.author.split("<")[0].trim()
-					: existingPackage.author?.name;
-
-			return fromPackage ?? (await getNpmAuthor());
-		},
+		author: () => readAuthorIfExists(existingPackage),
 		email: () => readEmailIfExists(existingPackage),
 		funding: readFundingIfExists,
-		owner: async () =>
-			(await $`git remote -v`).stdout.match(
-				/origin\s+https:\/\/\S+\.\w+\/([^/]+)/
-			)?.[1],
+		owner: readOwnerFromGitRemote,
 		releases: true,
 		title: existingReadme.match(/^(?:# |<h1\s+align="center">)(\S+)/)?.[1],
 		unitTests: true,

src/hydrate/values/readAuthorIfExists.test.ts

@@ -0,0 +1,40 @@
+import { describe, expect, it, vi } from "vitest";
+
+import { readAuthorIfExists } from "./readAuthorIfExists.js";
+
+const mockGetNpmAuthor = vi.fn();
+
+vi.mock("../../shared/getNpmAuthor.js", () => ({
+	get getNpmAuthor() {
+		return mockGetNpmAuthor;
+	},
+}));
+
+const npmAuthorMockResult = "Someone from NPM <[email protected]>";
+
+describe("readAuthorIfExists", () => {
+	it('reads author as a string from the existing package "author" field when it exists', async () => {
+		mockGetNpmAuthor.mockResolvedValue(npmAuthorMockResult);
+		const author = await readAuthorIfExists({
+			author: "John Doe <[email protected]>",
+		});
+		expect(author).not.toBe(npmAuthorMockResult);
+		expect(author).not.toContain(" <[email protected]>");
+		expect(author).toBe("John Doe");
+	});
+
+	it('reads author as an object from the existing package "author" field when it exists', async () => {
+		mockGetNpmAuthor.mockResolvedValue(npmAuthorMockResult);
+		const author = await readAuthorIfExists({
+			author: { email: "[email protected]", name: "John Doe" },
+		});
+		expect(author).not.toBe(npmAuthorMockResult);
+		expect(author).toBe("John Doe");
+	});
+
+	it("reads author from getNpmAuthor when author is missing from package", async () => {
+		mockGetNpmAuthor.mockResolvedValue(npmAuthorMockResult);
+		const author = await readAuthorIfExists({});
+		expect(author).toBe(npmAuthorMockResult);
+	});
+});

src/hydrate/values/readAuthorIfExists.ts

@@ -0,0 +1,14 @@
+import type { PartialPackageData } from "./types";
+
+import { getNpmAuthor } from "../../shared/getNpmAuthor.js";
+
+export async function readAuthorIfExists(
+	existingPackage: PartialPackageData
+): Promise<string | undefined> {
+	const fromPackage =
+		typeof existingPackage.author === "string"
+			? existingPackage.author.split("<")[0].trim()
+			: existingPackage.author?.name;
+
+	return fromPackage ?? (await getNpmAuthor());
+}

src/hydrate/values/readFundingIfExists.test.ts

@@ -0,0 +1,29 @@
+import { describe, expect, it, vi } from "vitest";
+
+import { readFundingIfExists } from "./readFundingIfExists.js";
+
+const mockReadFile = vi.fn();
+
+vi.mock("node:fs/promises", () => ({
+	get default() {
+		return {
+			get readFile() {
+				return mockReadFile;
+			},
+		};
+	},
+}));
+
+describe("readFundingIfExists", () => {
+	it("reads funding from .github/FUNDING.yml when it exists", async () => {
+		mockReadFile.mockResolvedValue("github: Contributor");
+		const result = await readFundingIfExists();
+		expect(result).toBe("Contributor");
+	});
+
+	it("returns undefined when funding does not exists", async () => {
+		mockReadFile.mockRejectedValue("Oops");
+		const result = await readFundingIfExists();
+		expect(result).toBe(undefined);
+	});
+});

src/hydrate/values/readOwnerFromGitRemote.test.ts

@@ -0,0 +1,29 @@
+import { describe, expect, it, vi } from "vitest";
+
+import { readOwnerFromGitRemote } from "./readOwnerFromGitRemote.js";
+
+const mock$ = vi.fn();
+
+vi.mock("execa", () => ({
+	get $() {
+		return mock$;
+	},
+}));
+
+describe("readOwnerFromGitRemote", () => {
+	it("reads owner from the git remote when it exists", async () => {
+		mock$.mockResolvedValue({
+			stdout:
+				"origin  https://github.com/Contributor/template-typescript-node-package.git (fetch)",
+		});
+		const result = await readOwnerFromGitRemote();
+
+		expect(result).toBe("Contributor");
+	});
+
+	it("reads undefined when no remote available", async () => {
+		mock$.mockResolvedValue({ stdout: "" });
+		const result = await readOwnerFromGitRemote();
+		expect(result).toBe(undefined);
+	});
+});

src/hydrate/values/readOwnerFromGitRemote.ts

@@ -0,0 +1,6 @@
+import { $ } from "execa";
+
+export async function readOwnerFromGitRemote(): Promise<string | undefined> {
+	const { stdout } = await $`git remote -v`;
+	return stdout.match(/origin\s+https:\/\/\S+\.\w+\/([^/]+)/)?.[1];
+}