Merge branch 'issue126'

RafaelGB · RafaelGB · commit f289836031f5 · 2022-09-05T15:26:51.000+02:00
diff --git a/src/DatabaseView.tsx b/src/DatabaseView.tsx
@@ -32,7 +32,6 @@ import DatabaseInfo from "services/DatabaseInfo";
 import { LOGGER } from "services/Logger";
 import { SettingsModal } from "Settings";
 import StateManager from "StateManager";
-export const databaseIcon = "blocks";
 
 export class DatabaseView extends TextFileView implements HoverParent {
   plugin: DBFolderPlugin;
diff --git a/src/commands/addDatabaseHelper/databaseHelperCreationModal.ts b/src/commands/addDatabaseHelper/databaseHelperCreationModal.ts
@@ -1,9 +1,20 @@
-import { Modal } from "obsidian";
+import { LocalSettings } from "cdm/SettingsModel";
+import { generateDbConfiguration, generateNewDatabase } from "helpers/CommandsHelper";
+import { InputType, SourceDataTypes, StyleClasses } from "helpers/Constants";
+import { resolve_tfolder } from "helpers/FileManagement";
+import { generateDataviewTableQuery } from "helpers/QueryHelper";
+import { Modal, Notice, Setting, TFolder } from "obsidian";
+import { DataviewService } from "services/DataviewService";
+import { add_dropdown, add_setting_header } from "settings/SettingsComponents";
+import { FileSuggest } from "settings/suggesters/FileSuggester";
+import { FolderSuggest } from "settings/suggesters/FolderSuggester";
 
 export class DatabaseHelperCreationModal extends Modal {
     databaseHelperCreationModalManager: DatabaseHelperCreationModalManager;
-    constructor() {
+    local_settings: LocalSettings;
+    constructor(local_settings: LocalSettings) {
         super(app);
+        this.local_settings = local_settings;
         this.databaseHelperCreationModalManager = new DatabaseHelperCreationModalManager(this);
     }
     onOpen() {
@@ -20,11 +31,222 @@ export class DatabaseHelperCreationModal extends Modal {
 
 export class DatabaseHelperCreationModalManager {
     databaseHelperCreationModal: DatabaseHelperCreationModal;
+    destinationFolder = '/';
+    databaseName = '';
     constructor(
         databaseHelperCreationModal: DatabaseHelperCreationModal,
     ) {
         this.databaseHelperCreationModal = databaseHelperCreationModal;
+
+
     }
     constructUI(containerEl: HTMLElement) {
+        add_setting_header(containerEl, "Database creator helper", 'h2');
+        const helperBody = containerEl.createDiv();
+        helperBody.addClass(StyleClasses.SETTINGS_MODAL_BODY);
+        helperBody.setAttribute("id", StyleClasses.SETTINGS_MODAL_BODY);
+        this.constructSettingBody(helperBody);
     }
-}
+
+    constructSettingBody(bodyElement: HTMLElement) {
+        new Setting(bodyElement)
+            .setName("Database name")
+            .setDesc("Name of the database to create")
+            .addText(text => {
+                text.setPlaceholder("Database name")
+                    .setValue(this.databaseName)
+                    .onChange(async (value: string): Promise<void> => {
+                        this.databaseName = this.parseValueToThuthyYaml(value);
+                    });
+            });
+
+        add_dropdown(
+            bodyElement,
+            'Select source',
+            'Select from which source you want to create your custom database.',
+            this.databaseHelperCreationModal.local_settings.source_data,
+            {
+                current_folder: SourceDataTypes.CURRENT_FOLDER,
+                tag: SourceDataTypes.TAG,
+                outgoing_link: SourceDataTypes.OUTGOING_LINK,
+                incoming_link: SourceDataTypes.INCOMING_LINK,
+                query: SourceDataTypes.QUERY,
+            },
+            async (value: string) => {
+                this.databaseHelperCreationModal.local_settings.source_data = value;
+                this.reset();
+            }
+        );
+        switch (this.databaseHelperCreationModal.local_settings.source_data) {
+            case SourceDataTypes.TAG:
+                this.tagHandler(bodyElement);
+                break;
+            case SourceDataTypes.INCOMING_LINK:
+            case SourceDataTypes.OUTGOING_LINK:
+                this.outgoingAndIncomingHandler(bodyElement);
+                break;
+            case SourceDataTypes.QUERY:
+                this.queryHandler(bodyElement);
+                break;
+            default:
+            // do nothing
+        }
+
+        new Setting(bodyElement)
+            .setName('Select where to save your database')
+            .setDesc('Select the destination of where you want to save your database.')
+            .addSearch((cb) => {
+                new FolderSuggest(
+                    cb.inputEl
+                );
+                cb.setPlaceholder("Example: path/to/folder")
+                    .setValue(this.destinationFolder)
+                    .onChange((value: string) => {
+                        this.destinationFolder = value;
+                    });
+            });
+
+        new Setting(bodyElement)
+            .setName('Submit')
+            .setDesc('Close to cancel or submit to create your database.')
+            .addButton((cb) => {
+                cb.setButtonText('Close')
+                    .onClick(() => {
+                        this.databaseHelperCreationModal.close();
+                    });
+            }).addButton((cb) => {
+                cb.setButtonText('Create')
+                    .onClick(async () => {
+                        await this.createButtonHandler()
+                    });
+            });
+    }
+
+    reset() {
+        const bodyElement = activeDocument.getElementById(StyleClasses.SETTINGS_MODAL_BODY);
+        // remove all sections
+        bodyElement.empty();
+        this.constructSettingBody(bodyElement);
+    }
+
+    async createButtonHandler() {
+        try {
+            const targetFolder = resolve_tfolder(this.destinationFolder);
+            await generateNewDatabase(
+                generateDbConfiguration(this.databaseHelperCreationModal.local_settings),
+                targetFolder,
+                this.databaseName
+            );
+            new Notice(`Database "${this.databaseName}" created in "${targetFolder.path}"`, 1500);
+        } catch (e) {
+            new Notice(`Error creating database "${this.databaseName}": ${e}`, 1500);
+        }
+        this.databaseHelperCreationModal.close();
+    }
+
+    tagHandler(containerEl: HTMLElement) {
+        const tagArray: Record<string, number> = (app.metadataCache as unknown as any).getTags();
+        if (tagArray) {
+            const tagRecords: Record<string, string> = {};
+            // Order tagRecord by key (tag name)
+            Object.entries(tagArray)
+                .sort((a, b) => a[0].localeCompare(b[0]))
+                .forEach(([key, value]) => {
+                    tagRecords[key] = `${key}(${value})`;
+                });
+            const source_form_promise = async (value: string): Promise<void> => {
+                // update form result
+                this.databaseHelperCreationModal.local_settings.source_form_result = value.slice(1);
+            };
+
+            add_dropdown(
+                containerEl,
+                'Select a tag',
+                'Select tag to get data from',
+                `#${this.databaseHelperCreationModal.local_settings.source_form_result}`,
+                tagRecords,
+                source_form_promise
+            );
+            this.destinationFolderHandler(containerEl);
+        }
+    }
+
+    queryHandler(containerEl: HTMLElement) {
+        const query_promise = async (value: string): Promise<void> => {
+            // update settings
+            this.databaseHelperCreationModal.local_settings.source_form_result = this.parseValueToThuthyYaml(value);
+        };
+        new Setting(containerEl)
+            .setName('Dataview query')
+            .setDesc('Enter a dataview query starting with FROM (the plugin autocomplete the query with TABLE & the column fields)')
+            .addTextArea((textArea) => {
+                textArea.setValue(this.databaseHelperCreationModal.local_settings.source_form_result);
+                textArea.setPlaceholder('Write here your dataview query...');
+                textArea.onChange(query_promise);
+            }).addExtraButton((cb) => {
+                cb.setIcon("check")
+                    .setTooltip("Validate query")
+                    .onClick(async (): Promise<void> => {
+                        const query = generateDataviewTableQuery(
+                            [],
+                            this.databaseHelperCreationModal.local_settings.source_form_result);
+                        if (query) {
+                            DataviewService.getDataviewAPI().tryQuery(query)
+                                .then(() => {
+                                    new Notice(`Dataview query "${query}" is valid!`, 2000);
+                                })
+                                .catch((e) => {
+                                    new Notice(`Dataview query "${query}" is invalid: ${e.message}`, 10000);
+                                });
+                        }
+                    });
+            });
+        this.destinationFolderHandler(containerEl);
+    }
+
+    outgoingAndIncomingHandler(containerEl: HTMLElement) {
+        const source_form_promise = async (value: string): Promise<void> => {
+            // update form result
+            this.databaseHelperCreationModal.local_settings.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,
+                    "/"
+                );
+                cb.setPlaceholder("Example: folder1/template_file")
+                    .setValue(this.databaseHelperCreationModal.local_settings.source_form_result)
+                    .onChange(source_form_promise);
+            });
+        this.destinationFolderHandler(containerEl);
+    }
+
+    destinationFolderHandler(containerEl: HTMLElement) {
+        const source_form_promise = async (value: string): Promise<void> => {
+            // update settings
+            this.databaseHelperCreationModal.local_settings.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(this.databaseHelperCreationModal.local_settings.source_destination_path)
+                    .onChange(source_form_promise);
+            });
+    }
+
+    parseValueToThuthyYaml(value: string): string {
+        return DataviewService.parseLiteral(
+            value,
+            InputType.MARKDOWN,
+            this.databaseHelperCreationModal.local_settings
+        ).toString();
+    }
+}
diff --git a/src/helpers/CommandsHelper.ts b/src/helpers/CommandsHelper.ts
@@ -0,0 +1,46 @@
+import { LocalSettings } from "cdm/SettingsModel";
+import { Notice, TFile, TFolder } from "obsidian";
+import { LOGGER } from "services/Logger";
+import { DatabaseCore, DatabaseFrontmatterOptions, DEFAULT_SETTINGS, YAML_INDENT } from "helpers/Constants";
+
+export async function generateNewDatabase(ddbbConfig: string, folder?: TFolder, ddbbName?: string) {
+    const targetFolder = folder
+        ?? app.fileManager.getNewFileParent(
+            app.workspace.getActiveFile()?.path || ''
+        );
+
+    try {
+        const database: TFile = await (
+            app.fileManager as any
+        ).createNewMarkdownFile(targetFolder, ddbbName ?? 'Untitled database');
+
+        await app.vault.modify(
+            database,
+            DatabaseFrontmatterOptions.BASIC
+                .concat('\n')
+                .concat(ddbbConfig)
+                .concat('\n')
+                .concat('%%>')
+        );
+        await app.workspace.getMostRecentLeaf().setViewState({
+            type: DatabaseCore.FRONTMATTER_KEY,
+            state: { file: database.path },
+        });
+    } catch (e) {
+        LOGGER.error('Error creating database folder:', e);
+        new Notice(`Error creating database folder: ${e}`, 5000);
+    }
+}
+
+/**
+ * Returns the default configuration for a database file.
+ */
+export function generateDbConfiguration(customLocalSettings: LocalSettings): string {
+    const defaultConfig = [];
+    defaultConfig.push("config:");
+    Object.entries(DEFAULT_SETTINGS.local_settings).forEach(([key, value]) => {
+        const defaultValue = customLocalSettings[key as keyof LocalSettings] !== undefined ? customLocalSettings[key as keyof LocalSettings] : value;
+        defaultConfig.push(`${YAML_INDENT}${key}: ${defaultValue}`);
+    });
+    return defaultConfig.join('\n');
+}
diff --git a/src/helpers/Constants.ts b/src/helpers/Constants.ts
@@ -274,7 +274,7 @@ export function getOperatorFilterValue(keyToFind: string): string {
 
 export const MarkdownBreakerRules = Object.freeze({
   INIT_CHARS: ['`', '"', '[', '{', '*', '!'],
-  BETWEEN_CHARS: [':'],
+  BETWEEN_CHARS: [':', '"'],
   UNIQUE_CHARS: ['?'],
 })
 
@@ -331,5 +331,12 @@ export const SUGGESTER_REGEX = Object.freeze({
 
   LINK_BLOCK: /\B\[\[([^#\]]+)#?\^([^\]]*)$/,
   EMBED_BLOCK: /\B!\[\[([^#\]]+)#?\^([^\]]*)$/
+});
 
+/******************************************************************************
+ *                          ICONS CONSTANTS
+ ******************************************************************************/
+export const DB_ICONS = Object.freeze({
+  NAME: 'database-folder-icon',
+  ICON: `<g transform="matrix(0.06 0 0 0.05 52 52)"><path stroke="currentColor" fill="#fff" vector-effect="non-scaling-stroke"  transform=" translate(-896, -896)" d="M 896 768 q 237 0 443 -43 t 325 -127 v 170 q 0 69 -103 128 t -280 93.5 t -385 34.5 t -385 -34.5 t -280 -93.5 t -103 -128 v -170 q 119 84 325 127 t 443 43 z m 0 768 q 237 0 443 -43 t 325 -127 v 170 q 0 69 -103 128 t -280 93.5 t -385 34.5 t -385 -34.5 t -280 -93.5 t -103 -128 v -170 q 119 84 325 127 t 443 43 z m 0 -384 q 237 0 443 -43 t 325 -127 v 170 q 0 69 -103 128 t -280 93.5 t -385 34.5 t -385 -34.5 t -280 -93.5 t -103 -128 v -170 q 119 84 325 127 t 443 43 z m 0 -1152 q 208 0 385 34.5 t 280 93.5 t 103 128 v 128 q 0 69 -103 128 t -280 93.5 t -385 34.5 t -385 -34.5 t -280 -93.5 t -103 -128 v -128 q 0 -69 103 -128 t 280 -93.5 t 385 -34.5 z" stroke-linecap="round" /></g>`
 });
diff --git a/src/helpers/Generators.ts b/src/helpers/Generators.ts
@@ -19,8 +19,6 @@ export function useIMEInputProps() {
     const isComposingRef = useRef<boolean>(false);
 
     return {
-        // Note: these are lowercased because we use preact
-        // See: https://github.com/preactjs/preact/issues/3003
         onCompositionStart: () => {
             isComposingRef.current = true;
         },
diff --git a/src/main.ts b/src/main.ts
diff --git a/src/services/DataviewService.ts b/src/services/DataviewService.ts
