added tests

Author: coderosh

jest.config.ts

@@ -0,0 +1,8 @@
+import type { Config } from "@jest/types";
+
+const config: Config.InitialOptions = {
+  preset: "ts-jest",
+  testMatch: ["**/*.test.ts"],
+};
+
+export default config;

package.json

@@ -5,7 +5,8 @@
   "main": "index.js",
   "scripts": {
     "watch": "tsc -w",
-    "build": "tsc"
+    "build": "tsc",
+    "test": "jest"
   },
   "repository": {
     "type": "git",
@@ -21,6 +22,7 @@
   "devDependencies": {
     "@types/jest": "^26.0.23",
     "@types/node": "^15.12.4",
+    "@types/node-fetch": "^2.5.10",
     "jest": "^27.0.4",
     "ts-jest": "^27.0.3",
     "ts-node": "^10.0.0",

src/index.ts

@@ -1,3 +1,4 @@
+import fetch from "node-fetch";
 import cheerio, { Cheerio, CheerioAPI, Node } from "cheerio";
 import { Format, output, Result } from "./utils";
 
@@ -71,7 +72,7 @@ function jsonFromTable<T extends Format>(options: Options = {}) {
 
 function getHeaders($: CheerioAPI, table: Cheerio<Node>, selectors: string[]) {
   for (const selector of selectors) {
-    const list = $(selector, table);
+    const list = $(selector, table.html());
 
     if (list.html() !== null) {
       const values = list.toArray().map((v) => $(v).text().trim());
@@ -84,14 +85,17 @@ function getHeaders($: CheerioAPI, table: Cheerio<Node>, selectors: string[]) {
 
 function getBody($: CheerioAPI, table: Cheerio<Node>, selectors: string[][]) {
   for (const selector of selectors) {
-    const rows = $(selector[0], table).toArray();
+    const rows = $(selector[0], table.html()).toArray();
 
     if (rows.length > 0) {
       let values: any[] = [];
 
       for (const row of rows) {
-        const tds = $(selector[1], row).toArray();
-        values.push(tds.map((v) => $(v).text()));
+        const tds = $(selector[1], $(row).html())
+          .toArray()
+          .map((v) => $(v).text());
+
+        values.push(tds);
       }
 
       return values;

src/utils.ts

@@ -40,10 +40,9 @@ function camalize(str: string) {
 
 function toObject(headers: string[], body: string[][]) {
   const obj: { [key: string]: string[] } = {};
-  const max = Math.max(body.length, headers.length);
 
-  for (let i = 0; i < max; i++) {
-    obj[camalize(`${headers[i] || i}`)] = body[i];
+  for (let i = 0; i < headers.length; i++) {
+    obj[camalize(`${headers[i] || i}`)] = body.map((v) => v[i]);
   }
 
   return obj;
@@ -54,14 +53,13 @@ function toJSON(headers: string[], body: string[][]) {
 }
 
 function toArray(headers: string[], body: string[][]) {
-  const max = Math.max(body.length, headers.length);
   const arr: [string, string[]][] = [];
 
-  for (let i = 0; i < max; i++) {
-    arr[i] = [`${headers[i] || i}`, body[i]];
+  for (let i = 0; i < headers.length; i++) {
+    arr[i] = [`${headers[i] || i}`, body.map((v) => v[i])];
   }
 
   return arr;
 }
 
-export { output, Format, Result };
+export { output, Format, Result, camalize, toJSON, toObject, toArray };

tests/index.test.ts

@@ -0,0 +1,49 @@
+import { jsonFromTable } from "../src/index";
+
+const html = `<table><tr><th>SN</th><th>Name</th></tr><tr><td>1</td><td>Roshan</td></tr><tr><td>2</td><td>John</td></tr></table>`;
+
+describe("jsonFromTable - errors", () => {
+  it("should throw error if both html and url are not provided", () => {
+    // @ts-ignore
+    expect(() => jsonFromTable()).toThrowError();
+  });
+
+  it("should throw error if table selector is no found in html", () => {
+    expect(() => jsonFromTable({ html, selector: ".random" })).toThrowError();
+  });
+
+  it("should not throw error if both select and html/url is valid", () => {
+    expect(() => jsonFromTable({ html, selector: "table" })).not.toThrowError();
+  });
+});
+
+describe("jsonFromTable - html", () => {
+  it("should return object from html table", () => {
+    const obj = jsonFromTable({ html });
+    expect(obj).toEqual({ name: ["Roshan", "John"], sn: ["1", "2"] });
+  });
+
+  it("should return array from html table", () => {
+    const arr = jsonFromTable({ html, format: "array" });
+    expect(arr).toEqual([
+      ["SN", ["1", "2"]],
+      ["Name", ["Roshan", "John"]],
+    ]);
+  });
+
+  it("should return json string from html table", () => {
+    const json = jsonFromTable({ html, format: "json" });
+    expect(json).toEqual(`{"sn":["1","2"],"name":["Roshan","John"]}`);
+  });
+
+  it("should return raw headers and body from html table", () => {
+    const raw = jsonFromTable({ html, format: "raw" });
+    expect(raw).toEqual({
+      body: [
+        ["1", "Roshan"],
+        ["2", "John"],
+      ],
+      headers: ["SN", "Name"],
+    });
+  });
+});

tests/utils.test.ts

@@ -0,0 +1,25 @@
+import { camalize } from "../src/utils";
+
+describe("camalize function", () => {
+  it("should remove hypen and should capitalize a character after hyphen", () => {
+    expect(camalize("my-name")).toBe("myName");
+  });
+
+  it("should remove space and should capitalize a character after space", () => {
+    expect(camalize("my name")).toBe("myName");
+  });
+
+  it("should lowercase all characters", () => {
+    expect(camalize("MYNAME")).toBe("myname");
+  });
+
+  it("should remove underscore and should capitalize a character after underscore", () => {
+    expect(camalize("my_name")).toBe("myName");
+  });
+
+  it("should work for multiple special characters", () => {
+    expect(camalize("my|name_is-roshan acharya")).toEqual(
+      "myNameIsRoshanAcharya"
+    );
+  });
+});

tsconfig.json

@@ -5,12 +5,13 @@
     "declaration": true,
     "sourceMap": true,
     "outDir": "dist",
-    "rootDir": "src",
     "removeComments": true,
     "strict": true,
     "moduleResolution": "node",
     "esModuleInterop": true,
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true
-  }
+  },
+  "include": ["src"],
+  "exclude": ["tests", "node_modules"]
 }

yarn.lock

@@ -604,6 +604,14 @@
     jest-diff "^26.0.0"
     pretty-format "^26.0.0"
 
+"@types/node-fetch@^2.5.10":
+  version "2.5.10"
+  resolved "https://registry.yarnpkg.com/@types/node-fetch/-/node-fetch-2.5.10.tgz#9b4d4a0425562f9fcea70b12cb3fcdd946ca8132"
+  integrity sha512-IpkX0AasN44hgEad0gEF/V6EgR5n69VEqPEgnmoM8GsIGro3PowbWs4tR6IhxUTyPLpOn+fiGG6nrQhcmoCuIQ==
+  dependencies:
+    "@types/node" "*"
+    form-data "^3.0.0"
+
 "@types/node@*", "@types/node@^15.12.4":
   version "15.12.4"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-15.12.4.tgz#e1cf817d70a1e118e81922c4ff6683ce9d422e26"