+ Adding a counter for unread articles(fixes #77)

+ Adding a option to define a custom folder when importing OPML(fixes #81) ~ Fixing parsing of wallabag feeds(fixes #79) ~ Adding a option to disable rendering of media(fixes #81) ~ hiding metadata block when reading a article(references #88)
joethei · Mar 31, 2022 · 72ea4bd · 72ea4bd
1 parent 1d1a89b
commit 72ea4bd
Show file tree

Hide file tree

Showing 31 changed files with 223 additions and 71 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,5 @@ main.js
 
 # obsidian
 data.json
+.nyc_output
+coverage
diff --git a/.mocharc.json b/.mocharc.json
@@ -1,5 +1,6 @@
 {
-  "extension": ["ts"],
-  "spec": "src/**/*.spec.ts",
-  "require": "ts-node/register"
+  "require": [
+    "./registerTests.js"
+  ],
+  "reporter": "dot"
 }
diff --git a/.nycrc.json b/.nycrc.json
@@ -0,0 +1,14 @@
+{
+  "extends": "@istanbuljs/nyc-config-typescript",
+  "include": [
+    "src/**/*.ts"
+  ],
+  "reporter": [
+    "text-summary",
+    "html",
+    "lcov",
+    "cobertura"
+  ],
+  "report-dir": "./coverage",
+  "all": true
+}
diff --git a/README.md b/README.md
@@ -41,6 +41,7 @@ After installing the plugin:
 - get fulltext content for some truncated RSS feeds with [morss.it](https://morss.it/)
 - get feeds from some social media sites with [RSS Box](https://rssbox.herokuapp.com/)
 - Filter content from feeds with [SiftRSS](https://siftrss.com/)
+- Get an RSS feed for a site that does not support RSS with [RSS-proxy](https://github.com/damoeb/rss-proxy/) or [RSS Hub](https://github.com/DIYgod/RSSHub)
 
 ## Template variables
 - `{{title}}` title of article

diff --git a/__mocks__/obsidian.ts b/__mocks__/obsidian.ts
@@ -0,0 +1,24 @@
+import fetch from "node-fetch";
+
+
+export interface RequestParam {
+    /** @public */
+    url: string;
+    /** @public */
+    method?: string;
+    /** @public */
+    contentType?: string;
+    /** @public */
+    body?: string;
+    /** @public */
+    headers?: Record<string, string>;
+}
+
+export async function request(request: RequestParam) : Promise<string> {
+    const result = await fetch(request.url,{
+        headers: request.headers,
+        method: request.method,
+        body: request.body
+    });
+    return result.text();
+}
diff --git a/babel.config.js b/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+    presets: ['@babel/preset-env']
+}
diff --git a/jest.config.js b/jest.config.js
@@ -0,0 +1,7 @@
+module.exports = {
+    transform: {"\\.ts$": ['ts-jest']},
+    collectCoverage: true,
+    testEnvironment: "jsdom",
+    moduleDirectories: ["node_modules", "src", "test"],
+
+};
diff --git a/manifest.json b/manifest.json
@@ -1,8 +1,8 @@
 {
 	"id": "rss-reader",
 	"name": "RSS Reader",
-	"version": "1.1.0",
-	"minAppVersion": "0.12.17",
+	"version": "1.2.0",
+	"minAppVersion": "0.13.33",
 	"description": "Read RSS Feeds from within obsidian",
 	"author": "Johannes Theiner",
 	"authorUrl": "https://github.com/joethei",

diff --git a/package.json b/package.json
@@ -1,19 +1,26 @@
 {
   "name": "rss-reader",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Read RSS Feeds from inside obsidian",
   "main": "main.js",
   "scripts": {
     "dev": "node esbuild.config.mjs",
     "build": "node esbuild.config.mjs production",
     "lint": "eslint . --ext .ts",
     "lint-css": "stylelint styles.css",
-    "test": "mocha"
+    "test": "jest --coverage"
   },
   "keywords": [],
   "author": "Johannes Theiner",
   "license": "GPL-3.0",
   "devDependencies": {
+    "jest": "27.5.1",
+    "@types/jest": "27.4.1",
+    "nyc": "15.1.0",
+    "sinon": "13.0.1",
+    "@types/sinon": "10.0.11",
+    "ts-jest": "27.1.4",
+    "@istanbuljs/nyc-config-typescript": "1.0.2",
     "@popperjs/core": "^2.10.2",
     "@types/chai": "^4.3.0",
     "@types/lodash.groupby": "^4.6.6",
@@ -48,6 +55,16 @@
     "ts-node": "^10.4.0",
     "tslint": "^6.1.3",
     "typescript": "^4.2.4",
-    "tslib": "^2.3.1"
+    "tslib": "^2.3.1",
+    "node-fetch": "3.2.3",
+    "@types/node-fetch": "2.6.1",
+    "@babel/core": "7.17.8",
+    "babel-jest": "27.5.1",
+    "@babel/preset-env": "7.16.11",
+    "@babel/preset-typescript": "7.16.7",
+    "@babel/plugin-transform-modules-commonjs": "7.17.7"
+  },
+  "dependencies": {
+
   }
 }
diff --git a/src/actions/Action.ts b/src/actions/Action.ts
@@ -40,7 +40,7 @@ export default class Action {
         return Promise.resolve();
     })));
 
-    static READ = new Action(t("mark_as_read_unread"), "feather-eye", ((async (plugin, item) : Promise<void> => {
+    static READ = new Action(t("mark_as_read_unread"), "eye", ((async (plugin, item) : Promise<void> => {
         if (item.read) {
             item.read = false;
             new Notice(t("marked_as_unread"));

diff --git a/src/functions.ts b/src/functions.ts
@@ -245,6 +245,10 @@ export function rssToMd(plugin: RssReaderPlugin, content: string): string {
         markdown = markdown.replace(/^```.*\n([\s\S]*?)```$/gm, "<pre>$&</pre>");
     }
 
+    if(!plugin.settings.displayMedia) {
+        //remove any embeds, but keep alias
+        markdown = markdown.replace(/!?\[(.*)\]\(.+\)/gm, "$1");
+    }
     return markdown;
 }
 

diff --git a/src/l10n/locales/en.ts b/src/l10n/locales/en.ts
@@ -209,5 +209,8 @@ export default {
     feed_title: "Title of feed",
     highlights: "Highlights",
     note_created: "Note creation date",
-    filename: "Filename"
+    filename: "Filename",
+
+    display_media: "Include Media",
+    base_folder: "Base folder"
 }
diff --git a/src/main.ts b/src/main.ts
@@ -15,7 +15,6 @@ import {
 } from "./stores";
 import {VIEW_ID} from "./consts";
 import {getFeedItems, RssFeedContent, RssFeedItem} from "./parser/rssParser";
-import {addFeatherIcon} from "obsidian-community-lib";
 import groupBy from "lodash.groupby";
 import mergeWith from "lodash.mergewith";
 import keyBy from "lodash.keyby";
@@ -35,19 +34,7 @@ export default class RssReaderPlugin extends Plugin {
     async onload(): Promise<void> {
         console.log('loading plugin rss reader');
 
-        addFeatherIcon("rss");
-        addFeatherIcon("eye");
-        addFeatherIcon("eye-off");
-        addFeatherIcon("star");
-        addFeatherIcon("headphones");
-        addFeatherIcon("upload");
-        addFeatherIcon("trash");
-        addFeatherIcon("plus");
-        addFeatherIcon("edit");
-        addFeatherIcon("download");
-        addFeatherIcon("archive");
-
-        //update settings whenever store contents change.
+        //update settings object whenever store contents change.
         this.register(
             settingsStore.subscribe((value: RssReaderSettings) => {
                 this.settings = value;
@@ -472,7 +459,7 @@ export default class RssReaderPlugin extends Plugin {
             try {
                 JSON.parse(file);
             } catch (e) {
-                console.log("RSS Reader: could not parse json, check if the plugins data.json is valid.");
+                console.log(t("RSS_Reader") + "  could not parse json, check if the plugins data.json is valid.");
                 console.error(e);
                 new Notice(t("RSS_Reader") + " could not parse plugin data. If this message keeps showing up, check the console");
                 return Promise.resolve();

diff --git a/src/modals/ImportModal.ts b/src/modals/ImportModal.ts
@@ -2,6 +2,7 @@ import {Modal, Notice, Setting} from "obsidian";
 import {loadFeedsFromString} from "../parser/opmlParser";
 import RssReaderPlugin from "../main";
 import t from "../l10n/locale";
+import {FeedFolderSuggest} from "../view/FeedFolderSuggest";
 
 //adapted from javalent's code here: https://discord.com/channels/686053708261228577/840286264964022302/918146537220112455
 export class ImportModal extends Modal {
@@ -14,6 +15,7 @@ export class ImportModal extends Modal {
     }
 
     importData = "";
+    defaultFolder = "";
 
     async onOpen() : Promise<void> {
         const setting = new Setting(this.contentEl).setName(t("choose_file")).setDesc(t("choose_file_help"));
@@ -37,13 +39,23 @@ export class ImportModal extends Modal {
             }
         }
 
+        new Setting(this.contentEl)
+            .setName(t("base_folder"))
+            .addSearch(search => {
+                new FeedFolderSuggest(this.app, search.inputEl);
+                search.setValue(this.defaultFolder)
+                   .onChange(value => {
+                       this.defaultFolder = value;
+                   })
+            });
+
         new Setting(this.contentEl).addButton((button) => {
             button
                 .setIcon("import-glyph")
                 .setTooltip(t("import"))
                 .onClick(async () => {
                     if (this.importData) {
-                        const feeds = await loadFeedsFromString(this.importData);
+                        const feeds = await loadFeedsFromString(this.importData, this.defaultFolder);
                         await this.plugin.writeFeeds(() => (this.plugin.settings.feeds.concat(feeds)));
                         new Notice(t("imported_x_feeds", String(feeds.length)));
                         this.close();

diff --git a/src/modals/ItemModal.ts b/src/modals/ItemModal.ts
@@ -149,7 +149,7 @@ export class ItemModal extends Modal {
 
     async markAsRead(): Promise<void> {
         await Action.READ.processor(this.plugin, this.item);
-        this.readButton.setIcon((this.item.read) ? 'feather-eye-off' : 'feather-eye');
+        this.readButton.setIcon((this.item.read) ? 'eye-off' : 'eye');
         this.readButton.setTooltip((this.item.read) ? t("mark_as_unread") : t("mark_as_unread"));
     }
 
@@ -168,7 +168,7 @@ export class ItemModal extends Modal {
 
         if (this.save) {
             this.readButton = new ButtonComponent(topButtons)
-                .setIcon(this.item.read ? 'feather-eye-off' : 'feather-eye')
+                .setIcon(this.item.read ? 'eye-off' : 'eye')
                 .setTooltip(this.item.read ? t("mark_as_unread") : t("mark_as_read"))
                 .onClick(async () => {
                     await this.markAsRead();
@@ -202,7 +202,7 @@ export class ItemModal extends Modal {
         //@ts-ignore
         if (this.app.plugins.plugins["obsidian-tts"]) {
             const ttsButton = new ButtonComponent(topButtons)
-                .setIcon("feather-headphones")
+                .setIcon("headphones")
                 .setTooltip(t("read_article_tts"))
                 .onClick(async () => {
                     const content = htmlToMarkdown(this.item.content);
@@ -250,7 +250,7 @@ export class ItemModal extends Modal {
         const content = contentEl.createDiv('rss-content');
         content.addClass("rss-scrollable-content", "rss-selectable");
 
-        if (this.item.enclosure) {
+        if (this.item.enclosure && this.plugin.settings.displayMedia) {
             if (this.item.enclosureType.toLowerCase().contains("audio")) {
                 const audio = content.createEl("audio", {attr: {controls: "controls"}});
                 audio.createEl("source", {attr: {src: this.item.enclosure, type: this.item.enclosureType}});
@@ -276,7 +276,7 @@ export class ItemModal extends Modal {
 
         if (this.item.content) {
             //prepend empty yaml to fix rendering errors
-            const markdown = "---\n----" + rssToMd(this.plugin, this.item.content);
+            const markdown = "---\n---" + rssToMd(this.plugin, this.item.content);
 
             await MarkdownRenderer.renderMarkdown(markdown, content, "", this.plugin);
 
@@ -370,7 +370,7 @@ export class ItemModal extends Modal {
                     if (this.app.plugins.plugins["obsidian-tts"]) {
                         menu.addItem(item => {
                             item
-                                .setIcon("feather-headphones")
+                                .setIcon("headphones")
                                 .setTitle(t("read_article_tts"))
                                 .onClick(() => {
                                     //@ts-ignore

diff --git a/src/parser/opmlParser.ts b/src/parser/opmlParser.ts
@@ -1,6 +1,6 @@
 import {RssFeed} from "../settings/settings";
 
-export async function loadFeedsFromString(importData: string): Promise<RssFeed[]> {
+export async function loadFeedsFromString(importData: string, defaultFolder: string): Promise<RssFeed[]> {
     const rawData = new window.DOMParser().parseFromString(importData, "text/xml");
     const feeds: RssFeed[] = [];
 
@@ -19,13 +19,13 @@ export async function loadFeedsFromString(importData: string): Promise<RssFeed[]
                 feeds.push({
                     name: title,
                     url: xmlUrl,
-                    folder: current.parentElement.getAttribute("title"),
+                    folder: defaultFolder + ((defaultFolder) ? "/" : "") + current.parentElement.getAttribute("title"),
                 });
             }else {
                 feeds.push({
                     name: title,
                     url: xmlUrl,
-                    folder: ""
+                    folder: defaultFolder + ""
                 });
             }
         }

diff --git a/src/parser/rssParser.ts b/src/parser/rssParser.ts
@@ -60,7 +60,7 @@ function getElementByName(element: Element | Document, name: string): ChildNode
         return;
     }
 
-    if (name.contains(":")) {
+    if (name.includes(":")) {
         const [namespace, tag] = name.split(":");
         const namespaceUri = element.lookupNamespaceURI(namespace);
         const byNamespace = element.getElementsByTagNameNS(namespaceUri, tag);
@@ -81,7 +81,7 @@ function getElementByName(element: Element | Document, name: string): ChildNode
             }
         }
 
-    } else if (name.contains(".")) {
+    } else if (name.includes(".")) {
         const [prefix, tag] = name.split(".");
         if (element.getElementsByTagName(prefix).length > 0) {
             const nodes = Array.from(element.getElementsByTagName(prefix)[0].childNodes);
@@ -101,6 +101,8 @@ function getElementByName(element: Element | Document, name: string): ChildNode
                 value = node;
         }
     }
+    //if(name === "content") console.log(value);
+
     return value;
 }
 
@@ -113,7 +115,7 @@ function getElementByName(element: Element | Document, name: string): ChildNode
 function getContent(element: Element | Document, names: string[]): string {
     let value: string;
     for (const name of names) {
-        if (name.contains("#")) {
+        if (name.includes("#")) {
             const [elementName, attr] = name.split("#");
             const data = getElementByName(element, elementName);
             if (data) {
@@ -129,11 +131,17 @@ function getContent(element: Element | Document, names: string[]): string {
             const data = getElementByName(element, name);
             if (data) {
                 //@ts-ignore
-                if (data.nodeValue && data.nodeValue.length > 0) {
+                if(data.wholeText && data.wholeText.length > 0) {
+                    //@ts-ignore
+                    value = data.wholeText;
+                }
+
+                //@ts-ignore
+                if (!value && data.nodeValue && data.nodeValue.length > 0) {
                     value = data.nodeValue;
                 }
                 //@ts-ignore
-                else if (data.innerHTML && data.innerHTML.length > 0) {
+                if (!value && data.innerHTML && data.innerHTML.length > 0) {
                     //@ts-ignore
                     value = data.innerHTML;
                 }
@@ -190,10 +198,14 @@ function getAllItems(doc: Document): Element[] {
     return items;
 }
 
+async function requestFeed(feed: RssFeed) : Promise<string> {
+    return await request({url: feed.url});
+}
+
 export async function getFeedItems(feed: RssFeed): Promise<RssFeedContent> {
     let data;
     try {
-        const rawData = await request({url: feed.url});
+        const rawData = await requestFeed(feed);
         data = new window.DOMParser().parseFromString(rawData, "text/xml");
     } catch (e) {
         console.error(e);