adding state config global and local

RafaelGB · RafaelGB · commit 7b8d04e1c91c · 2022-04-22T20:49:11.000+02:00
needs to work at local yet
diff --git a/dist/main.js b/dist/main.js
diff --git a/src/DatabaseView.tsx b/src/DatabaseView.tsx
@@ -26,6 +26,8 @@ export class DatabaseView extends TextFileView implements HoverParent {
     plugin: DBFolderPlugin;
     hoverPopover: HoverPopover | null;
     tableContainer: HTMLDivElement | null = null;
+    diskConfig: DatabaseInfo;
+
     constructor(leaf: WorkspaceLeaf, plugin: DBFolderPlugin) {
         super(leaf);
         this.plugin = plugin;
@@ -107,9 +109,9 @@ export class DatabaseView extends TextFileView implements HoverParent {
 
     async initDatabase(): Promise<void> {
       LOGGER.info(`=>initDatabase ${this.file.path}`);
-      const databaseInfo = new DatabaseInfo(this.file);
-      await databaseInfo.initDatabaseconfigYaml();
-      const columns = await obtainColumnsFromFolder(databaseInfo.yaml.columns);
+      this.diskConfig = new DatabaseInfo(this.file);
+      await this.diskConfig.initDatabaseconfigYaml();
+      const columns = await obtainColumnsFromFolder(this.diskConfig.yaml.columns);
       const metatadaColumns = await obtainMetadataColumns();
       columns.push(...metatadaColumns);
       const rows = await adapterTFilesToRows(this.file.parent.path);
@@ -119,8 +121,7 @@ export class DatabaseView extends TextFileView implements HoverParent {
         data: rows,
         skipReset: false,
         view: this,
-        stateManager: this.plugin.getStateManager(this.file),
-        diskConfig: databaseInfo
+        stateManager: this.plugin.getStateManager(this.file)
       }
       
       let table = createDatabase(tableProps);
diff --git a/src/Settings.ts b/src/Settings.ts
@@ -61,19 +61,27 @@ export interface SettingsManagerConfig {
       this.config = config;
       this.settings = settings;
     }
-    constructUI(containerEl: HTMLElement, heading: string, local: boolean) {
+
+    /**
+     * Render settings window
+     * @param containerEl 
+     * @param heading 
+     * @param local 
+     * @param view optional. Used only for local settings
+     */
+    constructUI(containerEl: HTMLElement, heading: string, local: boolean,view?: DatabaseView) {
         /** Common modal headings */
         containerEl.empty();
         containerEl.addClass('database-settings-modal');
         add_setting_header(containerEl,heading,'h2');
         const settingsBody:HTMLDivElement = containerEl.createDiv('database-settings-body');
-        this.constructSettingBody(settingsBody, local);
+        this.constructSettingBody(settingsBody, local, view);
     }
 
-    constructSettingBody(containerEl: HTMLElement, local: boolean) {
+    constructSettingBody(containerEl: HTMLElement, local: boolean, view?: DatabaseView) {
       containerEl.empty();
       /** Developer section */
-      developer_settings_section(this, containerEl, local);
+      developer_settings_section(this, containerEl, local, view);
     }
     cleanUp() {
         this.cleanupFns.forEach((fn) => fn());
diff --git a/src/cdm/DatabaseModel.ts b/src/cdm/DatabaseModel.ts
@@ -20,4 +20,7 @@ export type DatabaseYaml = {
     description: string,
     /** database columns */
     columns: Record<string, DatabaseColumn>
+    /** database local configuration 
+     * TODO typing*/
+    config?: Record<string, any>
 }
diff --git a/src/cdm/FolderModel.ts b/src/cdm/FolderModel.ts
@@ -59,8 +59,7 @@ export type TableDataType={
     skipReset: boolean,
     view: DatabaseView,
     stateManager?: StateManager,
-    dispatch?: Dispatch<any>,
-    diskConfig: DatabaseInfo
+    dispatch?: Dispatch<any>
 }
 export interface DatabaseHeaderProps{
     columns:any,
diff --git a/src/components/Table.tsx b/src/components/Table.tsx
@@ -241,7 +241,7 @@ export function Table(initialState: TableDataType){
                 }}
                 onDragEnd={() => {
                   // save on disk
-                  initialState.diskConfig.reorderColumns((state as any).columnOrder);
+                  initialState.view.diskConfig.reorderColumns((state as any).columnOrder);
                   // clear the current order
                   currentColOrder.current = null;
                 }}
diff --git a/src/components/reducers/DatabaseDispatch.tsx b/src/components/reducers/DatabaseDispatch.tsx
@@ -76,7 +76,7 @@ export function databaseReducer(state:TableDataType, action:ActionType) {
           // trim label will get a valid yaml key
           const update_col_key:string = action.label.trim();
           // Update configuration on disk
-          state.diskConfig.updateColumnProperties(
+          state.view.diskConfig.updateColumnProperties(
             action.columnId,
             {label: action.label, accessor: update_col_key, key: update_col_key}
           );
@@ -108,7 +108,7 @@ export function databaseReducer(state:TableDataType, action:ActionType) {
                 column => column.id === action.columnId
             );
             // Update configuration on disk
-            state.diskConfig.updateColumnProperties(action.columnId, {input: action.dataType});
+            state.view.diskConfig.updateColumnProperties(action.columnId, {input: action.dataType});
             // Update state
             switch (action.dataType) {
                 case DataTypes.NUMBER:
@@ -217,7 +217,7 @@ export function databaseReducer(state:TableDataType, action:ActionType) {
             position: leftId
           };
           // Update configuration on disk
-          state.diskConfig.addColumn(`newColumn${leftId}`, newLeftColumn);
+          state.view.diskConfig.addColumn(`newColumn${leftId}`, newLeftColumn);
           
           Promise.all(state.data.map(async (row:TableRow) => {
             updateRowFile(
@@ -262,7 +262,7 @@ export function databaseReducer(state:TableDataType, action:ActionType) {
             label: `new Column ${rightId}`
           };
           // Update configuration on disk
-          state.diskConfig.addColumn(rightId, newRIghtColumn);
+          state.view.diskConfig.addColumn(rightId, newRIghtColumn);
           
           Promise.all(state.data.map(async (row:TableRow) => {
             updateRowFile(
@@ -294,7 +294,7 @@ export function databaseReducer(state:TableDataType, action:ActionType) {
             (column) => column.id === action.columnId
           );
           // Update configuration on disk
-          state.diskConfig.removeColumn(action.columnId);
+          state.view.diskConfig.removeColumn(action.columnId);
           Promise.all(state.data.map(async (row:TableRow) => {
             updateRowFile(
               row.note.getFile(),
diff --git a/src/helpers/Constants.ts b/src/helpers/Constants.ts
@@ -50,7 +50,7 @@ export const DatabaseFrontmatterOptions = Object.freeze({
     '  key: column1',
     '  accessor: column1',
     '  label: Column 1',
-    '%%>'
+    '  position: 0',
   ].join('\n')
 });
 
diff --git a/src/main.ts b/src/main.ts
@@ -187,7 +187,12 @@ export default class DBFolderPlugin extends Plugin {
 			this.app.fileManager as any
 		  ).createNewMarkdownFile(targetFolder, 'Untitled database');
 	
-		  await this.app.vault.modify(database, DatabaseFrontmatterOptions.BASIC);
+		  await this.app.vault.modify(
+			  database, 
+			  DatabaseFrontmatterOptions.BASIC
+			  	.concat('\n')
+			  	.concat(this.defaultConfiguration())
+			);
 		  await this.app.workspace.activeLeaf.setViewState({
 			type: DatabaseCore.FRONTMATTER_KEY,
 			state: { file: database.path },
@@ -197,6 +202,17 @@ export default class DBFolderPlugin extends Plugin {
 		}
 	}
 
+	/**
+	 * Returns the default configuration for a database file.
+	 */
+	defaultConfiguration():string{
+		const local_settings = this.settings.local_settings;
+		return [
+			`configuration:`,
+			` enable_show_state: ${local_settings.enable_show_state}`,
+			'%%>'
+		].join('\n');
+	}
 	registerEvents() {
 		this.registerEvent(
 		  this.app.workspace.on('file-menu', (menu, file: TFile) => {
diff --git a/src/mock/mockUtils.tsx b/src/mock/mockUtils.tsx
@@ -58,6 +58,6 @@ export function makeData(count:number):TableDataType {
         options: options,
       }
     ];
-    return { columns: columns, metadataColumns:[], data: data, skipReset: false, diskConfig:null, view:null };
+    return { columns: columns, metadataColumns:[], data: data, skipReset: false, view:null };
   }
   
diff --git a/src/services/DatabaseInfo.ts b/src/services/DatabaseInfo.ts
@@ -108,4 +108,11 @@ export default class DatabaseInfo {
         this.yaml.columns[columnId] = properties;
         await this.saveOnDisk();
     }
+
+    async updateConfig(config:Record<string,any>):Promise<void>{
+        for (let key in config) {
+            this.yaml.config[key] = config[key];
+        }
+        await this.saveOnDisk();
+    }
 }
diff --git a/src/settings/DeveloperSection.ts b/src/settings/DeveloperSection.ts
@@ -1,13 +1,15 @@
 import { add_setting_header } from 'settings/SettingsComponents';
 import { SettingHandler } from 'settings/handlers/AbstractSettingHandler';
 import { LoggerToggleHandler } from 'settings/handlers/developer/LoggerToggleHandler';
+import { TableStateToggleHandler } from 'settings/handlers/developer/TableStateToggleHandler';
 import { SettingsManager } from 'Settings';
 import { LoggerLevelInfoDropDownHandler } from 'settings/handlers/developer/LoggerLevelInfoDropDownHandler';
+import { DatabaseView } from 'DatabaseView';
 
 /**
-     * developer settings section
-     */
-export function developer_settings_section(settingsManager: SettingsManager, containerEl: HTMLElement, local: boolean): void {
+ * developer settings section
+ */
+export function developer_settings_section(settingsManager: SettingsManager, containerEl: HTMLElement, local: boolean, view?: DatabaseView): void {
     // title of the section
     add_setting_header(containerEl,"Developer section",'h3');
     // add soft red background color to the section - TODO: make it configurable
@@ -19,7 +21,7 @@ export function developer_settings_section(settingsManager: SettingsManager, con
         handlers[i - 1].setNext(handlers[i]);
         i++;
     }
-  handlers[0].handle(settingsManager, containerEl, local);
+  handlers[0].handle(settingsManager, containerEl, local, view);
 }
 
 /**
@@ -28,6 +30,7 @@ export function developer_settings_section(settingsManager: SettingsManager, con
  function getHandlers(): SettingHandler[] {
     return [
         new LoggerToggleHandler(),
-        new LoggerLevelInfoDropDownHandler()
+        new LoggerLevelInfoDropDownHandler(),
+        new TableStateToggleHandler()
     ];
 }
diff --git a/src/settings/handlers/AbstractSettingHandler.ts b/src/settings/handlers/AbstractSettingHandler.ts
@@ -1,9 +1,10 @@
+import { DatabaseView } from "DatabaseView";
 import DBFolderPlugin from "main";
 import { SettingsManager } from "Settings";
 
 export interface SettingHandler {
     setNext(handler: SettingHandler): SettingHandler;
-    handle(settingsManager: SettingsManager,containerEl: HTMLElement, local: boolean): [string, string][];
+    handle(settingsManager: SettingsManager,containerEl: HTMLElement, local: boolean, view?: DatabaseView): [string, string][];
 }
 
 export abstract class AbstractSettingsHandler implements SettingHandler {
@@ -19,5 +20,5 @@ export abstract class AbstractSettingsHandler implements SettingHandler {
         this.nextHandler = handler;
         return handler;
     }
-    abstract handle(settingsManager: SettingsManager, containerEl: HTMLElement, local: boolean): [string, string][];
+    abstract handle(settingsManager: SettingsManager, containerEl: HTMLElement, local: boolean, view?: DatabaseView): [string, string][];
 }
diff --git a/src/settings/handlers/developer/LoggerToggleHandler.ts b/src/settings/handlers/developer/LoggerToggleHandler.ts
@@ -3,18 +3,19 @@ import { SettingsManager } from "Settings";
 import { add_toggle } from "settings/SettingsComponents";
 import { AbstractSettingsHandler } from "settings/handlers/AbstractSettingHandler";
 export class LoggerToggleHandler extends AbstractSettingsHandler {
-    settingTitle: string = 'Enable debug mode';
+    settingTitle: string = 'Enable developer settings. Logger will be enabled';
     handle(settingsManager: SettingsManager, containerEl: HTMLElement, local: boolean): [string, string][] {
         // pass if modal opened from local settings
         if(!local){
-            let debug_togle_promise = async (value: boolean): Promise<void> => {
+            const logger_togle_promise = async (value: boolean): Promise<void> => {
                 // set debug mode
                 const update_global_settings = settingsManager.plugin.settings.global_settings;
                 update_global_settings.enable_debug_mode = value;
                 // update settings
                 await settingsManager.plugin.updateSettings({ 
                     global_settings:update_global_settings 
                 });
+                // update service value
                 LOGGER.setDebugMode(value);
                 // Force refresh of settings
                 settingsManager.constructSettingBody(containerEl, local);
@@ -24,7 +25,7 @@ export class LoggerToggleHandler extends AbstractSettingsHandler {
                 this.settingTitle, 
                 "This will log all the errors and warnings in the console",
                 settingsManager.plugin.settings.global_settings.enable_debug_mode, 
-                debug_togle_promise
+                logger_togle_promise
             );
         }
         // Check next handler
diff --git a/src/settings/handlers/developer/TableStateToggleHandler.ts b/src/settings/handlers/developer/TableStateToggleHandler.ts
@@ -2,11 +2,33 @@
 import { SettingsManager } from "Settings";
 import { add_toggle } from "settings/SettingsComponents";
 import { AbstractSettingsHandler } from "settings/handlers/AbstractSettingHandler";
-export class LoggerLevelInfoDropDownHandler extends AbstractSettingsHandler {
+import { DatabaseView } from "DatabaseView";
+export class TableStateToggleHandler extends AbstractSettingsHandler {
     settingTitle: string = 'Show state of table';
-    handle(settingsManager: SettingsManager, containerEl: HTMLElement, local: boolean): [string, string][] {
+    handle(settingsManager: SettingsManager, containerEl: HTMLElement, local: boolean, view?: DatabaseView): [string, string][] {
         if(settingsManager.plugin.settings.global_settings.enable_debug_mode){
-            
+            const table_state_togle_promise = async (value: boolean): Promise<void> => {
+                // Check context to define correct promise
+                if(local){
+                    // Persist value
+                    view .diskConfig.updateConfig({enable_show_state: value});
+                }else{
+                    // switch table state on/off
+                    const update_local_settings = settingsManager.plugin.settings.local_settings;
+                    update_local_settings.enable_show_state = value;
+                    // update settings
+                    await settingsManager.plugin.updateSettings({ 
+                        local_settings:update_local_settings 
+                    });
+                }
+            }
+            add_toggle(
+                containerEl,
+                this.settingTitle, 
+                "This will show/hide properties of the table on the bottom of the view",
+                settingsManager.plugin.settings.local_settings.enable_show_state, 
+                table_state_togle_promise
+            );
         }
         // Check next handler
         if (this.nextHandler) {

Original file line number	Diff line number	Diff line change
`@@ -20,4 +20,7 @@ export type DatabaseYaml = {`
`20`	`20`	`description: string,`
`21`	`21`	`/** database columns */`
`22`	`22`	`columns: Record<string, DatabaseColumn>`
	`23`	`+ /** database local configuration`
	`24`	`+ * TODO typing*/`
	`25`	`+ config?: Record<string, any>`
`23`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,6 @@ export function makeData(count:number):TableDataType {`
`58`	`58`	`options: options,`
`59`	`59`	`}`
`60`	`60`	`];`
`61`		`- return { columns: columns, metadataColumns:[], data: data, skipReset: false, diskConfig:null, view:null };`
	`61`	`+ return { columns: columns, metadataColumns:[], data: data, skipReset: false, view:null };`
`62`	`62`	`}`
`63`	`63`