Update documentation

imed-ghomari · imed-ghomari · commit 63064f805aa5 · 2022-09-04T13:54:49.000+01:00
diff --git a/docs/docs/changelog.md b/docs/docs/changelog.md
@@ -1,3 +1,10 @@
+# 2.3.4
+*Published on 2022/09/04*
+### Improved
+- If you choose a source different of current folder, now you can select the destination of your new notes [ISSUE#318](https://github.com/RafaelGB/obsidian-db-folder/issues/318)
+### No longer broken
+- Hotfix of add a filter [ISSUE#322](https://github.com/RafaelGB/obsidian-db-folder/issues/322)
+- Hotfix od delete a row in some cases [ISSUE#319](https://github.com/RafaelGB/obsidian-db-folder/issues/319)
 # 2.3.3
 *Published on 2022/09/02*
 ### Shiny new things
diff --git a/manifest-beta.json b/manifest-beta.json
@@ -1,7 +1,7 @@
 {
 	"id": "dbfolder",
 	"name": "DB Folder",
-	"version": "2.3.3",
+	"version": "2.3.4",
 	"minAppVersion": "0.15.9",
 	"description": "Folder with the capability to store and retrieve data from a folder like database",
 	"author": "RafaelGB",
diff --git a/manifest.json b/manifest.json
@@ -1,7 +1,7 @@
 {
 	"id": "dbfolder",
 	"name": "DB Folder",
-	"version": "2.3.3",
+	"version": "2.3.4",
 	"minAppVersion": "0.15.9",
 	"description": "Folder with the capability to store and retrieve data from a folder like database",
 	"author": "RafaelGB",
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "obsidian-dbfolder",
-	"version": "2.3.3",
+	"version": "2.3.4",
 	"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
 	"main": "main.js",
 	"scripts": {
diff --git a/src/DatabaseView.tsx b/src/DatabaseView.tsx
@@ -192,6 +192,7 @@ export class DatabaseView extends TextFileView implements HoverParent {
   destroy() {
     LOGGER.info(`=>destroy ${this.file.path}`);
     // Remove draggables from render, as the DOM has already detached
+    this.getStateManager().unregisterView(this);
     this.plugin.removeView(this);
     this.tableContainer.remove();
     LOGGER.info(`<=destroy ${this.file.path}`);
diff --git a/src/StateManager.ts b/src/StateManager.ts
@@ -19,10 +19,10 @@ export default class StateManager {
   }
 
   registerView(view: DatabaseView) {
-    this.viewSet.clear();
-    this.viewSet.add(view);
-    view.initDatabase();
-
+    if (!this.viewSet.has(view)) {
+      this.viewSet.add(view);
+      view.initDatabase();
+    }
   }
 
   unregisterView(view: DatabaseView) {
diff --git a/src/cdm/SettingsModel.ts b/src/cdm/SettingsModel.ts
@@ -31,6 +31,7 @@ export interface LocalSettings {
     show_metadata_modified: boolean;
     show_metadata_tasks: boolean;
     source_form_result: string;
+    source_destination_path: string;
     source_data: string;
     sticky_first_column: boolean;
     row_templates_folder: string;
diff --git a/src/cdm/TableStateInterface.ts b/src/cdm/TableStateInterface.ts
@@ -24,7 +24,7 @@ export interface ConfigState {
     filters: FilterSettings;
     global: GlobalSettings;
     actions: {
-        alterFilters: (filters: Partial<FilterSettings>) => void;
+        alterFilters: (filters: Partial<FilterSettings>) => Promise<void>;
         alterConfig: (config: Partial<LocalSettings>) => void;
     }
     info: {
diff --git a/src/components/portals/DataviewFiltersPortal.tsx b/src/components/portals/DataviewFiltersPortal.tsx
@@ -22,10 +22,11 @@ import MenuUpIcon from "components/img/MenuUpIcon";
 const DataviewFiltersPortal = (props: DataviewFiltersProps) => {
   const { table } = props;
   const { tableState, view } = table.options.meta;
-  const [ddbbConfig, filters, configActions] = tableState.configState(
-    (state) => [state.ddbbConfig, state.filters, state.actions]
-  );
-
+  const [ddbbConfig, configActions] = tableState.configState((state) => [
+    state.ddbbConfig,
+    state.actions,
+  ]);
+  const filters = tableState.configState((state) => state.filters);
   const columns = tableState.columns((state) => state.columns);
   const dataActions = tableState.data((state) => state.actions);
   const [filtersRef, setFiltersRef] = useState(null);
diff --git a/src/helpers/Constants.ts b/src/helpers/Constants.ts
@@ -312,6 +312,7 @@ export const DEFAULT_SETTINGS: DatabaseSettings = {
     show_metadata_tasks: false,
     source_data: SourceDataTypes.CURRENT_FOLDER,
     source_form_result: 'root',
+    source_destination_path: '/',
     frontmatter_quote_wrap: false,
     row_templates_folder: '/',
     current_row_template: '',
diff --git a/src/main.ts b/src/main.ts
@@ -93,6 +93,7 @@ export default class DBFolderPlugin extends Plugin {
 
 		this.registerView(DatabaseCore.FRONTMATTER_KEY, (leaf) => new DatabaseView(leaf, this));
 		this.registerEvents();
+		this.registerCommands();
 		this.registerMonkeyPatches();
 		this.addMarkdownPostProcessor();
 		// Mount an empty component to start; views will be added as we go
@@ -417,7 +418,9 @@ export default class DBFolderPlugin extends Plugin {
 			})
 		);
 	}
-
+	registerCommands() {
+		// TODO - add command to create a new database
+	}
 	/**
 	   * Displays a transcluded .excalidraw image in markdown preview mode
 	   */
diff --git a/src/settings/handlers/source/SourceFormHandler.ts b/src/settings/handlers/source/SourceFormHandler.ts
@@ -6,7 +6,8 @@ import { Notice, Setting } from "obsidian";
 import { DataviewService } from "services/DataviewService";
 import { AbstractSettingsHandler, SettingHandlerResponse } from "settings/handlers/AbstractSettingHandler";
 import { add_dropdown } from "settings/SettingsComponents";
-import { FileSuggest } from "settings/suggesters/FileSuggester";
+import { filePathsRecordSuggester, FileSuggest } from "settings/suggesters/FileSuggester";
+import { FolderSuggest } from "settings/suggesters/FolderSuggester";
 
 export class SourceFormHandler extends AbstractSettingsHandler {
     settingTitle: string = 'Form in function of source data';
@@ -18,24 +19,7 @@ export class SourceFormHandler extends AbstractSettingsHandler {
                 break;
             case SourceDataTypes.OUTGOING_LINK:
             case SourceDataTypes.INCOMING_LINK:
-                const filePaths: Record<string, string> = {}
-                app.vault.getMarkdownFiles().forEach(file => { filePaths[file.path] = file.basename });
-                const source_form_promise = async (value: string): Promise<void> => {
-                    // update settings
-                    view.diskConfig.updateConfig({ source_form_result: value });
-                };
-                new Setting(containerEl)
-                    .setName('Select a file')
-                    .setDesc('Select file from vault to be used as source of data.')
-                    .addSearch((cb) => {
-                        new FileSuggest(
-                            cb.inputEl,
-                            view.file.parent.path
-                        );
-                        cb.setPlaceholder("Example: folder1/template_file")
-                            .setValue(view.diskConfig.yaml.config.source_form_result)
-                            .onChange(source_form_promise);
-                    });
+                outgoingAndIncomingHandler(view, containerEl);
                 break;
             case SourceDataTypes.QUERY:
                 queryHandler(view, containerEl, columns);
@@ -70,9 +54,30 @@ function tagHandler(view: DatabaseView, containerEl: HTMLElement) {
             tagRecords,
             source_form_promise
         );
+        destinationFolderHandler(view, containerEl);
     }
 }
 
+function outgoingAndIncomingHandler(view: DatabaseView, containerEl: HTMLElement) {
+    const source_form_promise = async (value: string): Promise<void> => {
+        // update settings
+        view.diskConfig.updateConfig({ source_form_result: value });
+    };
+    new Setting(containerEl)
+        .setName('Select a file')
+        .setDesc('Select file from vault to be used as source of data.')
+        .addSearch((cb) => {
+            new FileSuggest(
+                cb.inputEl,
+                view.file.parent.path
+            );
+            cb.setPlaceholder("Example: folder1/template_file")
+                .setValue(view.diskConfig.yaml.config.source_form_result)
+                .onChange(source_form_promise);
+        });
+    destinationFolderHandler(view, containerEl);
+}
+
 function queryHandler(view: DatabaseView, containerEl: HTMLElement, columns: TableColumn[]) {
     const query_promise = async (value: string): Promise<void> => {
         // update settings
@@ -104,4 +109,23 @@ function queryHandler(view: DatabaseView, containerEl: HTMLElement, columns: Tab
                     }
                 });
         });
+    destinationFolderHandler(view, containerEl);
+}
+
+function destinationFolderHandler(view: DatabaseView, containerEl: HTMLElement) {
+    const source_form_promise = async (value: string): Promise<void> => {
+        // update settings
+        view.diskConfig.updateConfig({ source_destination_path: value });
+    };
+    new Setting(containerEl)
+        .setName('Select destination folder')
+        .setDesc('Select the destination of new entries for this source')
+        .addSearch((cb) => {
+            new FolderSuggest(
+                cb.inputEl
+            );
+            cb.setPlaceholder("Example: path/to/folder")
+                .setValue(view.diskConfig.yaml.config.source_destination_path)
+                .onChange(source_form_promise);
+        });
 }
diff --git a/src/settings/suggesters/FileSuggester.ts b/src/settings/suggesters/FileSuggester.ts
@@ -52,4 +52,10 @@ export class FileSuggest extends TextInputSuggest<TFile> {
         this.inputEl.trigger("input");
         this.close();
     }
+}
+
+export function filePathsRecordSuggester(): Record<string, string> {
+    const filePaths: Record<string, string> = {}
+    app.vault.getMarkdownFiles().forEach(file => { filePaths[file.path] = file.basename });
+    return filePaths;
 }
diff --git a/src/stateManagement/data/handlers/AddRowHandlerAction.ts b/src/stateManagement/data/handlers/AddRowHandlerAction.ts
@@ -2,7 +2,9 @@ import { RowDatabaseFields } from "cdm/DatabaseModel";
 import { RowDataType, TableColumn } from "cdm/FolderModel";
 import { LocalSettings } from "cdm/SettingsModel";
 import { DataState, TableActionResponse } from "cdm/TableStateInterface";
-import { MetadataColumns } from "helpers/Constants";
+import { DatabaseView } from "DatabaseView";
+import { MetadataColumns, SourceDataTypes } from "helpers/Constants";
+import { resolve_tfolder } from "helpers/FileManagement";
 import { DateTime } from "luxon";
 import { Literal } from "obsidian-dataview";
 import { VaultManagerDB } from "services/FileManagerService";
@@ -13,13 +15,14 @@ export default class AddRowlHandlerAction extends AbstractTableAction<DataState>
     handle(tableActionResponse: TableActionResponse<DataState>): TableActionResponse<DataState> {
         const { view, set, implementation } = tableActionResponse;
         implementation.actions.addRow = (filename: string, columns: TableColumn[], ddbbConfig: LocalSettings) => set((state) => {
+            const destination_folder = this.destination_folder(view, ddbbConfig);
             let trimedFilename = filename.replace(/\.[^/.]+$/, "").trim();
-            let filepath = `${view.file.parent.path}/${trimedFilename}.md`;
+            let filepath = `${destination_folder}/${trimedFilename}.md`;
             // Validate possible duplicates
             let sufixOfDuplicate = 0;
             while (state.rows.find((row) => row.__note__.filepath === filepath)) {
                 sufixOfDuplicate++;
-                filepath = `${view.file.parent.path}/${trimedFilename}-${sufixOfDuplicate}.md`;
+                filepath = `${destination_folder}/${trimedFilename}-${sufixOfDuplicate}.md`;
             }
             if (sufixOfDuplicate > 0) {
                 trimedFilename = `${trimedFilename}-${sufixOfDuplicate}`;
@@ -37,7 +40,7 @@ export default class AddRowlHandlerAction extends AbstractTableAction<DataState>
                 });
             // Add note to persist row
             VaultManagerDB.create_markdown_file(
-                view.file.parent,
+                resolve_tfolder(destination_folder),
                 trimedFilename,
                 rowRecord,
                 ddbbConfig
@@ -62,4 +65,17 @@ export default class AddRowlHandlerAction extends AbstractTableAction<DataState>
         tableActionResponse.implementation = implementation;
         return this.goNext(tableActionResponse);
     }
+    destination_folder(view: DatabaseView, ddbbConfig: LocalSettings): string {
+        let destination_folder = view.file.parent.path;
+        switch (ddbbConfig.source_data) {
+            case SourceDataTypes.TAG:
+            case SourceDataTypes.OUTGOING_LINK:
+            case SourceDataTypes.INCOMING_LINK:
+                destination_folder = ddbbConfig.source_destination_path;
+                break;
+            default:
+            //Current folder
+        }
+        return destination_folder;
+    }
 }
diff --git a/src/stateManagement/useConfigStore.ts b/src/stateManagement/useConfigStore.ts
@@ -12,11 +12,12 @@ const useConfigStore = (view: DatabaseView) => {
             filters: filters,
             global: global_settings,
             actions: {
-                alterFilters: (partialFilters: Partial<FilterSettings>) =>
+                alterFilters: async (partialFilters: Partial<FilterSettings>) => {
+                    await view.diskConfig.updateFilters(partialFilters);
                     set((state) => {
-                        view.diskConfig.updateFilters(partialFilters);
                         return ({ filters: { ...state.filters, ...partialFilters } });
-                    }),
+                    })
+                },
                 alterConfig: (alteredConfig: Partial<LocalSettings>) =>
                     set((state) => {
                         view.diskConfig.updateConfig(alteredConfig);

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"id": "dbfolder",`
`3`	`3`	`"name": "DB Folder",`
`4`		`- "version": "2.3.3",`
	`4`	`+ "version": "2.3.4",`
`5`	`5`	`"minAppVersion": "0.15.9",`
`6`	`6`	`"description": "Folder with the capability to store and retrieve data from a folder like database",`
`7`	`7`	`"author": "RafaelGB",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "obsidian-dbfolder",`
`3`		`- "version": "2.3.3",`
	`3`	`+ "version": "2.3.4",`
`4`	`4`	`"description": "This is a sample plugin for Obsidian (https://obsidian.md)",`
`5`	`5`	`"main": "main.js",`
`6`	`6`	`"scripts": {`
Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,10 @@ export default class StateManager {`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`registerView(view: DatabaseView) {`
`22`		`- this.viewSet.clear();`
`23`		`- this.viewSet.add(view);`
`24`		`- view.initDatabase();`
`25`		`-`
	`22`	`+ if (!this.viewSet.has(view)) {`
	`23`	`+ this.viewSet.add(view);`
	`24`	`+ view.initDatabase();`
	`25`	`+ }`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`unregisterView(view: DatabaseView) {`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ export interface ConfigState {`
`24`	`24`	`filters: FilterSettings;`
`25`	`25`	`global: GlobalSettings;`
`26`	`26`	`actions: {`
`27`		`- alterFilters: (filters: Partial<FilterSettings>) => void;`
	`27`	`+ alterFilters: (filters: Partial<FilterSettings>) => Promise<void>;`
`28`	`28`	`alterConfig: (config: Partial<LocalSettings>) => void;`
`29`	`29`	`}`
`30`	`30`	`info: {`