Merge pull request #55 from Tch1b0/enhance-customization

Enhance customization

Author: Tch1b0

.npmignore

@@ -1,8 +1,10 @@
-test/
+.github/
 src/
+test/
+docs/
 node_modules/
+practical-test/
+
+.prettierrc
 package-lock.json
 tsconfig.json
-.prettierrc
-.github/
-practical-test/

package.json

@@ -1,6 +1,6 @@
 {
     "name": "dsbmobile",
-    "version": "1.1.9",
+    "version": "1.2.0",
     "description": "A Javascript wrapper for the dsbmobile api",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -10,6 +10,7 @@
         "btest": "npm run build && npm test",
         "test": "ts-mocha --config tsconfig.json --paths test/**/*.spec.ts",
         "lint": "eslint . --ext .ts",
+        "format": "eslint . --ext .ts --fix",
         "docs": "typedoc"
     },
     "repository": {

src/documents/documentpost.ts

@@ -24,6 +24,16 @@ export class DocumentPost {
         this.date = isText(date) ? new Date(date) : date;
     }
 
+    public equals(other: DocumentPost): boolean {
+        return (
+            this.id === other.id &&
+            this.title === other.title &&
+            this.date.getTime() === other.date.getTime() &&
+            this.url === other.url &&
+            this.previewURL === other.previewURL
+        );
+    }
+
     /**
      * Create a new `DocumentPost` from the json structure of the dsb backend
      * @param data The `JSON` data

src/dsbmobile.ts

@@ -187,7 +187,7 @@ export default class Dsbmobile {
     public async fetchToken() {
         const res = await this.requester.get(
             "/authid?bundleid=de.heinekingmedia.dsbmobile&appversion=35&osversion=22&pushid" +
-            `&user=${this.id}&password=${this.password}`,
+                `&user=${this.id}&password=${this.password}`,
         );
 
         this.token = res.data;

src/news/newspost.ts

@@ -11,6 +11,14 @@ export class NewsPost {
         this.date = isText(date) ? new Date(date) : date;
     }
 
+    public equals(other: NewsPost): boolean {
+        return (
+            this.title === other.title &&
+            this.date.getTime() === other.date.getTime() &&
+            this.detail === other.detail
+        );
+    }
+
     /**
      * Create a `NewsPost` object from JSON
      * @param json The json object you want to generate a `NewsPost` from

src/timetable/entry.ts

@@ -4,7 +4,9 @@ import { SubjectContainer } from "./subjectcontainer";
 
 export class Entry implements SubjectContainer {
     public readonly date: Date;
-    public readonly subjectShorts = new Map<string, string>(defaultSubjectShorts);
+    public readonly subjectShorts = new Map<string, string>(
+        defaultSubjectShorts,
+    );
 
     constructor(
         date: Date | string,
@@ -24,7 +26,9 @@ export class Entry implements SubjectContainer {
     /**
      * The entry only holds a `period` attribute, which does
      * not represent actual time.
-     * This function gives you the real time of the lesson
+     * This function gives you the real time of the lesson.
+     *
+     * This function assumes that the first period takes place at 07:30 and one period takes 45 minutes.
      *
      * @returns Real time of the lesson
      */
@@ -139,14 +143,16 @@ export class Entry implements SubjectContainer {
      * @returns whether the entries are equal
      */
     public equals(other: Entry): boolean {
-        return this.className === other.className &&
-            this.date.toString() === other.date.toString() &&
+        return (
+            this.className === other.className &&
+            this.date.getTime() === other.date.getTime() &&
             this.day === other.day &&
             this.description === other.description &&
             this.oldRoom === other.oldRoom &&
             this.newRoom === other.newRoom &&
             this.oldSubject === other.oldSubject &&
-            this.newSubject === other.newSubject;
+            this.newSubject === other.newSubject
+        );
     }
 
     /**

src/timetable/timetable.ts

@@ -1,5 +1,5 @@
 import { Entry } from "./entry";
-import { load } from "cheerio";
+import { CheerioAPI, load } from "cheerio";
 import { SubjectContainer } from "./subjectcontainer";
 import { defaultSubjectShorts } from "../utility";
 
@@ -9,6 +9,31 @@ import { defaultSubjectShorts } from "../utility";
 export class TimeTable implements SubjectContainer {
     public subjectShorts = new Map<string, string>(defaultSubjectShorts);
 
+    /**
+     * Parse the `TimeTable` from HTML in a custom way
+     *
+     * @param html The html object from where the data is to be extracted
+     * @returns a new `TimeTable` instance
+     *
+     * @example
+     * ```js
+     * // use custom html-handler
+     * TimeTable.htmlHandler = (html) => {
+     *     var div = html("my-div")
+     *     var data = div.text()
+     *
+     *     return new TimeTable(...)
+     * }
+     * ```
+     *
+     * @example
+     * ```js
+     * // reset html-handler to default
+     * TimeTable.htmlHandler = undefined
+     * ```
+     */
+    public static htmlHandler: (html: CheerioAPI) => TimeTable;
+
     constructor(public readonly entries: Entry[]) {
         entries.forEach((e) => e.registerSubjectShorts(this.subjectShorts));
     }
@@ -103,8 +128,11 @@ export class TimeTable implements SubjectContainer {
      * @param rawHtml The raw html string
      * @returns A new `TimeTable` resource
      */
-    static fromHtml(rawHtml: string) {
+    public static fromHtml(rawHtml: string) {
         const $ = load(rawHtml);
+        if (TimeTable.htmlHandler !== undefined) {
+            return TimeTable.htmlHandler($);
+        }
 
         const centers = $("center");
         const entries: Entry[] = [];
@@ -133,9 +161,10 @@ export class TimeTable implements SubjectContainer {
             );
 
             for (const row of $(center).find("tr")) {
-                if ($(row).find("th").length !== 0) continue;
+                const rowCheer = $(row);
+                if (rowCheer.find("th").length !== 0) continue;
 
-                const columns = $(row).find("td");
+                const columns = rowCheer.find("td");
 
                 let period = $(columns[1]).text();
                 if (period.includes("-")) {

src/utility.ts

@@ -51,4 +51,4 @@ export const defaultSubjectShorts: [string, string][] = [
     ["IFÖM", "Mathe Förderunterricht"],
     ["IFÖE", "Englisch Förderunterricht"],
     ["IFÖD", "Deutsch Förderunterricht"],
-]
+];

test/components.spec.ts

@@ -22,7 +22,7 @@ describe("Test components(classes)", () => {
         expect(entry1.longOldSubject).to.be.a("string").and.equal("Mathe");
         expect(entry1.longNewSubject).to.be.a("string").and.equal("Deutsch");
 
-        const entry2 = Entry.fromJSON(data)
+        const entry2 = Entry.fromJSON(data);
 
         data["old-subject"] = "This subject does not exist";
         const entry3 = Entry.fromJSON(data);
@@ -38,12 +38,13 @@ describe("Test components(classes)", () => {
             detail: "Detial",
         };
         const post = NewsPost.fromJSON(data);
+        const post2 = NewsPost.fromJSON(post.toJSON());
 
         expect(JSON.stringify(post.toJSON())).to.equal(JSON.stringify(data));
         expect(post.title).to.be.a("string").and.equal(data["title"]);
         expect(post.date).to.be.a("date").and.equal(data["date"]);
         expect(post.detail).to.be.a("string").and.equal(data["detail"]);
-        expect(NewsPost.fromJSON(post.toJSON()).date).be.instanceOf(Date);
+        expect(post2.equals(post)).to.be.true;
     });
 
     it("Create and test DocumentPost", () => {
@@ -55,6 +56,7 @@ describe("Test components(classes)", () => {
             "preview-url": "previewURL",
         };
         const post = DocumentPost.fromJSON(data);
+        const post2 = DocumentPost.fromJSON(post.toJSON());
 
         expect(JSON.stringify(post.toJSON())).to.equal(JSON.stringify(data));
         expect(post.id).to.be.a("string").and.equal(data["id"]);
@@ -64,6 +66,6 @@ describe("Test components(classes)", () => {
         expect(post.previewURL)
             .to.be.a("string")
             .and.equal(data["preview-url"]);
-        expect(DocumentPost.fromJSON(post.toJSON()).date).be.instanceOf(Date);
+        expect(post2.equals(post)).to.be.true;
     });
 });