Merge branch 'master' into imed-docu-branch

RafaelGB · RafaelGB · commit 5fb93514ab7c · 2022-09-07T13:55:39.000+02:00
diff --git a/docs/docs/changelog.md b/docs/docs/changelog.md
@@ -1,3 +1,10 @@
+# 2.3.6
+*Published on 2022/09/07*
+### Improved
+- The tab title bar with Obsidian 0.16 is optional, so the settings of the ddbb where moved to the bar of the plugin itself [ISSUE#330](https://github.com/RafaelGB/obsidian-db-folder/issues/330)
+### No longer broken
+- render of checkbox fixed [ISSUE#334](https://github.com/RafaelGB/obsidian-db-folder/issues/334)
+- order of multisort is persisted [ISSUE#324](https://github.com/RafaelGB/obsidian-db-folder/issues/324)
 # 2.3.5
 *Published on 2022/09/05*
 ### 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.5",
+	"version": "2.3.6",
 	"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.5",
+	"version": "2.3.6",
 	"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.5",
+	"version": "2.3.6",
 	"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
 	"main": "main.js",
 	"scripts": {
diff --git a/src/cdm/FolderModel.ts b/src/cdm/FolderModel.ts
@@ -54,6 +54,7 @@ export type BaseColumn = {
     isMetadata?: boolean;
     isSorted?: boolean;
     isSortedDesc?: boolean;
+    sortIndex?: number;
     isHidden?: boolean;
     skipPersist?: boolean;
     isDragDisabled?: boolean;
diff --git a/src/cdm/TableStateInterface.ts b/src/cdm/TableStateInterface.ts
@@ -37,7 +37,7 @@ export interface DataState {
     rows: RowDataType[];
     actions: {
         addRow: (filename: string, columns: TableColumn[], ddbbConfig: LocalSettings) => void;
-        updateCell: (rowIndex: number, column: TableColumn, value: Literal, columns: TableColumn[], ddbbConfig: LocalSettings, isMovingFile?: boolean) => void;
+        updateCell: (rowIndex: number, column: TableColumn, value: Literal, columns: TableColumn[], ddbbConfig: LocalSettings, isMovingFile?: boolean) => Promise<void>;
         parseDataOfColumn: (column: TableColumn, input: string, ddbbConfig: LocalSettings) => void;
         updateDataAfterLabelChange: (column: TableColumn, label: string, columns: TableColumn[], ddbbConfig: LocalSettings) => Promise<void>;
         removeRow: (row: RowDataType) => Promise<void>;
diff --git a/src/components/CsvButton.tsx b/src/components/CsvButton.tsx
@@ -1,12 +1,12 @@
-import Button from "@mui/material/Button";
 import { CsvButtonProps } from "cdm/MenuBarModel";
 import {
   normalizeColumnsToCsvHeader,
   normalizeRowsToCsvData,
 } from "parsers/NormalizeRowsToCSV";
 import React from "react";
 import { CSVLink } from "react-csv";
-import DownloadIcon from "components/img/DownloadIcon";
+import DownloadIcon from "@mui/icons-material/Download";
+import { MenuButtonStyle } from "components/styles/NavBarStyles";
 
 const CsvButton = (CsvButtonProps: CsvButtonProps) => {
   const { columns, rows, name } = CsvButtonProps;
@@ -35,7 +35,7 @@ const CsvButton = (CsvButtonProps: CsvButtonProps) => {
         ref={csvLink}
         target="_blank"
       >
-        <DownloadIcon />
+        <DownloadIcon {...MenuButtonStyle} />
         Download CSV
       </CSVLink>
     </>
diff --git a/src/components/NavBar.tsx b/src/components/NavBar.tsx
@@ -4,16 +4,21 @@ import MenuIcon from "components/img/MenuIcon";
 import { NavBarProps } from "cdm/MenuBarModel";
 import GlobalFilter from "components/reducers/GlobalFilter";
 import PaginationTable from "components/PaginationTable";
-import { NavBarConfig, StyleVariables } from "helpers/Constants";
+import { InputType, NavBarConfig, StyleVariables } from "helpers/Constants";
 import AppBar from "@mui/material/AppBar";
 import Box from "@mui/material/Box";
 import IconButton from "@mui/material/IconButton";
+import InsertDriveFileIcon from "@mui/icons-material/InsertDriveFile";
+import SettingsIcon from "@mui/icons-material/Settings";
 import Menu from "@mui/material/Menu";
 import MenuItem from "@mui/material/MenuItem";
+
 import Toolbar from "@mui/material/Toolbar";
 import { c } from "helpers/StylesHelper";
 import Typography from "@mui/material/Typography";
 import DataviewFilters from "components/reducers/DataviewFilters";
+import { MenuButtonStyle } from "components/styles/NavBarStyles";
+import { SettingsModal } from "Settings";
 
 export function NavBar(navBarProps: NavBarProps) {
   const { table } = navBarProps;
@@ -29,6 +34,28 @@ export function NavBar(navBarProps: NavBarProps) {
     setAnchorEl(event.currentTarget);
   };
 
+  const handleSettingsClick = () => {
+    setAnchorEl(null);
+    new SettingsModal(
+      view,
+      {
+        onSettingsChange: (settings) => {
+          /**
+           * Settings are saved into the database file, so we don't need to do anything here.
+           */
+        },
+      },
+      view.plugin.settings
+    ).open();
+  };
+
+  const handleOpenAsMarkdownClick = () => {
+    setAnchorEl(null);
+    view.plugin.databaseFileModes[(view.leaf as any).id || view.file.path] =
+      InputType.MARKDOWN;
+    view.plugin.setMarkdownView(view.leaf);
+  };
+
   return (
     <Box sx={{ flexGrow: 1 }}>
       <AppBar
@@ -71,7 +98,15 @@ export function NavBar(navBarProps: NavBarProps) {
               "aria-labelledby": "long-button",
             }}
           >
-            <MenuItem>
+            <MenuItem onClick={handleSettingsClick} disableRipple>
+              <SettingsIcon {...MenuButtonStyle} />
+              Settings
+            </MenuItem>
+            <MenuItem onClick={handleOpenAsMarkdownClick} disableRipple>
+              <InsertDriveFileIcon {...MenuButtonStyle} />
+              Open as Markdown
+            </MenuItem>
+            <MenuItem disableRipple>
               {/* CSV buttton download */}
               <CsvButton
                 columns={columns}
diff --git a/src/components/cellTypes/CheckboxCell.tsx b/src/components/cellTypes/CheckboxCell.tsx
@@ -1,31 +1,23 @@
-import React, { useState } from "react";
+import React from "react";
 import { TableColumn } from "cdm/FolderModel";
 import { c } from "helpers/StylesHelper";
 import { CellComponentProps } from "cdm/ComponentsModel";
 
 function CheckboxCell(props: CellComponentProps) {
   const { defaultCell } = props;
   const { row, column, table } = defaultCell;
-  const tableColumn = column.columnDef as TableColumn;
+  const { tableState } = table.options.meta;
 
-  const dataActions = table.options.meta.tableState.data(
-    (state) => state.actions
-  );
+  const dataActions = tableState.data((state) => state.actions);
 
-  const checkboxCell = table.options.meta.tableState.data(
-    (state) => state.rows[row.index]
-  );
+  const checkboxRow = tableState.data((state) => state.rows[row.index]);
 
-  const columnsInfo = table.options.meta.tableState.columns(
-    (state) => state.info
-  );
+  const columnsInfo = tableState.columns((state) => state.info);
 
-  const configInfo = table.options.meta.tableState.configState(
-    (state) => state.info
-  );
+  const configInfo = tableState.configState((state) => state.info);
 
   const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {
-    const newValue = event.target.checked ? 1 : 0;
+    const newValue = event.target.checked;
     // save on disk
     dataActions.updateCell(
       row.index,
@@ -35,12 +27,12 @@ function CheckboxCell(props: CellComponentProps) {
       configInfo.getLocalSettings()
     );
   };
-
   return (
-    <div className={`${c("checkbox")}`}>
+    <div key={`checkbox-div-${row.index}`} className={`${c("checkbox")}`}>
       <input
         type="checkbox"
-        checked={Boolean(checkboxCell[tableColumn.key])}
+        checked={checkboxRow[column.id] as boolean}
+        key={`checkbox-input-${row.index}`}
         onChange={handleChange}
       />
     </div>
diff --git a/src/components/cellTypes/NumberCell.tsx b/src/components/cellTypes/NumberCell.tsx
@@ -1,10 +1,8 @@
 import { CellComponentProps } from "cdm/ComponentsModel";
 import { TableColumn } from "cdm/FolderModel";
-import { Literal } from "obsidian-dataview";
 import React, {
   ChangeEventHandler,
   KeyboardEventHandler,
-  useEffect,
   useState,
 } from "react";
 
diff --git a/src/components/headerActions/handlers/buttons/SortHandlerAction.tsx b/src/components/headerActions/handlers/buttons/SortHandlerAction.tsx
@@ -52,9 +52,7 @@ function sortingUpButton(headerActionResponse: HeaderActionResponse) {
       tablecolumn.isSorted && !tablecolumn.isSortedDesc ? false : true;
     tablecolumn.isSortedDesc = false;
     hooks.setExpanded(false);
-    // Update state
-    columnActions.alterSorting(tablecolumn);
-
+    // Save on memory
     let currentSorting = [...table.options.state.sorting];
     if (tablecolumn.isSorted) {
       currentSorting.remove(
@@ -64,12 +62,16 @@ function sortingUpButton(headerActionResponse: HeaderActionResponse) {
         id: tablecolumn.id,
         desc: tablecolumn.isSortedDesc,
       });
+      tablecolumn.sortIndex = currentSorting.length;
     } else {
       currentSorting.remove(
         currentSorting.find((s) => s.id === tablecolumn.id)
       );
+      tablecolumn.sortIndex = -1;
     }
     table.setSorting(currentSorting);
+    // Save on disk
+    columnActions.alterSorting(tablecolumn);
   };
   const isAscSorted = column.getIsSorted() === "asc";
   return headerButtonComponent({
@@ -96,8 +98,7 @@ function sortingDownButton(headerActionResponse: HeaderActionResponse) {
     tablecolumn.isSortedDesc = true;
 
     hooks.setExpanded(false);
-    // Update state
-    columnActions.alterSorting(tablecolumn);
+    // Update on memory
     let currentSorting = [...table.options.state.sorting];
     if (tablecolumn.isSorted) {
       currentSorting.remove(
@@ -107,12 +108,16 @@ function sortingDownButton(headerActionResponse: HeaderActionResponse) {
         id: tablecolumn.id,
         desc: tablecolumn.isSortedDesc,
       });
+      tablecolumn.sortIndex = currentSorting.length;
     } else {
       currentSorting.remove(
         currentSorting.find((s) => s.id === tablecolumn.id)
       );
+      tablecolumn.sortIndex = -1;
     }
     table.setSorting(currentSorting);
+    // Update on disk
+    columnActions.alterSorting(tablecolumn);
   };
 
   return headerButtonComponent({
diff --git a/src/components/img/DownloadIcon.tsx b/src/components/img/DownloadIcon.tsx
diff --git a/src/components/styles/NavBarStyles.ts b/src/components/styles/NavBarStyles.ts
@@ -55,4 +55,11 @@ export const PaginationButtonStyle = {
         },
         backgroundColor: StyleVariables.TEXT_ACCENT,
     }
-}
+}
+
+export const MenuButtonStyle = {
+    sx: {
+        color: StyleVariables.TEXT_ACCENT_HOVER,
+    }
+}
+
diff --git a/src/helpers/InitialType.ts b/src/helpers/InitialType.ts
@@ -8,10 +8,20 @@ function obtainInitialType(columns: TableColumn[]): InitialType {
         if (column.isSorted) {
             sortElemList.push({
                 id: column.key,
-                desc: column.isSortedDesc
+                desc: column.isSortedDesc,
             });
         }
     });
+    // Sort by index
+    sortElemList.sort((a: ColumnSort, b: ColumnSort) => {
+        const aIndex = columns.find((column: TableColumn) => column.key === a.id)?.sortIndex;
+        const bIndex = columns.find((column: TableColumn) => column.key === b.id)?.sortIndex;
+        if (aIndex === -1 || bIndex === -1) {
+            return 0;
+        }
+        return aIndex - bIndex;
+    });
+
     initialType.sortBy = sortElemList;
     return initialType;
 }
diff --git a/src/main.ts b/src/main.ts
@@ -395,7 +395,6 @@ export default class DBFolderPlugin extends Plugin {
 		);
 	}
 	registerCommands() {
-		// TODO - add command to create a new database
 		this.addCommand({
 			id: 'create-new-database-folder',
 			name: 'Create a new database table',
diff --git a/src/parsers/handlers/marshall/MarshallColumnsHandler.ts b/src/parsers/handlers/marshall/MarshallColumnsHandler.ts
@@ -47,6 +47,7 @@ export class MarshallColumnsHandler extends AbstractYamlHandler {
                     this.addError(`There was not label in column ${key}`);
                     column.label = key;
                 }
+
                 if (column.skipPersist === undefined) {
                     column.skipPersist = false;
                 }
@@ -55,6 +56,10 @@ export class MarshallColumnsHandler extends AbstractYamlHandler {
                     column.isHidden = false;
                 }
 
+                if (column.sortIndex === undefined || typeof column.sortIndex !== 'number') {
+                    column.sortIndex = -1;
+                }
+
                 /** CONFIG COLUMN INFO */
                 if (!column.config && !(column.config instanceof Object)) {
                     column.config = DEFAULT_COLUMN_CONFIG;
diff --git a/src/stateManagement/columns/handlers/AlterSortingColumnAction.ts b/src/stateManagement/columns/handlers/AlterSortingColumnAction.ts
@@ -1,5 +1,6 @@
 import { TableColumn } from "cdm/FolderModel";
 import { ColumnsState, TableActionResponse } from "cdm/TableStateInterface";
+import obtainInitialType from "helpers/InitialType";
 import { AbstractTableAction } from "stateManagement/AbstractTableAction";
 
 export default class AlterSortingColumnHandlerAction extends AbstractTableAction<ColumnsState> {
@@ -11,13 +12,29 @@ export default class AlterSortingColumnHandlerAction extends AbstractTableAction
                 const index = newColumns.findIndex((c) => c.id === column.id);
                 newColumns[index].isSorted = column.isSorted;
                 newColumns[index].isSortedDesc = column.isSortedDesc;
+                newColumns[index].sortIndex = column.sortIndex;
                 view.diskConfig.updateColumnProperties(
                     column.id,
                     {
                         isSorted: column.isSorted,
                         isSortedDesc: column.isSortedDesc,
+                        sortIndex: column.sortIndex,
                     }
                 );
+                // reordering index in case of current was removed
+                if (column.sortIndex === -1) {
+                    const sortedColumns = obtainInitialType(newColumns);
+                    sortedColumns.sortBy.forEach((sortElem, index) => {
+                        view.diskConfig.updateColumnProperties(
+                            sortElem.id,
+                            {
+                                isSorted: true,
+                                isSortedDesc: sortElem.desc,
+                                sortIndex: index,
+                            }
+                        );
+                    });
+                }
                 return { columns: newColumns };
             });
 
diff --git a/src/stateManagement/data/handlers/UpdateCellHandlerAction.ts b/src/stateManagement/data/handlers/UpdateCellHandlerAction.ts

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