(MINOR) Merge pull request #27 from jamiefdhurst/feature/existing-folders

Choose folder to watch

Author: jamiefdhurst

src/__mocks__/obsidian.ts

@@ -51,9 +51,11 @@ export class DropdownComponent extends BaseComponent {
 export class ToggleComponent extends BaseComponent {}
 export class Setting {
   public containerEl: HTMLElement;
+  public controlEl: HTMLElement;
 
   constructor(el: HTMLElement) {
     this.containerEl = el;
+    this.controlEl = el.createDiv({ cls: 'setting-item-control' });
     return this;
   }
 

src/__tests__/inbox.test.ts

@@ -68,7 +68,29 @@ describe('Inbox', () => {
     expect(result.length).toEqual(2);
     expect(result[0].path).toEqual('bar');
     expect(result[1].path).toEqual('foo');
+  });
+
+  it('gets all folders with root included', () => {
+    const folders = [
+      new TFolder(),
+      new TFolder(),
+      new TFolder(),
+    ];
 
+    folders[0].name = '';
+    folders[0].path = '/';
+    folders[1].name = INBOX_FOLDER;
+    folders[1].path = INBOX_FOLDER;
+    folders[2].name = 'foo';
+    folders[2].path = 'foo';
+
+    jest.spyOn(vault, 'getAllFolders').mockReturnValue(folders);
+
+    const result = sut.getFolders(true);
+
+    expect(result.length).toEqual(2);
+    expect(result[0].path).toEqual('/');
+    expect(result[1].path).toEqual('foo');
   });
 
   it('moves a file', async () => {

src/__tests__/settings/tab.test.ts

@@ -1,21 +1,25 @@
-import { App, Setting } from 'obsidian';
+import { App, Setting, TFolder } from 'obsidian';
 import InboxOrganiser from '../..';
+import { Inbox } from '../../inbox';
 import { DEFAULT_SETTINGS } from '../../settings';
 import { InboxOrganiserTab } from '../../settings/tab';
 
 describe('Settings Tab', () => {
 
   let app: App;
   let plugin: InboxOrganiser;
+  let inbox: Inbox;
 
   let sut: InboxOrganiserTab;
 
   beforeEach(() => {
     app = jest.fn() as unknown as App;
     plugin = jest.fn() as unknown as InboxOrganiser;
     plugin.getSettings = jest.fn();
+    inbox = jest.fn() as unknown as Inbox;
+    inbox.getFolders = jest.fn();
 
-    sut = new InboxOrganiserTab(app, plugin);
+    sut = new InboxOrganiserTab(app, plugin, inbox);
     sut.containerEl = createDiv();
   });
 
@@ -26,11 +30,16 @@ describe('Settings Tab', () => {
 
   it('displays correctly', () => {
     jest.spyOn(plugin, 'getSettings').mockReturnValue(Object.assign({}, DEFAULT_SETTINGS));
+    const folders = [new TFolder(), new TFolder()];
+    folders[0].path = '/';
+    folders[1].path = 'abc';
+    const inboxGetFolders = jest.spyOn(inbox, 'getFolders').mockReturnValue(folders);
     const settingsSetName = jest.spyOn(Setting.prototype, 'setName');
 
     sut.display();
 
-    expect(settingsSetName).toHaveBeenCalledTimes(2);
+    expect(settingsSetName).toHaveBeenCalledTimes(3);
+    expect(inboxGetFolders).toHaveBeenCalledWith(true);
   });
 
 });

src/__tests__/watcher.test.ts

@@ -20,7 +20,7 @@ describe('Watcher', () => {
   });
 
   it('should not trigger filemanager when inbox is disabled', () => {
-    const settings: ISettings = { inbox: false, period: 'disabled' };
+    const settings: ISettings = { inbox: false, period: 'disabled', watchFolder: '/' };
     jest.spyOn(plugin, 'getSettings').mockReturnValue(settings);
     const fileManagerRenameFile = jest.spyOn(fileManager, 'renameFile');
 
@@ -30,7 +30,7 @@ describe('Watcher', () => {
   });
 
   it('should trigger filemanager when inbox is enabled', () => {
-    const settings: ISettings = { inbox: true, period: 'disabled' };
+    const settings: ISettings = { inbox: true, period: 'disabled', watchFolder: '/' };
     jest.spyOn(plugin, 'getSettings').mockReturnValue(settings);
     const fileManagerRenameFile = jest.spyOn(fileManager, 'renameFile');
 

src/inbox.ts

@@ -21,8 +21,8 @@ export class Inbox {
       .sort((a, b) => a.name.localeCompare(b.name))
   }
 
-  getFolders(): TFolder[] {
-    const folders = this.vault.getAllFolders(false);
+  getFolders(includeRoot: boolean = false): TFolder[] {
+    const folders = this.vault.getAllFolders(includeRoot);
 
     return folders
       .filter(folder => folder.path !== INBOX_FOLDER)
@@ -32,4 +32,4 @@ export class Inbox {
   async move(file: TFile, path: string): Promise<void> {
     return this.fileManager.renameFile(file, `${path}/${file.name}`);
   }
- }
+}

src/index.ts

@@ -1,6 +1,7 @@
 import { Plugin, TFile, type App, type PluginManifest } from 'obsidian';
 import { SETTINGS_UPDATED } from './events';
 import { Inbox } from './inbox';
+import debug from './log';
 import { OrganiserModal } from './modal';
 import { OrganiserNotice } from './notice';
 import { DEFAULT_SETTINGS, ISettings } from './settings';
@@ -32,8 +33,18 @@ export default class InboxOrganiser extends Plugin {
 
   onLayoutReady(): void {
     this.registerEvent(this.app.vault.on('create', (file) => {
-      if (file instanceof TFile && file.path.indexOf('/') === -1) {
-        this.watcher.notify(file);
+      if (file instanceof TFile) {
+        // Root needs a special case as it will not match the start of the file path
+        if (this.settings.watchFolder === '/' && file.path.indexOf('/') === -1) {
+          this.watcher.notify(file);
+        }
+        // Ensure sub-folders are ignored correctly
+        if (
+          file.path.indexOf(this.settings.watchFolder + '/') === 0
+          && file.path.split('/').length === this.settings.watchFolder.split('/').length + 1
+        ) {
+          this.watcher.notify(file);
+        }
       }
     }));
 
@@ -42,7 +53,7 @@ export default class InboxOrganiser extends Plugin {
     }, 300000));
     (new OrganiserNotice(this, this.modal, this.inbox)).display();
 
-    this.addSettingTab(new InboxOrganiserTab(this.app, this));
+    this.addSettingTab(new InboxOrganiserTab(this.app, this, this.inbox));
 
     this.addCommand({
 			id: 'inbox-organiser',
@@ -63,17 +74,20 @@ export default class InboxOrganiser extends Plugin {
       DEFAULT_SETTINGS,
       await this.loadData()
     );
+    debug('Loaded settings: ' + JSON.stringify(this.settings));
   }
 
   async updateSettings(settings: ISettings): Promise<void> {
     this.settings = settings;
     await this.saveData(settings);
     this.onSettingsUpdate();
+    debug('Saved settings: ' + JSON.stringify(this.settings));
   }
 
   private onSettingsUpdate(): void {
     const inboxFolder = this.app.vault.getFolderByPath(INBOX_FOLDER);
     if (this.settings.inbox && !inboxFolder) {
+      debug('Creating missing inbox folder');
       this.app.vault.createFolder(INBOX_FOLDER);
     }
 

src/log.ts

@@ -0,0 +1,3 @@
+export default function debug(msg: string): void {
+  console.debug(`[JH-IO] ${msg}`);
+}

src/settings/index.ts

@@ -1,3 +1,5 @@
+import { TFolder } from 'obsidian';
+
 export type Period =
   | 'disabled'
   | 'daily_9am'
@@ -12,9 +14,11 @@ export type Period =
 export interface ISettings {
   inbox: boolean;
   period: Period;
+  watchFolder: string;
 }
 
 export const DEFAULT_SETTINGS: ISettings = Object.freeze({
   inbox: false,
   period: 'disabled',
+  watchFolder: '/',
 });

src/settings/tab.ts

@@ -1,13 +1,17 @@
 import { type App, PluginSettingTab, Setting } from 'obsidian';
 import { ISettings, type Period } from '.';
 import InboxOrganiser from '..';
+import { Inbox } from '../inbox';
+import { FolderSuggest } from '../modal/folder-suggest';
 
 export class InboxOrganiserTab extends PluginSettingTab {
   private plugin: InboxOrganiser;
+  private inbox: Inbox;
 
-  constructor(app: App, plugin: InboxOrganiser) {
+  constructor(app: App, plugin: InboxOrganiser, inbox: Inbox) {
     super(app, plugin);
     this.plugin = plugin;
+    this.inbox = inbox;
   }
 
   display(): void {
@@ -37,6 +41,19 @@ export class InboxOrganiserTab extends PluginSettingTab {
             await this.plugin.updateSettings(settings);
           });
       });
+    
+    const watchFolder = new Setting(this.containerEl);
+    watchFolder.setName('Watched folder')
+      .setDesc('Which folder should be monitored for new notes to intercept and add into the inbox (default root).');
+    const watchFolderEl = watchFolder.controlEl.createEl('input', { type: 'text' });
+    watchFolderEl.setAttr('value', settings.watchFolder);
+    new FolderSuggest(this.app, this.inbox.getFolders(true), watchFolderEl);
+    watchFolderEl.addEventListener('change', (event: MouseEvent) => {
+      const el = event.target as HTMLSelectElement;
+      settings.watchFolder = el.value;
+      this.plugin.updateSettings(settings);
+    });
+
     new Setting(this.containerEl)
       .setName('Reminder period')
       .setDesc('How often to send a reminder to organise your inbox.')
@@ -47,7 +64,7 @@ export class InboxOrganiserTab extends PluginSettingTab {
           .onChange(async (val) => {
             settings.period = val as Period;
             await this.plugin.updateSettings(settings);
-          })
-      })
+          });
+      });
   }
 }

src/watcher.ts

@@ -1,5 +1,6 @@
 import { FileManager, TFile } from 'obsidian';
 import InboxOrganiser, { INBOX_FOLDER } from '.';
+import debug from './log';
 
 export class Watcher {
   private plugin: InboxOrganiser;
@@ -14,6 +15,7 @@ export class Watcher {
     const settings = this.plugin.getSettings();
 
     if (settings.inbox) {
+      debug('Moving newly created file to inbox');
       this.fileManager.renameFile(file, `${INBOX_FOLDER}/${file.name}`);
     }
   }