options: render in frontend

Author: yagebu

frontend/css/base.css

@@ -446,19 +446,3 @@ td .status-indicator {
   border-bottom: 5px solid var(--text-color-lightest);
   border-left: 5px solid transparent;
 }
-
-/*
- * View-specific and tables
- */
-
-.options td {
-  text-align: left;
-}
-
-.options td:nth-child(1) {
-  font-weight: 500;
-}
-
-.options td:nth-child(2) {
-  white-space: normal;
-}

frontend/src/api/index.ts

@@ -69,6 +69,7 @@ interface GetAPIParams {
   trial_balance: FiltersConversionInterval;
   ledger_data: undefined;
   move: { filename: string; account: string; new_name: string };
+  options: undefined;
   payee_accounts: { payee: string };
   payee_transaction: { payee: string };
   query: Filters & { query_string: string };

frontend/src/api/validators.ts

@@ -191,6 +191,10 @@ export const getAPIValidators = {
   income_statement: tree_report,
   ledger_data: ledgerDataValidator,
   move: string,
+  options: object({
+    fava_options: record(string),
+    beancount_options: record(string),
+  }),
   payee_accounts: array(string),
   payee_transaction: Transaction.validator,
   query: query_validator,

frontend/src/reports/options/Options.svelte

@@ -0,0 +1,17 @@
+<script lang="ts">
+  import { urlFor } from "../../helpers";
+  import { _ } from "../../i18n";
+  import OptionsTable from "./OptionsTable.svelte";
+
+  export let fava_options: Record<string, string>;
+  export let beancount_options: Record<string, string>;
+</script>
+
+<h2>
+  {_("Fava options")}
+  <a href={urlFor("help/options")}>({_("help")})</a>
+</h2>
+<OptionsTable options={fava_options} />
+
+<h2>{_("Beancount options")}</h2>
+<OptionsTable options={beancount_options} />

frontend/src/reports/options/OptionsTable.svelte

@@ -0,0 +1,41 @@
+<script lang="ts">
+  import { _ } from "../../i18n";
+  import { Sorter, StringColumn } from "../../sort";
+  import SortHeader from "../../sort/SortHeader.svelte";
+
+  type T = [string, string];
+  export let options: Record<string, string>;
+
+  const columns = [
+    new StringColumn<T>(_("Key"), (d) => d[0]),
+    new StringColumn<T>(_("Value"), (d) => d[1]),
+  ] as const;
+  let sorter = new Sorter(columns[0], "asc");
+
+  $: options_array = Object.entries(options);
+  $: sorted_options = sorter.sort(options_array);
+</script>
+
+<table>
+  <thead>
+    <tr>
+      {#each columns as column}
+        <SortHeader bind:sorter {column} />
+      {/each}
+    </tr>
+  </thead>
+  <tbody>
+    {#each sorted_options as [key, value] (key)}
+      <tr>
+        <td>{key}</td>
+        <td><pre>{value}</pre></td>
+      </tr>
+    {/each}
+  </tbody>
+</table>
+
+<style>
+  td:nth-child(1) {
+    font-weight: 500;
+  }
+</style>

frontend/src/reports/options/index.ts

@@ -0,0 +1,11 @@
+import { get } from "../../api";
+import { _ } from "../../i18n";
+import { Route } from "../route";
+import OptionsSvelte from "./Options.svelte";
+
+export const options = new Route(
+  "options",
+  OptionsSvelte,
+  async () => get("options"),
+  () => _("Options"),
+);

frontend/src/reports/routes.ts

@@ -7,6 +7,7 @@ import ErrorsSvelte from "./errors/Errors.svelte";
 import { events } from "./events";
 import { holdings } from "./holdings";
 import { import_report } from "./import";
+import { options } from "./options";
 import QuerySvelte from "./query/Query.svelte";
 import { noload, Route } from "./route";
 import { balance_sheet, income_statement, trial_balance } from "./tree_reports";
@@ -30,6 +31,7 @@ export const frontend_routes: Route[] = [
   holdings,
   import_report,
   income_statement,
+  options,
   new Route("query", QuerySvelte, noload, () => _("Query")),
   trial_balance,
 ];

src/fava/application.py

@@ -14,7 +14,6 @@
 
 import logging
 import mimetypes
-from dataclasses import fields
 from datetime import date
 from datetime import datetime
 from datetime import timezone
@@ -77,7 +76,6 @@
 
 SERVER_SIDE_REPORTS = [
     "journal",
-    "options",
     "statistics",
 ]
 
@@ -91,6 +89,7 @@
     "holdings",
     "import",
     "income_statement",
+    "options",
     "query",
     "trial_balance",
 ]
@@ -238,7 +237,6 @@ def _setup_template_config(fava_app: Flask, *, incognito: bool) -> None:
     fava_app.add_template_filter(template_filters.flag_to_type)
     fava_app.add_template_filter(template_filters.format_currency)
     fava_app.add_template_filter(template_filters.meta_items)
-    fava_app.add_template_filter(fields, "dataclass_fields")
     fava_app.add_template_filter(
         template_filters.replace_numbers
         if incognito

src/fava/json_api.py

@@ -10,11 +10,13 @@
 import shutil
 from abc import abstractmethod
 from dataclasses import dataclass
+from dataclasses import fields
 from functools import wraps
 from http import HTTPStatus
 from inspect import Parameter
 from inspect import signature
 from pathlib import Path
+from pprint import pformat
 from typing import Any
 from typing import Callable
 from typing import TYPE_CHECKING
@@ -504,6 +506,32 @@ def get_documents() -> Sequence[Document]:
     ]
 
 
+@dataclass(frozen=True)
+class Options:
+    """Fava and Beancount options as strings."""
+
+    fava_options: Mapping[str, str]
+    beancount_options: Mapping[str, str]
+
+
+@api_endpoint
+def get_options() -> Options:
+    """Get all options, rendered to strings for displaying in the frontend."""
+    g.ledger.changed()
+
+    fava_options = g.ledger.fava_options
+    pprinted_fava_options = {
+        field.name.replace("_", "-"): pformat(
+            getattr(fava_options, field.name)
+        )
+        for field in fields(fava_options)
+    }
+    return Options(
+        pprinted_fava_options,
+        {key: str(value) for key, value in g.ledger.options.items()},
+    )
+
+
 @dataclass(frozen=True)
 class CommodityPairWithPrices:
     """A pair of commodities and prices for them."""