From 77d6dc605875235a240208ac5258ea7f9dacec5e Mon Sep 17 00:00:00 2001
From: Ross Keenan <rossk29@gmail.com>
Date: Tue, 26 Oct 2021 09:06:39 +0200
Subject: [PATCH] refactor: :recycle: All analysis types into constants, not
 their own files

---
 src/Algorithms/Centrality.ts         |  41 --------
 src/Algorithms/LinkPrediction.ts     |  44 --------
 src/Algorithms/Similarity.ts         |  34 ------
 src/AnalysisView.ts                  |   3 +-
 src/Components/Centrality.svelte     |  15 ++-
 src/Components/CoCitations.svelte    |   4 +-
 src/Components/LinkPrediction.svelte |  11 +-
 src/Components/Similarity.svelte     |  11 +-
 src/Constants.ts                     |  42 +++++---
 src/MyGraph.ts                       |   2 +-
 src/Settings.ts                      | 149 +++++++++++++--------------
 src/Utility.ts                       |   4 +-
 src/main.ts                          |   2 +-
 13 files changed, 129 insertions(+), 233 deletions(-)
 delete mode 100644 src/Algorithms/Centrality.ts
 delete mode 100644 src/Algorithms/LinkPrediction.ts
 delete mode 100644 src/Algorithms/Similarity.ts

diff --git a/src/Algorithms/Centrality.ts b/src/Algorithms/Centrality.ts
deleted file mode 100644
index 1f3f0ba..0000000
--- a/src/Algorithms/Centrality.ts
+++ /dev/null
@@ -1,41 +0,0 @@
-
-// export const closenessCentrality: CentralityAlg = (g: Graph, a: string) => {
-// 	const paths = graphlib.alg.dijkstra(g, a);
-
-// 	const distances = [];
-// 	for (const target in paths) {
-// 		const dist = paths[target].distance;
-// 		if (dist < Infinity) {
-// 			distances.push(dist);
-// 		}
-// 	}
-
-// 	if (distances.length > 0) {
-// 		const closeness = roundNumber((g.nodes().length - 1) / sum(distances));
-// 		return closeness;
-// 	} else {
-// 		return 0;
-// 	}
-// }
-
-// export const centralityForAll: AnalysisForAll = (
-// 	alg: CentralityAlg,
-// 	g: Graph,
-// 	currNode: string) => {
-
-// 	const nodes = g.nodes();
-// 	const centralityArr: AnalysisObj[] = [];
-// 	nodes.forEach(node => centralityArr.push({
-// 		from: currNode,
-// 		to: node,
-// 		measure: alg(g, node),
-// 		linked: g.hasEdge(currNode, node)
-// 	}));
-// 	return centralityArr
-// }
-
-export const CENTRALITY_TYPES: {
-	subtype: string
-}[] = [
-		{ subtype: 'Closeness' }
-	]
\ No newline at end of file
diff --git a/src/Algorithms/LinkPrediction.ts b/src/Algorithms/LinkPrediction.ts
deleted file mode 100644
index d31f47d..0000000
--- a/src/Algorithms/LinkPrediction.ts
+++ /dev/null
@@ -1,44 +0,0 @@
-// export const adamicAdarLinkPrediction: LinkPredictionAlg = (g: Graph, a: string, b: string): number => {
-//     const [Na, Nb] = [g.neighbors(a) as string[], g.neighbors(b) as string[]];
-//     const Nab = nodeIntersection(Na, Nb);
-
-//     if (Nab.length) {
-//         const neighbours: number[] = Nab.map(node => (g.successors(node) as string[]).length)
-//         return roundNumber(sum(neighbours.map(neighbour => 1 / Math.log(neighbour))))
-//     } else {
-//         return Infinity
-//     }
-// }
-
-// export { adamicAdarLinkPrediction };
-
-// export const commonNeighboursLinkPrediction: LinkPredictionAlg = (g: Graph, a: string, b: string): number => {
-//     const [Na, Nb] = [g.neighbors(a) as string[], g.neighbors(b) as string[]];
-//     const Nab = nodeIntersection(Na, Nb)
-//     return Nab.length
-// }
-
-// export const linkPredictionsForAll: AnalysisForAll = (
-//     alg: LinkPredictionAlg,
-//     g: Graph,
-//     currNode: string) => {
-//     const predictionsArr: AnalysisObj[] = []
-//     const paths = g.nodes();
-
-//     for (let i = 0; i < paths.length; i++) {
-//         const node = paths[i];
-
-//         const prediction = alg(g, node, currNode)
-//         predictionsArr[i] = {
-//             from: currNode,
-//             to: node,
-//             measure: prediction,
-//             linked: g.hasEdge(currNode, node)
-//         }
-//     }
-//     return predictionsArr
-// }
-
-export const LINK_PREDICTION_TYPES: {
-  subtype: string
-}[] = [{ subtype: 'Adamic Adar' }, { subtype: 'Common Neighbours' }]
diff --git a/src/Algorithms/Similarity.ts b/src/Algorithms/Similarity.ts
deleted file mode 100644
index 7a6ed47..0000000
--- a/src/Algorithms/Similarity.ts
+++ /dev/null
@@ -1,34 +0,0 @@
-
-// export const JaccardSimilarity: SimilarityAlg = (g: Graph, a: string, b: string) => {
-//     const [Na, Nb] = [
-//         g.neighbors(a) as string[],
-//         g.neighbors(b) as string[]
-//     ];
-//     const Nab = nodeIntersection(Na, Nb);
-//     return (Nab.length / (Na.length + Nb.length - Nab.length))
-// }
-
-// export const similarityForAll: AnalysisForAll = (
-//     alg: SimilarityAlg,
-//     g: MyGraph,
-//     currNode: string) => {
-
-//     const similarityArr: AnalysisObj[] = [];
-//     const nodes = g.nodes();
-//     nodes.forEach(node => {
-//         const similarity = roundNumber(alg(g, node, currNode));
-//         similarityArr.push({
-//             from: currNode,
-//             to: node,
-//             measure: similarity,
-//             linked: g.hasEdge(currNode, node)
-//         })
-//     })
-//     return similarityArr;
-// }
-
-export const SIMILARITY_TYPES: {
-    subtype: string
-}[] = [
-        { subtype: 'Jaccard' },
-    ]
\ No newline at end of file
diff --git a/src/AnalysisView.ts b/src/AnalysisView.ts
index a35ed5e..bacb7cb 100644
--- a/src/AnalysisView.ts
+++ b/src/AnalysisView.ts
@@ -1,8 +1,7 @@
 import { ItemView, WorkspaceLeaf } from 'obsidian'
-import { ANALYSIS_TYPES, VIEW_TYPE_GRAPH_ANALYSIS } from 'src/Constants'
+import { ANALYSIS_TYPES, VIEW_TYPE_GRAPH_ANALYSIS } from 'src/constants'
 import type { Analyses } from 'src/Interfaces'
 import type GraphAnalysisPlugin from 'src/main'
-import { claim_component } from 'svelte/internal'
 import CoCitations from './Components/CoCitations.svelte'
 import LinkPrediction from './Components/LinkPrediction.svelte'
 import Similarity from './Components/Similarity.svelte'
diff --git a/src/Components/Centrality.svelte b/src/Components/Centrality.svelte
index 47701c2..3565eeb 100644
--- a/src/Components/Centrality.svelte
+++ b/src/Components/Centrality.svelte
@@ -1,12 +1,17 @@
 <script lang="ts">
   import type { App } from 'obsidian'
-  import { openOrSwitch } from 'obsidian-community-lib'
-  import { CENTRALITY_TYPES } from 'src/Algorithms/Centrality'
+  import { openOrSwitch, linkedQ } from 'obsidian-community-lib'
   import type AnalysisView from 'src/AnalysisView'
-  import { LINKED, NOT_LINKED, TD_MEASURE, TD_NODE } from 'src/Constants'
+  import {
+    CENTRALITY_TYPES,
+    LINKED,
+    NOT_LINKED,
+    TD_MEASURE,
+    TD_NODE,
+  } from 'src/constants'
   import type { GraphAnalysisSettings, Subtypes } from 'src/Interfaces'
   import type GraphAnalysisPlugin from 'src/main'
-  import { debug, dropPath, hoverPreview, linkedQ } from 'src/Utility'
+  import { debug, dropPath, hoverPreview } from 'src/Utility'
   import { onMount } from 'svelte'
 
   export let plugin: GraphAnalysisPlugin
@@ -85,7 +90,7 @@
       <tr class={node.linked ? LINKED : NOT_LINKED}>
         <td
           class="internal-link {TD_NODE}"
-          on:click={(e) => openOrSwitch(app, node.to, currFile, e)}
+          on:click={(e) => openOrSwitch(app, node.to, e)}
           on:mouseover={(e) => hoverPreview(e, view)}
         >
           {dropPath(node.to)}
diff --git a/src/Components/CoCitations.svelte b/src/Components/CoCitations.svelte
index cdbb7d9..62a3341 100644
--- a/src/Components/CoCitations.svelte
+++ b/src/Components/CoCitations.svelte
@@ -1,8 +1,8 @@
 <script lang="ts">
   import type { App } from 'obsidian'
-  import { openOrSwitch, linkedQ } from 'obsidian-community-lib'
+  import { linkedQ, openOrSwitch } from 'obsidian-community-lib'
   import type AnalysisView from 'src/AnalysisView'
-  import { LINKED, NOT_LINKED, TD_MEASURE, TD_NODE } from 'src/Constants'
+  import { LINKED, NOT_LINKED, TD_MEASURE, TD_NODE } from 'src/constants'
   import type { CoCitationRes, GraphAnalysisSettings } from 'src/Interfaces'
   import type GraphAnalysisPlugin from 'src/main'
   import {
diff --git a/src/Components/LinkPrediction.svelte b/src/Components/LinkPrediction.svelte
index 2cc2c8c..bd33ec9 100644
--- a/src/Components/LinkPrediction.svelte
+++ b/src/Components/LinkPrediction.svelte
@@ -1,9 +1,14 @@
 <script lang="ts">
   import type { App } from 'obsidian'
-  import { openOrSwitch, linkedQ } from 'obsidian-community-lib'
-  import { LINK_PREDICTION_TYPES } from 'src/Algorithms/LinkPrediction'
+  import { linkedQ, openOrSwitch } from 'obsidian-community-lib'
   import type AnalysisView from 'src/AnalysisView'
-  import { LINKED, NOT_LINKED, TD_MEASURE, TD_NODE } from 'src/Constants'
+  import {
+    LINKED,
+    LINK_PREDICTION_TYPES,
+    NOT_LINKED,
+    TD_MEASURE,
+    TD_NODE,
+  } from 'src/constants'
   import type { GraphAnalysisSettings } from 'src/Interfaces'
   import type GraphAnalysisPlugin from 'src/main'
   import { debug, dropPath, hoverPreview, openMenu } from 'src/Utility'
diff --git a/src/Components/Similarity.svelte b/src/Components/Similarity.svelte
index eb198d7..e62c875 100644
--- a/src/Components/Similarity.svelte
+++ b/src/Components/Similarity.svelte
@@ -1,9 +1,14 @@
 <script lang="ts">
   import type { App } from 'obsidian'
-  import { openOrSwitch, linkedQ } from 'obsidian-community-lib'
-  import { SIMILARITY_TYPES } from 'src/Algorithms/Similarity'
+  import { linkedQ, openOrSwitch } from 'obsidian-community-lib'
   import type AnalysisView from 'src/AnalysisView'
-  import { LINKED, NOT_LINKED, TD_MEASURE, TD_NODE } from 'src/Constants'
+  import {
+    LINKED,
+    NOT_LINKED,
+    SIMILARITY_TYPES,
+    TD_MEASURE,
+    TD_NODE,
+  } from 'src/constants'
   import type { GraphAnalysisSettings } from 'src/Interfaces'
   import type GraphAnalysisPlugin from 'src/main'
   import { debug, dropPath, hoverPreview, openMenu } from 'src/Utility'
diff --git a/src/Constants.ts b/src/Constants.ts
index 4bcbdb3..80fd806 100644
--- a/src/Constants.ts
+++ b/src/Constants.ts
@@ -1,28 +1,38 @@
-import type { Analyses, GraphAnalysisSettings } from "src/Interfaces";
+import type { Analyses, GraphAnalysisSettings } from 'src/Interfaces'
 
 export const DEFAULT_SETTINGS: GraphAnalysisSettings = {
-    noInfinity: true,
-    noZero: true,
-    defaultAnalysisType: 'Co-Citations',
-    debugMode: false,
-    superDebugMode: false,
+  noInfinity: true,
+  noZero: true,
+  defaultAnalysisType: 'Co-Citations',
+  debugMode: false,
+  superDebugMode: false,
 }
 
-export const DECIMALS = 4;
+export const DECIMALS = 4
 
-export const VIEW_TYPE_GRAPH_ANALYSIS = 'graph-analysis';
+export const VIEW_TYPE_GRAPH_ANALYSIS = 'graph-analysis'
 
 export const ANALYSIS_TYPES: Analyses[] = [
-    // 'Centrality',
-    'Link Prediction',
-    'Similarity',
-    'Co-Citations'
+  // 'Centrality',
+  'Link Prediction',
+  'Similarity',
+  'Co-Citations',
 ]
 
-export const LINKED = 'analysis-linked';
-export const NOT_LINKED = 'analysis-not-linked';
+export const LINKED = 'analysis-linked'
+export const NOT_LINKED = 'analysis-not-linked'
 
-export const TD_MEASURE = 'analysis-measure';
-export const TD_NODE = 'analysis-node';
+export const TD_MEASURE = 'analysis-measure'
+export const TD_NODE = 'analysis-node'
 
+export const CENTRALITY_TYPES: {
+  subtype: string
+}[] = [{ subtype: 'Closeness' }]
 
+export const LINK_PREDICTION_TYPES: {
+  subtype: string
+}[] = [{ subtype: 'Adamic Adar' }, { subtype: 'Common Neighbours' }]
+
+export const SIMILARITY_TYPES: {
+  subtype: string
+}[] = [{ subtype: 'Jaccard' }]
diff --git a/src/MyGraph.ts b/src/MyGraph.ts
index 49aa580..08a69d8 100644
--- a/src/MyGraph.ts
+++ b/src/MyGraph.ts
@@ -1,7 +1,7 @@
 import { Graph } from 'graphlib'
 import type { App, HeadingCache, ReferenceCache } from 'obsidian'
 import tokenizer from 'sbd'
-import { DECIMALS } from 'src/Constants'
+import { DECIMALS } from 'src/constants'
 import { nodeIntersection } from 'src/GeneralGraphFn'
 import type {
   AnalysisAlg,
diff --git a/src/Settings.ts b/src/Settings.ts
index 92764e3..63a5b4a 100644
--- a/src/Settings.ts
+++ b/src/Settings.ts
@@ -1,91 +1,82 @@
-import { App, PluginSettingTab, Setting } from "obsidian";
-import type { Analyses } from "src/Interfaces";
-import { ANALYSIS_TYPES } from "src/Constants";
-import type GraphAnalysisPlugin from "src/main";
+import { App, PluginSettingTab, Setting } from 'obsidian'
+import { ANALYSIS_TYPES } from 'src/constants'
+import type { Analyses } from 'src/Interfaces'
+import type GraphAnalysisPlugin from 'src/main'
 
 export class SampleSettingTab extends PluginSettingTab {
-    plugin: GraphAnalysisPlugin;
+  plugin: GraphAnalysisPlugin
 
-    constructor(app: App, plugin: GraphAnalysisPlugin) {
-        super(app, plugin);
-        this.plugin = plugin;
-    }
+  constructor(app: App, plugin: GraphAnalysisPlugin) {
+    super(app, plugin)
+    this.plugin = plugin
+  }
 
-    display(): void {
-        const plugin = this.plugin
-        let { containerEl } = this;
-        const { settings } = plugin
+  display(): void {
+    const plugin = this.plugin
+    let { containerEl } = this
+    const { settings } = plugin
 
-        containerEl.empty();
+    containerEl.empty()
 
-        containerEl.createEl("h3", { text: "Analysis Defaults" });
+    containerEl.createEl('h3', { text: 'Analysis Defaults' })
 
-        new Setting(containerEl)
-            .setName("Default Analysis Type")
-            .setDesc("Which analysis type to show on startup")
-            .addDropdown(dd => {
-                dd.setValue(settings.defaultAnalysisType)
-                const dict = {}
-                ANALYSIS_TYPES.forEach(type => {
-                    dict[type] = type
-                });
-                dd.addOptions(dict).onChange(async option => {
-                    settings.defaultAnalysisType = (option as Analyses)
-                    await plugin.saveSettings()
-                })
-            })
+    new Setting(containerEl)
+      .setName('Default Analysis Type')
+      .setDesc('Which analysis type to show on startup')
+      .addDropdown((dd) => {
+        dd.setValue(settings.defaultAnalysisType)
+        const dict = {}
+        ANALYSIS_TYPES.forEach((type) => {
+          dict[type] = type
+        })
+        dd.addOptions(dict).onChange(async (option) => {
+          settings.defaultAnalysisType = option as Analyses
+          await plugin.saveSettings()
+        })
+      })
 
-        new Setting(containerEl)
-            .setName("Exclude Infinity")
-            .setDesc("Whether to exclude Infinite values by default")
-            .addToggle((toggle) =>
-                toggle
-                    .setValue(settings.noInfinity)
-                    .onChange(async (value) => {
-                        settings.noInfinity = value;
-                        await plugin.saveSettings();
-                    })
-            );
+    new Setting(containerEl)
+      .setName('Exclude Infinity')
+      .setDesc('Whether to exclude Infinite values by default')
+      .addToggle((toggle) =>
+        toggle.setValue(settings.noInfinity).onChange(async (value) => {
+          settings.noInfinity = value
+          await plugin.saveSettings()
+        })
+      )
 
-        new Setting(containerEl)
-            .setName("Exclude Zero")
-            .setDesc("Whether to exclude Zero by default")
-            .addToggle((toggle) =>
-                toggle
-                    .setValue(settings.noZero)
-                    .onChange(async (value) => {
-                        settings.noZero = value;
-                        await plugin.saveSettings();
-                    })
-            );
+    new Setting(containerEl)
+      .setName('Exclude Zero')
+      .setDesc('Whether to exclude Zero by default')
+      .addToggle((toggle) =>
+        toggle.setValue(settings.noZero).onChange(async (value) => {
+          settings.noZero = value
+          await plugin.saveSettings()
+        })
+      )
 
+    containerEl.createEl('h3', { text: 'Debugging Options' })
 
-        containerEl.createEl("h3", { text: "Debugging Options" });
+    new Setting(containerEl)
+      .setName('Debug Mode')
+      .setDesc(
+        'Toggling this on will enable a few console logs to appear when using the graph analysis view.'
+      )
+      .addToggle((toggle) =>
+        toggle.setValue(settings.debugMode).onChange(async (value) => {
+          settings.debugMode = value
+          await plugin.saveSettings()
+        })
+      )
 
-        new Setting(containerEl)
-            .setName("Debug Mode")
-            .setDesc(
-                "Toggling this on will enable a few console logs to appear when using the graph analysis view."
-            )
-            .addToggle((toggle) =>
-                toggle
-                    .setValue(settings.debugMode)
-                    .onChange(async (value) => {
-                        settings.debugMode = value;
-                        await plugin.saveSettings();
-                    })
-            );
-
-        new Setting(containerEl)
-            .setName("Super Debug Mode")
-            .setDesc("Toggling this on will enable ALOT of console logs")
-            .addToggle((toggle) =>
-                toggle
-                    .setValue(settings.superDebugMode)
-                    .onChange(async (value) => {
-                        settings.superDebugMode = value;
-                        await plugin.saveSettings();
-                    })
-            );
-    }
-}
\ No newline at end of file
+    new Setting(containerEl)
+      .setName('Super Debug Mode')
+      .setDesc('Toggling this on will enable ALOT of console logs')
+      .addToggle((toggle) =>
+        toggle.setValue(settings.superDebugMode).onChange(async (value) => {
+          settings.superDebugMode = value
+          await plugin.saveSettings()
+        })
+      )
+  }
+}
diff --git a/src/Utility.ts b/src/Utility.ts
index 17dffb7..6f4e6d1 100644
--- a/src/Utility.ts
+++ b/src/Utility.ts
@@ -1,6 +1,6 @@
 import { App, ItemView, Menu, Notice, TFile } from 'obsidian'
-import { DECIMALS } from 'src/Constants'
-import type { GraphAnalysisSettings, ResolvedLinks } from 'src/Interfaces'
+import { DECIMALS } from 'src/constants'
+import type { GraphAnalysisSettings } from 'src/Interfaces'
 
 export const sum = (arr: number[]) => {
   if (arr.length === 0) {
diff --git a/src/main.ts b/src/main.ts
index 8c65c2d..4b6cf8f 100644
--- a/src/main.ts
+++ b/src/main.ts
@@ -1,6 +1,6 @@
 import { MarkdownView, Notice, Plugin, WorkspaceLeaf } from 'obsidian'
 import AnalysisView from 'src/AnalysisView'
-import { DEFAULT_SETTINGS, VIEW_TYPE_GRAPH_ANALYSIS } from 'src/Constants'
+import { DEFAULT_SETTINGS, VIEW_TYPE_GRAPH_ANALYSIS } from 'src/constants'
 import type { GraphAnalysisSettings } from 'src/Interfaces'
 import MyGraph from 'src/MyGraph'
 import { SampleSettingTab } from 'src/Settings'