Merge branch '59-fr-create-db-from-dataview-query'

RafaelGB · RafaelGB · commit 1bbe9c37cfc1 · 2022-05-30T19:14:53.000+02:00
diff --git a/docs/docs/changelog.md b/docs/docs/changelog.md
@@ -1,3 +1,12 @@
+## 1.6.0
+### Shiny new things
+- Another kind of data sources of dataview are added(current folder will be avaliable too, of course) [ISSUE#59](https://github.com/RafaelGB/obsidian-db-folder/issues/59):
+  - TAGs: select a tag from a list of all tags
+  - INCOMING_LINKS: select a file from a list of all files
+  - OUTGOING_LINKS: select a file from a list of all files
+
+### No longer broken
+- Filters of type "contains", "starts with" & "ends with" are fixed. A bug appears when original data was empty. [ISSUE#72](https://github.com/RafaelGB/obsidian-db-folder/issues/72)
 ## 1.5.1
 *Published on 2022/05/29*
 ### Shiny new things
diff --git a/manifest.json b/manifest.json
@@ -1,7 +1,7 @@
 {
 	"id": "dbfolder",
 	"name": "DB Folder",
-	"version": "1.5.1",
+	"version": "1.6.0",
 	"minAppVersion": "0.14.6",
 	"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": "1.5.1",
+	"version": "1.6.0",
 	"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
@@ -132,7 +132,7 @@ export class DatabaseView extends TextFileView implements HoverParent {
       const rows = await adapterTFilesToRows(
         this.file.parent.path,
         columns,
-        this.diskConfig.yaml.filters
+        this.diskConfig.yaml
       );
       const initialState: InitialState = obtainInitialState(columns, rows);
       // Define table properties
diff --git a/src/Settings.ts b/src/Settings.ts
@@ -6,9 +6,10 @@ import { LOGGER } from "services/Logger";
 import { developer_settings_section } from "settings/DeveloperSection";
 import { columns_settings_section } from "settings/ColumnsSection";
 import { folder_settings_section } from "settings/FolderSection";
-import { DEFAULT_COLUMN_CONFIG, StyleClasses } from "helpers/Constants";
+import { DEFAULT_COLUMN_CONFIG, SourceDataTypes, StyleClasses } from "helpers/Constants";
 import { SettingHandlerResponse } from "settings/handlers/AbstractSettingHandler";
 import { media_settings_section } from "settings/MediaSection";
+import { source_settings_section } from "settings/SourceSection";
 
 export interface MediaSettings {
   enable_media_view: boolean;
@@ -30,6 +31,8 @@ export interface LocalSettings {
   show_metadata_created: boolean;
   show_metadata_modified: boolean;
   show_metadata_tasks: boolean;
+  source_data: string;
+  source_form_result: string;
 }
 
 export interface DatabaseSettings {
@@ -53,7 +56,9 @@ export const DEFAULT_SETTINGS: DatabaseSettings = {
     group_folder_column: '',
     show_metadata_created: false,
     show_metadata_modified: false,
-    show_metadata_tasks: false
+    show_metadata_tasks: false,
+    source_data: SourceDataTypes.CURRENT_FOLDER,
+    source_form_result: 'root'
   }
 };
 
@@ -118,6 +123,8 @@ export class SettingsManager {
 
   constructSettingBody(settingHandlerResponse: SettingHandlerResponse) {
     if (settingHandlerResponse.local) {
+      /** Source section */
+      source_settings_section(settingHandlerResponse);
       /** Folder section */
       folder_settings_section(settingHandlerResponse);
     }
diff --git a/src/helpers/Constants.ts b/src/helpers/Constants.ts
@@ -175,6 +175,13 @@ export const StyleVariables = Object.freeze({
   TEXT_NORMAL: 'var(--text-normal)',
 });
 
+export const SourceDataTypes = Object.freeze({
+  CURRENT_FOLDER: 'current_folder',
+  TAG: 'tag',
+  OUTGOING_LINK: 'outgoing_link',
+  INCOMING_LINK: 'incoming_link',
+});
+
 export const WidthVariables = Object.freeze({
   ICON_SPACING: 17,
   MAGIC_SPACING: 10
diff --git a/src/helpers/VaultManagement.ts b/src/helpers/VaultManagement.ts
@@ -4,11 +4,13 @@ import { ActionType } from 'react-table';
 import { VaultManagerDB } from 'services/FileManagerService';
 import { LOGGER } from "services/Logger";
 import NoteInfo from 'services/NoteInfo';
-import { DatabaseCore, UpdateRowOptions } from "helpers/Constants";
+import { DatabaseCore, SourceDataTypes, UpdateRowOptions } from "helpers/Constants";
 import obtainRowDatabaseFields from 'parsers/FileToRowDatabaseFields';
 import { parseFrontmatterFieldsToString } from 'parsers/RowDatabaseFieldsToFile';
 import { DataviewService } from 'services/DataviewService';
-import { FilterCondition } from 'cdm/DatabaseModel';
+import { DatabaseYaml } from 'cdm/DatabaseModel';
+import { Literal } from 'obsidian-dataview/lib/data-model/value';
+import { DataArray } from 'obsidian-dataview/lib/api/data-array';
 
 const noBreakSpace = /\u00A0/g;
 
@@ -62,16 +64,16 @@ export function getNormalizedPath(path: string): NormalizedPath {
  * @param folderPath 
  * @returns 
  */
-export async function adapterTFilesToRows(folderPath: string, columns: TableColumn[], filters: FilterCondition[]): Promise<Array<RowDataType>> {
+export async function adapterTFilesToRows(folderPath: string, columns: TableColumn[], dbYaml: DatabaseYaml): Promise<Array<RowDataType>> {
   LOGGER.debug(`=> adapterTFilesToRows.  folderPath:${folderPath}`);
   const rows: Array<RowDataType> = [];
   let id = 0;
 
-  let folderFiles = DataviewService.getDataviewAPI().pages(`"${folderPath}"`)
+  let folderFiles = sourceDataviewPages(folderPath, dbYaml)
     .where(p => !p[DatabaseCore.FRONTMATTER_KEY]);
   // Config filters asociated with the database
-  if (filters) {
-    folderFiles = folderFiles.where(p => DataviewService.filter(filters, p));
+  if (dbYaml.filters) {
+    folderFiles = folderFiles.where(p => DataviewService.filter(dbYaml.filters, p));
   }
 
   folderFiles.map(async (page) => {
@@ -83,6 +85,18 @@ export async function adapterTFilesToRows(folderPath: string, columns: TableColu
   return rows;
 }
 
+export function sourceDataviewPages(folderPath: string, dbYaml: DatabaseYaml): DataArray<Record<string, Literal>> {
+  switch (dbYaml.config.source_data) {
+    case SourceDataTypes.TAG:
+      return DataviewService.getDataviewAPI().pages(`#${dbYaml.config.source_form_result}`);
+    case SourceDataTypes.INCOMING_LINK:
+      return DataviewService.getDataviewAPI().pages(`[[${dbYaml.config.source_form_result}]]`);
+    case SourceDataTypes.OUTGOING_LINK:
+      return DataviewService.getDataviewAPI().pages(`outgoing([[${dbYaml.config.source_form_result}]])`);
+    default:
+      return DataviewService.getDataviewAPI().pages(`"${folderPath}"`);
+  }
+}
 export async function updateRowFileProxy(file: TFile, columnId: string, newValue: string, state: TableDataType, option: string): Promise<void> {
   await updateRowFile(file, columnId, newValue, state, option).catch(e => {
     LOGGER.error(`updateRowFileProxy.  Error:${e}`);
diff --git a/src/parsers/handlers/marshall/MarshallConfigHandler.ts b/src/parsers/handlers/marshall/MarshallConfigHandler.ts
@@ -1,4 +1,5 @@
 import { YamlHandlerResponse } from 'cdm/MashallModel';
+import { SourceDataTypes } from 'helpers/Constants';
 import { AbstractYamlHandler } from 'parsers/handlers/marshall/AbstractYamlPropertyHandler';
 
 export class MarshallConfigHandler extends AbstractYamlHandler {
@@ -14,7 +15,7 @@ export class MarshallConfigHandler extends AbstractYamlHandler {
                 yaml.config.enable_show_state = false;
             }
 
-            // if group_folder_column is not defined, load default
+            // if group_folder_column is not defined, load empty (optional)
             if (checkNullable(yaml.config.group_folder_column)) {
                 yaml.config.group_folder_column = '';
             }
@@ -36,6 +37,17 @@ export class MarshallConfigHandler extends AbstractYamlHandler {
                 this.addError(`There was not show_metadata_modified key in yaml. Default will be loaded`);
                 yaml.config.show_metadata_modified = false;
             }
+
+            // if source_data is not defined, load default
+            if (checkNullable(yaml.config.source_data)) {
+                this.addError(`There was not source_data key in yaml. Default will be loaded`);
+                yaml.config.source_data = SourceDataTypes.CURRENT_FOLDER;
+            }
+
+            // if source_form_result is not defined, load empty (optional)
+            if (checkNullable(yaml.config.source_form_result)) {
+                yaml.config.source_form_result = '';
+            }
         }
         handlerResponse.yaml = yaml;
         return this.goNext(handlerResponse);
diff --git a/src/services/DataviewService.ts b/src/services/DataviewService.ts
@@ -46,13 +46,13 @@ class DataviewProxy {
                     if (p[c.field] > c.value) return false;
                     break;
                 case OperatorFilter.CONTAINS:
-                    if (!p[c.field].includes(c.value)) return false;
+                    if (p[c.field] !== undefined && !p[c.field].includes(c.value)) return false;
                     break;
                 case OperatorFilter.STARTS_WITH:
-                    if (!p[c.field].startsWith(c.value)) return false;
+                    if (p[c.field] !== undefined && !p[c.field].startsWith(c.value)) return false;
                     break;
                 case OperatorFilter.ENDS_WITH:
-                    if (!p[c.field].endsWith(c.value)) return false;
+                    if (p[c.field] !== undefined && !p[c.field].endsWith(c.value)) return false;
                     break;
                 default:
                     throw new Error(`Unknown operator: ${c.operator}`);
diff --git a/src/services/MarkdownPostProcessorService.ts b/src/services/MarkdownPostProcessorService.ts
@@ -137,7 +137,7 @@ export class PreviewDatabaseModeService {
         const rows = await adapterTFilesToRows(
             dbFile.parent.path,
             columns,
-            databaseDisk.yaml.filters
+            databaseDisk.yaml
         );
         const dataviewCols: string[] = columns
             .filter((col) => !col.skipPersist)
diff --git a/src/settings/SettingsComponents.ts b/src/settings/SettingsComponents.ts
@@ -1,4 +1,3 @@
-import { OperatorFilter } from "helpers/Constants";
 import { ButtonComponent, Setting } from "obsidian";
 
 /**
diff --git a/src/settings/SourceSection.ts b/src/settings/SourceSection.ts
@@ -0,0 +1,32 @@
+import { add_setting_header } from 'settings/SettingsComponents';
+import { SettingHandler, SettingHandlerResponse } from 'settings/handlers/AbstractSettingHandler';
+import { SourceDropDownHandler } from 'settings/handlers/source/SourceDropDownHandler';
+import { SourceFormHandler } from 'settings/handlers/source/SourceFormHandler';
+
+/**
+ * developer settings section
+ */
+export function source_settings_section(settingHandlerResponse: SettingHandlerResponse): SettingHandlerResponse {
+    const columns_section = settingHandlerResponse.containerEl.createDiv("configuration-section-container-source");
+    // title of the section
+    add_setting_header(columns_section, "Source of database", 'h3');
+    // section settings
+    const handlers = getHandlers();
+    let i = 1;
+    while (i < handlers.length) {
+        handlers[i - 1].setNext(handlers[i]);
+        i++;
+    }
+    settingHandlerResponse.containerEl = columns_section;
+    return handlers[0].handle(settingHandlerResponse);
+}
+
+/**
+ * Obtain all classes than extends from AbstractHandler
+ */
+function getHandlers(): SettingHandler[] {
+    return [
+        new SourceDropDownHandler(),
+        new SourceFormHandler()
+    ];
+}
diff --git a/src/settings/handlers/source/SourceDropDownHandler.ts b/src/settings/handlers/source/SourceDropDownHandler.ts
@@ -0,0 +1,31 @@
+import { SourceDataTypes } from "helpers/Constants";
+import { AbstractSettingsHandler, SettingHandlerResponse } from "settings/handlers/AbstractSettingHandler";
+import { add_dropdown } from "settings/SettingsComponents";
+
+export class SourceDropDownHandler extends AbstractSettingsHandler {
+    settingTitle: string = 'Select the source of database data';
+    handle(settingHandlerResponse: SettingHandlerResponse): SettingHandlerResponse {
+        const { settingsManager, containerEl, view } = settingHandlerResponse;
+        const source_dropdown_promise = async (value: string): Promise<void> => {
+            // update settings
+            view.diskConfig.updateConfig('source_data', value);
+            // Force refresh of settings
+            settingsManager.reset(settingHandlerResponse);
+        };
+        // render dropdown inside container
+        add_dropdown(
+            containerEl,
+            this.settingTitle,
+            'Select from which source you want to get the data to be displayed in the table.',
+            view.diskConfig.yaml.config.source_data,
+            {
+                current_folder: SourceDataTypes.CURRENT_FOLDER,
+                tag: SourceDataTypes.TAG,
+                outgoing_link: SourceDataTypes.OUTGOING_LINK,
+                incoming_link: SourceDataTypes.INCOMING_LINK,
+            },
+            source_dropdown_promise
+        );
+        return this.goNext(settingHandlerResponse);
+    }
+}
diff --git a/src/settings/handlers/source/SourceFormHandler.ts b/src/settings/handlers/source/SourceFormHandler.ts
@@ -0,0 +1,61 @@
+import { DatabaseView } from "DatabaseView";
+import { SourceDataTypes } from "helpers/Constants";
+import { AbstractSettingsHandler, SettingHandlerResponse } from "settings/handlers/AbstractSettingHandler";
+import { add_dropdown } from "settings/SettingsComponents";
+
+export class SourceFormHandler extends AbstractSettingsHandler {
+    settingTitle: string = 'Form in function of source data';
+    handle(settingHandlerResponse: SettingHandlerResponse): SettingHandlerResponse {
+        const { containerEl, view } = settingHandlerResponse;
+        switch (view.diskConfig.yaml.config.source_data) {
+            case SourceDataTypes.TAG:
+                tagHandler(view, containerEl);
+                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);
+                };
+
+                add_dropdown(
+                    containerEl,
+                    'Select a file',
+                    'Select file from vault to be used as source of data.',
+                    `${view.diskConfig.yaml.config.source_form_result}`,
+                    filePaths,
+                    source_form_promise
+                );
+                break;
+            default:
+            //Current folder
+        }
+
+        return this.goNext(settingHandlerResponse);
+    }
+}
+
+function tagHandler(view: DatabaseView, containerEl: HTMLElement) {
+    const tagArray: Record<string, number> = (app.metadataCache as unknown as any).getTags();
+    if (tagArray) {
+        const tagRecords: Record<string, string> = {};
+        Object.keys(tagArray).forEach((tag) => {
+            tagRecords[tag] = tag;
+        });
+        const source_form_promise = async (value: string): Promise<void> => {
+            // update settings
+            view.diskConfig.updateConfig('source_form_result', value.slice(1));
+        };
+
+        add_dropdown(
+            containerEl,
+            'Select a tag',
+            'Select tag to get data from',
+            `#${view.diskConfig.yaml.config.source_form_result}`,
+            tagRecords,
+            source_form_promise
+        );
+    }
+}

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": "1.5.1",`
	`4`	`+ "version": "1.6.0",`
`5`	`5`	`"minAppVersion": "0.14.6",`
`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": "1.5.1",`
	`3`	`+ "version": "1.6.0",`
`4`	`4`	`"description": "This is a sample plugin for Obsidian (https://obsidian.md)",`
`5`	`5`	`"main": "main.js",`
`6`	`6`	`"scripts": {`