Merge branch '457-fr-new-option-to-enabledisable-formula-scripts-load'

RafaelGB · RafaelGB · commit 114040422974 · 2022-10-02T13:52:21.000+02:00
diff --git a/src/automations/formula_functions/FormulaFunctions.ts b/src/automations/formula_functions/FormulaFunctions.ts
@@ -14,7 +14,7 @@ export class FormulaFunctions implements IGenerateObject {
     ): Promise<Record<string, unknown>> {
         let user_script_functions = {};
 
-        if (config.formula_folder_path) {
+        if (config.enable_js_formulas && config.formula_folder_path) {
             user_script_functions =
                 await this.js_script_functions.generate_object();
         }
diff --git a/src/cdm/SettingsModel.ts b/src/cdm/SettingsModel.ts
@@ -49,6 +49,7 @@ export interface LocalSettings {
     source_data: string;
     sticky_first_column: boolean;
     row_templates_folder: string;
+    enable_js_formulas: boolean;
     formula_folder_path: string;
     inline_default: boolean;
     inline_new_position: string;
diff --git a/src/components/NavBar.tsx b/src/components/NavBar.tsx
@@ -16,13 +16,13 @@ import { c } from "helpers/StylesHelper";
 import EditFiltersButton from "components/reducers/DataviewFilters";
 import { MenuButtonStyle } from "components/styles/NavBarStyles";
 import { SettingsModal } from "Settings";
-import CsvReader from "./navbar/CsvReader";
+import CsvReader from "components/navbar/CsvReader";
 import { t } from "lang/helpers";
 import AppBar from "@mui/material/AppBar";
 import ButtonGroup from "@mui/material/ButtonGroup";
 import ToggleFiltersButton from "components/reducers/ToggleFiltersButton";
 import Paper from "@mui/material/Paper";
-import QuickFilters from "./reducers/QuickFilters";
+import QuickFilters from "components/reducers/QuickFilters";
 
 export function NavBar(navBarProps: NavBarProps) {
   const { table } = navBarProps;
diff --git a/src/components/Table.tsx b/src/components/Table.tsx
@@ -33,9 +33,9 @@ import TableHeader from "components/TableHeader";
 import TableRow from "components/TableRow";
 import getInitialColumnSizing from "components/behavior/InitialColumnSizeRecord";
 import { globalDatabaseFilterFn } from "components/reducers/TableFilterFlavours";
-import dbfolderColumnSortingFn from "./reducers/CustomSortingFn";
+import dbfolderColumnSortingFn from "components/reducers/CustomSortingFn";
 import { useCallback, useState } from "react";
-import { AddRow } from "./AddRow";
+import { AddRow } from "components/AddRow";
 
 const defaultColumn: Partial<ColumnDef<RowDataType>> = {
   minSize: DatabaseLimits.MIN_COLUMN_HEIGHT,
diff --git a/src/helpers/Constants.ts b/src/helpers/Constants.ts
@@ -380,6 +380,7 @@ export const DEFAULT_SETTINGS: DatabaseSettings = {
     row_templates_folder: '/',
     current_row_template: '',
     pagination_size: 10,
+    enable_js_formulas: false,
     formula_folder_path: '/',
     inline_default: false,
     inline_new_position: INLINE_POSITION.TOP,
diff --git a/src/services/FileGroupingService.ts b/src/services/FileGroupingService.ts
@@ -1,5 +1,5 @@
 import { Notice } from "obsidian";
-import { LOGGER } from "./Logger";
+import { LOGGER } from "services/Logger";
 import pLimit from "p-limit";
 import { RowDataType } from "cdm/FolderModel";
 import { LocalSettings } from "cdm/SettingsModel";
@@ -89,14 +89,13 @@ export class FileGroupingService {
           throw error;
         }
       }
-      if (movedRows.length > 0) {         
+      if (movedRows.length > 0) {
         new Notice(
-          `Moved ${movedRows.length} file${
-            movedRows.length > 1 ? "s" : ""
+          `Moved ${movedRows.length} file${movedRows.length > 1 ? "s" : ""
           } into subfolders`,
           1500
         );
-      }     
+      }
       return movedRows;
     });
 
diff --git a/src/settings/AutomationSection.ts b/src/settings/AutomationSection.ts
@@ -3,6 +3,7 @@ import { SettingHandlerResponse } from 'settings/handlers/AbstractSettingHandler
 import { AbstractChain } from 'patterns/AbstractFactoryChain';
 import { AbstractHandler } from 'patterns/AbstractHandler';
 import { FormulaJSFolderHandler } from 'settings/handlers/automation/FormulaJSFolderHandler';
+import { FormulaJSToggleHandler } from 'settings/handlers/automation/FormulaJSToggleHandler';
 
 class AutomationSetttingsSection extends AbstractChain<SettingHandlerResponse> {
     protected customHandle(settingHandlerResponse: SettingHandlerResponse): SettingHandlerResponse {
@@ -14,6 +15,7 @@ class AutomationSetttingsSection extends AbstractChain<SettingHandlerResponse> {
     }
     protected getHandlers(): AbstractHandler<SettingHandlerResponse>[] {
         return [
+            new FormulaJSToggleHandler(),
             new FormulaJSFolderHandler()
         ];
     }
diff --git a/src/settings/handlers/automation/FormulaJSFolderHandler.ts b/src/settings/handlers/automation/FormulaJSFolderHandler.ts
@@ -6,34 +6,35 @@ export class FormulaJSFolderHandler extends AbstractSettingsHandler {
     settingTitle: string = 'Select the source of your formula JS files';
     handle(settingHandlerResponse: SettingHandlerResponse): SettingHandlerResponse {
         const { settingsManager, containerEl, view, local } = settingHandlerResponse;
+        if (view.diskConfig.yaml.config.enable_js_formulas) {
+            const formula_folder_promise = async (value: string): Promise<void> => {
+                if (local) {
+                    // update settings
+                    view.diskConfig.updateConfig({ formula_folder_path: value });
+                } else {
+                    // switch show created on/off
+                    const update_local_settings = settingsManager.plugin.settings.local_settings;
+                    update_local_settings.formula_folder_path = value;
+                    // update settings
+                    await settingsManager.plugin.updateSettings({
+                        local_settings: update_local_settings
+                    });
+                }
 
-        const formula_folder_promise = async (value: string): Promise<void> => {
-            if (local) {
-                // update settings
-                view.diskConfig.updateConfig({ formula_folder_path: value });
-            } else {
-                // switch show created on/off
-                const update_local_settings = settingsManager.plugin.settings.local_settings;
-                update_local_settings.formula_folder_path = value;
-                // update settings
-                await settingsManager.plugin.updateSettings({
-                    local_settings: update_local_settings
+            };
+            // render dropdown inside container
+            new Setting(containerEl)
+                .setName('Select the formula JS folder')
+                .setDesc('Select the destination of the formula JS files.')
+                .addSearch((cb) => {
+                    new FolderSuggest(
+                        cb.inputEl
+                    );
+                    cb.setPlaceholder("Example: path/to/folder")
+                        .setValue(local ? view.diskConfig.yaml.config.formula_folder_path : settingsManager.plugin.settings.local_settings.formula_folder_path)
+                        .onChange(formula_folder_promise);
                 });
-            }
-
-        };
-        // render dropdown inside container
-        new Setting(containerEl)
-            .setName('Select the formula JS folder')
-            .setDesc('Select the destination of the formula JS files.')
-            .addSearch((cb) => {
-                new FolderSuggest(
-                    cb.inputEl
-                );
-                cb.setPlaceholder("Example: path/to/folder")
-                    .setValue(local ? view.diskConfig.yaml.config.formula_folder_path : settingsManager.plugin.settings.local_settings.formula_folder_path)
-                    .onChange(formula_folder_promise);
-            });
+        }
         return this.goNext(settingHandlerResponse);
     }
 }
diff --git a/src/settings/handlers/automation/FormulaJSToggleHandler.ts b/src/settings/handlers/automation/FormulaJSToggleHandler.ts
@@ -0,0 +1,33 @@
+import { add_toggle } from "settings/SettingsComponents";
+import { AbstractSettingsHandler, SettingHandlerResponse } from "settings/handlers/AbstractSettingHandler";
+export class FormulaJSToggleHandler extends AbstractSettingsHandler {
+    settingTitle: string = 'Enable JavaScript formulas';
+    handle(settingHandlerResponse: SettingHandlerResponse): SettingHandlerResponse {
+        const { settingsManager, containerEl, view, local } = settingHandlerResponse;
+        // pass if modal opened from local settings
+        const formulas_togle_promise = async (value: boolean): Promise<void> => {
+            if (local) {
+                // update settings
+                view.diskConfig.updateConfig({ enable_js_formulas: value });
+            } else {
+                const update_local_settings = settingsManager.plugin.settings.local_settings;
+                update_local_settings.enable_js_formulas = value;
+                // update settings
+                await settingsManager.plugin.updateSettings({
+                    local_settings: update_local_settings
+                });
+            }
+            // Force refresh of settings
+            settingsManager.reset(settingHandlerResponse);
+        }
+        add_toggle(
+            containerEl,
+            this.settingTitle,
+            "Enable JavaScript formulas to be used in your database.",
+            local ? view.diskConfig.yaml.config.enable_js_formulas : settingsManager.plugin.settings.local_settings.enable_js_formulas,
+            formulas_togle_promise
+        );
+
+        return this.goNext(settingHandlerResponse);
+    }
+}
diff --git a/src/settings/handlers/columns/GroupFolderColumnTextInputHandler.ts b/src/settings/handlers/columns/GroupFolderColumnTextInputHandler.ts
@@ -3,60 +3,60 @@ import { destination_folder } from "helpers/FileManagement";
 import { FileGroupingService } from "services/FileGroupingService";
 import { AbstractSettingsHandler, SettingHandlerResponse } from "settings/handlers/AbstractSettingHandler";
 import { add_toggle } from "settings/SettingsComponents";
-import { FileGroupingColumnsSetting } from "./FileGroupingColumnsSetting";
+import { FileGroupingColumnsSetting } from "settings/handlers/columns/FileGroupingColumnsSetting";
 
 export class GroupFolderColumnTextInputHandler extends AbstractSettingsHandler {
   settingTitle: string = 'Define a schema to group files into folders';
-    handle(settingHandlerResponse: SettingHandlerResponse): SettingHandlerResponse {
-        const { containerEl, local, view,settingsManager } = settingHandlerResponse;
-        if (local) {
-            const columns = view.diskConfig.yaml.columns;
-            const allowedColumns = new Set(
-                Object.keys(columns)
-                .filter( (f) => columns[f].input === InputType.SELECT)
-                .map((key) => columns[key].label),
-            );
-        
-              settingsManager.cleanupFns.push(async () => {
-                const config = view.diskConfig.yaml.config;
-                if (config.automatically_group_files) {
-                  const folderPath = destination_folder(view, config);
-                  await FileGroupingService.organizeNotesIntoSubfolders( folderPath, view.rows, config);
-                  await FileGroupingService.removeEmptyFolders(folderPath, config);
-                  view.reloadDatabase();
-                }
-              });
-              
-            new FileGroupingColumnsSetting(view, allowedColumns).init(containerEl);
+  handle(settingHandlerResponse: SettingHandlerResponse): SettingHandlerResponse {
+    const { containerEl, local, view, settingsManager } = settingHandlerResponse;
+    if (local) {
+      const columns = view.diskConfig.yaml.columns;
+      const allowedColumns = new Set(
+        Object.keys(columns)
+          .filter((f) => columns[f].input === InputType.SELECT)
+          .map((key) => columns[key].label),
+      );
 
-            add_toggle(
-              containerEl,
-              "Group all files into folders automatically",
-              "By default, files are groupped individually, after a value is updated",
-              view.diskConfig.yaml.config.automatically_group_files,
-              async (value) => {
-                view.diskConfig.updateConfig({ automatically_group_files: value });
-              }
-            )
-            add_toggle(
-              containerEl,
-              "Remove empty folders",
-              "Automatically remove empty folders after grouping files.",
-              view.diskConfig.yaml.config.remove_empty_folders,
-              async (value) => {
-                view.diskConfig.updateConfig({ remove_empty_folders: value });
-              }
-            )
+      settingsManager.cleanupFns.push(async () => {
+        const config = view.diskConfig.yaml.config;
+        if (config.automatically_group_files) {
+          const folderPath = destination_folder(view, config);
+          await FileGroupingService.organizeNotesIntoSubfolders(folderPath, view.rows, config);
+          await FileGroupingService.removeEmptyFolders(folderPath, config);
+          view.reloadDatabase();
+        }
+      });
 
-            add_toggle(
-              containerEl,
-              "Hoist files with missing attributes to root folder",
-              "By default, files with missing attributes are hoisted to the lowest possible folder",
-              view.diskConfig.yaml.config.hoist_files_with_empty_attributes,
-              async (value) => {
-                view.diskConfig.updateConfig({ hoist_files_with_empty_attributes: value});
-              }
-            )
+      new FileGroupingColumnsSetting(view, allowedColumns).init(containerEl);
+
+      add_toggle(
+        containerEl,
+        "Group all files into folders automatically",
+        "By default, files are groupped individually, after a value is updated",
+        view.diskConfig.yaml.config.automatically_group_files,
+        async (value) => {
+          view.diskConfig.updateConfig({ automatically_group_files: value });
+        }
+      )
+      add_toggle(
+        containerEl,
+        "Remove empty folders",
+        "Automatically remove empty folders after grouping files.",
+        view.diskConfig.yaml.config.remove_empty_folders,
+        async (value) => {
+          view.diskConfig.updateConfig({ remove_empty_folders: value });
+        }
+      )
+
+      add_toggle(
+        containerEl,
+        "Hoist files with missing attributes to root folder",
+        "By default, files with missing attributes are hoisted to the lowest possible folder",
+        view.diskConfig.yaml.config.hoist_files_with_empty_attributes,
+        async (value) => {
+          view.diskConfig.updateConfig({ hoist_files_with_empty_attributes: value });
+        }
+      )
     }
     return this.goNext(settingHandlerResponse);
   }
diff --git a/src/stateManagement/data/DataStateActions.ts b/src/stateManagement/data/DataStateActions.ts
@@ -10,26 +10,25 @@ import DataviewRefreshHandlerAction from "stateManagement/data/handlers/Dataview
 import RemoveOptionForAllRowsAction from "stateManagement/data/handlers/RemoveOptionForAllRowsAction";
 import RenameFileHandlerAction from "stateManagement/data/handlers/RenameFileHandlerAction";
 import SaveDataFromFileHandlerAction from "stateManagement/data/handlers/SaveDataFromFileHandlerAction";
+import GroupFilesHandlerAction from "stateManagement/data/handlers/GroupFilesHandlerAction";
 import { AbstractHandler } from "patterns/AbstractHandler";
-import GroupFilesHandlerAction from "./handlers/GroupFilesHandlerAction";
-
 
 class DataStateActions extends AbstractChain<TableActionResponse<DataState>> {
-    protected getHandlers(): AbstractHandler<TableActionResponse<DataState>>[] {
-        return [
-          new AddRowlHandlerAction(),
-          new UpdateCellHandlerAction(),
-          new ParseDataOfColumnHandlerAction(),
-          new UpdateDataAfterLabelChangeHandlerAction(),
-          new RemoveRowHandlerAction(),
-          new RemoveDataOfColumnHandlerAction(),
-          new DataviewRefreshHandlerAction(),
-          new RemoveOptionForAllRowsAction(),
-          new RenameFileHandlerAction(),
-          new SaveDataFromFileHandlerAction(),
-          new GroupFilesHandlerAction()
-        ];
-    }
+  protected getHandlers(): AbstractHandler<TableActionResponse<DataState>>[] {
+    return [
+      new AddRowlHandlerAction(),
+      new UpdateCellHandlerAction(),
+      new ParseDataOfColumnHandlerAction(),
+      new UpdateDataAfterLabelChangeHandlerAction(),
+      new RemoveRowHandlerAction(),
+      new RemoveDataOfColumnHandlerAction(),
+      new DataviewRefreshHandlerAction(),
+      new RemoveOptionForAllRowsAction(),
+      new RenameFileHandlerAction(),
+      new SaveDataFromFileHandlerAction(),
+      new GroupFilesHandlerAction()
+    ];
+  }
 }
 
 const data_state_actions = new DataStateActions();

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ export class FormulaFunctions implements IGenerateObject {`
`14`	`14`	`): Promise<Record<string, unknown>> {`
`15`	`15`	`let user_script_functions = {};`
`16`	`16`
`17`		`- if (config.formula_folder_path) {`
	`17`	`+ if (config.enable_js_formulas && config.formula_folder_path) {`
`18`	`18`	`user_script_functions =`
`19`	`19`	`await this.js_script_functions.generate_object();`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ import { SettingHandlerResponse } from 'settings/handlers/AbstractSettingHandler`
`3`	`3`	`import { AbstractChain } from 'patterns/AbstractFactoryChain';`
`4`	`4`	`import { AbstractHandler } from 'patterns/AbstractHandler';`
`5`	`5`	`import { FormulaJSFolderHandler } from 'settings/handlers/automation/FormulaJSFolderHandler';`
	`6`	`+import { FormulaJSToggleHandler } from 'settings/handlers/automation/FormulaJSToggleHandler';`
`6`	`7`
`7`	`8`	`class AutomationSetttingsSection extends AbstractChain<SettingHandlerResponse> {`
`8`	`9`	`protected customHandle(settingHandlerResponse: SettingHandlerResponse): SettingHandlerResponse {`
`@@ -14,6 +15,7 @@ class AutomationSetttingsSection extends AbstractChain<SettingHandlerResponse> {`
`14`	`15`	`}`
`15`	`16`	`protected getHandlers(): AbstractHandler<SettingHandlerResponse>[] {`
`16`	`17`	`return [`
	`18`	`+ new FormulaJSToggleHandler(),`
`17`	`19`	`new FormulaJSFolderHandler()`
`18`	`20`	`];`
`19`	`21`	`}`