Merge pull request #14 from MonoScyron/dev

Dev into main

Author: MonoScyron

.idea/inspectionProfiles/Project_Default.xml

@@ -10,7 +10,8 @@ Firefox extension for the fanfiction website [ArchiveOfOurOwn](http://archiveofo
 
 This guide details how to install any add-on in general on Firefox Nightly browsers on mobile.
 
-Note: This extension should work on mobile, but it has not been extensively tested there. Please report any bugs you find in the issues tab!
+Note: This extension should work on mobile, but it has not been extensively tested there. Please report any bugs you
+find in the issues tab!
 
 1. Create a collection on the [Firefox Add-ons collections page](https://addons.mozilla.org/en-US/firefox/collections/)
 2. Add "AO3 Enhancer" (Or any other add-on) to that collection
@@ -27,6 +28,7 @@ Most features are disabled by default. Please click on the extension icon to ena
 ### Enhancer Additions
 
 - **Kudos to Hit Ratio**: Adds a kudos to hit percentage to the stats list of a work.
+- **Hide Fics by Ratio**: Automatically hides works with too low kudos to hit ratio.
 - **Hide Fics With Too Many Fandoms**: Automatically hides works with too many fandoms.
 
 ### Built-in Filtering Settings
@@ -47,7 +49,6 @@ These are features I currently plan on adding. Please suggest additional feature
 - [ ] Filter & sort your marked-for-later fics
 - [ ] Filter fics by if already read
 - [ ] Filter fics by individual fic ID
-- [ ] Filter fics by ratio of kudos to hits
 - [ ] Add ability to get notified when fics are completed
 
 #### TODO Lower Priority
@@ -80,6 +81,7 @@ This will cause webpack to optimize for production. To build for production, run
 `npm run build:prod`
 
 #### Add-on Compilation
+
 Latest version of the add-on was built using these software versions:
 
 ```
@@ -93,11 +95,10 @@ Node: v18.12.1
 
 This addon was inspired by the extensions I use to browse AO3:
 
--   [AO3 Enhancements](https://github.com/jsmnbom/ao3-enhancements) by `jsmnbom`
--   [AO3 Tag Blocker](https://github.com/ao3-tag-blocker/tag-blocker)
-
-The icon is a modified version of the icon for [AO3 Enhancements](https://github.com/jsmnbom/ao3-enhancements) by `jsmnbom`.
+- [AO3 Enhancements](https://github.com/jsmnbom/ao3-enhancements) by `jsmnbom`
+- [AO3 Tag Blocker](https://github.com/ao3-tag-blocker/tag-blocker)
 
-The options page background is CC-BY-4.0 by [Hero Patterns](http://www.heropatterns.com/).
+The icon is a modified version of the icon for [AO3 Enhancements](https://github.com/jsmnbom/ao3-enhancements)
+by `jsmnbom`.
 
-The eye and arrow icons used are MIT license by [Heroicons](https://heroicons.com/).
+The options page background is CC-BY-4.0 by [Hero Patterns](http://www.heropatterns.com/).

.idea/workspace.xml

@@ -1,49 +1,49 @@
 {
-    "manifest_version": 2,
-    "name": "AO3 Enhancer",
-    "version": "0.0.5",
-    "description": "Enhancement extension for Archive of Our Own.",
-    "author": "MonoScyron",
-    "icons": {
-        "48": "/build/icons/logo-48.png",
-        "96": "/build/icons/logo-96.png"
-    },
-    "permissions": [
-        "storage",
-        "webRequest",
-        "webRequestBlocking",
+  "manifest_version": 2,
+  "name": "AO3 Enhancer",
+  "version": "0.0.6",
+  "description": "Enhancement extension for Archive of Our Own.",
+  "author": "MonoScyron",
+  "icons": {
+    "48": "/build/icons/logo-48.png",
+    "96": "/build/icons/logo-96.png"
+  },
+  "permissions": [
+    "storage",
+    "webRequest",
+    "webRequestBlocking",
+    "https://archiveofourown.org/*"
+  ],
+  "browser_action": {
+    "default_icon": "/build/icons/logo-32.png",
+    "default_title": "AO3 Enhancer"
+  },
+  "options_ui": {
+    "page": "build/options/options.html",
+    "open_in_tab": true
+  },
+  "background": {
+    "scripts": [
+      "build/background/bg_bundle.js"
+    ]
+  },
+  "content_scripts": [
+    {
+      "matches": [
         "https://archiveofourown.org/*"
-    ],
-    "browser_action": {
-        "default_icon": "/build/icons/logo-32.png",
-        "default_title": "AO3 Enhancer"
-    },
-    "options_ui": {
-        "page": "build/options/options.html",
-        "open_in_tab": true
-    },
-    "background": {
-        "scripts": [
-            "build/background/bg_bundle.js"
-        ]
-    },
-    "content_scripts": [
-        {
-            "matches": [
-                "https://archiveofourown.org/*"
-            ],
-            "js": [
-                "build/content_scripts/cs_bundle.js"
-            ],
-            "css": [
-                "build/css/enhancer.css"
-            ]
-        }
-    ],
-    "browser_specific_settings": {
-        "gecko": {
-            "id": "ao3-enhancer@MonoScyron",
-            "strict_min_version": "57.0"
-        }
+      ],
+      "js": [
+        "build/content_scripts/cs_bundle.js"
+      ],
+      "css": [
+        "build/css/enhancer.css"
+      ]
     }
+  ],
+  "browser_specific_settings": {
+    "gecko": {
+      "id": "ao3-enhancer@MonoScyron",
+      "strict_min_version": "57.0"
+    }
+  }
 }

README.md

@@ -1,5 +1,7 @@
 {
   "scripts": {
+    "prod": "npm run build:prod && npm run zip",
+    "dev": "npm run build:dev && npm run zip",
     "build-cs:dev": "webpack --mode=development --config cs-webpack.config.js",
     "build-bg:dev": "webpack --mode=development --config bg-webpack.config.js",
     "build-op:dev": "webpack --mode=development --config op-webpack.config.js",
@@ -8,9 +10,7 @@
     "build-op:prod": "webpack --mode=production --config op-webpack.config.js",
     "build:dev": "npm run build-cs:dev && npm run build-bg:dev && npm run build-op:dev",
     "build:prod": "npm run build-cs:prod && npm run build-bg:prod && npm run build-op:prod",
-    "zip": "@powershell IF(!(Test-Path dist)) { mkdir dist }; tar.exe -a -c -f ./dist/ao3-enhancer-firefox.zip build manifest.json",
-    "dev": "npm run build:dev && npm run zip",
-    "prod": "npm run build:prod && npm run zip"
+    "zip": "@powershell IF(!(Test-Path dist)) { mkdir dist }; tar.exe -a -c -f ./dist/ao3-enhancer-firefox.zip build manifest.json"
   },
   "dependencies": {
     "@types/firefox-webext-browser": "^109.0.0",

manifest.json

@@ -4,11 +4,12 @@ import { WorkElement } from "../export/objects";
  * Checks each work on page and hides them if necessary
  * @param works Works on page
  * @param document Document the works belong to
+ * @param settings Settings of extension
  */
 export function hideWorks(works: WorkElement[], document: Document, settings: { [key: string]: any }) {
     let parser = new DOMParser();
     works.forEach(w => {
-        var reason = shouldHide(w, settings);
+        let reason = shouldHide(w, settings);
         if(reason != null)
             hideWork(w, reason, document, parser);
     });
@@ -23,10 +24,18 @@ export function hideWorks(works: WorkElement[], document: Document, settings: {
  */
 function shouldHide(work: WorkElement, settings: { [key: string]: any }): string | null {
     // ! When returning string, should be in form of `([Reason why work is hidden]: ${Value of reason})`
+
+    // Hide by num fandoms
     if(!Number.isNaN(settings.hideByNumFandom) && work.fandoms.length > settings.hideByNumFandom) {
         return `(Too many fandoms: ${work.fandoms.length})`
     }
-
+    // Hide by ratio
+    else if(work.hits == 0) {
+        return `(Ratio too small: 0 hits)`
+    }
+    else if(work.kudos == 0 || work.kudos / work.hits < settings.hideByRatio / 100.0) {
+        return `(Ratio too small: ${Math.round((work.kudos / work.hits) * 1000) / 10}%)`
+    }
     return null;
 }
 

package.json

@@ -18,9 +18,10 @@ browser.storage.local.get(STORAGE_KEYS).then((value) => {
 /**
  * Executed after all promises are fulfilled
  * @param value Local storage values of all saved settings
+ * @param document Document of the current page
  */
 function onloadPromise(value: { [key: string]: any }, document: Document): void {
-    var works = constructWorkList(document);
+    let works = constructWorkList(document);
 
     // Add kudos to hit ratio if enabled
     if(value.kudosHitRatio)
@@ -29,6 +30,4 @@ function onloadPromise(value: { [key: string]: any }, document: Document): void
     // Hide works if page not a work page
     if(document.URL.split('/')[3] != "works")
         hideWorks(works, document, value);
-}
-
-// TODO: On load to user marked-for-later page, filter it (https://www.npmjs.com/package/ao3api for how to POST requests)
+}

src/content_scripts/hide-works.ts

@@ -1,8 +1,8 @@
 import { WorkElement } from '../export/objects';
 
 /**
-  * Adds kudos to hit ratios to works on the page
- * @param document Document of the page
+ * Adds kudos to hit ratios to works on the page
+ * @param workList List of works on page
  */
 export function addKudosToHitRatios(workList: WorkElement[]): void {
     // Create ratio elements for all works on page
@@ -11,11 +11,11 @@ export function addKudosToHitRatios(workList: WorkElement[]): void {
 
     workList.forEach((work, i) => {
         if(work.kudos != 0 && work.hits != 0) {
-            var ratio_dt = document.createElement("dt");
+            let ratio_dt = document.createElement("dt");
             ratio_dt.className = `kudos-to-hit-ratio`;
             ratio_dt.innerText = "Ratio:";
 
-            var ratio_dd = document.createElement("dd");
+            let ratio_dd = document.createElement("dd");
             ratio_dd.className = `ratio`;
             ratio_dd.innerText = Math.round((work.kudos / work.hits) * 1000) / 10 + "%";
 
@@ -29,7 +29,7 @@ export function addKudosToHitRatios(workList: WorkElement[]): void {
     });
 
     // Add list of ratio elements to works
-    for(var i = 0; i < workList.length; i++) {
+    for(let i = 0; i < workList.length; i++) {
         if(ratio_dtList[i] != null && ratio_ddList[i] != null) {
             workList[i].element?.querySelector('dl.stats')?.append(ratio_dtList[i]!, ratio_ddList[i]!);
         }

src/content_scripts/onload.ts

@@ -13,7 +13,7 @@ export function constructWorkList(document: Document): WorkElement[] {
     }
     else {
         let rawWorks = constructRawWorkList(document);
-        for(var i = 0; i < rawWorks.length; i++) {
+        for(let i = 0; i < rawWorks.length; i++) {
             workList.push(constuctWorkElement(rawWorks[i]));
         }
     }