Fix bug where you weren't able to use both the -q and -j flags at the same time (#227)

- Fix bug where if you supplied both `-q`/`--query-metadata` and `-j`/`--json` the query metadata wasn't added to the output
- Update tests

#181

Reviewed-on: #227
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>

docs/cli.md

@@ -9,13 +9,12 @@ The project can be downloaded as a binary for your system via the [GitHub Releas
 We currently support:
 - Linux (x64)
 - Windows (x64)
-- macOS (x64, Arm64\*)
 
 The git repository can also be cloned and ran via `yarn build` and `yarn start`.
 
 You can produce the binary using the `yarn package` command. This creates the binaries in the `./bin` folder.
 
-> **NOTE:** We are aware of a bug in the macOS Arm64 builds failing to execute. For now you're still able to use the x64 builds under Rosetta fine. This will hopefully be fixed in a future release.
+> **NOTE:** As of version 2.4 I will no longer be supporting and building macOS builds as I have no capacity to test and build for it.
 
 ## Default Output
 
@@ -27,6 +26,7 @@ $ random-bunny
 Archived = false
 Author = Rabbit_Owner
 Downvotes = 0
+Gallery = https://i.redd.it/sfz0srdrimjc1.png, https://i.redd.it/sfz0srdrimjc1.png
 Hidden = false
 Permalink = /r/Rabbits/comments/1av1rg9/cute_baby_bun/
 Subreddit = Rabbits
@@ -36,6 +36,8 @@ Upvotes = 211
 Url = https://i.redd.it/sfz0srdrimjc1.png
 ```
 
+- The `Gallery` field is only shown when there is more than 1 image returned, which then the `Url` field is the first image of that list.
+
 ## Help
 
 The command also includes a help option in case you are stuck.
@@ -73,9 +75,11 @@ $ random-bunny --json
 
 $ randon-bunny -j
 
-{"Archived":false,"Author":"Rabbit_Owner","Downs":0,"Hidden":false,"Permalink":"/r/Rabbits/comments/1av1rg9/cute_baby_bun/","Subreddit":"Rabbits","SubredditSubscribers":486085,"Title":"Cute baby bun","Ups":210,"Url":"https://i.redd.it/sfz0srdrimjc1.png"}
+{"Archived":false,"Author":"Rabbit_Owner","Downs":0,"Hidden":false,"Permalink":"/r/Rabbits/comments/1av1rg9/cute_baby_bun/","Subreddit":"Rabbits","SubredditSubscribers":486085,"Title":"Cute baby bun","Ups":210,"Url":"https://i.redd.it/sfz0srdrimjc1.png","Gallery":["https://i.redd.it/sfz0srdrimjc1.png"]}
 ```
 
+- The `Url` field is the first image of the `Gallery` array
+
 ## Sort
 
 You can also choose the sorting option which reddit will use to return the available posts to randomise from.

package.json

@@ -6,7 +6,9 @@
   "author": "Vylpes",
   "exports": "./dist/index.js",
   "typings": "./dist/index.d.ts",
-  "bin": "./dist/cli.js",
+  "bin": {
+      "random-bunny": "./dist/cli.js"
+  },
   "main": "./dist/index.js",
   "keywords": [
     "rabbit",
@@ -43,24 +45,20 @@
     "@eslint/js": "^9.8.0",
     "@types/eslint": "^9.6.0",
     "@types/jest": "^29.5.8",
-    "@types/node": "^20.0.0",
-    "@typescript-eslint/eslint-plugin": "^7.18.0",
-    "@typescript-eslint/parser": "^7.18.0",
-    "@yao-pkg/pkg": "^5.12.0",
+    "@types/node": "^22.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "@yao-pkg/pkg": "^6.1.1",
     "eslint": "^9.8.0",
     "jest": "^29.7.0",
-    "jest-mock-extended": "^3.0.3",
+    "jest-mock-extended": "^3.0.7",
     "np": "^10.0.0",
     "ts-jest": "^29.1.1",
     "ts-mockito": "^2.6.1",
     "typescript": "^5.0.0",
     "typescript-eslint": "^7.18.0"
   },
-  "resolutions": {
-    "np/**/got": "^14.0.0",
-    "**/semver": "^7.5.2",
-    "@babel/traverse": "^7.23.2"
-  },
+  "resolutions": {},
   "files": [
     "dist"
   ],
@@ -68,8 +66,6 @@
     "scripts": "dist/**/*.js",
     "targets": [
       "latest-linux-x64",
-      "latest-macos-x64",
-      "latest-macos-arm64",
       "latest-win-x64"
     ],
     "outputPath": "bin"

readme.md

@@ -39,6 +39,7 @@ The json string which gets returned consists of:
 - archived
 - author
 - downs
+- gallery
 - hidden
 - permalink
 - subreddit

src/cli.ts

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 import { Command, Option } from "commander";
 import randomBunny from "./index";
 import ICliOptions from "./contracts/ICliOptions";

src/contracts/IRedditResult.ts

@@ -2,11 +2,12 @@ export default interface IRedditResult {
     Archived: boolean,
     Author: string,
     Downs: number,
+    Gallery: string[],
     Hidden: boolean,
     Permalink: string,
     Subreddit: string,
     SubredditSubscribers: number,
     Title: string,
     Ups: number,
-    Url: string
+    Url: string,
 }

src/helpers/imageHelper.ts

@@ -2,17 +2,19 @@ import fetch from "got-cjs";
 import * as htmlparser from "htmlparser2";
 
 export default class ImageHelper {
-    public static async FetchImageFromRedditGallery(url: string): Promise<string | undefined> {
+    public static async FetchImageFromRedditGallery(url: string): Promise<string[]> {
         const fetched = await fetch(url);
 
         if (!fetched || fetched.errored || fetched.statusCode != 200) {
-            return undefined;
+            return [];
         }
 
         const dom = htmlparser.parseDocument(fetched.body);
-        const img = htmlparser.DomUtils.findOne((x => x.tagName == "img" && x.attributes.find(y => y.value.includes("https://preview.redd.it")) != null), dom.children, true);
+        const img = htmlparser.DomUtils.findAll((x => x.tagName == "img" && x.attributes.find(y => y.value.includes("https://preview.redd.it")) != null), dom.children);
 
-        const imgSrc = img?.attributes.find(x => x.name == "src")?.value;
+        const imgSrc = img
+            .flatMap(x => x.attributes.find(x => x.name == "src")?.value)
+            .filter(x => x != undefined);
 
         return imgSrc;
     }

src/helpers/outputHelper.ts

@@ -5,29 +5,28 @@ export default class OutputHelper {
     public static GenerateOutput(response: IReturnResult, options: ICliOptions): string {
         const result = response.Result!;
 
-        const outputLines: string[] = [];
+        let outputObject = {};
+
+        outputObject = { ...result };
+
+        if (options.queryMetadata) {
+            outputObject = { ...outputObject, ...response.Query }
+        }
 
         if (options.json) {
-            return JSON.stringify(result);
+            return JSON.stringify(outputObject);
         }
 
-        outputLines.push(`Archived = ${result.Archived}`);
-        outputLines.push(`Author = ${result.Author}`);
-        outputLines.push(`Downvotes = ${result.Downs}`);
-        outputLines.push(`Hidden = ${result.Hidden}`);
-        outputLines.push(`Permalink = ${result.Permalink}`);
-        outputLines.push(`Subreddit = ${result.Subreddit}`);
-        outputLines.push(`Subreddit Subscribers = ${result.SubredditSubscribers}`);
-        outputLines.push(`Title = ${result.Title}`);
-        outputLines.push(`Upvotes = ${result.Ups}`);
-        outputLines.push(`Url = ${result.Url}`);
+        return this.GetFriendlyObjectText(outputObject);
+    }
 
-        if (options.queryMetadata != null) {
-            outputLines.push(`Query.Subreddit = ${response.Query.subreddit}`);
-            outputLines.push(`Query.Sort By = ${response.Query.sortBy}`);
-            outputLines.push(`Query.Limit = ${response.Query.limit}`);
+    private static GetFriendlyObjectText<T>(object: T): string {
+        const output: string[] = [];
+
+        for (const key in object) {
+            output.push(`${key} = ${object[key]}`);
         }
 
-        return outputLines.join("\n");
+        return output.join("\n");
     }
 }

src/index.ts

@@ -93,6 +93,7 @@ export default async function randomBunny(subreddit: string, sortBy: "new" | "ho
     const randomData = randomSelect.data;
 
     let url: string;
+    let gallery: string[];
 
     if (randomData.url.includes("/gallery")) {
         const galleryImage = await ImageHelper.FetchImageFromRedditGallery(randomData.url);
@@ -112,9 +113,11 @@ export default async function randomBunny(subreddit: string, sortBy: "new" | "ho
             }
         }
 
-        url = galleryImage;
+        url = galleryImage[0];
+        gallery = galleryImage;
     } else {
         url = randomData.url;
+        gallery = [randomData.url];
     }
 
     const redditResult: IRedditResult = {
@@ -128,6 +131,7 @@ export default async function randomBunny(subreddit: string, sortBy: "new" | "ho
         Title: randomData['title'],
         Ups: randomData['ups'],
         Url: url,
+        Gallery: gallery,
     };
 
     return {

tests/helpers/__snapshots__/outputHelper.test.ts.snap

@@ -3,30 +3,48 @@
 exports[`GenerateOutput EXPECT standout output to be returned 1`] = `
 "Archived = false
 Author = author
-Downvotes = 0
+Downs = 0
 Hidden = false
 Permalink = /r/Rabbits/comments/1dj8pbt/this_is_my_ms_bear/
 Subreddit = Rabbits
-Subreddit Subscribers = 654751
+SubredditSubscribers = 654751
 Title = This is my Ms Bear!
-Upvotes = 17
-Url = https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d"
+Ups = 17
+Url = https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d
+Gallery = https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d"
 `;
 
-exports[`GenerateOutput GIVEN options.json is true, EXPECT output to be returned as JSON 1`] = `"{"Archived":false,"Author":"author","Downs":0,"Hidden":false,"Permalink":"/r/Rabbits/comments/1dj8pbt/this_is_my_ms_bear/","Subreddit":"Rabbits","SubredditSubscribers":654751,"Title":"This is my Ms Bear!","Ups":17,"Url":"https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d"}"`;
+exports[`GenerateOutput GIVEN options.json is true, EXPECT output to be returned as JSON 1`] = `"{"Archived":false,"Author":"author","Downs":0,"Hidden":false,"Permalink":"/r/Rabbits/comments/1dj8pbt/this_is_my_ms_bear/","Subreddit":"Rabbits","SubredditSubscribers":654751,"Title":"This is my Ms Bear!","Ups":17,"Url":"https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d","Gallery":["https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d"]}"`;
+
+exports[`GenerateOutput GIVEN options.queryMetadata AND options.json is supplied, EXPECT query metadata to be in JSON format 1`] = `"{"Archived":false,"Author":"author","Downs":0,"Hidden":false,"Permalink":"/r/Rabbits/comments/1dj8pbt/this_is_my_ms_bear/","Subreddit":"Rabbits","SubredditSubscribers":654751,"Title":"This is my Ms Bear!","Ups":17,"Url":"https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d","subreddit":"rabbits","sortBy":"hot","limit":100}"`;
 
 exports[`GenerateOutput GIVEN options.queryMetadata is supplied, EXPECT query metadata to be added 1`] = `
 "Archived = false
 Author = author
-Downvotes = 0
+Downs = 0
 Hidden = false
 Permalink = /r/Rabbits/comments/1dj8pbt/this_is_my_ms_bear/
 Subreddit = Rabbits
-Subreddit Subscribers = 654751
+SubredditSubscribers = 654751
 Title = This is my Ms Bear!
-Upvotes = 17
+Ups = 17
 Url = https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d
-Query.Subreddit = rabbits
-Query.Sort By = hot
-Query.Limit = 100"
+Gallery = https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d
+subreddit = rabbits
+sortBy = hot
+limit = 100"
+`;
+
+exports[`GenerateOutput GIVEN the Gallery input has more than 1 item, EXPECT Gallery line to be added 1`] = `
+"Archived = false
+Author = author
+Downs = 0
+Hidden = false
+Permalink = /r/Rabbits/comments/1dj8pbt/this_is_my_ms_bear/
+Subreddit = Rabbits
+SubredditSubscribers = 654751
+Title = This is my Ms Bear!
+Ups = 17
+Url = https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d
+Gallery = https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d,https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d"
 `;

tests/helpers/imageHelper.test.ts

@@ -17,18 +17,19 @@ describe("FetchImageFromRedditGallery", () => {
         expect(fetchMock).toHaveBeenCalledTimes(1);
         expect(fetchMock).toHaveBeenCalledWith("https://redd.it/gallery/image");
 
-        expect(result).toBe("https://preview.redd.it/image.png");
+        expect(result.length).toBe(1);
+        expect(result[0]).toBe("https://preview.redd.it/image.png");
     });
 
-    test("GIVEN fetch is unable to return data, EXPECT undefined returned", async () => {
+    test("GIVEN fetch is unable to return data, EXPECT empty array returned", async () => {
         fetchMock.mockResolvedValue(null);
 
         const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image");
 
-        expect(result).toBeUndefined();
+        expect(result.length).toBe(0);
     });
 
-    test("GIVEN fetch is an error, EXPECT undefined returned", async () => {
+    test("GIVEN fetch is an error, EXPECT empty array returned", async () => {
         fetchMock.mockResolvedValue({
             body: "<html><body><img src='https://preview.redd.it/image.png' /></body></html>",
             errored: "Error",
@@ -37,10 +38,10 @@ describe("FetchImageFromRedditGallery", () => {
 
         const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image");
 
-        expect(result).toBeUndefined();
+        expect(result.length).toBe(0);
     });
 
-    test("GIVEN fetch is not status code of 200, EXPECT undefined returned", async () => {
+    test("GIVEN fetch is not status code of 200, EXPECT empty array returned", async () => {
         fetchMock.mockResolvedValue({
             body: "<html><body><img src='https://preview.redd.it/image.png' /></body></html>",
             errored: undefined,
@@ -49,10 +50,10 @@ describe("FetchImageFromRedditGallery", () => {
 
         const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image");
 
-        expect(result).toBeUndefined();
+        expect(result.length).toBe(0);
     });
 
-    test("GIVEN image tag is not found, EXPECT undefined returned", async () => {
+    test("GIVEN image tag is not found, EXPECT empty array returned", async () => {
         fetchMock.mockResolvedValue({
             body: "<html><body></body></html>",
             errored: undefined,
@@ -61,10 +62,10 @@ describe("FetchImageFromRedditGallery", () => {
 
         const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image");
 
-        expect(result).toBeUndefined();
+        expect(result.length).toBe(0);
     });
 
-    test("GIVEN image source attribute is not found, EXPECT undefined returned", async () => {
+    test("GIVEN image source attribute is not found, EXPECT empty array returned", async () => {
         fetchMock.mockResolvedValue({
             body: "<html><body><img /></body></html>",
             errored: undefined,
@@ -73,10 +74,10 @@ describe("FetchImageFromRedditGallery", () => {
 
         const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image");
 
-        expect(result).toBeUndefined();
+        expect(result.length).toBe(0);
     });
 
-    test("GIVEN image source attribute is not found that is a preview.redd.it url, EXPECT undefined returned", async () => {
+    test("GIVEN image source attribute is not found that is a preview.redd.it url, EXPECT empty array returned", async () => {
         fetchMock.mockResolvedValue({
             body: "<html><body><img src='main.png' /></body></html>",
             errored: undefined,
@@ -85,6 +86,6 @@ describe("FetchImageFromRedditGallery", () => {
 
         const result = await ImageHelper.FetchImageFromRedditGallery("https://redd.it/gallery/image");
 
-        expect(result).toBeUndefined();
+        expect(result.length).toBe(0);
     });
 });

tests/helpers/outputHelper.test.ts

@@ -23,6 +23,7 @@ describe("GenerateOutput", () => {
                 Title: "This is my Ms Bear!",
                 Ups: 17,
                 Url: "https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d",
+                Gallery: ["https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d"],
             },
         } as IReturnResult;
 
@@ -55,6 +56,7 @@ describe("GenerateOutput", () => {
                 Title: "This is my Ms Bear!",
                 Ups: 17,
                 Url: "https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d",
+                Gallery: ["https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d"],
             },
         } as IReturnResult;
 
@@ -89,6 +91,7 @@ describe("GenerateOutput", () => {
                 Title: "This is my Ms Bear!",
                 Ups: 17,
                 Url: "https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d",
+                Gallery: ["https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d"],
             },
         } as IReturnResult;
 
@@ -102,4 +105,75 @@ describe("GenerateOutput", () => {
         // Assert
         expect(result).toMatchSnapshot();
     });
+
+    test("GIVEN options.queryMetadata AND options.json is supplied, EXPECT query metadata to be in JSON format", () => {
+        // Arrange
+        const response = {
+            IsSuccess: true,
+            Query: {
+                subreddit: "rabbits",
+                sortBy: "hot",
+                limit: 100,
+            },
+            Result: {
+                Archived: false,
+                Author: 'author',
+                Downs: 0,
+                Hidden: false,
+                Permalink: "/r/Rabbits/comments/1dj8pbt/this_is_my_ms_bear/",
+                Subreddit: "Rabbits",
+                SubredditSubscribers: 654751,
+                Title: "This is my Ms Bear!",
+                Ups: 17,
+                Url: "https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d",
+            },
+        } as IReturnResult;
+
+        const options = {
+            json: true,
+            queryMetadata: true,
+        } as ICliOptions;
+
+        // Act
+        const result = OutputHelper.GenerateOutput(response, options);
+
+        // Assert
+        expect(result).toMatchSnapshot();
+    });
+
+    test("GIVEN the Gallery input has more than 1 item, EXPECT Gallery line to be added", () => {
+        // Arrange
+        const response = {
+            IsSuccess: true,
+            Query: {
+                subreddit: "rabbits",
+                sortBy: "hot",
+                limit: 100,
+            },
+            Result: {
+                Archived: false,
+                Author: 'author',
+                Downs: 0,
+                Hidden: false,
+                Permalink: "/r/Rabbits/comments/1dj8pbt/this_is_my_ms_bear/",
+                Subreddit: "Rabbits",
+                SubredditSubscribers: 654751,
+                Title: "This is my Ms Bear!",
+                Ups: 17,
+                Url: "https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d",
+                Gallery: [
+                    "https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d",
+                    "https://preview.redd.it/d5yno653zf7d1.jpg?width=640&crop=smart&auto=webp&s=5064d1caec3c12ac2855eb57ff131d0b313d5e9d"
+                ],
+            },
+        } as IReturnResult;
+
+        const options = {} as ICliOptions;
+
+        // Act
+        const result = OutputHelper.GenerateOutput(response, options);
+
+        // Assert
+        expect(result).toMatchSnapshot();
+    });
 });