Merge pull request #5 from forketyfork/codex/add-customizable-goals-file-and-progress-bar

Add goals progress tracking

Author: forketyfork

CLAUDE.md

@@ -20,6 +20,9 @@ This file provides guidance to AI agents when working with code in this reposito
 ## General guidelines
 
 - IMPORTANT: After finishing your task, make sure to run `yarn build` and fix any introduced issues.
+- IMPORTANT: On finishing your task, make sure the README.md file is up to date with regards to the new features, usage, and development.
+- IMPORTANT: Always try to extract testable logic that can be independent of Obsidian plugins to separate classes or functions and write unit tests for it.
+- IMPORTANT: Do not write useless tests just to increase coverage, make them actually useful for catching issues in the code.
 
 ## Typescript & Testing
 

DocumentTotalManager.ts

@@ -27,7 +27,7 @@ export default class DocumentTotalManager {
 			cls: "food-tracker-total",
 		});
 
-		this.documentTotalElement.textContent = totalText;
+		this.documentTotalElement.innerHTML = totalText;
 
 		// Append at the end of contentEl so it appears at the bottom
 		contentEl.appendChild(this.documentTotalElement);
@@ -61,7 +61,7 @@ export default class DocumentTotalManager {
 		}
 
 		if (this.documentTotalElement) {
-			this.documentTotalElement.textContent = totalText;
+			this.documentTotalElement.innerHTML = totalText;
 		} else {
 			this.show(totalText, view);
 		}

FoodTrackerPlugin.ts

@@ -5,8 +5,10 @@ import NutrientCache from "./NutrientCache";
 import FoodSuggest from "./FoodSuggest";
 import NutritionTotal from "./NutritionTotal";
 import FoodHighlightExtension from "./FoodHighlightExtension";
+import GoalsHighlightExtension from "./GoalsHighlightExtension";
 import DocumentTotalManager from "./DocumentTotalManager";
 import { SettingsService, FoodTrackerPluginSettings, DEFAULT_SETTINGS } from "./SettingsService";
+import GoalsService from "./GoalsService";
 
 export default class FoodTrackerPlugin extends Plugin {
 	settings: FoodTrackerPluginSettings;
@@ -16,7 +18,9 @@ export default class FoodTrackerPlugin extends Plugin {
 	statusBarItem: HTMLElement;
 	documentTotalManager: DocumentTotalManager;
 	settingsService: SettingsService;
+	goalsService: GoalsService;
 	private foodHighlightExtension: FoodHighlightExtension;
+	private goalsHighlightExtension: GoalsHighlightExtension;
 
 	async onload() {
 		await this.loadSettings();
@@ -28,14 +32,18 @@ export default class FoodTrackerPlugin extends Plugin {
 		this.settingsService = new SettingsService();
 		this.settingsService.initialize(this.settings);
 
+		this.goalsService = new GoalsService(this.app, this.settings.goalsFile || "");
+		// Delay goals loading until vault is ready
+		this.app.workspace.onLayoutReady(() => this.goalsService.loadGoals());
+
 		// Register food autocomplete
 		this.foodSuggest = new FoodSuggest(this.app, this.settingsService, this.nutrientCache);
 		this.registerEditorSuggest(this.foodSuggest);
 
 		// Initialize nutrition total
 		this.nutritionTotal = new NutritionTotal(this.nutrientCache);
 		this.statusBarItem = this.addStatusBarItem();
-		this.statusBarItem.setText("");
+		this.statusBarItem.innerHTML = "";
 
 		// Initialize document total manager
 		this.documentTotalManager = new DocumentTotalManager();
@@ -112,6 +120,15 @@ export default class FoodTrackerPlugin extends Plugin {
 			})
 		);
 
+		this.registerEvent(
+			this.app.vault.on("modify", file => {
+				if (file.path === this.settings.goalsFile || file.name === this.settings.goalsFile) {
+					void this.goalsService.loadGoals();
+					void this.updateNutritionTotal();
+				}
+			})
+		);
+
 		// Update nutrition total when active file changes
 		this.registerEvent(
 			this.app.workspace.on("active-leaf-change", () => {
@@ -123,6 +140,10 @@ export default class FoodTrackerPlugin extends Plugin {
 		this.foodHighlightExtension = new FoodHighlightExtension(this.settingsService);
 		this.registerEditorExtension(this.foodHighlightExtension.createExtension());
 
+		// Register CodeMirror extension for goals highlighting
+		this.goalsHighlightExtension = new GoalsHighlightExtension(this.settingsService);
+		this.registerEditorExtension(this.goalsHighlightExtension.createExtension());
+
 		// Initial total update
 		void this.updateNutritionTotal();
 	}
@@ -132,6 +153,9 @@ export default class FoodTrackerPlugin extends Plugin {
 		if (this.foodHighlightExtension) {
 			this.foodHighlightExtension.destroy();
 		}
+		if (this.goalsHighlightExtension) {
+			this.goalsHighlightExtension.destroy();
+		}
 		this.foodSuggest?.suggestionCore?.destroy();
 	}
 
@@ -150,6 +174,13 @@ export default class FoodTrackerPlugin extends Plugin {
 			this.nutritionTotal = new NutritionTotal(this.nutrientCache);
 		}
 
+		if (this.goalsService) {
+			this.goalsService.setGoalsFile(this.settings.goalsFile || "");
+			await this.goalsService.loadGoals();
+		}
+
+		// Goals highlighting extension automatically updates via SettingsService subscription
+
 		// Update settings service
 		if (this.settingsService) {
 			this.settingsService.updateSettings(this.settings);
@@ -175,14 +206,15 @@ export default class FoodTrackerPlugin extends Plugin {
 			const totalText = this.nutritionTotal.calculateTotalNutrients(
 				content,
 				this.settingsService.currentEscapedFoodTag,
-				true
+				true,
+				this.goalsService.currentGoals
 			);
 
 			if (this.settings.totalDisplayMode === "status-bar") {
-				this.statusBarItem?.setText(totalText);
+				if (this.statusBarItem) this.statusBarItem.innerHTML = totalText;
 				this.documentTotalManager.remove();
 			} else {
-				this.statusBarItem?.setText("");
+				if (this.statusBarItem) this.statusBarItem.innerHTML = "";
 				this.documentTotalManager.show(totalText, activeView);
 			}
 		} catch (error) {
@@ -192,7 +224,7 @@ export default class FoodTrackerPlugin extends Plugin {
 	}
 
 	private clearTotal(): void {
-		this.statusBarItem?.setText("");
+		if (this.statusBarItem) this.statusBarItem.innerHTML = "";
 		this.documentTotalManager.remove();
 	}
 }

FoodTrackerSettingTab.ts

@@ -49,5 +49,18 @@ export default class FoodTrackerSettingTab extends PluginSettingTab {
 					await this.plugin.saveSettings();
 				})
 			);
+
+		new Setting(containerEl)
+			.setName("Goals file")
+			.setDesc("File containing daily nutrition goals")
+			.addText(text =>
+				text
+					.setPlaceholder("nutrition-goals.md")
+					.setValue(this.plugin.settings.goalsFile)
+					.onChange(async value => {
+						this.plugin.settings.goalsFile = value;
+						await this.plugin.saveSettings();
+					})
+			);
 	}
 }

GoalsHighlightCore.ts

@@ -0,0 +1,48 @@
+export interface GoalsHighlightRange {
+	start: number;
+	end: number;
+	type: "value";
+}
+
+/**
+ * Extracts highlight ranges from text content for goals files
+ * This is a pure function with no Obsidian dependencies for easy testing
+ */
+export function extractGoalsHighlightRanges(text: string, lineStart: number): GoalsHighlightRange[] {
+	const ranges: GoalsHighlightRange[] = [];
+
+	// Match pattern: "key: value" where value is a number (with optional decimal)
+	const goalsRegex = /^(\w+):\s*(\d+(?:\.\d+)?)/;
+	const match = goalsRegex.exec(text);
+
+	if (match?.index !== undefined) {
+		const valueText = match[2];
+		const valueStart = lineStart + match.index + match[0].indexOf(valueText);
+		const valueEnd = valueStart + valueText.length;
+
+		ranges.push({
+			start: valueStart,
+			end: valueEnd,
+			type: "value",
+		});
+	}
+
+	return ranges;
+}
+
+/**
+ * Processes multiple lines of text and extracts all highlight ranges for goals
+ */
+export function extractMultilineGoalsHighlightRanges(text: string, startOffset: number): GoalsHighlightRange[] {
+	const ranges: GoalsHighlightRange[] = [];
+	const lines = text.split("\n");
+	let lineStart = startOffset;
+
+	for (const line of lines) {
+		const lineRanges = extractGoalsHighlightRanges(line, lineStart);
+		ranges.push(...lineRanges);
+		lineStart += line.length + 1; // +1 for newline
+	}
+
+	return ranges;
+}

GoalsHighlightExtension.ts

@@ -0,0 +1,102 @@
+import { Extension } from "@codemirror/state";
+import { EditorView, ViewPlugin, Decoration, DecorationSet, ViewUpdate } from "@codemirror/view";
+import { RangeSetBuilder } from "@codemirror/state";
+import { extractMultilineGoalsHighlightRanges } from "./GoalsHighlightCore";
+import { SettingsService } from "./SettingsService";
+import { Subscription } from "rxjs";
+
+/**
+ * CodeMirror extension that highlights values in goals files
+ * Provides visual feedback for nutrition goal values
+ */
+export default class GoalsHighlightExtension {
+	private settingsService: SettingsService;
+	private goalsFile: string = "";
+	private subscription: Subscription;
+
+	constructor(settingsService: SettingsService) {
+		this.settingsService = settingsService;
+
+		// Subscribe to goals file changes
+		this.subscription = this.settingsService.goalsFile$.subscribe(goalsFile => {
+			this.goalsFile = goalsFile;
+		});
+	}
+
+	/**
+	 * Clean up subscriptions when the extension is destroyed
+	 */
+	destroy(): void {
+		if (this.subscription) {
+			this.subscription.unsubscribe();
+		}
+	}
+
+	createExtension(): Extension {
+		const goalsValueDecoration = Decoration.mark({
+			class: "goals-value",
+		});
+
+		const getGoalsFile = () => this.goalsFile;
+
+		const goalsHighlightPlugin = ViewPlugin.fromClass(
+			class {
+				decorations: DecorationSet;
+
+				constructor(view: EditorView) {
+					this.decorations = this.buildDecorations(view);
+				}
+
+				update(update: ViewUpdate) {
+					// Always rebuild decorations when document changes or viewport changes
+					// This ensures highlighting updates when switching files
+					if (update.docChanged || update.viewportChanged) {
+						this.decorations = this.buildDecorations(update.view);
+					}
+				}
+
+				/**
+				 * Scans visible text for goals entries and creates decorations for highlighting
+				 * Uses a simple heuristic to detect if we're in a goals file
+				 */
+				buildDecorations(view: EditorView): DecorationSet {
+					const builder = new RangeSetBuilder<Decoration>();
+
+					const goalsFile = getGoalsFile();
+					if (!goalsFile) {
+						return builder.finish();
+					}
+
+					// Get the full document text to check if it looks like a goals file
+					const docText = view.state.doc.toString();
+
+					// Simple heuristic: if the document contains goal-like patterns, highlight it
+					// This is more reliable than trying to get the file path from CodeMirror
+					const goalPatterns = /^(calories|fats|protein|carbs|fiber|sugar|sodium):\s*\d+/m;
+					if (!goalPatterns.test(docText)) {
+						return builder.finish();
+					}
+
+					for (let { from, to } of view.visibleRanges) {
+						const text = view.state.doc.sliceString(from, to);
+
+						// Extract highlight ranges using the pure function
+						const ranges = extractMultilineGoalsHighlightRanges(text, from);
+
+						// Convert ranges to CodeMirror decorations
+						for (const range of ranges) {
+							builder.add(range.start, range.end, goalsValueDecoration);
+						}
+					}
+
+					return builder.finish();
+				}
+			},
+			{
+				decorations: v => v.decorations,
+			}
+		);
+
+		return goalsHighlightPlugin;
+	}
+}

GoalsService.ts

@@ -0,0 +1,73 @@
+import { App, TFile } from "obsidian";
+
+export interface NutrientGoals {
+	calories?: number;
+	fats?: number;
+	protein?: number;
+	carbs?: number;
+	fiber?: number;
+	sugar?: number;
+	sodium?: number;
+}
+
+export default class GoalsService {
+	private app: App;
+	private goalsFile: string;
+	private goals: NutrientGoals = {};
+
+	constructor(app: App, goalsFile: string) {
+		this.app = app;
+		this.goalsFile = goalsFile;
+	}
+
+	setGoalsFile(path: string): void {
+		this.goalsFile = path;
+	}
+
+	get currentGoals(): NutrientGoals {
+		return this.goals;
+	}
+
+	async loadGoals(): Promise<void> {
+		if (!this.goalsFile) {
+			this.goals = {};
+			return;
+		}
+		try {
+			let file = this.app.vault.getAbstractFileByPath(this.goalsFile);
+			if (file instanceof TFile) {
+				const content = await this.app.vault.read(file);
+				this.goals = this.parseGoals(content);
+			} else {
+				this.goals = {};
+			}
+		} catch (error) {
+			console.error("Error loading goals file:", error);
+			this.goals = {};
+		}
+	}
+
+	private parseGoals(content: string): NutrientGoals {
+		const goals: NutrientGoals = {};
+		const lines = content.split(/\r?\n/);
+		for (const line of lines) {
+			const match = line.match(/^(\w+):\s*(\d+(?:\.\d+)?)/);
+			if (match) {
+				const key = match[1].toLowerCase();
+				const value = parseFloat(match[2]);
+				switch (key) {
+					case "calories":
+					case "fats":
+					case "protein":
+					case "carbs":
+					case "fiber":
+					case "sugar":
+					case "sodium":
+						(goals as Record<string, number>)[key] = value;
+						break;
+				}
+			}
+		}
+		return goals;
+	}
+}